SynthesisTask (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, 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
`SynthesisTask`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` Timestamp for the time the synthesis task was started.
`String`	`getEngine()` Specifies the engine (`standard` or `neural`) 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` or `neural`) 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` or `neural`) for Amazon Polly to use when processing input text for speech synthesis.
`SynthesisTask`	`withEngine(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(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.

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

- Constructor Detail
  - SynthesisTask
```
public SynthesisTask()
```
- Method Detail
  - setEngine
```
public void setEngine(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.
    
    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
  - getEngine
```
public 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.
    
    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
  - withEngine
```
public SynthesisTask withEngine(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - setTaskId
```
public void setTaskId(String taskId)
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Parameters:
    
    taskId - The Amazon Polly generated identifier for a speech synthesis task.
  - getTaskId
```
public String getTaskId()
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Returns:
    
    The Amazon Polly generated identifier for a speech synthesis task.
  - withTaskId
```
public SynthesisTask withTaskId(String taskId)
```
    The Amazon Polly generated identifier for a speech synthesis task.
    
    Parameters:
    
    taskId - The Amazon Polly generated identifier for a speech synthesis task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTaskStatus
```
public void setTaskStatus(String taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Parameters:
    
    taskStatus - Current status of the individual speech synthesis task.
    
    See Also:
    
    TaskStatus
  - getTaskStatus
```
public String getTaskStatus()
```
    Current status of the individual speech synthesis task.
    
    Returns:
    
    Current status of the individual speech synthesis task.
    
    See Also:
    
    TaskStatus
  - withTaskStatus
```
public SynthesisTask withTaskStatus(String taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Parameters:
    
    taskStatus - Current status of the individual speech synthesis task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - withTaskStatus
```
public SynthesisTask withTaskStatus(TaskStatus taskStatus)
```
    Current status of the individual speech synthesis task.
    
    Parameters:
    
    taskStatus - Current status of the individual speech synthesis task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TaskStatus
  - setTaskStatusReason
```
public void setTaskStatusReason(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.
  - getTaskStatusReason
```
public 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.
  - withTaskStatusReason
```
public SynthesisTask withTaskStatusReason(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputUri
```
public void setOutputUri(String outputUri)
```
    Pathway for the output speech file.
    
    Parameters:
    
    outputUri - Pathway for the output speech file.
  - getOutputUri
```
public String getOutputUri()
```
    Pathway for the output speech file.
    
    Returns:
    
    Pathway for the output speech file.
  - withOutputUri
```
public SynthesisTask withOutputUri(String outputUri)
```
    Pathway for the output speech file.
    
    Parameters:
    
    outputUri - Pathway for the output speech file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Timestamp for the time the synthesis task was started.
    
    Parameters:
    
    creationTime - Timestamp for the time the synthesis task was started.
  - getCreationTime
```
public Date getCreationTime()
```
    Timestamp for the time the synthesis task was started.
    
    Returns:
    
    Timestamp for the time the synthesis task was started.
  - withCreationTime
```
public SynthesisTask withCreationTime(Date creationTime)
```
    Timestamp for the time the synthesis task was started.
    
    Parameters:
    
    creationTime - Timestamp for the time the synthesis task was started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequestCharacters
```
public void setRequestCharacters(Integer requestCharacters)
```
    Number of billable characters synthesized.
    
    Parameters:
    
    requestCharacters - Number of billable characters synthesized.
  - getRequestCharacters
```
public Integer getRequestCharacters()
```
    Number of billable characters synthesized.
    
    Returns:
    
    Number of billable characters synthesized.
  - withRequestCharacters
```
public SynthesisTask withRequestCharacters(Integer requestCharacters)
```
    Number of billable characters synthesized.
    
    Parameters:
    
    requestCharacters - Number of billable characters synthesized.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSnsTopicArn
```
public void setSnsTopicArn(String snsTopicArn)
```
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Parameters:
    
    snsTopicArn - ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
  - getSnsTopicArn
```
public String getSnsTopicArn()
```
    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.
  - withSnsTopicArn
```
public SynthesisTask withSnsTopicArn(String snsTopicArn)
```
    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Parameters:
    
    snsTopicArn - ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLexiconNames
```
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.
    
    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(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.
    
    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(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLexiconNames
```
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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputFormat
```
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.
    
    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
  - getOutputFormat
```
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.
    
    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
  - withOutputFormat
```
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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OutputFormat
  - setSampleRate
```
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".
    
    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".
  - getSampleRate
```
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".
    
    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".
  - withSampleRate
```
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".
    
    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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSpeechMarkTypes
```
public List<String> getSpeechMarkTypes()
```
    The type of speech marks returned for the input text.
    
    Returns:
    
    The type of speech marks returned for the input text.
    
    See Also:
    
    SpeechMarkType
  - setSpeechMarkTypes
```
public void setSpeechMarkTypes(Collection<String> speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Parameters:
    
    speechMarkTypes - The type of speech marks returned for the input text.
    
    See Also:
    
    SpeechMarkType
  - withSpeechMarkTypes
```
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.
    
    Parameters:
    
    speechMarkTypes - The type of speech marks returned for the input text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SpeechMarkType
  - withSpeechMarkTypes
```
public SynthesisTask withSpeechMarkTypes(Collection<String> speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Parameters:
    
    speechMarkTypes - The type of speech marks returned for the input text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SpeechMarkType
  - withSpeechMarkTypes
```
public SynthesisTask withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)
```
    The type of speech marks returned for the input text.
    
    Parameters:
    
    speechMarkTypes - The type of speech marks returned for the input text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SpeechMarkType
  - setTextType
```
public void setTextType(String textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Parameters:
    
    textType - Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    See Also:
    
    TextType
  - getTextType
```
public String getTextType()
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns:
    
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    See Also:
    
    TextType
  - withTextType
```
public SynthesisTask withTextType(String textType)
```
    Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Parameters:
    
    textType - Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    Parameters:
    
    textType - Specifies whether the input text is plain text or SSML. The default value is plain text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - setVoiceId
```
public void setVoiceId(String voiceId)
```
    Voice ID to use for the synthesis.
    
    Parameters:
    
    voiceId - Voice ID to use for the synthesis.
    
    See Also:
    
    VoiceId
  - getVoiceId
```
public String getVoiceId()
```
    Voice ID to use for the synthesis.
    
    Returns:
    
    Voice ID to use for the synthesis.
    
    See Also:
    
    VoiceId
  - withVoiceId
```
public SynthesisTask withVoiceId(String voiceId)
```
    Voice ID to use for the synthesis.
    
    Parameters:
    
    voiceId - Voice ID to use for the synthesis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - withVoiceId
```
public SynthesisTask withVoiceId(VoiceId voiceId)
```
    Voice ID to use for the synthesis.
    
    Parameters:
    
    voiceId - Voice ID to use for the synthesis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - setLanguageCode
```
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.
    
    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
  - getLanguageCode
```
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.
    
    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
  - withLanguageCode
```
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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SynthesisTask clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class SynthesisTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SynthesisTask

Method Detail

setEngine

getEngine

withEngine

withEngine

setTaskId

getTaskId

withTaskId

setTaskStatus

getTaskStatus

withTaskStatus

withTaskStatus

setTaskStatusReason

getTaskStatusReason

withTaskStatusReason

setOutputUri

getOutputUri

withOutputUri

setCreationTime

getCreationTime

withCreationTime

setRequestCharacters

getRequestCharacters

withRequestCharacters

setSnsTopicArn

getSnsTopicArn

withSnsTopicArn

getLexiconNames

setLexiconNames

withLexiconNames

withLexiconNames

setOutputFormat

getOutputFormat

withOutputFormat

withOutputFormat

setSampleRate

getSampleRate

withSampleRate

getSpeechMarkTypes

setSpeechMarkTypes

withSpeechMarkTypes

withSpeechMarkTypes

withSpeechMarkTypes

setTextType

getTextType

withTextType

withTextType

setVoiceId

getVoiceId

withVoiceId

withVoiceId

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

toString

equals

hashCode

clone

marshall