/* * 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.transcribe.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Creates a new custom vocabulary. *

*

* When creating a new custom vocabulary, you can either upload a text file that * contains your new entries, phrases, and terms into an Amazon S3 bucket and * include the URI in your request. Or you can include a list of terms directly * in your request using the Phrases flag. *

*

* Each language has a character set that contains all allowed characters for * that specific language. If you use unsupported characters, your custom * vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your * language. *

*

* For more information, see Custom vocabularies. *

*/ public class CreateVocabularyRequest extends AmazonWebServiceRequest implements Serializable { /** *

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must be unique * within an Amazon Web Services account. If you try to create a new custom * vocabulary with the same name as an existing custom vocabulary, you get a * ConflictException error. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String vocabularyName; /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE */ private String languageCode; /** *

* Use this parameter if you want to create your custom vocabulary by * including all desired terms, as comma-separated values, within your * request. The other option for creating your custom vocabulary is to save * your entries in a text file and upload them to an Amazon S3 bucket, then * specify the location of your file using the * VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, you cannot * use VocabularyFileUri; you must choose one or the other. *

*

* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *

*/ private java.util.List phrases; /** *

* The Amazon S3 location of the text file that contains your custom * vocabulary. The URI must be located in the same Amazon Web Services * Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in your request, * you cannot use the Phrases flag; you must choose one or the * other. *

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
*/ private String vocabularyFileUri; /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new custom vocabulary at the time you create this new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

*/ private java.util.List tags; /** *

* The Amazon Resource Name (ARN) of an IAM role that has permissions to * access the Amazon S3 bucket that contains your input files (in this case, * your custom vocabulary). If the role that you specify doesn’t have the * appropriate permissions to access the specified Amazon S3 location, your * request fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. For * example: arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
*/ private String dataAccessRoleArn; /** *

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must be unique * within an Amazon Web Services account. If you try to create a new custom * vocabulary with the same name as an existing custom vocabulary, you get a * ConflictException error. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must be * unique within an Amazon Web Services account. If you try to * create a new custom vocabulary with the same name as an existing * custom vocabulary, you get a ConflictException * error. *

*/ public String getVocabularyName() { return vocabularyName; } /** *

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must be unique * within an Amazon Web Services account. If you try to create a new custom * vocabulary with the same name as an existing custom vocabulary, you get a * ConflictException error. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param vocabularyName

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must * be unique within an Amazon Web Services account. If you try to * create a new custom vocabulary with the same name as an * existing custom vocabulary, you get a * ConflictException error. *

*/ public void setVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; } /** *

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must be unique * within an Amazon Web Services account. If you try to create a new custom * vocabulary with the same name as an existing custom vocabulary, you get a * ConflictException error. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param vocabularyName

* A unique name, chosen by you, for your new custom vocabulary. *

*

* This name is case sensitive, cannot contain spaces, and must * be unique within an Amazon Web Services account. If you try to * create a new custom vocabulary with the same name as an * existing custom vocabulary, you get a * ConflictException error. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withVocabularyName(String vocabularyName) { this.vocabularyName = vocabularyName; return this; } /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @return

* The language code that represents the language of the entries in * your custom vocabulary. Each custom vocabulary must contain terms * in only one language. *

*

* A custom vocabulary can only be used to transcribe files in the * same language as the custom vocabulary. For example, if you * create a custom vocabulary using US English (en-US), * you can only apply this custom vocabulary to files that contain * English audio. *

*

* For a list of supported languages and their associated language * codes, refer to the Supported languages table. *

* @see LanguageCode */ public String getLanguageCode() { return languageCode; } /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param languageCode

* The language code that represents the language of the entries * in your custom vocabulary. Each custom vocabulary must contain * terms in only one language. *

*

* A custom vocabulary can only be used to transcribe files in * the same language as the custom vocabulary. For example, if * you create a custom vocabulary using US English ( * en-US), you can only apply this custom vocabulary * to files that contain English audio. *

*

* For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param languageCode

* The language code that represents the language of the entries * in your custom vocabulary. Each custom vocabulary must contain * terms in only one language. *

*

* A custom vocabulary can only be used to transcribe files in * the same language as the custom vocabulary. For example, if * you create a custom vocabulary using US English ( * en-US), you can only apply this custom vocabulary * to files that contain English audio. *

*

* For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public CreateVocabularyRequest withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param languageCode

* The language code that represents the language of the entries * in your custom vocabulary. Each custom vocabulary must contain * terms in only one language. *

*

* A custom vocabulary can only be used to transcribe files in * the same language as the custom vocabulary. For example, if * you create a custom vocabulary using US English ( * en-US), you can only apply this custom vocabulary * to files that contain English audio. *

*

* For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** *

* The language code that represents the language of the entries in your * custom vocabulary. Each custom vocabulary must contain terms in only one * language. *

*

* A custom vocabulary can only be used to transcribe files in the same * language as the custom vocabulary. For example, if you create a custom * vocabulary using US English (en-US), you can only apply this * custom vocabulary to files that contain English audio. *

*

* For a list of supported languages and their associated language codes, * refer to the Supported languages table. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Allowed Values: af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, * en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, * fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, * pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ, * vi-VN, sv-SE * * @param languageCode

* The language code that represents the language of the entries * in your custom vocabulary. Each custom vocabulary must contain * terms in only one language. *

*

* A custom vocabulary can only be used to transcribe files in * the same language as the custom vocabulary. For example, if * you create a custom vocabulary using US English ( * en-US), you can only apply this custom vocabulary * to files that contain English audio. *

*

* For a list of supported languages and their associated * language codes, refer to the Supported languages table. *

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public CreateVocabularyRequest withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

* Use this parameter if you want to create your custom vocabulary by * including all desired terms, as comma-separated values, within your * request. The other option for creating your custom vocabulary is to save * your entries in a text file and upload them to an Amazon S3 bucket, then * specify the location of your file using the * VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, you cannot * use VocabularyFileUri; you must choose one or the other. *

*

* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *

* * @return

* Use this parameter if you want to create your custom vocabulary * by including all desired terms, as comma-separated values, within * your request. The other option for creating your custom * vocabulary is to save your entries in a text file and upload them * to an Amazon S3 bucket, then specify the location of your file * using the VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, * you cannot use VocabularyFileUri; you must choose * one or the other. *

*

* Each language has a character set that contains all allowed * characters for that specific language. If you use unsupported * characters, your custom vocabulary filter request fails. Refer to * Character Sets for Custom Vocabularies to get the character * set for your language. *

*/ public java.util.List getPhrases() { return phrases; } /** *

* Use this parameter if you want to create your custom vocabulary by * including all desired terms, as comma-separated values, within your * request. The other option for creating your custom vocabulary is to save * your entries in a text file and upload them to an Amazon S3 bucket, then * specify the location of your file using the * VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, you cannot * use VocabularyFileUri; you must choose one or the other. *

*

* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *

* * @param phrases

* Use this parameter if you want to create your custom * vocabulary by including all desired terms, as comma-separated * values, within your request. The other option for creating * your custom vocabulary is to save your entries in a text file * and upload them to an Amazon S3 bucket, then specify the * location of your file using the VocabularyFileUri * parameter. *

*

* Note that if you include Phrases in your request, * you cannot use VocabularyFileUri; you must choose * one or the other. *

*

* Each language has a character set that contains all allowed * characters for that specific language. If you use unsupported * characters, your custom vocabulary filter request fails. Refer * to Character Sets for Custom Vocabularies to get the * character set for your language. *

*/ public void setPhrases(java.util.Collection phrases) { if (phrases == null) { this.phrases = null; return; } this.phrases = new java.util.ArrayList(phrases); } /** *

* Use this parameter if you want to create your custom vocabulary by * including all desired terms, as comma-separated values, within your * request. The other option for creating your custom vocabulary is to save * your entries in a text file and upload them to an Amazon S3 bucket, then * specify the location of your file using the * VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, you cannot * use VocabularyFileUri; you must choose one or the other. *

*

* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param phrases

* Use this parameter if you want to create your custom * vocabulary by including all desired terms, as comma-separated * values, within your request. The other option for creating * your custom vocabulary is to save your entries in a text file * and upload them to an Amazon S3 bucket, then specify the * location of your file using the VocabularyFileUri * parameter. *

*

* Note that if you include Phrases in your request, * you cannot use VocabularyFileUri; you must choose * one or the other. *

*

* Each language has a character set that contains all allowed * characters for that specific language. If you use unsupported * characters, your custom vocabulary filter request fails. Refer * to Character Sets for Custom Vocabularies to get the * character set for your language. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withPhrases(String... phrases) { if (getPhrases() == null) { this.phrases = new java.util.ArrayList(phrases.length); } for (String value : phrases) { this.phrases.add(value); } return this; } /** *

* Use this parameter if you want to create your custom vocabulary by * including all desired terms, as comma-separated values, within your * request. The other option for creating your custom vocabulary is to save * your entries in a text file and upload them to an Amazon S3 bucket, then * specify the location of your file using the * VocabularyFileUri parameter. *

*

* Note that if you include Phrases in your request, you cannot * use VocabularyFileUri; you must choose one or the other. *

*

* Each language has a character set that contains all allowed characters * for that specific language. If you use unsupported characters, your * custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for * your language. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param phrases

* Use this parameter if you want to create your custom * vocabulary by including all desired terms, as comma-separated * values, within your request. The other option for creating * your custom vocabulary is to save your entries in a text file * and upload them to an Amazon S3 bucket, then specify the * location of your file using the VocabularyFileUri * parameter. *

*

* Note that if you include Phrases in your request, * you cannot use VocabularyFileUri; you must choose * one or the other. *

*

* Each language has a character set that contains all allowed * characters for that specific language. If you use unsupported * characters, your custom vocabulary filter request fails. Refer * to Character Sets for Custom Vocabularies to get the * character set for your language. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withPhrases(java.util.Collection phrases) { setPhrases(phrases); return this; } /** *

* The Amazon S3 location of the text file that contains your custom * vocabulary. The URI must be located in the same Amazon Web Services * Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in your request, * you cannot use the Phrases flag; you must choose one or the * other. *

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @return

* The Amazon S3 location of the text file that contains your custom * vocabulary. The URI must be located in the same Amazon Web * Services Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in your * request, you cannot use the Phrases flag; you must * choose one or the other. *

*/ public String getVocabularyFileUri() { return vocabularyFileUri; } /** *

* The Amazon S3 location of the text file that contains your custom * vocabulary. The URI must be located in the same Amazon Web Services * Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in your request, * you cannot use the Phrases flag; you must choose one or the * other. *

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @param vocabularyFileUri

* The Amazon S3 location of the text file that contains your * custom vocabulary. The URI must be located in the same Amazon * Web Services Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in * your request, you cannot use the Phrases flag; * you must choose one or the other. *

*/ public void setVocabularyFileUri(String vocabularyFileUri) { this.vocabularyFileUri = vocabularyFileUri; } /** *

* The Amazon S3 location of the text file that contains your custom * vocabulary. The URI must be located in the same Amazon Web Services * Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in your request, * you cannot use the Phrases flag; you must choose one or the * other. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @param vocabularyFileUri

* The Amazon S3 location of the text file that contains your * custom vocabulary. The URI must be located in the same Amazon * Web Services Region as the resource you're calling. *

*

* Here's an example URI path: * s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt *

*

* Note that if you include VocabularyFileUri in * your request, you cannot use the Phrases flag; * you must choose one or the other. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withVocabularyFileUri(String vocabularyFileUri) { this.vocabularyFileUri = vocabularyFileUri; return this; } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new custom vocabulary at the time you create this new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

* * @return

* Adds one or more custom tags, each in the form of a key:value * pair, to a new custom vocabulary at the time you create this new * custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to * Tagging resources. *

*/ public java.util.List getTags() { return tags; } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new custom vocabulary at the time you create this new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

* * @param tags

* Adds one or more custom tags, each in the form of a key:value * pair, to a new custom vocabulary at the time you create this * new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer * to Tagging resources. *

*/ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new custom vocabulary at the time you create this new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param tags

* Adds one or more custom tags, each in the form of a key:value * pair, to a new custom vocabulary at the time you create this * new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer * to Tagging resources. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withTags(Tag... tags) { if (getTags() == null) { this.tags = new java.util.ArrayList(tags.length); } for (Tag value : tags) { this.tags.add(value); } return this; } /** *

* Adds one or more custom tags, each in the form of a key:value pair, to a * new custom vocabulary at the time you create this new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer to Tagging resources. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param tags

* Adds one or more custom tags, each in the form of a key:value * pair, to a new custom vocabulary at the time you create this * new custom vocabulary. *

*

* To learn more about using tags with Amazon Transcribe, refer * to Tagging resources. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permissions to * access the Amazon S3 bucket that contains your input files (in this case, * your custom vocabulary). If the role that you specify doesn’t have the * appropriate permissions to access the specified Amazon S3 location, your * request fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. For * example: arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @return

* The Amazon Resource Name (ARN) of an IAM role that has * permissions to access the Amazon S3 bucket that contains your * input files (in this case, your custom vocabulary). If the role * that you specify doesn’t have the appropriate permissions to * access the specified Amazon S3 location, your request fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. * For example: arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*/ public String getDataAccessRoleArn() { return dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permissions to * access the Amazon S3 bucket that contains your input files (in this case, * your custom vocabulary). If the role that you specify doesn’t have the * appropriate permissions to access the specified Amazon S3 location, your * request fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. For * example: arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of an IAM role that has * permissions to access the Amazon S3 bucket that contains your * input files (in this case, your custom vocabulary). If the * role that you specify doesn’t have the appropriate permissions * to access the specified Amazon S3 location, your request * fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path * . For example: * arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*/ public void setDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of an IAM role that has permissions to * access the Amazon S3 bucket that contains your input files (in this case, * your custom vocabulary). If the role that you specify doesn’t have the * appropriate permissions to access the specified Amazon S3 location, your * request fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path. For * example: arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of an IAM role that has * permissions to access the Amazon S3 bucket that contains your * input files (in this case, your custom vocabulary). If the * role that you specify doesn’t have the appropriate permissions * to access the specified Amazon S3 location, your request * fails. *

*

* IAM role ARNs have the format * arn:partition:iam::account:role/role-name-with-path * . For example: * arn:aws:iam::111122223333:role/Admin. *

*

* For more information, see IAM ARNs. *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateVocabularyRequest withDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getVocabularyName() != null) sb.append("VocabularyName: " + getVocabularyName() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode() + ","); if (getPhrases() != null) sb.append("Phrases: " + getPhrases() + ","); if (getVocabularyFileUri() != null) sb.append("VocabularyFileUri: " + getVocabularyFileUri() + ","); if (getTags() != null) sb.append("Tags: " + getTags() + ","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: " + getDataAccessRoleArn()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getPhrases() == null) ? 0 : getPhrases().hashCode()); hashCode = prime * hashCode + ((getVocabularyFileUri() == null) ? 0 : getVocabularyFileUri().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateVocabularyRequest == false) return false; CreateVocabularyRequest other = (CreateVocabularyRequest) obj; if (other.getVocabularyName() == null ^ this.getVocabularyName() == null) return false; if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getPhrases() == null ^ this.getPhrases() == null) return false; if (other.getPhrases() != null && other.getPhrases().equals(this.getPhrases()) == false) return false; if (other.getVocabularyFileUri() == null ^ this.getVocabularyFileUri() == null) return false; if (other.getVocabularyFileUri() != null && other.getVocabularyFileUri().equals(this.getVocabularyFileUri()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null) return false; if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false) return false; return true; } }