Interface ListUsersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListUsersRequest.Builder,
,ListUsersRequest> IdentitystoreRequest.Builder
,SdkBuilder<ListUsersRequest.Builder,
,ListUsersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListUsersRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<Filter> filters) Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.filters
(Consumer<Filter.Builder>... filters) Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.identityStoreId
(String identityStoreId) The globally unique identifier for the identity store, such asd-1234567890
.maxResults
(Integer maxResults) The maximum number of results to be returned per request.The pagination token used for theListUsers
andListGroups
API operations.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.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.services.identitystore.model.IdentitystoreRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
identityStoreId
The globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers 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 asd-1234567890
. In this example,d-
is a fixed prefix, and1234567890
is a randomly generated string that contains numbers 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
The maximum number of results to be returned per request. This parameter is used in the
ListUsers
andListGroups
requests 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. This parameter is used in theListUsers
andListGroups
requests 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
The pagination token used for the
ListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.- Parameters:
nextToken
- The pagination token used for theListUsers
andListGroups
API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it 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
Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.A list of
Filter
objects, which is used in theListUsers
andListGroups
requests.- Parameters:
filters
- A list ofFilter
objects, which is used in theListUsers
andListGroups
requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.A list of
Filter
objects, which is used in theListUsers
andListGroups
requests.- Parameters:
filters
- A list ofFilter
objects, which is used in theListUsers
andListGroups
requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Deprecated.Using filters with ListUsers API is deprecated, please use GetGroupId API instead.A list of
This is a convenience method that creates an instance of theFilter
objects, which is used in theListUsers
andListGroups
requests.Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-