SynthesisTask (aws-android-sdk-polly 2.53.0 API)

java.lang.Object
- com.amazonaws.services.polly.model.SynthesisTask

All Implemented Interfaces:

java.io.Serializable
```
public class SynthesisTask
extends java.lang.Object
implements java.io.Serializable
```
SynthesisTask object that provides information about a speech synthesis task.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SynthesisTask()

Constructors
Constructor and Description
`SynthesisTask()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.util.Date`	`getCreationTime()` Timestamp for the time the synthesis task was started.
`java.lang.String`	`getEngine()` Specifies the engine (`standard` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
`java.lang.String`	`getLanguageCode()` Optional language code for a synthesis task.
`java.util.List<java.lang.String>`	`getLexiconNames()` List of one or more pronunciation lexicon names you want the service to apply during synthesis.
`java.lang.String`	`getOutputFormat()` The format in which the returned output will be encoded.
`java.lang.String`	`getOutputUri()` Pathway for the output speech file.
`java.lang.Integer`	`getRequestCharacters()` Number of billable characters synthesized.
`java.lang.String`	`getSampleRate()` The audio frequency specified in Hz.
`java.lang.String`	`getSnsTopicArn()` ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
`java.util.List<java.lang.String>`	`getSpeechMarkTypes()` The type of speech marks returned for the input text.
`java.lang.String`	`getTaskId()` The Amazon Polly generated identifier for a speech synthesis task.
`java.lang.String`	`getTaskStatus()` Current status of the individual speech synthesis task.
`java.lang.String`	`getTaskStatusReason()` Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
`java.lang.String`	`getTextType()` Specifies whether the input text is plain text or SSML.
`java.lang.String`	`getVoiceId()` Voice ID to use for the synthesis.
`int`	`hashCode()`
`void`	`setCreationTime(java.util.Date creationTime)` Timestamp for the time the synthesis task was started.
`void`	`setEngine(Engine engine)` Specifies the engine (`standard` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
`void`	`setEngine(java.lang.String engine)` Specifies the engine (`standard` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
`void`	`setLanguageCode(LanguageCode languageCode)` Optional language code for a synthesis task.
`void`	`setLanguageCode(java.lang.String languageCode)` Optional language code for a synthesis task.
`void`	`setLexiconNames(java.util.Collection<java.lang.String> lexiconNames)` List of one or more pronunciation lexicon names you want the service to apply during synthesis.
`void`	`setOutputFormat(OutputFormat outputFormat)` The format in which the returned output will be encoded.
`void`	`setOutputFormat(java.lang.String outputFormat)` The format in which the returned output will be encoded.
`void`	`setOutputUri(java.lang.String outputUri)` Pathway for the output speech file.
`void`	`setRequestCharacters(java.lang.Integer requestCharacters)` Number of billable characters synthesized.
`void`	`setSampleRate(java.lang.String sampleRate)` The audio frequency specified in Hz.
`void`	`setSnsTopicArn(java.lang.String snsTopicArn)` ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
`void`	`setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)` The type of speech marks returned for the input text.
`void`	`setTaskId(java.lang.String taskId)` The Amazon Polly generated identifier for a speech synthesis task.
`void`	`setTaskStatus(java.lang.String taskStatus)` Current status of the individual speech synthesis task.
`void`	`setTaskStatus(TaskStatus taskStatus)` Current status of the individual speech synthesis task.
`void`	`setTaskStatusReason(java.lang.String taskStatusReason)` Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
`void`	`setTextType(java.lang.String textType)` Specifies whether the input text is plain text or SSML.
`void`	`setTextType(TextType textType)` Specifies whether the input text is plain text or SSML.
`void`	`setVoiceId(java.lang.String voiceId)` Voice ID to use for the synthesis.
`void`	`setVoiceId(VoiceId voiceId)` Voice ID to use for the synthesis.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SynthesisTask`	`withCreationTime(java.util.Date creationTime)` Timestamp for the time the synthesis task was started.
`SynthesisTask`	`withEngine(Engine engine)` Specifies the engine (`standard` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
`SynthesisTask`	`withEngine(java.lang.String engine)` Specifies the engine (`standard` or `neural`) 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(java.lang.String languageCode)` Optional language code for a synthesis task.
`SynthesisTask`	`withLexiconNames(java.util.Collection<java.lang.String> lexiconNames)` List of one or more pronunciation lexicon names you want the service to apply during synthesis.
`SynthesisTask`	`withLexiconNames(java.lang.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(java.lang.String outputFormat)` The format in which the returned output will be encoded.
`SynthesisTask`	`withOutputUri(java.lang.String outputUri)` Pathway for the output speech file.
`SynthesisTask`	`withRequestCharacters(java.lang.Integer requestCharacters)` Number of billable characters synthesized.
`SynthesisTask`	`withSampleRate(java.lang.String sampleRate)` The audio frequency specified in Hz.
`SynthesisTask`	`withSnsTopicArn(java.lang.String snsTopicArn)` ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
`SynthesisTask`	`withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)` The type of speech marks returned for the input text.
`SynthesisTask`	`withSpeechMarkTypes(java.lang.String... speechMarkTypes)` The type of speech marks returned for the input text.
`SynthesisTask`	`withTaskId(java.lang.String taskId)` The Amazon Polly generated identifier for a speech synthesis task.
`SynthesisTask`	`withTaskStatus(java.lang.String taskStatus)` Current status of the individual speech synthesis task.
`SynthesisTask`	`withTaskStatus(TaskStatus taskStatus)` Current status of the individual speech synthesis task.
`SynthesisTask`	`withTaskStatusReason(java.lang.String taskStatusReason)` Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
`SynthesisTask`	`withTextType(java.lang.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(java.lang.String voiceId)` Voice ID to use for the synthesis.
`SynthesisTask`	`withVoiceId(VoiceId voiceId)` Voice ID to use for the synthesis.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SynthesisTask
```
public SynthesisTask()
```
- Method Detail
  - getEngine
```
public java.lang.String getEngine()
```
    Specifies the engine (standard or neural) 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.
    
    Constraints:
    Allowed Values: standard, neural
    
    Returns:
    
    Specifies the engine (standard or neural) 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:
    
    Engine
  - setEngine
```
public void setEngine(java.lang.String engine)
```
    Specifies the engine (standard or neural) 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.
    
    Constraints:
    Allowed Values: standard, neural
    
    Parameters:
    
    engine -
    Specifies the engine (standard or neural) 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:
    
    Engine
  - withEngine
```
public SynthesisTask withEngine(java.lang.String engine)
```
    Specifies the engine (standard or neural) 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, neural
    
    Parameters:
    
    engine -
    Specifies the engine (standard or neural) 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - setEngine
```
public void setEngine(Engine engine)
```
    Specifies the engine (standard or neural) 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.
    
    Constraints:
    Allowed Values: standard, neural
    
    Parameters:
    
    engine -
    Specifies the engine (standard or neural) 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:
    
    Engine
  - withEngine
```
public SynthesisTask withEngine(Engine engine)
```
    Specifies the engine (standard or neural) 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: standard, neural
    
    Parameters:
    
    engine -
    Specifies the engine (standard or neural) 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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - getTaskId
```
public java.lang.String getTaskId()
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Constraints:
    Pattern: ^[a-zA-Z0-9_-]{1,100}$
    
    Returns:
    
    The Amazon Polly generated identifier for a speech synthesis task.
  - setTaskId
```
public void setTaskId(java.lang.String taskId)
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Constraints:
    Pattern: ^[a-zA-Z0-9_-]{1,100}$
    
    Parameters:
    
    taskId -
    The Amazon Polly generated identifier for a speech synthesis task.
  - withTaskId
```
public SynthesisTask withTaskId(java.lang.String taskId)
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^[a-zA-Z0-9_-]{1,100}$
    
    Parameters:
    
    taskId -
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTaskStatus
```
public java.lang.String getTaskStatus()
```
    Current status of the individual speech synthesis task.
    
    Constraints:
    Allowed Values: scheduled, inProgress, completed, failed
    
    Returns:
    
    Current status of the individual speech synthesis task.
    
    See Also:
    
    TaskStatus
  - setTaskStatus
```
public void setTaskStatus(java.lang.String taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Constraints:
    Allowed Values: scheduled, inProgress, completed, failed
    
    Parameters:
    
    taskStatus -
    Current status of the individual speech synthesis task.
    
    See Also:
    
    TaskStatus
  - withTaskStatus
```
public SynthesisTask withTaskStatus(java.lang.String taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: scheduled, inProgress, completed, failed
    
    Parameters:
    
    taskStatus -
    Current status of the individual speech synthesis task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - setTaskStatus
```
public void setTaskStatus(TaskStatus taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Constraints:
    Allowed Values: scheduled, inProgress, completed, failed
    
    Parameters:
    
    taskStatus -
    Current status of the individual speech synthesis task.
    
    See Also:
    
    TaskStatus
  - withTaskStatus
```
public SynthesisTask withTaskStatus(TaskStatus taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: scheduled, inProgress, completed, failed
    
    Parameters:
    
    taskStatus -
    Current status of the individual speech synthesis task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - getTaskStatusReason
```
public java.lang.String getTaskStatusReason()
```
    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.
  - setTaskStatusReason
```
public void setTaskStatusReason(java.lang.String taskStatusReason)
```
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
    
    Parameters:
    
    taskStatusReason -
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
  - withTaskStatusReason
```
public SynthesisTask withTaskStatusReason(java.lang.String taskStatusReason)
```
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    taskStatusReason -
    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputUri
```
public java.lang.String getOutputUri()
```
    Pathway for the output speech file.
    
    Returns:
    
    Pathway for the output speech file.
  - setOutputUri
```
public void setOutputUri(java.lang.String outputUri)
```
    Pathway for the output speech file.
    
    Parameters:
    
    outputUri -
    Pathway for the output speech file.
  - withOutputUri
```
public SynthesisTask withOutputUri(java.lang.String outputUri)
```
    Pathway for the output speech file.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputUri -
    Pathway for the output speech file.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreationTime
```
public java.util.Date getCreationTime()
```
    Timestamp for the time the synthesis task was started.
    
    Returns:
    
    Timestamp for the time the synthesis task was started.
  - setCreationTime
```
public void setCreationTime(java.util.Date creationTime)
```
    Timestamp for the time the synthesis task was started.
    
    Parameters:
    
    creationTime -
    Timestamp for the time the synthesis task was started.
  - withCreationTime
```
public SynthesisTask withCreationTime(java.util.Date creationTime)
```
    Timestamp for the time the synthesis task was started.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    creationTime -
    Timestamp for the time the synthesis task was started.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRequestCharacters
```
public java.lang.Integer getRequestCharacters()
```
    Number of billable characters synthesized.
    
    Returns:
    
    Number of billable characters synthesized.
  - setRequestCharacters
```
public void setRequestCharacters(java.lang.Integer requestCharacters)
```
    Number of billable characters synthesized.
    
    Parameters:
    
    requestCharacters -
    Number of billable characters synthesized.
  - withRequestCharacters
```
public SynthesisTask withRequestCharacters(java.lang.Integer requestCharacters)
```
    Number of billable characters synthesized.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    requestCharacters -
    Number of billable characters synthesized.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSnsTopicArn
```
public java.lang.String getSnsTopicArn()
```
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Constraints:
    Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$
    
    Returns:
    
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
  - setSnsTopicArn
```
public void setSnsTopicArn(java.lang.String snsTopicArn)
```
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Constraints:
    Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$
    
    Parameters:
    
    snsTopicArn -
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
  - withSnsTopicArn
```
public SynthesisTask withSnsTopicArn(java.lang.String snsTopicArn)
```
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0- 9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$
    
    Parameters:
    
    snsTopicArn -
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLexiconNames
```
public java.util.List<java.lang.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.
    
    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.
  - setLexiconNames
```
public void setLexiconNames(java.util.Collection<java.lang.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.
    
    Parameters:
    
    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.
  - withLexiconNames
```
public SynthesisTask withLexiconNames(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withLexiconNames
```
public SynthesisTask withLexiconNames(java.util.Collection<java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputFormat
```
public java.lang.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.
    
    Constraints:
    Allowed Values: json, mp3, ogg_vorbis, pcm
    
    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
  - setOutputFormat
```
public void setOutputFormat(java.lang.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.
    
    Constraints:
    Allowed Values: json, mp3, ogg_vorbis, pcm
    
    Parameters:
    
    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.
    
    See Also:
    
    OutputFormat
  - withOutputFormat
```
public SynthesisTask withOutputFormat(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: json, mp3, ogg_vorbis, pcm
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    OutputFormat
  - setOutputFormat
```
public void setOutputFormat(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.
    
    Constraints:
    Allowed Values: json, mp3, ogg_vorbis, pcm
    
    Parameters:
    
    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.
    
    See Also:
    
    OutputFormat
  - withOutputFormat
```
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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: json, mp3, ogg_vorbis, pcm
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    OutputFormat
  - getSampleRate
```
public java.lang.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".
    
    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".
    
    Valid values for pcm are "8000" and "16000" The default value is "16000".
  - setSampleRate
```
public void setSampleRate(java.lang.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".
    
    Valid values for pcm are "8000" and "16000" The default value is "16000".
    
    Parameters:
    
    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".
    
    Valid values for pcm are "8000" and "16000" The default value is "16000".
  - withSampleRate
```
public SynthesisTask withSampleRate(java.lang.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".
    
    Valid values for pcm are "8000" and "16000" The default value is "16000".
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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".
    
    Valid values for pcm are "8000" and "16000" The default value is "16000".
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSpeechMarkTypes
```
public java.util.List<java.lang.String> getSpeechMarkTypes()
```
    The type of speech marks returned for the input text.
    
    Returns:
    
    The type of speech marks returned for the input text.
  - setSpeechMarkTypes
```
public void setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Parameters:
    
    speechMarkTypes -
    The type of speech marks returned for the input text.
  - withSpeechMarkTypes
```
public SynthesisTask withSpeechMarkTypes(java.lang.String... speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    speechMarkTypes -
    The type of speech marks returned for the input text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSpeechMarkTypes
```
public SynthesisTask withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    speechMarkTypes -
    The type of speech marks returned for the input text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTextType
```
public java.lang.String getTextType()
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Constraints:
    Allowed Values: ssml, text
    
    Returns:
    
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    See Also:
    
    TextType
  - setTextType
```
public void setTextType(java.lang.String textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Constraints:
    Allowed Values: ssml, text
    
    Parameters:
    
    textType -
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    See Also:
    
    TextType
  - withTextType
```
public SynthesisTask withTextType(java.lang.String textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ssml, text
    
    Parameters:
    
    textType -
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - setTextType
```
public void setTextType(TextType textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Constraints:
    Allowed Values: ssml, text
    
    Parameters:
    
    textType -
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    See Also:
    
    TextType
  - withTextType
```
public SynthesisTask withTextType(TextType textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: ssml, text
    
    Parameters:
    
    textType -
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - getVoiceId
```
public java.lang.String getVoiceId()
```
    Voice ID to use for the synthesis.
    
    Constraints:
    Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal
    
    Returns:
    
    Voice ID to use for the synthesis.
    
    See Also:
    
    VoiceId
  - setVoiceId
```
public void setVoiceId(java.lang.String voiceId)
```
    Voice ID to use for the synthesis.
    
    Constraints:
    Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal
    
    Parameters:
    
    voiceId -
    Voice ID to use for the synthesis.
    
    See Also:
    
    VoiceId
  - withVoiceId
```
public SynthesisTask withVoiceId(java.lang.String voiceId)
```
    Voice ID to use for the synthesis.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal
    
    Parameters:
    
    voiceId -
    Voice ID to use for the synthesis.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - setVoiceId
```
public void setVoiceId(VoiceId voiceId)
```
    Voice ID to use for the synthesis.
    
    Constraints:
    Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal
    
    Parameters:
    
    voiceId -
    Voice ID to use for the synthesis.
    
    See Also:
    
    VoiceId
  - withVoiceId
```
public SynthesisTask withVoiceId(VoiceId voiceId)
```
    Voice ID to use for the synthesis.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal
    
    Parameters:
    
    voiceId -
    Voice ID to use for the synthesis.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - getLanguageCode
```
public java.lang.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.
    
    Constraints:
    Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT
    
    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:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.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.
    
    Constraints:
    Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT
    
    Parameters:
    
    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.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public SynthesisTask withLanguageCode(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(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.
    
    Constraints:
    Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT
    
    Parameters:
    
    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.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class SynthesisTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SynthesisTask

Method Detail

getEngine

setEngine

withEngine

setEngine

withEngine

getTaskId

setTaskId

withTaskId

getTaskStatus

setTaskStatus

withTaskStatus

setTaskStatus

withTaskStatus

getTaskStatusReason

setTaskStatusReason

withTaskStatusReason

getOutputUri

setOutputUri

withOutputUri

getCreationTime

setCreationTime

withCreationTime

getRequestCharacters

setRequestCharacters

withRequestCharacters

getSnsTopicArn

setSnsTopicArn

withSnsTopicArn

getLexiconNames

setLexiconNames

withLexiconNames

withLexiconNames

getOutputFormat

setOutputFormat

withOutputFormat

setOutputFormat

withOutputFormat

getSampleRate

setSampleRate

withSampleRate

getSpeechMarkTypes

setSpeechMarkTypes

withSpeechMarkTypes

withSpeechMarkTypes

getTextType

setTextType

withTextType

setTextType

withTextType

getVoiceId

setVoiceId

withVoiceId

setVoiceId

withVoiceId

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

toString

hashCode

equals