Package org.projectnessie.client.api

Interface NessieApiV1

All Superinterfaces:

AutoCloseable, NessieApi

All Known Implementing Classes:

HttpApiV1

public interface NessieApiV1
extends NessieApi

Interface for the Nessie V1 API implementation.

Method Summary

Modifier and Type	Method	Description
AssignBranchBuilder	assignBranch()	Update a branch.
AssignTagBuilder	assignTag()	Update a tag.
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.
GetContentsBuilder	getContents()
Branch	getDefaultBranch()	Get details for the default reference.
GetEntriesBuilder	getEntries()	Retrieve objects for a ref, potentially truncated by the backend.
GetReferenceBuilder	getReference()	Get details of a particular ref, if it exists.
MergeReferenceBuilder	mergeRefIntoBranch()	merge mergeRef onto ref.
TransplantCommitsBuilder	transplantCommitsIntoBranch()	cherry pick a set of commits into a branch.

Methods inherited from interface org.projectnessie.client.api.NessieApi

close

Method Detail

getConfig

NessieConfiguration getConfig()

Get the server configuration.

getDefaultBranch

Branch getDefaultBranch()
                 throws NessieNotFoundException

Get details for the default reference.

Throws:

NessieNotFoundException

getContents

GetContentsBuilder getContents()

getAllReferences

GetAllReferencesBuilder getAllReferences()

Get all references.

createReference

CreateReferenceBuilder createReference()

Create a new reference.

getReference

GetReferenceBuilder getReference()

Get details of a particular ref, if it exists.

getEntries

GetEntriesBuilder getEntries()

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.hasMore() 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.

getCommitLog

GetCommitLogBuilder getCommitLog()

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.hasMore() 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.

assignTag

AssignTagBuilder assignTag()

Update a tag.

deleteTag

DeleteTagBuilder deleteTag()

Delete a tag.

assignBranch

AssignBranchBuilder assignBranch()

Update a branch.

deleteBranch

DeleteBranchBuilder deleteBranch()

Delete a branch.

transplantCommitsIntoBranch

TransplantCommitsBuilder transplantCommitsIntoBranch()

cherry pick a set of commits into a branch.

mergeRefIntoBranch

MergeReferenceBuilder mergeRefIntoBranch()

merge mergeRef onto ref.

commitMultipleOperations

CommitMultipleOperationsBuilder commitMultipleOperations()