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

Interface ListTermsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<ListTermsResponse.Builder,ListTermsResponse>, SdkBuilder<ListTermsResponse.Builder,ListTermsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListTermsResponse

@Mutable
@NotThreadSafe
public static interface ListTermsResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<ListTermsResponse.Builder,ListTermsResponse>

Method Summary

Modifier and Type	Method	Description
ListTermsResponse.Builder	nextToken(String nextToken)	This API operation returns a limited number of results.
ListTermsResponse.Builder	terms(Collection<TermsDescriptionType> terms)	A summary of the requested terms documents.
ListTermsResponse.Builder	terms(Consumer<TermsDescriptionType.Builder>... terms)	A summary of the requested terms documents.
ListTermsResponse.Builder	terms(TermsDescriptionType... terms)	A summary of the requested terms documents.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

terms

ListTermsResponse.Builder terms(Collection<TermsDescriptionType> terms)

A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

Parameters:

terms - A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

Returns:

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

terms

ListTermsResponse.Builder terms(TermsDescriptionType... terms)

A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

Parameters:

terms - A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

Returns:

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

terms

ListTermsResponse.Builder terms(Consumer<TermsDescriptionType.Builder>... terms)

A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.

This is a convenience method that creates an instance of the TermsDescriptionType.Builder avoiding the need to create one manually via TermsDescriptionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #terms(List).

Parameters:

terms - a consumer that will call methods on TermsDescriptionType.Builder

Returns:

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

See Also:

#terms(java.util.Collection)

nextToken

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