Interface NessieApiV1
-
- All Superinterfaces:
java.lang.AutoCloseable,NessieApi
- All Known Subinterfaces:
NessieApiV2
public interface NessieApiV1 extends NessieApi
Interface for the Nessie V1 API implementation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description AssignBranchBuilderassignBranch()Update a branch.AssignTagBuilderassignTag()Update a tag.CommitMultipleOperationsBuildercommitMultipleOperations()CreateNamespaceBuildercreateNamespace()Create a singleNamespace.CreateReferenceBuildercreateReference()Create a new reference.DeleteBranchBuilderdeleteBranch()Delete a branch.DeleteNamespaceBuilderdeleteNamespace()Delete a singleNamespace.DeleteTagBuilderdeleteTag()Delete a tag.GetAllReferencesBuildergetAllReferences()Get all references.GetCommitLogBuildergetCommitLog()Retrieve the commit log for a ref, potentially truncated by the backend.org.projectnessie.model.NessieConfigurationgetConfig()Get the server configuration.GetContentBuildergetContent()org.projectnessie.model.BranchgetDefaultBranch()Get details for the default reference.GetDiffBuildergetDiff()Retrieve a diff between two references.GetEntriesBuildergetEntries()Retrieve objects for a ref, potentially truncated by the backend.GetMultipleNamespacesBuildergetMultipleNamespaces()Fetch one or moreNamespaces based on a given prefix.GetNamespaceBuildergetNamespace()Fetch a singleNamespace.GetReferenceBuildergetReference()Get details of a particular ref, if it exists.GetRefLogBuildergetRefLog()Deprecated.MergeReferenceBuildermergeRefIntoBranch()merge mergeRef onto ref.TransplantCommitsBuildertransplantCommitsIntoBranch()cherry pick a set of commits into a branch.UpdateNamespaceBuilderupdateProperties()Updates properties of aNamespace.
-
-
-
Method Detail
-
getConfig
org.projectnessie.model.NessieConfiguration getConfig()
Get the server configuration.
-
getDefaultBranch
org.projectnessie.model.Branch getDefaultBranch() throws org.projectnessie.error.NessieNotFoundExceptionGet details for the default reference.- Throws:
org.projectnessie.error.NessieNotFoundException
-
getContent
GetContentBuilder getContent()
-
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
maxRecordsobjects for the given named reference (tag or branch). The backend may respect the givenmaxrecords 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, iftrue, pass the value ofEntriesResponse.getToken()in the next invocation ofgetEntries()as thepageTokenparameter.See
org.projectnessie.client.StreamingUtilinnessie-client.
-
getCommitLog
GetCommitLogBuilder getCommitLog()
Retrieve the commit log for a ref, potentially truncated by the backend.Retrieves up to
maxRecordscommit-log-entries starting at the HEAD of the given named reference (tag or branch). The backend may respect the givenmaxrecords 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, iftrue, pass the value ofLogResponse.getToken()in the next invocation ofgetCommitLog()as thepageTokenparameter.See
org.projectnessie.client.StreamingUtilinnessie-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()
-
getDiff
GetDiffBuilder getDiff()
Retrieve a diff between two references.
-
getRefLog
@Deprecated GetRefLogBuilder getRefLog()
Deprecated.Retrieve the reflog from the HEAD of the RefLog resource, potentially truncated by the backend.The Nessie reflog in this form is deprecated, likely for removal.
Retrieves up to
maxRecordsrefLog-entries starting at the HEAD of the RefLog resource. The backend may respect the givenmaxrecords 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, iftrue, pass the value ofRefLogResponse.getToken()in the next invocation ofgetRefLog()as thepageTokenparameter.See
org.projectnessie.client.StreamingUtilinnessie-client.
-
getNamespace
GetNamespaceBuilder getNamespace()
Fetch a singleNamespace.
-
getMultipleNamespaces
GetMultipleNamespacesBuilder getMultipleNamespaces()
Fetch one or moreNamespaces based on a given prefix.
-
createNamespace
CreateNamespaceBuilder createNamespace()
Create a singleNamespace.
-
deleteNamespace
DeleteNamespaceBuilder deleteNamespace()
Delete a singleNamespace.
-
updateProperties
UpdateNamespaceBuilder updateProperties()
Updates properties of aNamespace.
-
-