Voice (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Voice
extends Object
implements Serializable, Cloneable, StructuredPojo

Description of the voice.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Voice()

Constructors
Constructor and Description
`Voice()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Voice`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalLanguageCodes()` Additional codes for languages available for the specified voice in addition to its default language.
`String`	`getGender()` Gender of the voice.
`String`	`getId()` Amazon Polly assigned voice ID.
`String`	`getLanguageCode()` Language code of the voice.
`String`	`getLanguageName()` Human readable name of the language in English.
`String`	`getName()` Name of the voice (for example, Salli, Kendra, etc.).
`List<String>`	`getSupportedEngines()` Specifies which engines (`standard`, `neural`, `long-form` or `generative`) are supported by a given voice.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalLanguageCodes(Collection<String> additionalLanguageCodes)` Additional codes for languages available for the specified voice in addition to its default language.
`void`	`setGender(Gender gender)` Gender of the voice.
`void`	`setGender(String gender)` Gender of the voice.
`void`	`setId(String id)` Amazon Polly assigned voice ID.
`void`	`setId(VoiceId id)` Amazon Polly assigned voice ID.
`void`	`setLanguageCode(LanguageCode languageCode)` Language code of the voice.
`void`	`setLanguageCode(String languageCode)` Language code of the voice.
`void`	`setLanguageName(String languageName)` Human readable name of the language in English.
`void`	`setName(String name)` Name of the voice (for example, Salli, Kendra, etc.).
`void`	`setSupportedEngines(Collection<String> supportedEngines)` Specifies which engines (`standard`, `neural`, `long-form` or `generative`) are supported by a given voice.
`String`	`toString()` Returns a string representation of this object.
`Voice`	`withAdditionalLanguageCodes(Collection<String> additionalLanguageCodes)` Additional codes for languages available for the specified voice in addition to its default language.
`Voice`	`withAdditionalLanguageCodes(LanguageCode... additionalLanguageCodes)` Additional codes for languages available for the specified voice in addition to its default language.
`Voice`	`withAdditionalLanguageCodes(String... additionalLanguageCodes)` Additional codes for languages available for the specified voice in addition to its default language.
`Voice`	`withGender(Gender gender)` Gender of the voice.
`Voice`	`withGender(String gender)` Gender of the voice.
`Voice`	`withId(String id)` Amazon Polly assigned voice ID.
`Voice`	`withId(VoiceId id)` Amazon Polly assigned voice ID.
`Voice`	`withLanguageCode(LanguageCode languageCode)` Language code of the voice.
`Voice`	`withLanguageCode(String languageCode)` Language code of the voice.
`Voice`	`withLanguageName(String languageName)` Human readable name of the language in English.
`Voice`	`withName(String name)` Name of the voice (for example, Salli, Kendra, etc.).
`Voice`	`withSupportedEngines(Collection<String> supportedEngines)` Specifies which engines (`standard`, `neural`, `long-form` or `generative`) are supported by a given voice.
`Voice`	`withSupportedEngines(Engine... supportedEngines)` Specifies which engines (`standard`, `neural`, `long-form` or `generative`) are supported by a given voice.
`Voice`	`withSupportedEngines(String... supportedEngines)` Specifies which engines (`standard`, `neural`, `long-form` or `generative`) are supported by a given voice.

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

- Constructor Detail
  - Voice
```
public Voice()
```
- Method Detail
  - setGender
```
public void setGender(String gender)
```
    Gender of the voice.
    
    Parameters:
    
    gender - Gender of the voice.
    
    See Also:
    
    Gender
  - getGender
```
public String getGender()
```
    Gender of the voice.
    
    Returns:
    
    Gender of the voice.
    
    See Also:
    
    Gender
  - withGender
```
public Voice withGender(String gender)
```
    Gender of the voice.
    
    Parameters:
    
    gender - Gender of the voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Gender
  - setGender
```
public void setGender(Gender gender)
```
    Gender of the voice.
    
    Parameters:
    
    gender - Gender of the voice.
    
    See Also:
    
    Gender
  - withGender
```
public Voice withGender(Gender gender)
```
    Gender of the voice.
    
    Parameters:
    
    gender - Gender of the voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Gender
  - setId
```
public void setId(String id)
```
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Parameters:
    
    id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    See Also:
    
    VoiceId
  - getId
```
public String getId()
```
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Returns:
    
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    See Also:
    
    VoiceId
  - withId
```
public Voice withId(String id)
```
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Parameters:
    
    id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - setId
```
public void setId(VoiceId id)
```
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Parameters:
    
    id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    See Also:
    
    VoiceId
  - withId
```
public Voice withId(VoiceId id)
```
    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Parameters:
    
    id - Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VoiceId
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    Language code of the voice.
    
    Parameters:
    
    languageCode - Language code of the voice.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    Language code of the voice.
    
    Returns:
    
    Language code of the voice.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public Voice withLanguageCode(String languageCode)
```
    Language code of the voice.
    
    Parameters:
    
    languageCode - Language code of the voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(LanguageCode languageCode)
```
    Language code of the voice.
    
    Parameters:
    
    languageCode - Language code of the voice.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public Voice withLanguageCode(LanguageCode languageCode)
```
    Language code of the voice.
    
    Parameters:
    
    languageCode - Language code of the voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageName
```
public void setLanguageName(String languageName)
```
    Human readable name of the language in English.
    
    Parameters:
    
    languageName - Human readable name of the language in English.
  - getLanguageName
```
public String getLanguageName()
```
    Human readable name of the language in English.
    
    Returns:
    
    Human readable name of the language in English.
  - withLanguageName
```
public Voice withLanguageName(String languageName)
```
    Human readable name of the language in English.
    
    Parameters:
    
    languageName - Human readable name of the language in English.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
    
    Parameters:
    
    name - Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
  - getName
```
public String getName()
```
    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
    
    Returns:
    
    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
  - withName
```
public Voice withName(String name)
```
    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
    
    Parameters:
    
    name - Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalLanguageCodes
```
public List<String> getAdditionalLanguageCodes()
```
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Returns:
    
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    See Also:
    
    LanguageCode
  - setAdditionalLanguageCodes
```
public void setAdditionalLanguageCodes(Collection<String> additionalLanguageCodes)
```
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Parameters:
    
    additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    See Also:
    
    LanguageCode
  - withAdditionalLanguageCodes
```
public Voice withAdditionalLanguageCodes(String... additionalLanguageCodes)
```
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalLanguageCodes(java.util.Collection) or withAdditionalLanguageCodes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withAdditionalLanguageCodes
```
public Voice withAdditionalLanguageCodes(Collection<String> additionalLanguageCodes)
```
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Parameters:
    
    additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withAdditionalLanguageCodes
```
public Voice withAdditionalLanguageCodes(LanguageCode... additionalLanguageCodes)
```
    Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Parameters:
    
    additionalLanguageCodes - Additional codes for languages available for the specified voice in addition to its default language.
    
    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - getSupportedEngines
```
public List<String> getSupportedEngines()
```
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Returns:
    
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    See Also:
    
    Engine
  - setSupportedEngines
```
public void setSupportedEngines(Collection<String> supportedEngines)
```
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Parameters:
    
    supportedEngines - Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    See Also:
    
    Engine
  - withSupportedEngines
```
public Voice withSupportedEngines(String... supportedEngines)
```
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedEngines(java.util.Collection) or withSupportedEngines(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    supportedEngines - Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - withSupportedEngines
```
public Voice withSupportedEngines(Collection<String> supportedEngines)
```
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Parameters:
    
    supportedEngines - Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - withSupportedEngines
```
public Voice withSupportedEngines(Engine... supportedEngines)
```
    Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Parameters:
    
    supportedEngines - Specifies which engines (standard, neural, long-form or generative) are supported by a given voice.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Engine
  - 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 Voice 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class Voice

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Voice

Method Detail

setGender

getGender

withGender

setGender

withGender

setId

getId

withId

setId

withId

setLanguageCode

getLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

setLanguageName

getLanguageName

withLanguageName

setName

getName

withName

getAdditionalLanguageCodes

setAdditionalLanguageCodes

withAdditionalLanguageCodes

withAdditionalLanguageCodes

withAdditionalLanguageCodes

getSupportedEngines

setSupportedEngines

withSupportedEngines

withSupportedEngines

withSupportedEngines

toString

equals

hashCode

clone

marshall