Package org.projectnessie.client.api
Interface PagingBuilder<R extends PagingBuilder<R,RESP,ENTRY>,RESP,ENTRY>
-
- All Known Subinterfaces:
GetAllReferencesBuilder,GetCommitLogBuilder,GetEntriesBuilder,GetRefLogBuilder
public interface PagingBuilder<R extends PagingBuilder<R,RESP,ENTRY>,RESP,ENTRY>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RESPget()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.RmaxRecords(int maxRecords)Sets the maximum number of records to be returned in a single response object from theget()method.RpageToken(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 JavaStream, 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 theget()method.This setter reflects the OpenAPI parameter
maxRecordsin a paged request, for exampleCommitLogParamsforTreeApi.getCommitLog(String, CommitLogParams).
-
pageToken
R pageToken(java.lang.String pageToken)
Sets the page token from the previous'get()method invocation. When usingstream()methods this parameter must not be set.Only for manual paging via
get()- do not call when using any of thestream()functions.This setter reflects the OpenAPI parameter
pageTokenin a paged request, for exampleCommitLogParamsforTreeApi.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, usestream()instead.- Throws:
org.projectnessie.error.NessieNotFoundException
-
stream
java.util.stream.Stream<ENTRY> stream() throws org.projectnessie.error.NessieNotFoundException
Retrieve entries/results as a JavaStream, uses automatic paging.- Throws:
org.projectnessie.error.NessieNotFoundException
-
-