com.amazonaws.services.transcribe.model.CreateMedicalVocabularyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transcribe Show documentation
/*
* Copyright 2019-2024 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 CreateMedicalVocabularyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
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.
*
*/
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
*
*/
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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public CreateMedicalVocabularyRequest withVocabularyName(String vocabularyName) {
setVocabularyName(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.
*
*
* @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.
*
*
* @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 this.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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public CreateMedicalVocabularyRequest withLanguageCode(String languageCode) {
setLanguageCode(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.
*
*
* @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 Returns a reference to this 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
*
*
* @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
*
*
* @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 this.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
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
public CreateMedicalVocabularyRequest 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 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.
*
*
* 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 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 Returns a reference to this object so that method calls can be chained together.
*/
public CreateMedicalVocabularyRequest 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 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.
* @return Returns a reference to this 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. 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 (getVocabularyFileUri() != null)
sb.append("VocabularyFileUri: ").append(getVocabularyFileUri()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@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;
}
@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 CreateMedicalVocabularyRequest clone() {
return (CreateMedicalVocabularyRequest) super.clone();
}
}