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 Details

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListTermsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.