Class VoiceSettings

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

Defines settings for using an Amazon Polly voice to communicate with a user.

Valid values include:

  • standard

  • neural

  • long-form

  • generative

See Also:

  • Method Details

    • voiceId

      public final String voiceId()

      The identifier of the Amazon Polly voice to use.

      Returns:
      The identifier of the Amazon Polly voice to use.

    • engine

      public final VoiceEngine engine()

      Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

      If you do not specify a value, the default is standard.

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

      Returns:
      Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

      If you do not specify a value, the default is standard.

      See Also:

    • engineAsString

      public final String engineAsString()

      Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

      If you do not specify a value, the default is standard.

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

      Returns:
      Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

      If you do not specify a value, the default is standard.

      See Also:

    • toBuilder

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

    • builder

      public static VoiceSettings.Builder builder()

    • serializableBuilderClass

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