software.amazon.awssdk.services.resourcegroups.model

Interface ListGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>, ResourceGroupsRequest.Builder, SdkBuilder<ListGroupsRequest.Builder,ListGroupsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListGroupsRequest

public static interface ListGroupsRequest.Builder
extends ResourceGroupsRequest.Builder, SdkPojo, CopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

Method Summary

Modifier and Type	Method and Description
ListGroupsRequest.Builder	filters(Collection<GroupFilter> filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
ListGroupsRequest.Builder	filters(Consumer<GroupFilter.Builder>... filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
ListGroupsRequest.Builder	filters(GroupFilter... filters) Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
ListGroupsRequest.Builder	maxResults(Integer maxResults) The maximum number of resource group results that are returned by ListGroups in paginated output.
ListGroupsRequest.Builder	nextToken(String nextToken) The NextToken value that is returned in a paginated ListGroups request.
ListGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

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

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

filters

ListGroupsRequest.Builder filters(Collection<GroupFilter> filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

Parameters:

filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

ListGroupsRequest.Builder filters(GroupFilter... filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

Parameters:

filters - Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

ListGroupsRequest.Builder filters(Consumer<GroupFilter.Builder>... filters)

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

maxResults

ListGroupsRequest.Builder maxResults(Integer maxResults)

The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

Parameters:

maxResults - The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

ListGroupsRequest.Builder nextToken(String nextToken)

The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

Parameters:

nextToken - The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.