Interface SearchResourcesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>,ResourceGroupsRequest.Builder,SdkBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- SearchResourcesRequest
public static interface SearchResourcesRequest.Builder extends ResourceGroupsRequest.Builder, SdkPojo, CopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description SearchResourcesRequest.BuildermaxResults(Integer maxResults)The total number of results that you want included on each page of the response.SearchResourcesRequest.BuildernextToken(String nextToken)The parameter for receiving additional results if you receive aNextTokenresponse in a previous request.SearchResourcesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SearchResourcesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)default SearchResourcesRequest.BuilderresourceQuery(Consumer<ResourceQuery.Builder> resourceQuery)The search query, using the same formats that are supported for resource group definition.SearchResourcesRequest.BuilderresourceQuery(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 Detail
-
resourceQuery
SearchResourcesRequest.Builder resourceQuery(ResourceQuery 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
default SearchResourcesRequest.Builder resourceQuery(Consumer<ResourceQuery.Builder> 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.Builderavoiding the need to create one manually viaResourceQuery.builder().When the
Consumercompletes,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:
resourceQuery(ResourceQuery)
-
maxResults
SearchResourcesRequest.Builder maxResults(Integer 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
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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 checkNextTokenafter 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, theNextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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 checkNextTokenafter 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
SearchResourcesRequest.Builder nextToken(String nextToken)
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from.- Parameters:
nextToken- The parameter for receiving additional results if you receive aNextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse 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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SearchResourcesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-