Package org.projectnessie.client.api

Interface GetAllReferencesBuilder

All Superinterfaces:

PagingBuilder<GetAllReferencesBuilder>, QueryBuilder<GetAllReferencesBuilder>

public interface GetAllReferencesBuilder
extends QueryBuilder<GetAllReferencesBuilder>, PagingBuilder<GetAllReferencesBuilder>

Request builder for "get all references".

Since:

NessieApiV1

Method Summary

Modifier and Type	Method	Description
GetAllReferencesBuilder	fetch(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.
ReferencesResponse	get()	Fetches all references and returns them in a ReferencesResponse instance.

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

maxRecords, pageToken

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

filter

Method Detail

fetch

GetAllReferencesBuilder fetch(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

get

ReferencesResponse get()

Fetches all references and returns them in a ReferencesResponse instance.

Returns:

Fetches all references and returns them in a ReferencesResponse instance.