Package software.amazon.awssdk.services.polly.model

Class Voice

    • Method Detail

      • gender

        public final Gender gender()

        Gender of the voice.

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

        Returns:
        Gender of the voice.
        See Also:
        Gender

      • genderAsString

        public final String genderAsString()

        Gender of the voice.

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

        Returns:
        Gender of the voice.
        See Also:
        Gender

      • id

        public final VoiceId id()

        Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

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

        Returns:
        Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
        See Also:
        VoiceId

      • idAsString

        public final String idAsString()

        Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

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

        Returns:
        Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
        See Also:
        VoiceId

      • languageName

        public final String languageName()

        Human readable name of the language in English.

        Returns:
        Human readable name of the language in English.

      • name

        public final String name()

        Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

        Returns:
        Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

      • additionalLanguageCodes

        public final List<LanguageCode> additionalLanguageCodes()

        Additional codes for languages available for the specified voice in addition to its default language.

        For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

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

        Returns:
        Additional codes for languages available for the specified voice in addition to its default language.

        For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

      • hasAdditionalLanguageCodes

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

      • additionalLanguageCodesAsStrings

        public final List<String> additionalLanguageCodesAsStrings()

        Additional codes for languages available for the specified voice in addition to its default language.

        For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

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

        Returns:
        Additional codes for languages available for the specified voice in addition to its default language.

        For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

      • supportedEngines

        public final List<Engine> supportedEngines()

        Specifies which engines (standard, neural or long-form) are supported by a given voice.

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

        Returns:
        Specifies which engines (standard, neural or long-form) are supported by a given voice.

      • hasSupportedEngines

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

      • supportedEnginesAsStrings

        public final List<String> supportedEnginesAsStrings()

        Specifies which engines (standard, neural or long-form) are supported by a given voice.

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

        Returns:
        Specifies which engines (standard, neural or long-form) are supported by a given voice.

      • serializableBuilderClass

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

      • hashCode

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

      • equals

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

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