com.amazonaws.services.pinpoint.model

Class SMSMessage

java.lang.Object

com.amazonaws.services.pinpoint.model.SMSMessage

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

SMS Message.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SMSMessage()

Method Summary

Modifier and Type	Method and Description
SMSMessage	addSubstitutionsEntry(String key, List<String> value)
SMSMessage	clearSubstitutionsEntries() Removes all the entries added into Substitutions.
SMSMessage	clone()
boolean	equals(Object obj)
String	getBody() The body of the SMS message.
String	getKeyword() The SMS program name that you provided to AWS Support when you requested your dedicated number.
String	getMessageType() Is this a transaction priority message or lower priority.
String	getOriginationNumber() The phone number that the SMS message originates from.
String	getSenderId() The sender ID that is shown as the message sender on the recipient's device.
Map<String,List<String>>	getSubstitutions() Default message substitutions.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setBody(String body) The body of the SMS message.
void	setKeyword(String keyword) The SMS program name that you provided to AWS Support when you requested your dedicated number.
void	setMessageType(MessageType messageType) Is this a transaction priority message or lower priority.
void	setMessageType(String messageType) Is this a transaction priority message or lower priority.
void	setOriginationNumber(String originationNumber) The phone number that the SMS message originates from.
void	setSenderId(String senderId) The sender ID that is shown as the message sender on the recipient's device.
void	setSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.
String	toString() Returns a string representation of this object.
SMSMessage	withBody(String body) The body of the SMS message.
SMSMessage	withKeyword(String keyword) The SMS program name that you provided to AWS Support when you requested your dedicated number.
SMSMessage	withMessageType(MessageType messageType) Is this a transaction priority message or lower priority.
SMSMessage	withMessageType(String messageType) Is this a transaction priority message or lower priority.
SMSMessage	withOriginationNumber(String originationNumber) The phone number that the SMS message originates from.
SMSMessage	withSenderId(String senderId) The sender ID that is shown as the message sender on the recipient's device.
SMSMessage	withSubstitutions(Map<String,List<String>> substitutions) Default message substitutions.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SMSMessage

public SMSMessage()

Method Detail

setBody

public void setBody(String body)

The body of the SMS message.

Parameters:

body - The body of the SMS message.

getBody

public String getBody()

The body of the SMS message.

Returns:

The body of the SMS message.

withBody

public SMSMessage withBody(String body)

The body of the SMS message.

Parameters:

body - The body of the SMS message.

Returns:

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

setKeyword

public void setKeyword(String keyword)

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Parameters:

keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

getKeyword

public String getKeyword()

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Returns:

The SMS program name that you provided to AWS Support when you requested your dedicated number.

withKeyword

public SMSMessage withKeyword(String keyword)

The SMS program name that you provided to AWS Support when you requested your dedicated number.

Parameters:

keyword - The SMS program name that you provided to AWS Support when you requested your dedicated number.

Returns:

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

setMessageType

public void setMessageType(String messageType)

Is this a transaction priority message or lower priority.

Parameters:

messageType - Is this a transaction priority message or lower priority.

See Also:

MessageType

getMessageType

public String getMessageType()

Is this a transaction priority message or lower priority.

Returns:

Is this a transaction priority message or lower priority.

See Also:

MessageType

withMessageType

public SMSMessage withMessageType(String messageType)

Is this a transaction priority message or lower priority.

Parameters:

messageType - Is this a transaction priority message or lower priority.

Returns:

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

See Also:

MessageType

setMessageType

public void setMessageType(MessageType messageType)

Is this a transaction priority message or lower priority.

Parameters:

messageType - Is this a transaction priority message or lower priority.

See Also:

MessageType

withMessageType

public SMSMessage withMessageType(MessageType messageType)

Is this a transaction priority message or lower priority.

Parameters:

messageType - Is this a transaction priority message or lower priority.

Returns:

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

See Also:

MessageType

setOriginationNumber

public void setOriginationNumber(String originationNumber)

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Parameters:

originationNumber - The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

getOriginationNumber

public String getOriginationNumber()

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns:

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

withOriginationNumber

public SMSMessage withOriginationNumber(String originationNumber)

The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Parameters:

originationNumber - The phone number that the SMS message originates from. Specify one of the dedicated long codes or short codes that you requested from AWS Support and that is assigned to your account. If this attribute is not specified, Amazon Pinpoint randomly assigns a long code.

Returns:

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

setSenderId

public void setSenderId(String senderId)

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Parameters:

senderId - The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

getSenderId

public String getSenderId()

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Returns:

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

withSenderId

public SMSMessage withSenderId(String senderId)

The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Parameters:

senderId - The sender ID that is shown as the message sender on the recipient's device. Support for sender IDs varies by country or region.

Returns:

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

getSubstitutions

public Map<String,List<String>> getSubstitutions()

Default message substitutions. Can be overridden by individual address substitutions.

Returns:

Default message substitutions. Can be overridden by individual address substitutions.

setSubstitutions

public void setSubstitutions(Map<String,List<String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

withSubstitutions

public SMSMessage withSubstitutions(Map<String,List<String>> substitutions)

Default message substitutions. Can be overridden by individual address substitutions.

Parameters:

substitutions - Default message substitutions. Can be overridden by individual address substitutions.

Returns:

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

addSubstitutionsEntry

public SMSMessage addSubstitutionsEntry(String key,
                                        List<String> value)

clearSubstitutionsEntries

public SMSMessage clearSubstitutionsEntries()

Removes all the entries added into Substitutions.

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 SMSMessage clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo