Package org.projectnessie.client.api
Interface GetAllReferencesBuilder
-
- All Superinterfaces:
PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>,QueryBuilder<GetAllReferencesBuilder>
public interface GetAllReferencesBuilder extends QueryBuilder<GetAllReferencesBuilder>, PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>
Request builder for "get all references".- Since:
NessieApiV1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description GetAllReferencesBuilderfetch(org.projectnessie.api.params.FetchOption fetchOption)Will fetch additional metadata aboutBranch/Taginstances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.org.projectnessie.model.ReferencesResponseget()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.-
Methods inherited from interface org.projectnessie.client.api.PagingBuilder
maxRecords, pageToken, stream
-
Methods inherited from interface org.projectnessie.client.api.QueryBuilder
filter
-
-
-
-
Method Detail
-
fetch
GetAllReferencesBuilder fetch(org.projectnessie.api.params.FetchOption fetchOption)
Will fetch additional metadata aboutBranch/Taginstances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.- Parameters:
fetchOption- The option indicating how much info to fetch- Returns:
GetAllReferencesBuilder
-
get
org.projectnessie.model.ReferencesResponse get()
Description copied from interface:PagingBuilderAdvanced 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, usePagingBuilder.stream()instead.- Specified by:
getin interfacePagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>
-
-