Interface DescribeOptedOutNumbersResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeOptedOutNumbersResponse.Builder,DescribeOptedOutNumbersResponse>, PinpointSmsVoiceV2Response.Builder, SdkBuilder<DescribeOptedOutNumbersResponse.Builder,DescribeOptedOutNumbersResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeOptedOutNumbersResponse

@Mutable
@NotThreadSafe
public static interface DescribeOptedOutNumbersResponse.Builder
extends PinpointSmsVoiceV2Response.Builder, SdkPojo, CopyableBuilder<DescribeOptedOutNumbersResponse.Builder,DescribeOptedOutNumbersResponse>

Method Summary

Modifier and Type	Method	Description
DescribeOptedOutNumbersResponse.Builder	nextToken(String nextToken)	The token to be used for the next set of paginated results.
DescribeOptedOutNumbersResponse.Builder	optedOutNumbers(Collection<OptedOutNumberInformation> optedOutNumbers)	An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
DescribeOptedOutNumbersResponse.Builder	optedOutNumbers(Consumer<OptedOutNumberInformation.Builder>... optedOutNumbers)	An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
DescribeOptedOutNumbersResponse.Builder	optedOutNumbers(OptedOutNumberInformation... optedOutNumbers)	An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
DescribeOptedOutNumbersResponse.Builder	optOutListArn(String optOutListArn)	The Amazon Resource Name (ARN) of the OptOutList.
DescribeOptedOutNumbersResponse.Builder	optOutListName(String optOutListName)	The name of the OptOutList.

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

copy

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

build, responseMetadata, responseMetadata

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 Details

optOutListArn

DescribeOptedOutNumbersResponse.Builder optOutListArn(String optOutListArn)

The Amazon Resource Name (ARN) of the OptOutList.

Parameters:

optOutListArn - The Amazon Resource Name (ARN) of the OptOutList.

Returns:

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

optOutListName

DescribeOptedOutNumbersResponse.Builder optOutListName(String optOutListName)

The name of the OptOutList.

Parameters:

optOutListName - The name of the OptOutList.

Returns:

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

optedOutNumbers

DescribeOptedOutNumbersResponse.Builder optedOutNumbers(Collection<OptedOutNumberInformation> optedOutNumbers)

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

Parameters:

optedOutNumbers - An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

Returns:

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

optedOutNumbers

DescribeOptedOutNumbersResponse.Builder optedOutNumbers(OptedOutNumberInformation... optedOutNumbers)

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

Parameters:

optedOutNumbers - An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

Returns:

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

optedOutNumbers

DescribeOptedOutNumbersResponse.Builder optedOutNumbers(Consumer<OptedOutNumberInformation.Builder>... optedOutNumbers)

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

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

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

Parameters:

optedOutNumbers - a consumer that will call methods on OptedOutNumberInformation.Builder

Returns:

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

See Also:

• optedOutNumbers(java.util.Collection<OptedOutNumberInformation>)

nextToken

DescribeOptedOutNumbersResponse.Builder nextToken(String nextToken)

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Parameters:

nextToken - The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Returns:

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