Class SynthesisTask

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

SynthesisTask object that provides information about a speech synthesis task.

See Also:

  • Method Details

    • engine

      public final Engine engine()

      Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

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

      Returns:
      Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
      See Also:

    • engineAsString

      public final String engineAsString()

      Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

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

      Returns:
      Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.
      See Also:

    • taskId

      public final String taskId()

      The Amazon Polly generated identifier for a speech synthesis task.

      Returns:
      The Amazon Polly generated identifier for a speech synthesis task.

    • taskStatus

      public final TaskStatus taskStatus()

      Current status of the individual speech synthesis task.

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

      Returns:
      Current status of the individual speech synthesis task.
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      Current status of the individual speech synthesis task.

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

      Returns:
      Current status of the individual speech synthesis task.
      See Also:

    • taskStatusReason

      public final String taskStatusReason()

      Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

      Returns:
      Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

    • outputUri

      public final String outputUri()

      Pathway for the output speech file.

      Returns:
      Pathway for the output speech file.

    • creationTime

      public final Instant creationTime()

      Timestamp for the time the synthesis task was started.

      Returns:
      Timestamp for the time the synthesis task was started.

    • requestCharacters

      public final Integer requestCharacters()

      Number of billable characters synthesized.

      Returns:
      Number of billable characters synthesized.

    • snsTopicArn

      public final String snsTopicArn()

      ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

      Returns:
      ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    • hasLexiconNames

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

    • lexiconNames

      public final List<String> lexiconNames()

      List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the 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 hasLexiconNames() method.

      Returns:
      List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

    • outputFormat

      public final OutputFormat outputFormat()

      The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

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

      Returns:
      The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

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

      Returns:
      The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.
      See Also:

    • sampleRate

      public final String sampleRate()

      The audio frequency specified in Hz.

      The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

      Valid values for pcm are "8000" and "16000" The default value is "16000".

      Returns:
      The audio frequency specified in Hz.

      The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

      Valid values for pcm are "8000" and "16000" The default value is "16000".

    • speechMarkTypes

      public final List<SpeechMarkType> speechMarkTypes()

      The type of speech marks returned for the input text.

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

      Returns:
      The type of speech marks returned for the input text.

    • hasSpeechMarkTypes

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

    • speechMarkTypesAsStrings

      public final List<String> speechMarkTypesAsStrings()

      The type of speech marks returned for the input text.

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

      Returns:
      The type of speech marks returned for the input text.

    • textType

      public final TextType textType()

      Specifies whether the input text is plain text or SSML. The default value is plain text.

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

      Returns:
      Specifies whether the input text is plain text or SSML. The default value is plain text.
      See Also:

    • textTypeAsString

      public final String textTypeAsString()

      Specifies whether the input text is plain text or SSML. The default value is plain text.

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

      Returns:
      Specifies whether the input text is plain text or SSML. The default value is plain text.
      See Also:

    • voiceId

      public final VoiceId voiceId()

      Voice ID to use for the synthesis.

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

      Returns:
      Voice ID to use for the synthesis.
      See Also:

    • voiceIdAsString

      public final String voiceIdAsString()

      Voice ID to use for the synthesis.

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

      Returns:
      Voice ID to use for the synthesis.
      See Also:

    • languageCode

      public final LanguageCode languageCode()

      Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

      If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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

      Returns:
      Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

      If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

      If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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

      Returns:
      Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

      If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

      See Also:

    • toBuilder

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

    • builder

      public static SynthesisTask.Builder builder()

    • serializableBuilderClass

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