Interface PagingBuilder<R extends PagingBuilder<R,​RESP,​ENTRY>,​RESP,​ENTRY>

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RESP get()
      Advanced usage, for manual paging: fetches a response chunk (might be one page or complete response depending on use case and parameters), but callers must implement paging on their own, if necessary.
      R maxRecords​(int maxRecords)
      Sets the maximum number of records to be returned in a single response object from the get() method.
      R pageToken​(java.lang.String pageToken)
      Sets the page token from the previous' get() method invocation.
      java.util.stream.Stream<ENTRY> stream()
      Retrieve entries/results as a Java Stream, uses automatic paging.
    • Method Detail

      • maxRecords

        R maxRecords​(int maxRecords)
        Sets the maximum number of records to be returned in a single response object from the get() method.

        This setter reflects the OpenAPI parameter maxRecords in a paged request, for example CommitLogParams for TreeApi.getCommitLog(String, CommitLogParams).

      • pageToken

        R pageToken​(java.lang.String pageToken)
        Sets the page token from the previous' get() method invocation. When using stream() methods this parameter must not be set.

        Only for manual paging via get() - do not call when using any of the stream() functions.

        This setter reflects the OpenAPI parameter pageToken in a paged request, for example CommitLogParams for TreeApi.getCommitLog(String, CommitLogParams).

      • get

        RESP get()
          throws org.projectnessie.error.NessieNotFoundException
        Advanced usage, for manual paging: fetches a response chunk (might be one page or complete response depending on use case and parameters), but callers must implement paging on their own, if necessary. If in doubt, use stream() instead.
        Throws:
        org.projectnessie.error.NessieNotFoundException
      • stream

        java.util.stream.Stream<ENTRY> stream()
                                       throws org.projectnessie.error.NessieNotFoundException
        Retrieve entries/results as a Java Stream, uses automatic paging.
        Throws:
        org.projectnessie.error.NessieNotFoundException