Class UpdateVoiceParameters

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

The updated delivery parameters for the voice channel. Absent members preserve the current value, and the empty sentinel on a member clears it.

See Also:

  • Method Details

    • inlineTemplateBody

      public final String inlineTemplateBody()

      The updated freeform voice template body. An empty string clears the previously stored value.

      Returns:
      The updated freeform voice template body. An empty string clears the previously stored value.

    • languageCode

      public final String languageCode()

      The updated BCP 47 language code. An empty string clears the previously stored value.

      Returns:
      The updated BCP 47 language code. An empty string clears the previously stored value.

    • voiceId

      public final String voiceId()

      The updated Amazon Polly voice ID. An empty string clears the previously stored value.

      Returns:
      The updated Amazon Polly voice ID. An empty string clears the previously stored value.

    • voiceMessageBodyTextType

      public final VoiceMessageBodyTextType voiceMessageBodyTextType()

      The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.

      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 updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.
      See Also:

    • voiceMessageBodyTextTypeAsString

      public final String voiceMessageBodyTextTypeAsString()

      The updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.

      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 updated format of the voice message body. Valid values are TEXT and SSML. Omit this member to preserve the current value.
      See Also:

    • toBuilder

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

    • builder

      public static UpdateVoiceParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateVoiceParameters.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.