Interface NessieApiV1

  • All Superinterfaces:
    java.lang.AutoCloseable, NessieApi
    All Known Implementing Classes:
    HttpApiV1

    public interface NessieApiV1
    extends NessieApi
    Interface for the Nessie V1 API implementation.
    • Method Detail

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

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

      • transplantCommitsIntoBranch

        TransplantCommitsBuilder transplantCommitsIntoBranch()
        cherry pick a set of commits into a branch.
      • 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.

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