Interface ListIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudDirectoryRequest.Builder, CopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>, SdkBuilder<ListIndexRequest.Builder,ListIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListIndexRequest

@Mutable
@NotThreadSafe
public static interface ListIndexRequest.Builder
extends CloudDirectoryRequest.Builder, SdkPojo, CopyableBuilder<ListIndexRequest.Builder,ListIndexRequest>

Method Summary

Modifier and Type	Method	Description
ListIndexRequest.Builder	consistencyLevel(String consistencyLevel)	The consistency level to execute the request at.
ListIndexRequest.Builder	consistencyLevel(ConsistencyLevel consistencyLevel)	The consistency level to execute the request at.
ListIndexRequest.Builder	directoryArn(String directoryArn)	The ARN of the directory that the index exists in.
default ListIndexRequest.Builder	indexReference(Consumer<ObjectReference.Builder> indexReference)	The reference to the index to list.
ListIndexRequest.Builder	indexReference(ObjectReference indexReference)	The reference to the index to list.
ListIndexRequest.Builder	maxResults(Integer maxResults)	The maximum number of objects in a single page to retrieve from the index during a request.
ListIndexRequest.Builder	nextToken(String nextToken)	The pagination token.
ListIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListIndexRequest.Builder	rangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues)	Specifies the ranges of indexed values that you want to query.
ListIndexRequest.Builder	rangesOnIndexedValues(Consumer<ObjectAttributeRange.Builder>... rangesOnIndexedValues)	Specifies the ranges of indexed values that you want to query.
ListIndexRequest.Builder	rangesOnIndexedValues(ObjectAttributeRange... rangesOnIndexedValues)	Specifies the ranges of indexed values that you want to query.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.clouddirectory.model.CloudDirectoryRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

directoryArn

ListIndexRequest.Builder directoryArn(String directoryArn)

The ARN of the directory that the index exists in.

Parameters:

directoryArn - The ARN of the directory that the index exists in.

Returns:

Returns a reference to this object so that method calls can be chained together.

rangesOnIndexedValues

ListIndexRequest.Builder rangesOnIndexedValues(Collection<ObjectAttributeRange> rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

Parameters:

rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

Returns:

Returns a reference to this object so that method calls can be chained together.

rangesOnIndexedValues

ListIndexRequest.Builder rangesOnIndexedValues(ObjectAttributeRange... rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

Parameters:

rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

Returns:

Returns a reference to this object so that method calls can be chained together.

rangesOnIndexedValues

ListIndexRequest.Builder rangesOnIndexedValues(Consumer<ObjectAttributeRange.Builder>... rangesOnIndexedValues)

Specifies the ranges of indexed values that you want to query.

This is a convenience method that creates an instance of the ObjectAttributeRange.Builder avoiding the need to create one manually via ObjectAttributeRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rangesOnIndexedValues(List<ObjectAttributeRange>).

Parameters:

rangesOnIndexedValues - a consumer that will call methods on ObjectAttributeRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• rangesOnIndexedValues(java.util.Collection<ObjectAttributeRange>)

indexReference

ListIndexRequest.Builder indexReference(ObjectReference indexReference)

The reference to the index to list.

Parameters:

indexReference - The reference to the index to list.

Returns:

Returns a reference to this object so that method calls can be chained together.

indexReference

default ListIndexRequest.Builder indexReference(Consumer<ObjectReference.Builder> indexReference)

The reference to the index to list.

This is a convenience method that creates an instance of the ObjectReference.Builder avoiding the need to create one manually via ObjectReference.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to indexReference(ObjectReference).

Parameters:

indexReference - a consumer that will call methods on ObjectReference.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• indexReference(ObjectReference)

maxResults

ListIndexRequest.Builder maxResults(Integer maxResults)

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

Parameters:

maxResults - The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListIndexRequest.Builder nextToken(String nextToken)

The pagination token.

Parameters:

nextToken - The pagination token.

Returns:

Returns a reference to this object so that method calls can be chained together.

consistencyLevel

ListIndexRequest.Builder consistencyLevel(String consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ConsistencyLevel
• ConsistencyLevel

consistencyLevel

ListIndexRequest.Builder consistencyLevel(ConsistencyLevel consistencyLevel)

The consistency level to execute the request at.

Parameters:

consistencyLevel - The consistency level to execute the request at.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ConsistencyLevel
• ConsistencyLevel

overrideConfiguration

ListIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ListIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.