Interface ListIndexesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListIndexesRequest.Builder,
,ListIndexesRequest> ResourceExplorer2Request.Builder
,SdkBuilder<ListIndexesRequest.Builder,
,ListIndexesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListIndexesRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The maximum number of results that you want included on each page of the response.The parameter for receiving additional results if you receive aNextToken
response in a previous request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.regions
(Collection<String> regions) If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.resourceexplorer2.model.ResourceExplorer2Request.Builder
build
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
-
maxResults
The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the
NextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results.- Parameters:
maxResults
- The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, theNextToken
response element is present and has a value (is not null). Include that value as theNextToken
request parameter in the next call to the operation to get the next part of the results.An API operation can return fewer results than the maximum even when there are more results available. You should check
NextToken
after every operation to ensure that you receive all of the results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours.- Parameters:
nextToken
- The parameter for receiving additional results if you receive aNextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
response to indicate where the output should continue from. The pagination tokens expire after 24 hours.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
- Parameters:
regions
- If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
regions
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
- Parameters:
regions
- If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- Parameters:
type
- If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- Parameters:
type
- If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListIndexesRequest.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
ListIndexesRequest.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.
-