com.amazonaws.services.pinpointsmsvoicev2.model

Class SendTextMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.SendTextMessageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendTextMessageRequest
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
SendTextMessageRequest()

Method Summary

Modifier and Type	Method and Description
SendTextMessageRequest	addContextEntry(String key, String value) Add a single Context entry
SendTextMessageRequest	addDestinationCountryParametersEntry(String key, String value) Add a single DestinationCountryParameters entry
SendTextMessageRequest	clearContextEntries() Removes all the entries added into Context.
SendTextMessageRequest	clearDestinationCountryParametersEntries() Removes all the entries added into DestinationCountryParameters.
SendTextMessageRequest	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	getDestinationPhoneNumber() The destination phone number in E.164 format.
Boolean	getDryRun() When set to true, the message is checked and validated, but isn't sent to the end recipient.
String	getKeyword() When you register a short code in the US, you must specify a program name.
String	getMaxPrice() The maximum amount that you want to spend, in US dollars, per each text message.
String	getMessageBody() The body of the text message.
String	getMessageType() The type of message.
String	getOriginationIdentity() The origination identity of the message.
String	getProtectConfigurationId() The unique identifier for the protect configuration.
Integer	getTimeToLive() How long the text message is valid for, in seconds.
int	hashCode()
Boolean	isDryRun() When set to true, the message is checked and validated, but isn't sent to the end recipient.
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	setDestinationPhoneNumber(String destinationPhoneNumber) The destination phone number in E.164 format.
void	setDryRun(Boolean dryRun) When set to true, the message is checked and validated, but isn't sent to the end recipient.
void	setKeyword(String keyword) When you register a short code in the US, you must specify a program name.
void	setMaxPrice(String maxPrice) The maximum amount that you want to spend, in US dollars, per each text message.
void	setMessageBody(String messageBody) The body of the text message.
void	setMessageType(String messageType) The type of message.
void	setOriginationIdentity(String originationIdentity) The origination identity of the message.
void	setProtectConfigurationId(String protectConfigurationId) The unique identifier for the protect configuration.
void	setTimeToLive(Integer timeToLive) How long the text message is valid for, in seconds.
String	toString() Returns a string representation of this object.
SendTextMessageRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use.
SendTextMessageRequest	withContext(Map<String,String> context) You can specify custom data in this field.
SendTextMessageRequest	withDestinationCountryParameters(Map<String,String> destinationCountryParameters) This field is used for any country-specific registration requirements.
SendTextMessageRequest	withDestinationPhoneNumber(String destinationPhoneNumber) The destination phone number in E.164 format.
SendTextMessageRequest	withDryRun(Boolean dryRun) When set to true, the message is checked and validated, but isn't sent to the end recipient.
SendTextMessageRequest	withKeyword(String keyword) When you register a short code in the US, you must specify a program name.
SendTextMessageRequest	withMaxPrice(String maxPrice) The maximum amount that you want to spend, in US dollars, per each text message.
SendTextMessageRequest	withMessageBody(String messageBody) The body of the text message.
SendTextMessageRequest	withMessageType(MessageType messageType) The type of message.
SendTextMessageRequest	withMessageType(String messageType) The type of message.
SendTextMessageRequest	withOriginationIdentity(String originationIdentity) The origination identity of the message.
SendTextMessageRequest	withProtectConfigurationId(String protectConfigurationId) The unique identifier for the protect configuration.
SendTextMessageRequest	withTimeToLive(Integer timeToLive) How long the text message is valid for, in seconds.

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

SendTextMessageRequest

public SendTextMessageRequest()

Method Detail

setDestinationPhoneNumber

public void setDestinationPhoneNumber(String destinationPhoneNumber)

The destination phone number in E.164 format.

Parameters:

destinationPhoneNumber - The destination phone number in E.164 format.

getDestinationPhoneNumber

public String getDestinationPhoneNumber()

The destination phone number in E.164 format.

Returns:

The destination phone number in E.164 format.

withDestinationPhoneNumber

public SendTextMessageRequest withDestinationPhoneNumber(String destinationPhoneNumber)

The destination phone number in E.164 format.

Parameters:

destinationPhoneNumber - The destination phone number in E.164 format.

Returns:

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

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

setMessageBody

public void setMessageBody(String messageBody)

The body of the text message.

Parameters:

messageBody - The body of the text message.

getMessageBody

public String getMessageBody()

The body of the text message.

Returns:

The body of the text message.

withMessageBody

public SendTextMessageRequest withMessageBody(String messageBody)

The body of the text message.

Parameters:

messageBody - The body of the text message.

Returns:

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

setMessageType

public void setMessageType(String messageType)

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageType - The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

getMessageType

public String getMessageType()

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

withMessageType

public SendTextMessageRequest withMessageType(String messageType)

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageType - The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

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

See Also:

MessageType

withMessageType

public SendTextMessageRequest withMessageType(MessageType messageType)

The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageType - The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

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

See Also:

MessageType

setKeyword

public void setKeyword(String keyword)

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

Parameters:

keyword - When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

getKeyword

public String getKeyword()

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

Returns:

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

withKeyword

public SendTextMessageRequest withKeyword(String keyword)

When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

Parameters:

keyword - When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.

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

setMaxPrice

public void setMaxPrice(String maxPrice)

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

Parameters:

maxPrice - The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

getMaxPrice

public String getMaxPrice()

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

Returns:

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

withMaxPrice

public SendTextMessageRequest withMaxPrice(String maxPrice)

The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

Parameters:

maxPrice - The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.

Returns:

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

setTimeToLive

public void setTimeToLive(Integer timeToLive)

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

Parameters:

timeToLive - How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

getTimeToLive

public Integer getTimeToLive()

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

Returns:

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

withTimeToLive

public SendTextMessageRequest withTimeToLive(Integer timeToLive)

How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

Parameters:

timeToLive - How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.

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 SendTextMessageRequest 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 SendTextMessageRequest addContextEntry(String key,
                                              String value)

Add a single Context entry

See Also:

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

clearContextEntries

public SendTextMessageRequest 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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

withDestinationCountryParameters

public SendTextMessageRequest 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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

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.

• IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.

• IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.

  Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.

Returns:

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

addDestinationCountryParametersEntry

public SendTextMessageRequest addDestinationCountryParametersEntry(String key,
                                                                   String value)

Add a single DestinationCountryParameters entry

See Also:

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

clearDestinationCountryParametersEntries

public SendTextMessageRequest clearDestinationCountryParametersEntries()

Removes all the entries added into DestinationCountryParameters.

Returns:

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

setDryRun

public void setDryRun(Boolean dryRun)

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

Parameters:

dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

getDryRun

public Boolean getDryRun()

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

Returns:

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

withDryRun

public SendTextMessageRequest withDryRun(Boolean dryRun)

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

Parameters:

dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

Returns:

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

isDryRun

public Boolean isDryRun()

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

Returns:

When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.

The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the AWS End User Messaging SMS User Guide..

setProtectConfigurationId

public void setProtectConfigurationId(String protectConfigurationId)

The unique identifier for the protect configuration.

Parameters:

protectConfigurationId - The unique identifier for the protect configuration.

getProtectConfigurationId

public String getProtectConfigurationId()

The unique identifier for the protect configuration.

Returns:

The unique identifier for the protect configuration.

withProtectConfigurationId

public SendTextMessageRequest withProtectConfigurationId(String protectConfigurationId)

The unique identifier for the protect configuration.

Parameters:

protectConfigurationId - The unique identifier for the protect configuration.

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 SendTextMessageRequest 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()