Package org.projectnessie.client.builder

Class BaseGetDiffBuilder<PARAMS>

java.lang.Object

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

All Implemented Interfaces:

GetDiffBuilder, KeyRangeBuilder<GetDiffBuilder>, PagingBuilder<GetDiffBuilder,org.projectnessie.model.DiffResponse,org.projectnessie.model.DiffResponse.DiffEntry>, QueryBuilder<GetDiffBuilder>

public abstract class BaseGetDiffBuilder<PARAMS>
extends Object
implements GetDiffBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	filter
protected String	fromHashOnRef
protected String	fromRefName
protected final List<org.projectnessie.model.ContentKey>	keys
protected org.projectnessie.model.ContentKey	maxKey
protected Integer	maxRecords
protected org.projectnessie.model.ContentKey	minKey
protected org.projectnessie.model.ContentKey	prefixKey
protected String	toHashOnRef
protected String	toRefName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseGetDiffBuilder(BiFunction<PARAMS,String,PARAMS> paramsForPage)

Method Summary

Modifier and Type	Method	Description
GetDiffBuilder	filter(String filter)	Required: the CEL script.
GetDiffBuilder	fromHashOnRef(String fromHashOnRef)
GetDiffBuilder	fromRefName(String fromRefName)
org.projectnessie.model.DiffResponse	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.DiffResponse	get(PARAMS p)
GetDiffBuilder	key(org.projectnessie.model.ContentKey key)
GetDiffBuilder	keys(Collection<org.projectnessie.model.ContentKey> keys)
GetDiffBuilder	maxKey(org.projectnessie.model.ContentKey maxKey)
GetDiffBuilder	maxRecords(int maxRecords)	Sets the maximum number of records to be returned in a single response object from the PagingBuilder.get() method.
GetDiffBuilder	minKey(org.projectnessie.model.ContentKey minKey)
GetDiffBuilder	pageToken(String pageToken)	Sets the page token from the previous' PagingBuilder.get() method invocation.
protected abstract PARAMS	params()
GetDiffBuilder	prefixKey(org.projectnessie.model.ContentKey prefixKey)
Stream<org.projectnessie.model.DiffResponse.DiffEntry>	stream()	Retrieve entries/results as a Java Stream, uses automatic paging.
GetDiffBuilder	toHashOnRef(String toHashOnRef)
GetDiffBuilder	toRefName(String toRefName)

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

fromRef, toRef

Field Details

maxRecords

protected Integer maxRecords

fromRefName

protected String fromRefName

fromHashOnRef

protected String fromHashOnRef

toRefName

protected String toRefName

toHashOnRef

protected String toHashOnRef

keys

protected final 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 String filter

Constructor Details

BaseGetDiffBuilder

protected BaseGetDiffBuilder(BiFunction<PARAMS,String,PARAMS> paramsForPage)

Method Details

fromRefName

public GetDiffBuilder fromRefName(String fromRefName)

Specified by:

fromRefName in interface GetDiffBuilder

fromHashOnRef

public GetDiffBuilder fromHashOnRef(String fromHashOnRef)

Specified by:

fromHashOnRef in interface GetDiffBuilder

toRefName

public GetDiffBuilder toRefName(String toRefName)

Specified by:

toRefName in interface GetDiffBuilder

toHashOnRef

public GetDiffBuilder toHashOnRef(String toHashOnRef)

Specified by:

toHashOnRef in interface GetDiffBuilder

maxRecords

public GetDiffBuilder 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<GetDiffBuilder,org.projectnessie.model.DiffResponse,org.projectnessie.model.DiffResponse.DiffEntry>

pageToken

public GetDiffBuilder pageToken(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<GetDiffBuilder,org.projectnessie.model.DiffResponse,org.projectnessie.model.DiffResponse.DiffEntry>

key

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

Specified by:

key in interface KeyRangeBuilder<PARAMS>

keys

public GetDiffBuilder keys(Collection<org.projectnessie.model.ContentKey> keys)

Specified by:

keys in interface KeyRangeBuilder<PARAMS>

minKey

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

Specified by:

minKey in interface KeyRangeBuilder<PARAMS>

maxKey

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

Specified by:

maxKey in interface KeyRangeBuilder<PARAMS>

prefixKey

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

Specified by:

prefixKey in interface KeyRangeBuilder<PARAMS>

filter

public GetDiffBuilder filter(String filter)

Description copied from interface: QueryBuilder

Required: the CEL script.

Specified by:

filter in interface QueryBuilder<PARAMS>

get

public org.projectnessie.model.DiffResponse 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 GetDiffBuilder

Specified by:

get in interface PagingBuilder<GetDiffBuilder,org.projectnessie.model.DiffResponse,org.projectnessie.model.DiffResponse.DiffEntry>

Throws:

org.projectnessie.error.NessieNotFoundException

params

protected abstract PARAMS params()

get

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

Throws:

org.projectnessie.error.NessieNotFoundException

stream

public Stream<org.projectnessie.model.DiffResponse.DiffEntry> 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<GetDiffBuilder,org.projectnessie.model.DiffResponse,org.projectnessie.model.DiffResponse.DiffEntry>

Throws:

org.projectnessie.error.NessieNotFoundException