/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateVocabularyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* 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. *

*/ 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. *

*/ 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. *

*/ 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. *

*/ private String dataAccessRoleArn; /** *

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

* * @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. *

* * @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 this.vocabularyName; } /** *

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

* * @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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withVocabularyName(String vocabularyName) { setVocabularyName(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. *

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

* * @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. *

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

* * @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.

* For a list of supported languages and their associated language codes, refer to the Supported languages * table. * @see LanguageCode */ public String getLanguageCode() { return this.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. *

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

* * @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.

* For a list of supported languages and their associated language codes, refer to the Supported languages * table. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public CreateVocabularyRequest withLanguageCode(String languageCode) { setLanguageCode(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. *

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

* * @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.

* For a list of supported languages and their associated language codes, refer to the Supported languages * table. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public CreateVocabularyRequest withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

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

* * @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. *

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

* * @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); } /** *

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

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setPhrases(java.util.Collection)} or {@link #withPhrases(java.util.Collection)} if you want to override * the existing values. *

* 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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withPhrases(String... phrases) { if (this.phrases == null) { setPhrases(new java.util.ArrayList(phrases.length)); } for (String ele : phrases) { this.phrases.add(ele); } return this; } /** *

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

* 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 Returns a reference to this 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. *

* * @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. *

* * @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 this.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. *

* 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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withVocabularyFileUri(String vocabularyFileUri) { setVocabularyFileUri(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. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *

* * @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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } 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. *

* * @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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

* 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. *

* * @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; } /** *

* 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 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 this.dataAccessRoleArn; } /** *

* 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. *

* 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 Returns a reference to this object so that method calls can be chained together. */ public CreateVocabularyRequest withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); return this; } /** * 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. * * @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: ").append(getVocabularyName()).append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getPhrases() != null) sb.append("Phrases: ").append(getPhrases()).append(","); if (getVocabularyFileUri() != null) sb.append("VocabularyFileUri: ").append(getVocabularyFileUri()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()); sb.append("}"); return sb.toString(); } @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; } @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 CreateVocabularyRequest clone() { return (CreateVocabularyRequest) super.clone(); } }