software.amazon.awssdk.services.identitystore.model

Interface ListUsersRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListUsersRequest

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

Method Summary

Modifier and Type	Method and Description
ListUsersRequest.Builder	filters(Collection<Filter> filters) A list of Filter objects, which is used in the ListUsers and ListGroups request.
ListUsersRequest.Builder	filters(Consumer<Filter.Builder>... filters) A list of Filter objects, which is used in the ListUsers and ListGroups request.
ListUsersRequest.Builder	filters(Filter... filters) A list of Filter objects, which is used in the ListUsers and ListGroups request.
ListUsersRequest.Builder	identityStoreId(String identityStoreId) The globally unique identifier for the identity store, such as d-1234567890.
ListUsersRequest.Builder	maxResults(Integer maxResults) The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page.
ListUsersRequest.Builder	nextToken(String nextToken) The pagination token used for the ListUsers and ListGroups APIs.
ListUsersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.identitystore.model.IdentitystoreRequest.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

identityStoreId

ListUsersRequest.Builder identityStoreId(String identityStoreId)

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Parameters:

identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

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 be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Parameters:

maxResults - The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Returns:

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

nextToken

ListUsersRequest.Builder nextToken(String nextToken)

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Parameters:

nextToken - The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Returns:

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

filters

ListUsersRequest.Builder filters(Collection<Filter> filters)

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Parameters:

filters - A list of Filter objects, which is used in the ListUsers and ListGroups request.

Returns:

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

filters

ListUsersRequest.Builder filters(Filter... filters)

A list of Filter objects, which is used in the ListUsers and ListGroups request.

Parameters:

filters - A list of Filter objects, which is used in the ListUsers and ListGroups request.

Returns:

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

filters

ListUsersRequest.Builder filters(Consumer<Filter.Builder>... filters)

A list of Filter objects, which is used in the ListUsers and ListGroups request.

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)

overrideConfiguration

ListUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder