Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface DescribePhoneNumbersRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribePhoneNumbersRequest

public static interface DescribePhoneNumbersRequest.Builder
extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<DescribePhoneNumbersRequest.Builder,DescribePhoneNumbersRequest>

Method Summary

Modifier and Type	Method	Description
DescribePhoneNumbersRequest.Builder	filters(Collection<PhoneNumberFilter> filters)	An array of PhoneNumberFilter objects to filter the results.
DescribePhoneNumbersRequest.Builder	filters(Consumer<PhoneNumberFilter.Builder>... filters)	An array of PhoneNumberFilter objects to filter the results.
DescribePhoneNumbersRequest.Builder	filters(PhoneNumberFilter... filters)	An array of PhoneNumberFilter objects to filter the results.
DescribePhoneNumbersRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per each request.
DescribePhoneNumbersRequest.Builder	nextToken(String nextToken)	The token to be used for the next set of paginated results.
DescribePhoneNumbersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribePhoneNumbersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribePhoneNumbersRequest.Builder	phoneNumberIds(String... phoneNumberIds)	The unique identifier of phone numbers to find information about.
DescribePhoneNumbersRequest.Builder	phoneNumberIds(Collection<String> phoneNumberIds)	The unique identifier of phone numbers to find information about.

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, sdkFields

Method Details

phoneNumberIds

DescribePhoneNumbersRequest.Builder phoneNumberIds(Collection<String> phoneNumberIds)

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Parameters:

phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Returns:

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

phoneNumberIds

DescribePhoneNumbersRequest.Builder phoneNumberIds(String... phoneNumberIds)

The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Parameters:

phoneNumberIds - The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.

Returns:

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

filters

DescribePhoneNumbersRequest.Builder filters(Collection<PhoneNumberFilter> filters)

An array of PhoneNumberFilter objects to filter the results.

Parameters:

filters - An array of PhoneNumberFilter objects to filter the results.

Returns:

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

filters

DescribePhoneNumbersRequest.Builder filters(PhoneNumberFilter... filters)

An array of PhoneNumberFilter objects to filter the results.

Parameters:

filters - An array of PhoneNumberFilter objects to filter the results.

Returns:

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

filters

DescribePhoneNumbersRequest.Builder filters(Consumer<PhoneNumberFilter.Builder>... filters)

An array of PhoneNumberFilter objects to filter the results.

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

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

Parameters:

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

Returns:

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

See Also:

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

nextToken

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

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

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

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