SendTextMessageRequest (AWS Java SDK :: Services :: Pinpoint SMS Voice V2 2.20.110 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
    - - software.amazon.awssdk.services.pinpointsmsvoicev2.model.SendTextMessageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendTextMessageRequest
extends PinpointSmsVoiceV2Request
implements ToCopyableBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SendTextMessageRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SendTextMessageRequest.Builder`	`builder()`
`String`	`configurationSetName()` The name of the configuration set to use.
`Map<String,String>`	`context()` You can specify custom data in this field.
`Map<DestinationCountryParameterKey,String>`	`destinationCountryParameters()` This field is used for any country-specific registration requirements.
`Map<String,String>`	`destinationCountryParametersAsStrings()` This field is used for any country-specific registration requirements.
`String`	`destinationPhoneNumber()` The destination phone number in E.164 format.
`Boolean`	`dryRun()` When set to true, the message is checked and validated, but isn't sent to the end recipient.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContext()` For responses, this returns true if the service returned a value for the Context property.
`boolean`	`hasDestinationCountryParameters()` For responses, this returns true if the service returned a value for the DestinationCountryParameters property.
`int`	`hashCode()`
`String`	`keyword()` When you register a short code in the US, you must specify a program name.
`String`	`maxPrice()` The maximum amount that you want to spend, in US dollars, per each text message part.
`String`	`messageBody()` The body of the text message.
`MessageType`	`messageType()` The type of message.
`String`	`messageTypeAsString()` The type of message.
`String`	`originationIdentity()` The origination identity of the message.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SendTextMessageRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`timeToLive()` How long the text message is valid for.
`SendTextMessageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - destinationPhoneNumber
```
public final String destinationPhoneNumber()
```
    The destination phone number in E.164 format.
    
    Returns:
    
    The destination phone number in E.164 format.
  - originationIdentity
```
public final String originationIdentity()
```
    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.
  - messageBody
```
public final String messageBody()
```
    The body of the text message.
    
    Returns:
    
    The body of the text message.
  - messageType
```
public final MessageType messageType()
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    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 type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - messageTypeAsString
```
public final String messageTypeAsString()
```
    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    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 type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
    
    See Also:
    
    MessageType
  - keyword
```
public final 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.
    
    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.
  - configurationSetName
```
public final String configurationSetName()
```
    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.
  - maxPrice
```
public final String maxPrice()
```
    The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
    
    Returns:
    
    The maximum amount that you want to spend, in US dollars, per each text message part. A text message can contain multiple parts.
  - timeToLive
```
public final Integer timeToLive()
```
    How long the text message is valid for. By default this is 72 hours.
    
    Returns:
    
    How long the text message is valid for. By default this is 72 hours.
  - hasContext
```
public final boolean hasContext()
```
    For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - context
```
public final Map<String,String> context()
```
    You can specify custom data in this field. If you do, that data is logged to the event destination.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.
    
    Returns:
    
    You can specify custom data in this field. If you do, that data is logged to the event destination.
  - destinationCountryParameters
```
public final Map<DestinationCountryParameterKey,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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationCountryParameters() method.
    
    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.
  - hasDestinationCountryParameters
```
public final boolean hasDestinationCountryParameters()
```
    For responses, this returns true if the service returned a value for the DestinationCountryParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - destinationCountryParametersAsStrings
```
public final Map<String,String> destinationCountryParametersAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinationCountryParameters() method.
    
    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.
  - dryRun
```
public final Boolean dryRun()
```
    When set to true, the message is checked and validated, but isn't sent to the end recipient.
    
    Returns:
    
    When set to true, the message is checked and validated, but isn't sent to the end recipient.
  - toBuilder
```
public SendTextMessageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SendTextMessageRequest.Builder,SendTextMessageRequest>
    
    Specified by:
    
    toBuilder in class PinpointSmsVoiceV2Request
  - builder
```
public static SendTextMessageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SendTextMessageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class SendTextMessageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

destinationPhoneNumber

originationIdentity

messageBody

messageType

messageTypeAsString

keyword

configurationSetName

maxPrice

timeToLive

hasContext

context

destinationCountryParameters

hasDestinationCountryParameters

destinationCountryParametersAsStrings

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields