Package org.projectnessie.client.rest.v2

Class HttpApiV2

java.lang.Object

org.projectnessie.client.rest.v2.HttpApiV2

All Implemented Interfaces:

AutoCloseable, NessieApi, NessieApiV1, NessieApiV2

public class HttpApiV2
extends Object
implements NessieApiV2

Constructor Summary

Constructors

Constructor	Description
HttpApiV2(HttpClient client)

Method Summary

Modifier and Type	Method	Description
AssignBranchBuilder	assignBranch()	Update a branch.
AssignReferenceBuilder	assignReference()	Update a branch or a tag (make it point to an arbitrary commit).
AssignTagBuilder	assignTag()	Update a tag.
void	close()
CommitMultipleOperationsBuilder	commitMultipleOperations()
CreateReferenceBuilder	createReference()	Create a new reference.
DeleteBranchBuilder	deleteBranch()	Delete a branch.
DeleteReferenceBuilder	deleteReference()	Delete a branch or a tag.
DeleteTagBuilder	deleteTag()	Delete a tag.
GetAllReferencesBuilder	getAllReferences()	Get all references.
GetCommitLogBuilder	getCommitLog()	Retrieve the commit log for a ref, potentially truncated by the backend.
org.projectnessie.model.NessieConfiguration	getConfig()	Get the server configuration.
GetContentBuilder	getContent()
org.projectnessie.model.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.
GetRepositoryConfigBuilder	getRepositoryConfig()
MergeReferenceBuilder	mergeRefIntoBranch()	merge mergeRef onto ref.
ReferenceHistoryBuilder	referenceHistory()	Retrieve the recorded recent history of a reference.
TransplantCommitsBuilder	transplantCommitsIntoBranch()	cherry pick a set of commits into a branch.
<C> Optional<C>	unwrapClient(Class<C> clientType)	Returns the possibly protocol but definitely implementation specific client instance.
UpdateRepositoryConfigBuilder	updateRepositoryConfig()

Methods inherited from class java.lang.Object

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

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

createNamespace, deleteNamespace, getMultipleNamespaces, getNamespace, getRefLog, updateProperties

Constructor Details

HttpApiV2

public HttpApiV2(HttpClient client)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface NessieApi

unwrapClient

public <C> Optional<C> unwrapClient(Class<C> clientType)

Description copied from interface: NessieApi

Returns the possibly protocol but definitely implementation specific client instance.

Specified by:

unwrapClient in interface NessieApi

Type Parameters:

C - requested/expected client type.

Parameters:

clientType - Expected client type.

Returns:

an Optional with either the client of the requested type or empty.

getConfig

public org.projectnessie.model.NessieConfiguration getConfig()

Description copied from interface: NessieApiV1

Get the server configuration.

Specified by:

getConfig in interface NessieApiV1

getDefaultBranch

public org.projectnessie.model.Branch getDefaultBranch()
                                                throws org.projectnessie.error.NessieNotFoundException

Description copied from interface: NessieApiV1

Get details for the default reference.

Specified by:

getDefaultBranch in interface NessieApiV1

Throws:

org.projectnessie.error.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

createReference

public CreateReferenceBuilder createReference()

Description copied from interface: NessieApiV1

Create a new reference.

Specified by:

createReference 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

referenceHistory

public ReferenceHistoryBuilder referenceHistory()

Description copied from interface: NessieApiV2

Retrieve the recorded recent history of a reference.

A reference's history is a size and time limited record of changes of the reference's current pointer, aka HEAD. The size and time limits are configured in the Nessie server configuration.

Specified by:

referenceHistory in interface NessieApiV2

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.

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.

Specified by:

getCommitLog in interface NessieApiV1

assignTag

public AssignTagBuilder assignTag()

Description copied from interface: NessieApiV2

Update a tag.

Specified by:

assignTag in interface NessieApiV1

Specified by:

assignTag in interface NessieApiV2

deleteTag

public DeleteTagBuilder deleteTag()

Description copied from interface: NessieApiV2

Delete a tag.

Specified by:

deleteTag in interface NessieApiV1

Specified by:

deleteTag in interface NessieApiV2

assignBranch

public AssignBranchBuilder assignBranch()

Description copied from interface: NessieApiV2

Update a branch.

Specified by:

assignBranch in interface NessieApiV1

Specified by:

assignBranch in interface NessieApiV2

deleteBranch

public DeleteBranchBuilder deleteBranch()

Description copied from interface: NessieApiV2

Delete a branch.

Specified by:

deleteBranch in interface NessieApiV1

Specified by:

deleteBranch in interface NessieApiV2

assignReference

public AssignReferenceBuilder assignReference()

Description copied from interface: NessieApiV2

Update a branch or a tag (make it point to an arbitrary commit).

Specified by:

assignReference in interface NessieApiV2

deleteReference

public DeleteReferenceBuilder deleteReference()

Description copied from interface: NessieApiV2

Delete a branch or a tag.

Specified by:

deleteReference in interface NessieApiV2

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

getRepositoryConfig

public GetRepositoryConfigBuilder getRepositoryConfig()

Specified by:

getRepositoryConfig in interface NessieApiV2

updateRepositoryConfig

public UpdateRepositoryConfigBuilder updateRepositoryConfig()

Specified by:

updateRepositoryConfig in interface NessieApiV2