Package org.projectnessie.client.api

Interface NessieApiV1

All Superinterfaces:
AutoCloseable, NessieApi
All Known Subinterfaces:
NessieApiV2
All Known Implementing Classes:
HttpApiV1, HttpApiV2
public interface NessieApiV1 extends NessieApi
Interface for the Nessie V1 API implementation.

  • Method Details

    • getConfig

      org.projectnessie.model.NessieConfiguration getConfig()
      Get the server configuration.

    • getDefaultBranch

      org.projectnessie.model.Branch getDefaultBranch() throws org.projectnessie.error.NessieNotFoundException
      Get 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 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.

    • 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.isHasMore() and, if true, pass the value of LogResponse.getToken() in the next invocation of getCommitLog() as the pageToken parameter.

    • 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 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.

    • getNamespace

      GetNamespaceBuilder getNamespace()
      Fetch a single Namespace.

    • getMultipleNamespaces

      GetMultipleNamespacesBuilder getMultipleNamespaces()
      Fetch one or more Namespaces based on a given prefix.

    • createNamespace

      CreateNamespaceBuilder createNamespace()
      Create a single Namespace.

    • deleteNamespace

      DeleteNamespaceBuilder deleteNamespace()
      Delete a single Namespace.

    • updateProperties

      UpdateNamespaceBuilder updateProperties()
      Updates properties of a Namespace.