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

*

* Before creating a new custom medical vocabulary, you must first upload a text * file that contains your vocabulary table into an Amazon S3 bucket. Note that * this differs from , where you can include a list of terms within your request * using the Phrases flag; CreateMedicalVocabulary * does not support the Phrases flag and only accepts vocabularies * in table format. *

*

* 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 CreateMedicalVocabularyRequest extends AmazonWebServiceRequest implements Serializable { /** *

* A unique name, chosen by you, for your new custom medical 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 * medical vocabulary with the same name as an existing custom medical * 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. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

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

* The Amazon S3 location (URI) of the text file that contains your custom * medical vocabulary. The URI must be 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 *

*

* 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 medical 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; /** *

* A unique name, chosen by you, for your new custom medical 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 * medical vocabulary with the same name as an existing custom medical * 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 medical * 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 medical vocabulary with the same name as an * existing custom medical vocabulary, you get a * ConflictException error. *

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

* A unique name, chosen by you, for your new custom medical 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 * medical vocabulary with the same name as an existing custom medical * 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 medical * 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 medical vocabulary with the same name as * an existing custom medical vocabulary, you get a * ConflictException error. *

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

* A unique name, chosen by you, for your new custom medical 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 * medical vocabulary with the same name as an existing custom medical * 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 medical * 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 medical vocabulary with the same name as * an existing custom medical vocabulary, you get a * ConflictException error. *

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

* The language code that represents the language of the entries in your * custom vocabulary. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

* 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. US English (en-US) is the * only language supported with Amazon Transcribe Medical. *

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

* The language code that represents the language of the entries in your * custom vocabulary. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

* 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. US English (en-US) is * the only language supported with Amazon Transcribe Medical. *

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

* The language code that represents the language of the entries in your * custom vocabulary. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

* 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. US English (en-US) is * the only language supported with Amazon Transcribe Medical. *

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

* The language code that represents the language of the entries in your * custom vocabulary. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

* 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. US English (en-US) is * the only language supported with Amazon Transcribe Medical. *

* @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. US English (en-US) is the only language * supported with Amazon Transcribe Medical. *

*

* 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. US English (en-US) is * the only language supported with Amazon Transcribe Medical. *

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

* The Amazon S3 location (URI) of the text file that contains your custom * medical vocabulary. The URI must be 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 *

*

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

* The Amazon S3 location (URI) of the text file that contains your * custom medical vocabulary. The URI must be 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 *

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

* The Amazon S3 location (URI) of the text file that contains your custom * medical vocabulary. The URI must be 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 *

*

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

* The Amazon S3 location (URI) of the text file that contains * your custom medical vocabulary. The URI must be 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 *

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

* The Amazon S3 location (URI) of the text file that contains your custom * medical vocabulary. The URI must be 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 *

*

* 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 (URI) of the text file that contains * your custom medical vocabulary. The URI must be 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 *

* @return A reference to this updated object so that method calls can be * chained together. */ public CreateMedicalVocabularyRequest 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 medical 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 medical 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 medical 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 medical 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 medical 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 medical 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 CreateMedicalVocabularyRequest 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 medical 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 medical 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 CreateMedicalVocabularyRequest withTags(java.util.Collection tags) { setTags(tags); 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 (getVocabularyFileUri() != null) sb.append("VocabularyFileUri: " + getVocabularyFileUri() + ","); if (getTags() != null) sb.append("Tags: " + getTags()); 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 + ((getVocabularyFileUri() == null) ? 0 : getVocabularyFileUri().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateMedicalVocabularyRequest == false) return false; CreateMedicalVocabularyRequest other = (CreateMedicalVocabularyRequest) 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.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; return true; } }