/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.polly.model; import java.io.Serializable; /** *
* Description of the voice. *
*/ public class Voice implements Serializable { /** ** Gender of the voice. *
*
* Constraints:
* Allowed Values: Female, Male
*/
private String gender;
/**
*
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*/
private String id;
/**
*
* Language code of the voice. *
*
* 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, yue-CN, ar-AE, fi-FI, en-IE
*/
private String languageCode;
/**
*
* Human readable name of the language in English. *
*/ private String languageName; /** ** Name of the voice (for example, Salli, Kendra, etc.). This provides a * human readable voice name that you might display in your application. *
*/ private String name; /** ** 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
.
*
* Specifies which engines (standard
or neural
)
* that are supported by a given voice.
*
* Gender of the voice. *
*
* Constraints:
* Allowed Values: Female, Male
*
* @return
* Gender of the voice. *
* @see Gender */ public String getGender() { return gender; } /** ** Gender of the voice. *
*
* Constraints:
* Allowed Values: Female, Male
*
* @param gender
* Gender of the voice. *
* @see Gender */ public void setGender(String gender) { this.gender = gender; } /** ** Gender of the voice. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: Female, Male
*
* @param gender
* Gender of the voice. *
* @return A reference to this updated object so that method calls can be * chained together. * @see Gender */ public Voice withGender(String gender) { this.gender = gender; return this; } /** ** Gender of the voice. *
*
* Constraints:
* Allowed Values: Female, Male
*
* @param gender
* Gender of the voice. *
* @see Gender */ public void setGender(Gender gender) { this.gender = gender.toString(); } /** ** Gender of the voice. *
** Returns a reference to this object so that method calls can be chained * together. *
* Constraints:
* Allowed Values: Female, Male
*
* @param gender
* Gender of the voice. *
* @return A reference to this updated object so that method calls can be * chained together. * @see Gender */ public Voice withGender(Gender gender) { this.gender = gender.toString(); return this; } /** *
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*
* @return
* Amazon Polly assigned voice ID. This is the ID that you specify
* when calling the SynthesizeSpeech
operation.
*
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you
* specify when calling the SynthesizeSpeech
* operation.
*
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you
* specify when calling the SynthesizeSpeech
* operation.
*
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you
* specify when calling the SynthesizeSpeech
* operation.
*
* Amazon Polly assigned voice ID. This is the ID that you specify when
* calling the SynthesizeSpeech
operation.
*
* 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, Hiujin, Laura,
* Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth,
* Stephen, Kazuha, Tomoko, Niamh, Sofie
*
* @param id
* Amazon Polly assigned voice ID. This is the ID that you
* specify when calling the SynthesizeSpeech
* operation.
*
* Language code of the voice. *
*
* 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, yue-CN, ar-AE, fi-FI, en-IE
*
* @return
* Language code of the voice. *
* @see LanguageCode */ public String getLanguageCode() { return languageCode; } /** ** Language code of the voice. *
*
* 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, yue-CN, ar-AE, fi-FI, en-IE
*
* @param languageCode
* Language code of the voice. *
* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** Language code of the voice. *
** 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, yue-CN, ar-AE, fi-FI, en-IE
*
* @param languageCode
* Language code of the voice. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public Voice withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** ** Language code of the voice. *
*
* 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, yue-CN, ar-AE, fi-FI, en-IE
*
* @param languageCode
* Language code of the voice. *
* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** ** Language code of the voice. *
** 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, yue-CN, ar-AE, fi-FI, en-IE
*
* @param languageCode
* Language code of the voice. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public Voice withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** ** Human readable name of the language in English. *
* * @return* Human readable name of the language in English. *
*/ public String getLanguageName() { return languageName; } /** ** Human readable name of the language in English. *
* * @param languageName* Human readable name of the language in English. *
*/ public void setLanguageName(String languageName) { this.languageName = languageName; } /** ** Human readable name of the language in English. *
** Returns a reference to this object so that method calls can be chained * together. * * @param languageName
* Human readable name of the language in English. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Voice withLanguageName(String languageName) { this.languageName = languageName; return this; } /** ** Name of the voice (for example, Salli, Kendra, etc.). This provides a * human readable voice name that you might display in your application. *
* * @return* Name of the voice (for example, Salli, Kendra, etc.). This * provides a human readable voice name that you might display in * your application. *
*/ public String getName() { return name; } /** ** Name of the voice (for example, Salli, Kendra, etc.). This provides a * human readable voice name that you might display in your application. *
* * @param name* Name of the voice (for example, Salli, Kendra, etc.). This * provides a human readable voice name that you might display in * your application. *
*/ public void setName(String name) { this.name = 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 a reference to this object so that method calls can be chained * together. * * @param name
* Name of the voice (for example, Salli, Kendra, etc.). This * provides a human readable voice name that you might display in * your application. *
* @return A reference to this updated object so that method calls can be * chained together. */ public Voice withName(String name) { this.name = name; return this; } /** ** 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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
.
*
* 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 a reference to this object so that method calls can be chained * together. * * @param 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
.
*
* Specifies which engines (standard
or neural
)
* that are supported by a given voice.
*
* Specifies which engines (standard
or
* neural
) that are supported by a given voice.
*
* Specifies which engines (standard
or neural
)
* that are supported by a given voice.
*
* Specifies which engines (standard
or
* neural
) that are supported by a given voice.
*
* Specifies which engines (standard
or neural
)
* that are supported by a given voice.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param supportedEngines
* Specifies which engines (standard
or
* neural
) that are supported by a given voice.
*
* Specifies which engines (standard
or neural
)
* that are supported by a given voice.
*
* Returns a reference to this object so that method calls can be chained * together. * * @param supportedEngines
* Specifies which engines (standard
or
* neural
) that are supported by a given voice.
*