software.amazon.awssdk.services.pinpoint.model

Class SMSMessage

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SMSMessage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SMSMessage.Builder,SMSMessage>

@Generated(value="software.amazon.awssdk:codegen")
public final class SMSMessage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SMSMessage.Builder,SMSMessage>

SMS Message.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SMSMessage.Builder

Method Summary

Modifier and Type	Method and Description
String	body() The body of the SMS message.
static SMSMessage.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyword() The SMS program name that you provided to AWS Support when you requested your dedicated number.
MessageType	messageType() Is this a transaction priority message or lower priority.
String	messageTypeAsString() Is this a transaction priority message or lower priority.
String	originationNumber() The phone number that the SMS message originates from.
List<SdkField<?>>	sdkFields()
String	senderId() The sender ID that is shown as the message sender on the recipient's device.
static Class<? extends SMSMessage.Builder>	serializableBuilderClass()
Map<String,List<String>>	substitutions() Default message substitutions.
SMSMessage.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

body

public String body()

The body of the SMS message.

Returns:

The body of the SMS message.

keyword

public String keyword()

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.

messageType

public MessageType messageType()

Is this a transaction priority message or lower priority.

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

Returns:

Is this a transaction priority message or lower priority.

See Also:

MessageType

messageTypeAsString

public String messageTypeAsString()

Is this a transaction priority message or lower priority.

If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

Returns:

Is this a transaction priority message or lower priority.

See Also:

MessageType

originationNumber

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

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.

senderId

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

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.

substitutions

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

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public SMSMessage.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SMSMessage.Builder,SMSMessage>

Returns:

a builder for type T

builder

public static SMSMessage.Builder builder()

serializableBuilderClass

public static Class<? extends SMSMessage.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.