Package org.projectnessie.client.builder

Class BaseGetAllReferencesBuilder<PARAMS>

java.lang.Object

org.projectnessie.client.builder.BaseGetAllReferencesBuilder<PARAMS>

All Implemented Interfaces:

GetAllReferencesBuilder, PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>, QueryBuilder<GetAllReferencesBuilder>

public abstract class BaseGetAllReferencesBuilder<PARAMS>
extends java.lang.Object
implements GetAllReferencesBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected org.projectnessie.model.FetchOption	fetchOption
protected java.lang.String	filter
protected java.lang.Integer	maxRecords

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseGetAllReferencesBuilder(java.util.function.BiFunction<PARAMS,java.lang.String,PARAMS> paramsForPage)

Method Summary

Modifier and Type	Method	Description
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.
GetAllReferencesBuilder	filter(java.lang.String filter)	Required: the CEL script.
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.
protected abstract org.projectnessie.model.ReferencesResponse	get(PARAMS p)
GetAllReferencesBuilder	maxRecords(int maxRecords)	Sets the maximum number of records to be returned in a single response object from the PagingBuilder.get() method.
GetAllReferencesBuilder	pageToken(java.lang.String pageToken)	Sets the page token from the previous' PagingBuilder.get() method invocation.
protected abstract PARAMS	params()
java.util.stream.Stream<org.projectnessie.model.Reference>	stream()	Retrieve entries/results as a Java Stream, uses automatic paging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

fetch

Field Detail

maxRecords

protected java.lang.Integer maxRecords

fetchOption

protected org.projectnessie.model.FetchOption fetchOption

filter

protected java.lang.String filter

Constructor Detail

BaseGetAllReferencesBuilder

protected BaseGetAllReferencesBuilder(java.util.function.BiFunction<PARAMS,java.lang.String,PARAMS> paramsForPage)

Method Detail

maxRecords

public GetAllReferencesBuilder maxRecords(int maxRecords)

Description copied from interface: PagingBuilder

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

This setter reflects the OpenAPI parameter maxRecords in a paged request.

Specified by:

maxRecords in interface PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>

pageToken

public GetAllReferencesBuilder pageToken(java.lang.String pageToken)

Description copied from interface: PagingBuilder

Sets the page token from the previous' PagingBuilder.get() method invocation. When using PagingBuilder.stream() methods this parameter must not be set.

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

This setter reflects the OpenAPI parameter pageToken in a paged request.

Specified by:

pageToken in interface PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>

fetch

public GetAllReferencesBuilder fetch(org.projectnessie.model.FetchOption fetchOption)

Description copied from interface: GetAllReferencesBuilder

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.

Specified by:

fetch in interface GetAllReferencesBuilder

Parameters:

fetchOption - The option indicating how much info to fetch

Returns:

GetAllReferencesBuilder

filter

public GetAllReferencesBuilder filter(java.lang.String filter)

Description copied from interface: QueryBuilder

Required: the CEL script.

Specified by:

filter in interface QueryBuilder<PARAMS>

params

protected abstract PARAMS params()

get

protected abstract org.projectnessie.model.ReferencesResponse get(PARAMS p)

get

public 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 GetAllReferencesBuilder

Specified by:

get in interface PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>

stream

public java.util.stream.Stream<org.projectnessie.model.Reference> stream()
                                                                  throws org.projectnessie.error.NessieNotFoundException

Description copied from interface: PagingBuilder

Retrieve entries/results as a Java Stream, uses automatic paging.

Specified by:

stream in interface PagingBuilder<GetAllReferencesBuilder,org.projectnessie.model.ReferencesResponse,org.projectnessie.model.Reference>

Throws:

org.projectnessie.error.NessieNotFoundException