Package org.projectnessie.client.api

Interface GetAllReferencesBuilder

All Superinterfaces:
PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>, QueryBuilder<GetAllReferencesBuilder>
All Known Implementing Classes:
BaseGetAllReferencesBuilder
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

    Modifier and Type
    Method
    Description
    default GetAllReferencesBuilder
    fetch(org.projectnessie.api.params.FetchOption fetchOption)
    Deprecated.
    GetAllReferencesBuilder
    fetch(org.projectnessie.model.FetchOption fetchOption)
    Will fetch additional metadata about Branch / Tag instances, 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.ReferencesResponse
    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.

    Methods inherited from interface org.projectnessie.client.api.PagingBuilder

    maxRecords, pageToken, stream

    Methods inherited from interface org.projectnessie.client.api.QueryBuilder

    filter

  • Method Details

    • fetch

      GetAllReferencesBuilder fetch(org.projectnessie.model.FetchOption fetchOption)
      Will fetch additional metadata about Branch / Tag instances, 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

    • fetch

      @Deprecated default GetAllReferencesBuilder fetch(org.projectnessie.api.params.FetchOption fetchOption)
      Deprecated.
      Legacy API method for backward compatibility. Use fetch(FetchOption) instead.

    • get

      org.projectnessie.model.ReferencesResponse get()
      Description copied from interface: PagingBuilder
      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 PagingBuilder.stream() instead.
      Specified by:
      get in interface PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>