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

Interface DescribeSenderIdsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeSenderIdsRequest

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

Method Summary

Modifier and Type	Method	Description
DescribeSenderIdsRequest.Builder	filters(Collection<SenderIdFilter> filters)	An array of SenderIdFilter objects to filter the results.
DescribeSenderIdsRequest.Builder	filters(Consumer<SenderIdFilter.Builder>... filters)	An array of SenderIdFilter objects to filter the results.
DescribeSenderIdsRequest.Builder	filters(SenderIdFilter... filters)	An array of SenderIdFilter objects to filter the results.
DescribeSenderIdsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per each request.
DescribeSenderIdsRequest.Builder	nextToken(String nextToken)	The token to be used for the next set of paginated results.
DescribeSenderIdsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeSenderIdsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeSenderIdsRequest.Builder	owner(String owner)	Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account.
DescribeSenderIdsRequest.Builder	owner(Owner owner)	Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account.
DescribeSenderIdsRequest.Builder	senderIds(Collection<SenderIdAndCountry> senderIds)	An array of SenderIdAndCountry objects to search for.
DescribeSenderIdsRequest.Builder	senderIds(Consumer<SenderIdAndCountry.Builder>... senderIds)	An array of SenderIdAndCountry objects to search for.
DescribeSenderIdsRequest.Builder	senderIds(SenderIdAndCountry... senderIds)	An array of SenderIdAndCountry objects to search for.

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 Detail

senderIds

DescribeSenderIdsRequest.Builder senderIds(Collection<SenderIdAndCountry> senderIds)

An array of SenderIdAndCountry objects to search for.

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:

senderIds - An array of SenderIdAndCountry objects to search for.

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.

senderIds

DescribeSenderIdsRequest.Builder senderIds(SenderIdAndCountry... senderIds)

An array of SenderIdAndCountry objects to search for.

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:

senderIds - An array of SenderIdAndCountry objects to search for.

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.

senderIds

DescribeSenderIdsRequest.Builder senderIds(Consumer<SenderIdAndCountry.Builder>... senderIds)

An array of SenderIdAndCountry objects to search for.

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

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

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

Parameters:

senderIds - a consumer that will call methods on SenderIdAndCountry.Builder

Returns:

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

See Also:

#senderIds(java.util.Collection)

filters

DescribeSenderIdsRequest.Builder filters(Collection<SenderIdFilter> filters)

An array of SenderIdFilter objects to filter the results.

Parameters:

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

Returns:

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

filters

DescribeSenderIdsRequest.Builder filters(SenderIdFilter... filters)

An array of SenderIdFilter objects to filter the results.

Parameters:

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

Returns:

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

filters

DescribeSenderIdsRequest.Builder filters(Consumer<SenderIdFilter.Builder>... filters)

An array of SenderIdFilter objects to filter the results.

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

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

Parameters:

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

Returns:

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

See Also:

#filters(java.util.Collection)

nextToken

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

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

owner

DescribeSenderIdsRequest.Builder owner(String owner)

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

Parameters:

owner - Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

Returns:

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

See Also:

Owner, Owner

owner

DescribeSenderIdsRequest.Builder owner(Owner owner)

Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

Parameters:

owner - Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.

Returns:

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

See Also:

Owner, Owner

overrideConfiguration

DescribeSenderIdsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder