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

Interface ListTermsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListTermsRequest

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

Method Summary

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

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

ListTermsRequest.Builder userPoolId(String userPoolId)

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

Parameters:

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

Returns:

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

maxResults

ListTermsRequest.Builder maxResults(Integer maxResults)

The maximum number of terms documents that you want Amazon Cognito to return in the response.

Parameters:

maxResults - The maximum number of terms documents 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

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

ListTermsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder