Class VoiceParameters

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

The delivery parameters for the voice channel.

See Also:

  • Method Details

    • inlineTemplateBody

      public final String inlineTemplateBody()

      The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.

      Returns:
      The freeform message template used to render the one-time passcode for the voice channel. The template must contain the code placeholder.

    • languageCode

      public final String languageCode()

      The BCP 47 language code used to render the voice message.

      Returns:
      The BCP 47 language code used to render the voice message.

    • voiceId

      public final String voiceId()

      The Amazon Polly voice ID used for the voice channel.

      Returns:
      The Amazon Polly voice ID used for the voice channel.

    • voiceMessageBodyTextType

      public final VoiceMessageBodyTextType voiceMessageBodyTextType()

      The format of the voice message body. Valid values are TEXT and SSML.

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

      Returns:
      The format of the voice message body. Valid values are TEXT and SSML.
      See Also:

    • voiceMessageBodyTextTypeAsString

      public final String voiceMessageBodyTextTypeAsString()

      The format of the voice message body. Valid values are TEXT and SSML.

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

      Returns:
      The format of the voice message body. Valid values are TEXT and SSML.
      See Also:

    • toBuilder

      public VoiceParameters.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<VoiceParameters.Builder,VoiceParameters>
      Returns:
      a builder for type T

    • builder

      public static VoiceParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VoiceParameters.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.