Interface ListUsersRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListUsersRequest

public static interface ListUsersRequest.Builder
extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

Method Summary

Modifier and Type	Method	Description
default ListUsersRequest.Builder	filters(Consumer<ListUsersFilters.Builder> filters)	Limit the user search results based on the filter criteria.
ListUsersRequest.Builder	filters(ListUsersFilters filters)	Limit the user search results based on the filter criteria.
ListUsersRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
ListUsersRequest.Builder	nextToken(String nextToken)	The token to use to retrieve the next page of results.
ListUsersRequest.Builder	organizationId(String organizationId)	The identifier for the organization under which the users exist.
ListUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListUsersRequest.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, sdkFields

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

build

Method Details

organizationId

ListUsersRequest.Builder organizationId(String organizationId)

The identifier for the organization under which the users exist.

Parameters:

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

Returns:

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

nextToken

ListUsersRequest.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

ListUsersRequest.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

ListUsersRequest.Builder filters(ListUsersFilters filters)

Limit the user search results based on the filter criteria. You can only use one filter per request.

Parameters:

filters - Limit the user search results based on the filter criteria. You can only use one filter per request.

Returns:

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

filters

default ListUsersRequest.Builder filters(Consumer<ListUsersFilters.Builder> filters)

Limit the user search results based on the filter criteria. You can only use one filter per request.

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

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

Parameters:

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

Returns:

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

See Also:

• filters(ListUsersFilters)

overrideConfiguration

ListUsersRequest.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

ListUsersRequest.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.