Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface ListGroupsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListGroupsRequest

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

Method Summary

Modifier and Type	Method	Description
ListGroupsRequest.Builder	limit(Integer limit)	The maximum number of groups that you want Amazon Cognito to return in the response.
ListGroupsRequest.Builder	nextToken(String nextToken)	This API operation returns a limited number of results.
ListGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListGroupsRequest.Builder	userPoolId(String userPoolId)	The ID of the user pool where you want to list user groups.

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 Detail

userPoolId

ListGroupsRequest.Builder userPoolId(String userPoolId)

The ID of the user pool where you want to list user groups.

Parameters:

userPoolId - The ID of the user pool where you want to list user groups.

Returns:

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

limit

ListGroupsRequest.Builder limit(Integer 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

ListGroupsRequest.Builder nextToken(String 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

ListGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder