Interface ListUsersInGroupRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<ListUsersInGroupRequest.Builder,
,ListUsersInGroupRequest> SdkBuilder<ListUsersInGroupRequest.Builder,
,ListUsersInGroupRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListUsersInGroupRequest
@Mutable
@NotThreadSafe
public static interface ListUsersInGroupRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<ListUsersInGroupRequest.Builder,ListUsersInGroupRequest>
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the group that you want to query for user membership.The maximum number of groups that you want Amazon Cognito to return in the response.This API operation returns a limited number of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.userPoolId
(String userPoolId) The ID of the user pool where you want to view the membership of the requested group.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
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
-
Method Details
-
userPoolId
The ID of the user pool where you want to view the membership of the requested group.
- Parameters:
userPoolId
- The ID of the user pool where you want to view the membership of the requested group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupName
The name of the group that you want to query for user membership.
- Parameters:
groupName
- The name of the group that you want to query for user membership.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limit
The maximum number of groups that you want Amazon Cognito to return in the response.
- Parameters:
limit
- The maximum number of groups that you want Amazon Cognito to return in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
- Parameters:
nextToken
- This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListUsersInGroupRequest.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
ListUsersInGroupRequest.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.
-