Package org.projectnessie.api.params

Class EntriesParamsBuilder

java.lang.Object

org.projectnessie.api.params.EntriesParamsBuilder

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@NotThreadSafe
public final class EntriesParamsBuilder
extends Object

EntriesParamsBuilder collects parameters and invokes the static factory method: new org.projectnessie.api.params.EntriesParams(..). Call the build() method to get a result of type org.projectnessie.api.params.EntriesParams.

EntriesParamsBuilder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Constructor Summary

Constructors

Constructor	Description
EntriesParamsBuilder()	Creates a EntriesParamsBuilder factory builder.

Method Summary

Modifier and Type	Method	Description
EntriesParams	build()	Invokes new org.projectnessie.api.params.EntriesParams(..) using the collected parameters and returns the result of the invocation
EntriesParamsBuilder	filter(String filter)	Initializes the value for the filter attribute.
EntriesParamsBuilder	hashOnRef(String hashOnRef)	Initializes the value for the hashOnRef attribute.
EntriesParamsBuilder	maxRecords(Integer maxRecords)	Initializes the value for the maxRecords attribute.
EntriesParamsBuilder	namespaceDepth(Integer namespaceDepth)	Initializes the value for the namespaceDepth attribute.
EntriesParamsBuilder	pageToken(String pageToken)	Initializes the value for the pageToken attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntriesParamsBuilder

public EntriesParamsBuilder()

Creates a EntriesParamsBuilder factory builder.

 new EntriesParamsBuilder()
    .hashOnRef(String | null) // nullable hashOnRef
    .maxRecords(Integer | null) // nullable maxRecords
    .pageToken(String | null) // nullable pageToken
    .namespaceDepth(Integer | null) // nullable namespaceDepth
    .filter(String | null) // nullable filter
    .build();
 

Method Detail

hashOnRef

@CanIgnoreReturnValue
public final EntriesParamsBuilder hashOnRef(@Nullable
                                            String hashOnRef)

Initializes the value for the hashOnRef attribute.

Parameters:

hashOnRef - The value for hashOnRef (can be null)

Returns:

this builder for use in a chained invocation

maxRecords

@CanIgnoreReturnValue
public final EntriesParamsBuilder maxRecords(@Nullable
                                             Integer maxRecords)

Initializes the value for the maxRecords attribute.

Parameters:

maxRecords - The value for maxRecords (can be null)

Returns:

this builder for use in a chained invocation

pageToken

@CanIgnoreReturnValue
public final EntriesParamsBuilder pageToken(@Nullable
                                            String pageToken)

Initializes the value for the pageToken attribute.

Parameters:

pageToken - The value for pageToken (can be null)

Returns:

this builder for use in a chained invocation

namespaceDepth

@CanIgnoreReturnValue
public final EntriesParamsBuilder namespaceDepth(@Nullable
                                                 Integer namespaceDepth)

Initializes the value for the namespaceDepth attribute.

Parameters:

namespaceDepth - The value for namespaceDepth (can be null)

Returns:

this builder for use in a chained invocation

filter

@CanIgnoreReturnValue
public final EntriesParamsBuilder filter(@Nullable
                                         String filter)

Initializes the value for the filter attribute.

Parameters:

filter - The value for filter (can be null)

Returns:

this builder for use in a chained invocation

build

public EntriesParams build()

Invokes new org.projectnessie.api.params.EntriesParams(..) using the collected parameters and returns the result of the invocation

Returns:

A result of type org.projectnessie.api.params.EntriesParams

Throws:

IllegalStateException - if any required attributes are missing