Package org.projectnessie.client.http.v1api

Class HttpApiV1

java.lang.Object

org.projectnessie.client.http.v1api.HttpApiV1

All Implemented Interfaces:

AutoCloseable, NessieApi, NessieApiV1

public final class HttpApiV1
extends Object
implements NessieApiV1

Constructor Summary

Constructors

Constructor	Description
HttpApiV1(NessieApiClient client)

Method Summary

Modifier and Type	Method	Description
AssignBranchBuilder	assignBranch()	Update a branch.
AssignTagBuilder	assignTag()	Update a tag.
void	close()
CommitMultipleOperationsBuilder	commitMultipleOperations()
CreateReferenceBuilder	createReference()	Create a new reference.
DeleteBranchBuilder	deleteBranch()	Delete a branch.
DeleteTagBuilder	deleteTag()	Delete a tag.
GetAllReferencesBuilder	getAllReferences()	Get all references.
GetCommitLogBuilder	getCommitLog()	Retrieve the commit log for a ref, potentially truncated by the backend.
NessieConfiguration	getConfig()	Get the server configuration.
GetContentBuilder	getContent()
Branch	getDefaultBranch()	Get details for the default reference.
GetDiffBuilder	getDiff()	Retrieve a diff between two references.
GetEntriesBuilder	getEntries()	Retrieve objects for a ref, potentially truncated by the backend.
GetReferenceBuilder	getReference()	Get details of a particular ref, if it exists.
GetRefLogBuilder	getRefLog()	Retrieve the reflog from the HEAD of the RefLog resource, potentially truncated by the backend.
MergeReferenceBuilder	mergeRefIntoBranch()	merge mergeRef onto ref.
TransplantCommitsBuilder	transplantCommitsIntoBranch()	cherry pick a set of commits into a branch.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpApiV1

public HttpApiV1(NessieApiClient client)

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NessieApi

getConfig

public NessieConfiguration getConfig()

Description copied from interface: NessieApiV1

Get the server configuration.

Specified by:

getConfig in interface NessieApiV1

getDefaultBranch

public Branch getDefaultBranch()
                        throws NessieNotFoundException

Description copied from interface: NessieApiV1

Get details for the default reference.

Specified by:

getDefaultBranch in interface NessieApiV1

Throws:

NessieNotFoundException

getContent

public GetContentBuilder getContent()

Specified by:

getContent in interface NessieApiV1

getAllReferences

public GetAllReferencesBuilder getAllReferences()

Description copied from interface: NessieApiV1

Get all references.

Specified by:

getAllReferences in interface NessieApiV1

getReference

public GetReferenceBuilder getReference()

Description copied from interface: NessieApiV1

Get details of a particular ref, if it exists.

Specified by:

getReference in interface NessieApiV1

createReference

public CreateReferenceBuilder createReference()

Description copied from interface: NessieApiV1

Create a new reference.

Specified by:

createReference in interface NessieApiV1

getEntries

public GetEntriesBuilder getEntries()

Description copied from interface: NessieApiV1

Retrieve objects for a ref, potentially truncated by the backend.

Retrieves up to maxRecords objects for the given named reference (tag or branch). The backend may respect the given max records hint, but return less or more entries. Backends may also cap the returned entries at a hard-coded limit, the default REST server implementation has such a hard-coded limit.

Invoking getEntries() does not guarantee to return all commit log entries of a given reference, because the result can be truncated by the backend.

To implement paging, check EntriesResponse.isHasMore() and, if true, pass the value of EntriesResponse.getToken() in the next invocation of getEntries() as the pageToken parameter.

See org.projectnessie.client.StreamingUtil in nessie-client.

Specified by:

getEntries in interface NessieApiV1

getCommitLog

public GetCommitLogBuilder getCommitLog()

Description copied from interface: NessieApiV1

Retrieve the commit log for a ref, potentially truncated by the backend.

Retrieves up to maxRecords commit-log-entries starting at the HEAD of the given named reference (tag or branch). The backend may respect the given max records hint, but return less or more entries. Backends may also cap the returned entries at a hard-coded limit, the default REST server implementation has such a hard-coded limit.

Invoking getCommitLog() does not guarantee to return all commit log entries of a given reference, because the result can be truncated by the backend.

To implement paging, check LogResponse.isHasMore() and, if true, pass the value of LogResponse.getToken() in the next invocation of getCommitLog() as the pageToken parameter.

See org.projectnessie.client.StreamingUtil in nessie-client.

Specified by:

getCommitLog in interface NessieApiV1

assignTag

public AssignTagBuilder assignTag()

Description copied from interface: NessieApiV1

Update a tag.

Specified by:

assignTag in interface NessieApiV1

deleteTag

public DeleteTagBuilder deleteTag()

Description copied from interface: NessieApiV1

Delete a tag.

Specified by:

deleteTag in interface NessieApiV1

assignBranch

public AssignBranchBuilder assignBranch()

Description copied from interface: NessieApiV1

Update a branch.

Specified by:

assignBranch in interface NessieApiV1

deleteBranch

public DeleteBranchBuilder deleteBranch()

Description copied from interface: NessieApiV1

Delete a branch.

Specified by:

deleteBranch in interface NessieApiV1

transplantCommitsIntoBranch

public TransplantCommitsBuilder transplantCommitsIntoBranch()

Description copied from interface: NessieApiV1

cherry pick a set of commits into a branch.

Specified by:

transplantCommitsIntoBranch in interface NessieApiV1

mergeRefIntoBranch

public MergeReferenceBuilder mergeRefIntoBranch()

Description copied from interface: NessieApiV1

merge mergeRef onto ref.

Specified by:

mergeRefIntoBranch in interface NessieApiV1

commitMultipleOperations

public CommitMultipleOperationsBuilder commitMultipleOperations()

Specified by:

commitMultipleOperations in interface NessieApiV1

getDiff

public GetDiffBuilder getDiff()

Description copied from interface: NessieApiV1

Retrieve a diff between two references.

Specified by:

getDiff in interface NessieApiV1

getRefLog

public GetRefLogBuilder getRefLog()

Description copied from interface: NessieApiV1

Retrieve the reflog from the HEAD of the RefLog resource, potentially truncated by the backend.

Retrieves up to maxRecords refLog-entries starting at the HEAD of the RefLog resource. The backend may respect the given max records hint, but return less or more entries. Backends may also cap the returned entries at a hard-coded limit, the default REST server implementation has such a hard-coded limit.

Invoking getRefLog() does not guarantee to return all reflog entries, because the result can be truncated by the backend.

To implement paging, check RefLogResponse.isHasMore() and, if true, pass the value of RefLogResponse.getToken() in the next invocation of getRefLog() as the pageToken parameter.

See org.projectnessie.client.StreamingUtil in nessie-client.

Specified by:

getRefLog in interface NessieApiV1