Interface SendDestinationNumberVerificationCodeRequest.Builder

All Superinterfaces:

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

Enclosing class:

SendDestinationNumberVerificationCodeRequest

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

Method Summary

Modifier and Type	Method	Description
SendDestinationNumberVerificationCodeRequest.Builder	configurationSetName(String configurationSetName)	The name of the configuration set to use.
SendDestinationNumberVerificationCodeRequest.Builder	context(Map<String,String> context)	You can specify custom data in this field.
SendDestinationNumberVerificationCodeRequest.Builder	destinationCountryParameters(Map<DestinationCountryParameterKey,String> destinationCountryParameters)	This field is used for any country-specific registration requirements.
SendDestinationNumberVerificationCodeRequest.Builder	destinationCountryParametersWithStrings(Map<String,String> destinationCountryParameters)	This field is used for any country-specific registration requirements.
SendDestinationNumberVerificationCodeRequest.Builder	languageCode(String languageCode)	Choose the language to use for the message.
SendDestinationNumberVerificationCodeRequest.Builder	languageCode(LanguageCode languageCode)	Choose the language to use for the message.
SendDestinationNumberVerificationCodeRequest.Builder	originationIdentity(String originationIdentity)	The origination identity of the message.
SendDestinationNumberVerificationCodeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendDestinationNumberVerificationCodeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
SendDestinationNumberVerificationCodeRequest.Builder	verificationChannel(String verificationChannel)	Choose to send the verification code as an SMS or voice message.
SendDestinationNumberVerificationCodeRequest.Builder	verificationChannel(VerificationChannel verificationChannel)	Choose to send the verification code as an SMS or voice message.
SendDestinationNumberVerificationCodeRequest.Builder	verifiedDestinationNumberId(String verifiedDestinationNumberId)	The unique identifier for the verified destination phone number.

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

verifiedDestinationNumberId

SendDestinationNumberVerificationCodeRequest.Builder verifiedDestinationNumberId(String verifiedDestinationNumberId)

The unique identifier for the verified destination phone number.

Parameters:

verifiedDestinationNumberId - The unique identifier for the verified destination phone number.

Returns:

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

verificationChannel

SendDestinationNumberVerificationCodeRequest.Builder verificationChannel(String verificationChannel)

Choose to send the verification code as an SMS or voice message.

Parameters:

verificationChannel - Choose to send the verification code as an SMS or voice message.

Returns:

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

See Also:

• VerificationChannel
• VerificationChannel

verificationChannel

SendDestinationNumberVerificationCodeRequest.Builder verificationChannel(VerificationChannel verificationChannel)

Choose to send the verification code as an SMS or voice message.

Parameters:

verificationChannel - Choose to send the verification code as an SMS or voice message.

Returns:

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

See Also:

• VerificationChannel
• VerificationChannel

languageCode

SendDestinationNumberVerificationCodeRequest.Builder languageCode(String languageCode)

Choose the language to use for the message.

Parameters:

languageCode - Choose the language to use for the message.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

languageCode

SendDestinationNumberVerificationCodeRequest.Builder languageCode(LanguageCode languageCode)

Choose the language to use for the message.

Parameters:

languageCode - Choose the language to use for the message.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

originationIdentity

SendDestinationNumberVerificationCodeRequest.Builder originationIdentity(String originationIdentity)

The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

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 of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.

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.

configurationSetName

SendDestinationNumberVerificationCodeRequest.Builder configurationSetName(String configurationSetName)

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Parameters:

configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Returns:

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

context

SendDestinationNumberVerificationCodeRequest.Builder context(Map<String,String> context)

You can specify custom data in this field. If you do, that data is logged to the event destination.

Parameters:

context - You can specify custom data in this field. If you do, that data is logged to the event destination.

Returns:

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

destinationCountryParametersWithStrings

SendDestinationNumberVerificationCodeRequest.Builder destinationCountryParametersWithStrings(Map<String,String> destinationCountryParameters)

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Parameters:

destinationCountryParameters - This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Returns:

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

destinationCountryParameters

SendDestinationNumberVerificationCodeRequest.Builder destinationCountryParameters(Map<DestinationCountryParameterKey,String> destinationCountryParameters)

This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Parameters:

destinationCountryParameters - This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.

Returns:

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

overrideConfiguration

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

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