Class HttpApiV1

    • Method Detail

      • close

        public void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface NessieApi
      • 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
      • 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.

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

        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.

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

        Specified by:
        getCommitLog in interface NessieApiV1
      • getRefLog

        public GetRefLogBuilder getRefLog()
        Description copied from interface: NessieApiV1
        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.

        Specified by:
        getRefLog in interface NessieApiV1