Interface ListIndexRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudDirectoryRequest.Builder
,CopyableBuilder<ListIndexRequest.Builder,
,ListIndexRequest> SdkBuilder<ListIndexRequest.Builder,
,ListIndexRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListIndexRequest
-
Method Summary
Modifier and TypeMethodDescriptionconsistencyLevel
(String consistencyLevel) The consistency level to execute the request at.consistencyLevel
(ConsistencyLevel consistencyLevel) The consistency level to execute the request at.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.indexReference
(ObjectReference indexReference) The reference to the index to list.maxResults
(Integer maxResults) The maximum number of objects in a single page to retrieve from the index during a request.The pagination token.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.rangesOnIndexedValues
(Collection<ObjectAttributeRange> rangesOnIndexedValues) Specifies the ranges of indexed values that you want to query.rangesOnIndexedValues
(Consumer<ObjectAttributeRange.Builder>... rangesOnIndexedValues) Specifies the ranges of indexed values that you want to query.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, sdkFields
-
Method Details
-
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
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 theObjectAttributeRange.Builder
avoiding the need to create one manually viaObjectAttributeRange.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torangesOnIndexedValues(List<ObjectAttributeRange>)
.- Parameters:
rangesOnIndexedValues
- a consumer that will call methods onObjectAttributeRange.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The reference to the index to list.
This is a convenience method that creates an instance of theObjectReference.Builder
avoiding the need to create one manually viaObjectReference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toindexReference(ObjectReference)
.- Parameters:
indexReference
- a consumer that will call methods onObjectReference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
The pagination token.
- Parameters:
nextToken
- The pagination token.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
overrideConfiguration
ListIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-