com.amazonaws.services.pinpointsmsvoicev2.model

Class SendDestinationNumberVerificationCodeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.SendDestinationNumberVerificationCodeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendDestinationNumberVerificationCodeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendDestinationNumberVerificationCodeRequest()

Method Summary

Modifier and Type	Method and Description
SendDestinationNumberVerificationCodeRequest	addContextEntry(String key, String value) Add a single Context entry
SendDestinationNumberVerificationCodeRequest	addDestinationCountryParametersEntry(String key, String value) Add a single DestinationCountryParameters entry
SendDestinationNumberVerificationCodeRequest	clearContextEntries() Removes all the entries added into Context.
SendDestinationNumberVerificationCodeRequest	clearDestinationCountryParametersEntries() Removes all the entries added into DestinationCountryParameters.
SendDestinationNumberVerificationCodeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConfigurationSetName() The name of the configuration set to use.
Map<String,String>	getContext() You can specify custom data in this field.
Map<String,String>	getDestinationCountryParameters() This field is used for any country-specific registration requirements.
String	getLanguageCode() Choose the language to use for the message.
String	getOriginationIdentity() The origination identity of the message.
String	getVerificationChannel() Choose to send the verification code as an SMS or voice message.
String	getVerifiedDestinationNumberId() The unique identifier for the verified destination phone number.
int	hashCode()
void	setConfigurationSetName(String configurationSetName) The name of the configuration set to use.
void	setContext(Map<String,String> context) You can specify custom data in this field.
void	setDestinationCountryParameters(Map<String,String> destinationCountryParameters) This field is used for any country-specific registration requirements.
void	setLanguageCode(String languageCode) Choose the language to use for the message.
void	setOriginationIdentity(String originationIdentity) The origination identity of the message.
void	setVerificationChannel(String verificationChannel) Choose to send the verification code as an SMS or voice message.
void	setVerifiedDestinationNumberId(String verifiedDestinationNumberId) The unique identifier for the verified destination phone number.
String	toString() Returns a string representation of this object.
SendDestinationNumberVerificationCodeRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use.
SendDestinationNumberVerificationCodeRequest	withContext(Map<String,String> context) You can specify custom data in this field.
SendDestinationNumberVerificationCodeRequest	withDestinationCountryParameters(Map<String,String> destinationCountryParameters) This field is used for any country-specific registration requirements.
SendDestinationNumberVerificationCodeRequest	withLanguageCode(LanguageCode languageCode) Choose the language to use for the message.
SendDestinationNumberVerificationCodeRequest	withLanguageCode(String languageCode) Choose the language to use for the message.
SendDestinationNumberVerificationCodeRequest	withOriginationIdentity(String originationIdentity) The origination identity of the message.
SendDestinationNumberVerificationCodeRequest	withVerificationChannel(String verificationChannel) Choose to send the verification code as an SMS or voice message.
SendDestinationNumberVerificationCodeRequest	withVerificationChannel(VerificationChannel verificationChannel) Choose to send the verification code as an SMS or voice message.
SendDestinationNumberVerificationCodeRequest	withVerifiedDestinationNumberId(String verifiedDestinationNumberId) The unique identifier for the verified destination phone number.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendDestinationNumberVerificationCodeRequest

public SendDestinationNumberVerificationCodeRequest()

Method Detail

setVerifiedDestinationNumberId

public void setVerifiedDestinationNumberId(String verifiedDestinationNumberId)

The unique identifier for the verified destination phone number.

Parameters:

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

getVerifiedDestinationNumberId

public String getVerifiedDestinationNumberId()

The unique identifier for the verified destination phone number.

Returns:

The unique identifier for the verified destination phone number.

withVerifiedDestinationNumberId

public SendDestinationNumberVerificationCodeRequest withVerifiedDestinationNumberId(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.

setVerificationChannel

public void setVerificationChannel(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.

See Also:

VerificationChannel

getVerificationChannel

public String getVerificationChannel()

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

Returns:

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

See Also:

VerificationChannel

withVerificationChannel

public SendDestinationNumberVerificationCodeRequest withVerificationChannel(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

withVerificationChannel

public SendDestinationNumberVerificationCodeRequest withVerificationChannel(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

setLanguageCode

public void setLanguageCode(String languageCode)

Choose the language to use for the message.

Parameters:

languageCode - Choose the language to use for the message.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

Choose the language to use for the message.

Returns:

Choose the language to use for the message.

See Also:

LanguageCode

withLanguageCode

public SendDestinationNumberVerificationCodeRequest withLanguageCode(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

withLanguageCode

public SendDestinationNumberVerificationCodeRequest withLanguageCode(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

setOriginationIdentity

public void setOriginationIdentity(String originationIdentity)

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

Parameters:

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

getOriginationIdentity

public String getOriginationIdentity()

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

Returns:

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

withOriginationIdentity

public SendDestinationNumberVerificationCodeRequest withOriginationIdentity(String originationIdentity)

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

Parameters:

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

Returns:

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

setConfigurationSetName

public void setConfigurationSetName(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.

getConfigurationSetName

public String getConfigurationSetName()

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

Returns:

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

withConfigurationSetName

public SendDestinationNumberVerificationCodeRequest withConfigurationSetName(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.

getContext

public Map<String,String> getContext()

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

Returns:

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

setContext

public void setContext(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.

withContext

public SendDestinationNumberVerificationCodeRequest withContext(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.

addContextEntry

public SendDestinationNumberVerificationCodeRequest addContextEntry(String key,
                                                                    String value)

Add a single Context entry

See Also:

withContext(java.util.Map<java.lang.String, java.lang.String>)

clearContextEntries

public SendDestinationNumberVerificationCodeRequest clearContextEntries()

Removes all the entries added into Context.

Returns:

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

getDestinationCountryParameters

public Map<String,String> getDestinationCountryParameters()

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:

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.

setDestinationCountryParameters

public void setDestinationCountryParameters(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.

withDestinationCountryParameters

public SendDestinationNumberVerificationCodeRequest withDestinationCountryParameters(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.

addDestinationCountryParametersEntry

public SendDestinationNumberVerificationCodeRequest addDestinationCountryParametersEntry(String key,
                                                                                         String value)

Add a single DestinationCountryParameters entry

See Also:

withDestinationCountryParameters(java.util.Map<java.lang.String, java.lang.String>)

clearDestinationCountryParametersEntries

public SendDestinationNumberVerificationCodeRequest clearDestinationCountryParametersEntries()

Removes all the entries added into DestinationCountryParameters.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendDestinationNumberVerificationCodeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()