Package org.projectnessie.client.api

Interface NessieApiV2

  • All Superinterfaces:
    java.lang.AutoCloseable, NessieApi, NessieApiV1
    All Known Implementing Classes:
    HttpApiV2
    public interface NessieApiV2
extends NessieApiV1
    Interface for the Nessie V2 API implementation.

    At the java client level this API uses the same builder classes and model types as API v1, however the behaviour of some API methods is different.

    Most changes between v1 and v2 exist at the REST level (HTTP).

    • Method Detail

      • deleteReference

        DeleteReferenceBuilder<org.projectnessie.model.Reference> deleteReference()
        Delete a branch or a tag.

      • assignReference

        AssignReferenceBuilder<org.projectnessie.model.Reference> assignReference()
        Update a branch or a tag (make it point to an arbitrary commit).

      • getRefLog

        @Deprecated
default GetRefLogBuilder getRefLog()
        Deprecated.
        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.

        Specified by:
        getRefLog in interface NessieApiV1

      • referenceHistory

        ReferenceHistoryBuilder referenceHistory()
        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.