Package org.projectnessie.client.builder

Class BaseGetEntriesBuilder<PARAMS>

java.lang.Object

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

All Implemented Interfaces:

GetEntriesBuilder, KeyRangeBuilder<GetEntriesBuilder>, OnReferenceBuilder<GetEntriesBuilder>, PagingBuilder<GetEntriesBuilder,org.projectnessie.model.EntriesResponse,org.projectnessie.model.EntriesResponse.Entry>, QueryBuilder<GetEntriesBuilder>

public abstract class BaseGetEntriesBuilder<PARAMS>
extends java.lang.Object
implements GetEntriesBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	filter
protected java.lang.String	hashOnRef
protected java.util.List<org.projectnessie.model.ContentKey>	keys
protected org.projectnessie.model.ContentKey	maxKey
protected java.lang.Integer	maxRecords
protected org.projectnessie.model.ContentKey	minKey
protected java.lang.Integer	namespaceDepth
protected org.projectnessie.model.ContentKey	prefixKey
protected java.lang.String	refName
protected boolean	withContent

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetEntriesBuilder	filter(java.lang.String filter)	Required: the CEL script.
org.projectnessie.model.EntriesResponse	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.EntriesResponse	get(PARAMS p)
R	hashOnRef(java.lang.String hashOnRef)
GetEntriesBuilder	key(org.projectnessie.model.ContentKey key)
GetEntriesBuilder	keys(java.util.Collection<org.projectnessie.model.ContentKey> keys)
GetEntriesBuilder	maxKey(org.projectnessie.model.ContentKey maxKey)
GetEntriesBuilder	maxRecords(int maxRecords)	Sets the maximum number of records to be returned in a single response object from the PagingBuilder.get() method.
GetEntriesBuilder	minKey(org.projectnessie.model.ContentKey minKey)
GetEntriesBuilder	namespaceDepth(java.lang.Integer namespaceDepth)
GetEntriesBuilder	pageToken(java.lang.String pageToken)	Sets the page token from the previous' PagingBuilder.get() method invocation.
protected abstract PARAMS	params()
GetEntriesBuilder	prefixKey(org.projectnessie.model.ContentKey prefixKey)
R	refName(java.lang.String refName)
java.util.stream.Stream<org.projectnessie.model.EntriesResponse.Entry>	stream()	Retrieve entries/results as a Java Stream, uses automatic paging.
GetEntriesBuilder	withContent(boolean withContent)

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.OnReferenceBuilder

hashOnRef, reference, refName

Field Detail

maxRecords

protected java.lang.Integer maxRecords

keys

protected final java.util.List<org.projectnessie.model.ContentKey> keys

minKey

protected org.projectnessie.model.ContentKey minKey

maxKey

protected org.projectnessie.model.ContentKey maxKey

prefixKey

protected org.projectnessie.model.ContentKey prefixKey

filter

protected java.lang.String filter

namespaceDepth

protected java.lang.Integer namespaceDepth

withContent

protected boolean withContent

refName

protected java.lang.String refName

hashOnRef

protected java.lang.String hashOnRef

Constructor Detail

BaseGetEntriesBuilder

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

Method Detail

maxRecords

public GetEntriesBuilder 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<GetEntriesBuilder,org.projectnessie.model.EntriesResponse,org.projectnessie.model.EntriesResponse.Entry>

pageToken

public GetEntriesBuilder 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<GetEntriesBuilder,org.projectnessie.model.EntriesResponse,org.projectnessie.model.EntriesResponse.Entry>

key

public GetEntriesBuilder key(org.projectnessie.model.ContentKey key)

Specified by:

key in interface KeyRangeBuilder<PARAMS>

keys

public GetEntriesBuilder keys(java.util.Collection<org.projectnessie.model.ContentKey> keys)

Specified by:

keys in interface KeyRangeBuilder<PARAMS>

minKey

public GetEntriesBuilder minKey(org.projectnessie.model.ContentKey minKey)

Specified by:

minKey in interface KeyRangeBuilder<PARAMS>

maxKey

public GetEntriesBuilder maxKey(org.projectnessie.model.ContentKey maxKey)

Specified by:

maxKey in interface KeyRangeBuilder<PARAMS>

prefixKey

public GetEntriesBuilder prefixKey(org.projectnessie.model.ContentKey prefixKey)

Specified by:

prefixKey in interface KeyRangeBuilder<PARAMS>

filter

public GetEntriesBuilder filter(java.lang.String filter)

Description copied from interface: QueryBuilder

Required: the CEL script.

Specified by:

filter in interface QueryBuilder<PARAMS>

namespaceDepth

public GetEntriesBuilder namespaceDepth(java.lang.Integer namespaceDepth)

Specified by:

namespaceDepth in interface GetEntriesBuilder

withContent

public GetEntriesBuilder withContent(boolean withContent)

Specified by:

withContent in interface GetEntriesBuilder

params

protected abstract PARAMS params()

get

protected abstract org.projectnessie.model.EntriesResponse get(PARAMS p)
                                                        throws org.projectnessie.error.NessieNotFoundException

Throws:

org.projectnessie.error.NessieNotFoundException

get

public org.projectnessie.model.EntriesResponse get()
                                            throws org.projectnessie.error.NessieNotFoundException

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 GetEntriesBuilder

Specified by:

get in interface PagingBuilder<GetEntriesBuilder,org.projectnessie.model.EntriesResponse,org.projectnessie.model.EntriesResponse.Entry>

Throws:

org.projectnessie.error.NessieNotFoundException

stream

public java.util.stream.Stream<org.projectnessie.model.EntriesResponse.Entry> 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<GetEntriesBuilder,org.projectnessie.model.EntriesResponse,org.projectnessie.model.EntriesResponse.Entry>

Throws:

org.projectnessie.error.NessieNotFoundException

refName

public R refName(java.lang.String refName)

Specified by:

refName in interface OnReferenceBuilder<R extends OnReferenceBuilder<R>>

hashOnRef

public R hashOnRef(java.lang.String hashOnRef)

Specified by:

hashOnRef in interface OnReferenceBuilder<R extends OnReferenceBuilder<R>>