Package software.amazon.awssdk.services.pinpoint.model

Class VoiceMessage

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.VoiceMessage
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VoiceMessage.Builder,VoiceMessage>
@Generated("software.amazon.awssdk:codegen") public final class VoiceMessage extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VoiceMessage.Builder,VoiceMessage>

Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

See Also:

  • Method Details

    • body

      public final String body()

      The text of the script to use for the voice message.

      Returns:
      The text of the script to use for the voice message.

    • languageCode

      public final String languageCode()

      The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

      Returns:
      The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.

    • originationNumber

      public final String originationNumber()

      The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

      Returns:
      The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

    • hasSubstitutions

      public final boolean hasSubstitutions()
      For responses, this returns true if the service returned a value for the Substitutions 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.

    • substitutions

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

      The default message variables to use in the voice 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.

      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 hasSubstitutions() method.

      Returns:
      The default message variables to use in the voice message. You can override the default variables with individual address variables.

    • voiceId

      public final String voiceId()

      The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

      Returns:
      The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

    • toBuilder

      public VoiceMessage.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<VoiceMessage.Builder,VoiceMessage>

    • builder

      public static VoiceMessage.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo