Interface DescribeKeywordsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeKeywordsRequest.Builder,DescribeKeywordsRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<DescribeKeywordsRequest.Builder,DescribeKeywordsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeKeywordsRequest

@Mutable
@NotThreadSafe
public static interface DescribeKeywordsRequest.Builder
extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<DescribeKeywordsRequest.Builder,DescribeKeywordsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeKeywordsRequest.Builder	filters(Collection<KeywordFilter> filters)	An array of keyword filters to filter the results.
DescribeKeywordsRequest.Builder	filters(Consumer<KeywordFilter.Builder>... filters)	An array of keyword filters to filter the results.
DescribeKeywordsRequest.Builder	filters(KeywordFilter... filters)	An array of keyword filters to filter the results.
DescribeKeywordsRequest.Builder	keywords(String... keywords)	An array of keywords to search for.
DescribeKeywordsRequest.Builder	keywords(Collection<String> keywords)	An array of keywords to search for.
DescribeKeywordsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per each request.
DescribeKeywordsRequest.Builder	nextToken(String nextToken)	The token to be used for the next set of paginated results.
DescribeKeywordsRequest.Builder	originationIdentity(String originationIdentity)	The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
DescribeKeywordsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeKeywordsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request.Builder

build

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

originationIdentity

DescribeKeywordsRequest.Builder originationIdentity(String originationIdentity)

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Parameters:

originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

Returns:

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

keywords

DescribeKeywordsRequest.Builder keywords(Collection<String> keywords)

An array of keywords to search for.

Parameters:

keywords - An array of keywords to search for.

Returns:

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

keywords

DescribeKeywordsRequest.Builder keywords(String... keywords)

An array of keywords to search for.

Parameters:

keywords - An array of keywords to search for.

Returns:

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

filters

DescribeKeywordsRequest.Builder filters(Collection<KeywordFilter> filters)

An array of keyword filters to filter the results.

Parameters:

filters - An array of keyword filters to filter the results.

Returns:

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

filters

DescribeKeywordsRequest.Builder filters(KeywordFilter... filters)

An array of keyword filters to filter the results.

Parameters:

filters - An array of keyword filters to filter the results.

Returns:

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

filters

DescribeKeywordsRequest.Builder filters(Consumer<KeywordFilter.Builder>... filters)

An array of keyword filters to filter the results.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<KeywordFilter>).

Parameters:

filters - a consumer that will call methods on KeywordFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<KeywordFilter>)

nextToken

DescribeKeywordsRequest.Builder nextToken(String nextToken)

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Parameters:

nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Returns:

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

maxResults

DescribeKeywordsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per each request.

Parameters:

maxResults - The maximum number of results to return per each request.

Returns:

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

overrideConfiguration

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

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