software.amazon.awssdk.services.resourcegroups.model

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

Modifier and Type	Method and Description
SearchResourcesRequest.Builder	maxResults(Integer maxResults) The total number of results that you want included on each page of the response.
SearchResourcesRequest.Builder	nextToken(String nextToken) The parameter for receiving additional results if you receive a NextToken response in a previous request.
SearchResourcesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SearchResourcesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default SearchResourcesRequest.Builder	resourceQuery(Consumer<ResourceQuery.Builder> resourceQuery) The search query, using the same formats that are supported for resource group definition.
SearchResourcesRequest.Builder	resourceQuery(ResourceQuery resourceQuery) The search query, using the same formats that are supported for resource group definition.

Methods inherited from interface software.amazon.awssdk.services.resourcegroups.model.ResourceGroupsRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

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 the ResourceQuery.Builder avoiding the need to create one manually via ResourceQuery.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceQuery(ResourceQuery).

Parameters:

resourceQuery - a consumer that will call methods on ResourceQuery.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 NextToken response element is present and has a value (is not null). Include that value as the NextToken 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 check NextToken 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, the NextToken response element is present and has a value (is not null). Include that value as the NextToken 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 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

SearchResourcesRequest.Builder nextToken(String nextToken)

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

Parameters:

nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken 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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder