@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SynthesisTask extends Object implements Serializable, Cloneable, StructuredPojo
SynthesisTask object that provides information about a speech synthesis task.
Constructor and Description |
---|
SynthesisTask() |
Modifier and Type | Method and Description |
---|---|
SynthesisTask |
clone() |
boolean |
equals(Object obj) |
Date |
getCreationTime()
Timestamp for the time the synthesis task was started.
|
String |
getEngine()
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
String |
getLanguageCode()
Optional language code for a synthesis task.
|
List<String> |
getLexiconNames()
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
String |
getOutputFormat()
The format in which the returned output will be encoded.
|
String |
getOutputUri()
Pathway for the output speech file.
|
Integer |
getRequestCharacters()
Number of billable characters synthesized.
|
String |
getSampleRate()
The audio frequency specified in Hz.
|
String |
getSnsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
List<String> |
getSpeechMarkTypes()
The type of speech marks returned for the input text.
|
String |
getTaskId()
The Amazon Polly generated identifier for a speech synthesis task.
|
String |
getTaskStatus()
Current status of the individual speech synthesis task.
|
String |
getTaskStatusReason()
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
|
String |
getTextType()
Specifies whether the input text is plain text or SSML.
|
String |
getVoiceId()
Voice ID to use for the synthesis.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreationTime(Date creationTime)
Timestamp for the time the synthesis task was started.
|
void |
setEngine(String engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
void |
setLanguageCode(String languageCode)
Optional language code for a synthesis task.
|
void |
setLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
void |
setOutputFormat(String outputFormat)
The format in which the returned output will be encoded.
|
void |
setOutputUri(String outputUri)
Pathway for the output speech file.
|
void |
setRequestCharacters(Integer requestCharacters)
Number of billable characters synthesized.
|
void |
setSampleRate(String sampleRate)
The audio frequency specified in Hz.
|
void |
setSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
void |
setSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
|
void |
setTaskId(String taskId)
The Amazon Polly generated identifier for a speech synthesis task.
|
void |
setTaskStatus(String taskStatus)
Current status of the individual speech synthesis task.
|
void |
setTaskStatusReason(String taskStatusReason)
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
|
void |
setTextType(String textType)
Specifies whether the input text is plain text or SSML.
|
void |
setVoiceId(String voiceId)
Voice ID to use for the synthesis.
|
String |
toString()
Returns a string representation of this object.
|
SynthesisTask |
withCreationTime(Date creationTime)
Timestamp for the time the synthesis task was started.
|
SynthesisTask |
withEngine(Engine engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
SynthesisTask |
withEngine(String engine)
Specifies the engine (
standard , neural , long-form or
generative ) for Amazon Polly to use when processing input text for speech synthesis. |
SynthesisTask |
withLanguageCode(LanguageCode languageCode)
Optional language code for a synthesis task.
|
SynthesisTask |
withLanguageCode(String languageCode)
Optional language code for a synthesis task.
|
SynthesisTask |
withLexiconNames(Collection<String> lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
SynthesisTask |
withLexiconNames(String... lexiconNames)
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
SynthesisTask |
withOutputFormat(OutputFormat outputFormat)
The format in which the returned output will be encoded.
|
SynthesisTask |
withOutputFormat(String outputFormat)
The format in which the returned output will be encoded.
|
SynthesisTask |
withOutputUri(String outputUri)
Pathway for the output speech file.
|
SynthesisTask |
withRequestCharacters(Integer requestCharacters)
Number of billable characters synthesized.
|
SynthesisTask |
withSampleRate(String sampleRate)
The audio frequency specified in Hz.
|
SynthesisTask |
withSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
SynthesisTask |
withSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
|
SynthesisTask |
withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)
The type of speech marks returned for the input text.
|
SynthesisTask |
withSpeechMarkTypes(String... speechMarkTypes)
The type of speech marks returned for the input text.
|
SynthesisTask |
withTaskId(String taskId)
The Amazon Polly generated identifier for a speech synthesis task.
|
SynthesisTask |
withTaskStatus(String taskStatus)
Current status of the individual speech synthesis task.
|
SynthesisTask |
withTaskStatus(TaskStatus taskStatus)
Current status of the individual speech synthesis task.
|
SynthesisTask |
withTaskStatusReason(String taskStatusReason)
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
|
SynthesisTask |
withTextType(String textType)
Specifies whether the input text is plain text or SSML.
|
SynthesisTask |
withTextType(TextType textType)
Specifies whether the input text is plain text or SSML.
|
SynthesisTask |
withVoiceId(String voiceId)
Voice ID to use for the synthesis.
|
SynthesisTask |
withVoiceId(VoiceId voiceId)
Voice ID to use for the synthesis.
|
public void setEngine(String 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.
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.Engine
public String getEngine()
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.
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.Engine
public SynthesisTask withEngine(String 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.
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.Engine
public SynthesisTask withEngine(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.
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.Engine
public void setTaskId(String taskId)
The Amazon Polly generated identifier for a speech synthesis task.
taskId
- The Amazon Polly generated identifier for a speech synthesis task.public String getTaskId()
The Amazon Polly generated identifier for a speech synthesis task.
public SynthesisTask withTaskId(String taskId)
The Amazon Polly generated identifier for a speech synthesis task.
taskId
- The Amazon Polly generated identifier for a speech synthesis task.public void setTaskStatus(String taskStatus)
Current status of the individual speech synthesis task.
taskStatus
- Current status of the individual speech synthesis task.TaskStatus
public String getTaskStatus()
Current status of the individual speech synthesis task.
TaskStatus
public SynthesisTask withTaskStatus(String taskStatus)
Current status of the individual speech synthesis task.
taskStatus
- Current status of the individual speech synthesis task.TaskStatus
public SynthesisTask withTaskStatus(TaskStatus taskStatus)
Current status of the individual speech synthesis task.
taskStatus
- Current status of the individual speech synthesis task.TaskStatus
public void setTaskStatusReason(String taskStatusReason)
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
taskStatusReason
- Reason for the current status of a specific speech synthesis task, including errors if the task has
failed.public String getTaskStatusReason()
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
public SynthesisTask withTaskStatusReason(String taskStatusReason)
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
taskStatusReason
- Reason for the current status of a specific speech synthesis task, including errors if the task has
failed.public void setOutputUri(String outputUri)
Pathway for the output speech file.
outputUri
- Pathway for the output speech file.public String getOutputUri()
Pathway for the output speech file.
public SynthesisTask withOutputUri(String outputUri)
Pathway for the output speech file.
outputUri
- Pathway for the output speech file.public void setCreationTime(Date creationTime)
Timestamp for the time the synthesis task was started.
creationTime
- Timestamp for the time the synthesis task was started.public Date getCreationTime()
Timestamp for the time the synthesis task was started.
public SynthesisTask withCreationTime(Date creationTime)
Timestamp for the time the synthesis task was started.
creationTime
- Timestamp for the time the synthesis task was started.public void setRequestCharacters(Integer requestCharacters)
Number of billable characters synthesized.
requestCharacters
- Number of billable characters synthesized.public Integer getRequestCharacters()
Number of billable characters synthesized.
public SynthesisTask withRequestCharacters(Integer requestCharacters)
Number of billable characters synthesized.
requestCharacters
- Number of billable characters synthesized.public void setSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
snsTopicArn
- ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.public String getSnsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
public SynthesisTask withSnsTopicArn(String snsTopicArn)
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
snsTopicArn
- ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.public List<String> getLexiconNames()
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.
public void setLexiconNames(Collection<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.
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.public SynthesisTask withLexiconNames(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.
NOTE: This method appends the values to the existing list (if any). Use
setLexiconNames(java.util.Collection)
or withLexiconNames(java.util.Collection)
if you want to
override the existing values.
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.public SynthesisTask withLexiconNames(Collection<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.
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.public void setOutputFormat(String 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.
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.OutputFormat
public String getOutputFormat()
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.
OutputFormat
public SynthesisTask withOutputFormat(String 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.
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.OutputFormat
public SynthesisTask withOutputFormat(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.
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.OutputFormat
public void setSampleRate(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".
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".
public String getSampleRate()
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".
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".
public SynthesisTask withSampleRate(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".
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".
public List<String> getSpeechMarkTypes()
The type of speech marks returned for the input text.
SpeechMarkType
public void setSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public SynthesisTask withSpeechMarkTypes(String... speechMarkTypes)
The type of speech marks returned for the input text.
NOTE: This method appends the values to the existing list (if any). Use
setSpeechMarkTypes(java.util.Collection)
or withSpeechMarkTypes(java.util.Collection)
if you
want to override the existing values.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public SynthesisTask withSpeechMarkTypes(Collection<String> speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public SynthesisTask withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)
The type of speech marks returned for the input text.
speechMarkTypes
- The type of speech marks returned for the input text.SpeechMarkType
public void setTextType(String textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public String getTextType()
Specifies whether the input text is plain text or SSML. The default value is plain text.
TextType
public SynthesisTask withTextType(String textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public SynthesisTask withTextType(TextType textType)
Specifies whether the input text is plain text or SSML. The default value is plain text.
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.TextType
public void setVoiceId(String voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public String getVoiceId()
Voice ID to use for the synthesis.
VoiceId
public SynthesisTask withVoiceId(String voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public SynthesisTask withVoiceId(VoiceId voiceId)
Voice ID to use for the synthesis.
voiceId
- Voice ID to use for the synthesis.VoiceId
public void setLanguageCode(String 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.
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.
LanguageCode
public String getLanguageCode()
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 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.
LanguageCode
public SynthesisTask withLanguageCode(String 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.
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.
LanguageCode
public SynthesisTask withLanguageCode(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.
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.
LanguageCode
public String toString()
toString
in class Object
Object.toString()
public SynthesisTask clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.