SMSMessage (AWS Java SDK :: Services :: Amazon Pinpoint 2.15.45 API)

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>
```
Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SMSMessage.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SMSMessage.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`body()` The body of the SMS message.
`static SMSMessage.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSubstitutions()` Returns true if the Substitutions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`keyword()` The SMS program name that you provided to AWS Support when you requested your dedicated number.
`String`	`mediaUrl()` This field is reserved for future use.
`MessageType`	`messageType()` The SMS message type.
`String`	`messageTypeAsString()` The SMS message type.
`String`	`originationNumber()` The number to send the SMS message from.
`List<SdkField<?>>`	`sdkFields()`
`String`	`senderId()` The sender ID to display as the sender of the message on a recipient's device.
`static Class<? extends SMSMessage.Builder>`	`serializableBuilderClass()`
`Map<String,List<String>>`	`substitutions()` The message variables to use in the SMS message.
`SMSMessage.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, 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.
  - mediaUrl
```
public String mediaUrl()
```
    This field is reserved for future use.
    
    Returns:
    
    This field is reserved for future use.
  - messageType
```
public MessageType messageType()
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    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:
    
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
public String messageTypeAsString()
```
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    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:
    
    The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
    
    See Also:
    
    MessageType
  - originationNumber
```
public String originationNumber()
```
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
    
    Returns:
    
    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
  - senderId
```
public String senderId()
```
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
    
    Returns:
    
    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
  - hasSubstitutions
```
public boolean hasSubstitutions()
```
    Returns true if the Substitutions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - substitutions
```
public Map<String,List<String>> substitutions()
```
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSubstitutions() to see if a value was sent in this field.
    
    Returns:
    
    The message variables to use in the SMS message. You can override the default variables with individual address variables.
  - toBuilder
```
public SMSMessage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SMSMessage.Builder,SMSMessage>
  - 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
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SMSMessage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

body

keyword

mediaUrl

messageType

messageTypeAsString

originationNumber

senderId

hasSubstitutions

substitutions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields