Interface SearchResourcesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchResourcesRequest.Builder,
,SearchResourcesRequest> ResourceGroupsRequest.Builder
,SdkBuilder<SearchResourcesRequest.Builder,
,SearchResourcesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchResourcesRequest
-
Method Summary
Modifier and TypeMethodDescriptionmaxResults
(Integer maxResults) The total 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.default SearchResourcesRequest.Builder
resourceQuery
(Consumer<ResourceQuery.Builder> resourceQuery) The search query, using the same formats that are supported for resource group definition.resourceQuery
(ResourceQuery resourceQuery) The search query, using the same formats that are supported for resource group definition.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.resourcegroups.model.ResourceGroupsRequest.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
-
resourceQuery
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
- Parameters:
resourceQuery
- The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceQuery
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
This is a convenience method that creates an instance of theResourceQuery.Builder
avoiding the need to create one manually viaResourceQuery.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceQuery(ResourceQuery)
.- Parameters:
resourceQuery
- a consumer that will call methods onResourceQuery.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The total 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 that is specific to the operation. If additional items exist beyond the maximum you specify, 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. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.- Parameters:
maxResults
- The total 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 that is specific to the operation. If additional items exist beyond the maximum you specify, 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. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
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 provided by a previous call'sNextToken
response to indicate where the output should continue from.- 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 provided by a previous call'sNextToken
response to indicate where the output should continue from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SearchResourcesRequest.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
SearchResourcesRequest.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.
-