com.amazonaws.services.transcribe.model

Class CreateVocabularyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.CreateVocabularyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateVocabularyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateVocabularyRequest()

Method Summary

Modifier and Type	Method and Description
CreateVocabularyRequest	clone()
boolean	equals(Object obj)
String	getLanguageCode() The language code of the vocabulary entries.
List<String>	getPhrases() An array of strings that contains the vocabulary entries.
List<Tag>	getTags() Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
String	getVocabularyFileUri() The S3 location of the text file that contains the definition of the custom vocabulary.
String	getVocabularyName() The name of the vocabulary.
int	hashCode()
void	setLanguageCode(String languageCode) The language code of the vocabulary entries.
void	setPhrases(Collection<String> phrases) An array of strings that contains the vocabulary entries.
void	setTags(Collection<Tag> tags) Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
void	setVocabularyFileUri(String vocabularyFileUri) The S3 location of the text file that contains the definition of the custom vocabulary.
void	setVocabularyName(String vocabularyName) The name of the vocabulary.
String	toString() Returns a string representation of this object.
CreateVocabularyRequest	withLanguageCode(LanguageCode languageCode) The language code of the vocabulary entries.
CreateVocabularyRequest	withLanguageCode(String languageCode) The language code of the vocabulary entries.
CreateVocabularyRequest	withPhrases(Collection<String> phrases) An array of strings that contains the vocabulary entries.
CreateVocabularyRequest	withPhrases(String... phrases) An array of strings that contains the vocabulary entries.
CreateVocabularyRequest	withTags(Collection<Tag> tags) Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
CreateVocabularyRequest	withTags(Tag... tags) Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create this new vocabulary.
CreateVocabularyRequest	withVocabularyFileUri(String vocabularyFileUri) The S3 location of the text file that contains the definition of the custom vocabulary.
CreateVocabularyRequest	withVocabularyName(String vocabularyName) The name of the vocabulary.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVocabularyRequest

public CreateVocabularyRequest()

Method Detail

setVocabularyName

public void setVocabularyName(String vocabularyName)

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Parameters:

vocabularyName - The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

getVocabularyName

public String getVocabularyName()

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Returns:

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

withVocabularyName

public CreateVocabularyRequest withVocabularyName(String vocabularyName)

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Parameters:

vocabularyName - The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Returns:

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

setLanguageCode

public void setLanguageCode(String languageCode)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Parameters:

languageCode - The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Returns:

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

See Also:

LanguageCode

withLanguageCode

public CreateVocabularyRequest withLanguageCode(String languageCode)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Parameters:

languageCode - The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Returns:

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

See Also:

LanguageCode

withLanguageCode

public CreateVocabularyRequest withLanguageCode(LanguageCode languageCode)

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Parameters:

languageCode - The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see table-language-matrix.

Returns:

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

See Also:

LanguageCode

getPhrases

public List<String> getPhrases()

An array of strings that contains the vocabulary entries.

Returns:

An array of strings that contains the vocabulary entries.

setPhrases

public void setPhrases(Collection<String> phrases)

An array of strings that contains the vocabulary entries.

Parameters:

phrases - An array of strings that contains the vocabulary entries.

withPhrases

public CreateVocabularyRequest withPhrases(String... phrases)

An array of strings that contains the vocabulary entries.

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

Parameters:

phrases - An array of strings that contains the vocabulary entries.

Returns:

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

withPhrases

public CreateVocabularyRequest withPhrases(Collection<String> phrases)

An array of strings that contains the vocabulary entries.

Parameters:

phrases - An array of strings that contains the vocabulary entries.

Returns:

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

setVocabularyFileUri

public void setVocabularyFileUri(String vocabularyFileUri)

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

Parameters:

vocabularyFileUri - The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

getVocabularyFileUri

public String getVocabularyFileUri()

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

Returns:

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

withVocabularyFileUri

public CreateVocabularyRequest withVocabularyFileUri(String vocabularyFileUri)

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

Parameters:

vocabularyFileUri - The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is:

https://s3.<Amazon Web Services-region>.amazonaws.com/<AWSDOC-EXAMPLE-BUCKET>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies, see Custom vocabularies.

Returns:

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

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(Collection<Tag> tags)

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

Parameters:

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

withTags

public CreateVocabularyRequest withTags(Tag... tags)

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

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

Parameters:

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

Returns:

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

withTags

public CreateVocabularyRequest withTags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateVocabularyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest