software.amazon.awssdk.services.polly.model

Class SynthesisTask

java.lang.Object

software.amazon.awssdk.services.polly.model.SynthesisTask

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SynthesisTask.Builder,SynthesisTask>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SynthesisTask.Builder

Method Summary

Modifier and Type	Method and Description
static SynthesisTask.Builder	builder()
Instant	creationTime() Timestamp for the time the synthesis task was started.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() Optional language code for a synthesis task.
String	languageCodeAsString() Optional language code for a synthesis task.
List<String>	lexiconNames() List of one or more pronunciation lexicon names you want the service to apply during synthesis.
OutputFormat	outputFormat() The format in which the returned output will be encoded.
String	outputFormatAsString() The format in which the returned output will be encoded.
String	outputUri() Pathway for the output speech file.
Integer	requestCharacters() Number of billable characters synthesized.
String	sampleRate() The audio frequency specified in Hz.
List<SdkField<?>>	sdkFields()
static Class<? extends SynthesisTask.Builder>	serializableBuilderClass()
String	snsTopicArn() ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
List<SpeechMarkType>	speechMarkTypes() The type of speech marks returned for the input text.
List<String>	speechMarkTypesAsStrings() The type of speech marks returned for the input text.
String	taskId() The Amazon Polly generated identifier for a speech synthesis task.
TaskStatus	taskStatus() Current status of the individual speech synthesis task.
String	taskStatusAsString() Current status of the individual speech synthesis task.
String	taskStatusReason() Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
TextType	textType() Specifies whether the input text is plain text or SSML.
String	textTypeAsString() Specifies whether the input text is plain text or SSML.
SynthesisTask.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
VoiceId	voiceId() Voice ID to use for the synthesis.
String	voiceIdAsString() Voice ID to use for the synthesis.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

taskId

public 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 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:

TaskStatus

taskStatusAsString

public 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:

TaskStatus

taskStatusReason

public 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 String outputUri()

Pathway for the output speech file.

Returns:

Pathway for the output speech file.

creationTime

public Instant creationTime()

Timestamp for the time the synthesis task was started.

Returns:

Timestamp for the time the synthesis task was started.

requestCharacters

public Integer requestCharacters()

Number of billable characters synthesized.

Returns:

Number of billable characters synthesized.

snsTopicArn

public 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.

lexiconNames

public 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.

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 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:

OutputFormat

outputFormatAsString

public 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:

OutputFormat

sampleRate

public String sampleRate()

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", and "22050". The default value is "22050".

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", and "22050". The default value is "22050".

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

speechMarkTypes

public 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.

Returns:

The type of speech marks returned for the input text.

speechMarkTypesAsStrings

public 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.

Returns:

The type of speech marks returned for the input text.

textType

public 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:

TextType

textTypeAsString

public 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:

TextType

voiceId

public 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:

VoiceId

voiceIdAsString

public 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:

VoiceId

languageCode

public 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 will use 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 will use 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:

LanguageCode

languageCodeAsString

public 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 will use 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 will use 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:

LanguageCode

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.