Interface ListGroupsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListGroupsRequest

@Mutable
@NotThreadSafe
public static interface ListGroupsRequest.Builder
extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

Method Summary

Modifier and Type	Method	Description
default ListGroupsRequest.Builder	filters(Consumer<ListGroupsFilters.Builder> filters)	Limit the search results based on the filter criteria.
ListGroupsRequest.Builder	filters(ListGroupsFilters filters)	Limit the search results based on the filter criteria.
ListGroupsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
ListGroupsRequest.Builder	nextToken(String nextToken)	The token to use to retrieve the next page of results.
ListGroupsRequest.Builder	organizationId(String organizationId)	The identifier for the organization under which the groups exist.
ListGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.utils.builder.SdkBuilder

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailRequest.Builder

build

Method Details

organizationId

ListGroupsRequest.Builder organizationId(String organizationId)

The identifier for the organization under which the groups exist.

Parameters:

organizationId - The identifier for the organization under which the groups exist.

Returns:

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

nextToken

ListGroupsRequest.Builder nextToken(String nextToken)

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Parameters:

nextToken - The token to use to retrieve the next page of results. The first call does not contain any tokens.

Returns:

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

maxResults

ListGroupsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

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

filters

ListGroupsRequest.Builder filters(ListGroupsFilters filters)

Limit the search results based on the filter criteria. Only one filter per request is supported.

Parameters:

filters - Limit the search results based on the filter criteria. Only one filter per request is supported.

Returns:

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

filters

default ListGroupsRequest.Builder filters(Consumer<ListGroupsFilters.Builder> filters)

Limit the search results based on the filter criteria. Only one filter per request is supported.

This is a convenience method that creates an instance of the ListGroupsFilters.Builder avoiding the need to create one manually via ListGroupsFilters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(ListGroupsFilters).

Parameters:

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

Returns:

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

See Also:

• filters(ListGroupsFilters)

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.