Interface HttpRefLogApi

  • All Superinterfaces:
    RefLogApi

    @Consumes("application/json")
    @Path("reflogs")
    public interface HttpRefLogApi
    extends RefLogApi
    • Method Detail

      • getRefLog

        @GET
        @Produces("application/json")
        RefLogResponse getRefLog​(@BeanParam
                                 RefLogParams params)
                          throws NessieNotFoundException
        Description copied from interface: RefLogApi
        Retrieve the reflog, potentially truncated by the backend.

        Retrieves up to maxRecords refLog-entries starting at the HEAD of current-reflog. 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 RefLogApi
        Returns:
        RefLogResponse
        Throws:
        NessieNotFoundException