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() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getLanguageCode() The language code that represents the language of the entries in your custom vocabulary.
List<String>	getPhrases() Use this flag to include a list of terms within your request.
List<Tag>	getTags() Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
String	getVocabularyFileUri() The S3 location of the text file that contains your custom vocabulary.
String	getVocabularyName() The name of your new vocabulary.
int	hashCode()
void	setLanguageCode(String languageCode) The language code that represents the language of the entries in your custom vocabulary.
void	setPhrases(Collection<String> phrases) Use this flag to include a list of terms within your request.
void	setTags(Collection<Tag> tags) Adds one or more tags, each in the form of a key:value pair, to a new custom vocabulary at the time you create this new vocabulary.
void	setVocabularyFileUri(String vocabularyFileUri) The S3 location of the text file that contains your custom vocabulary.
void	setVocabularyName(String vocabularyName) The name of your new vocabulary.
String	toString() Returns a string representation of this object.
CreateVocabularyRequest	withLanguageCode(LanguageCode languageCode) The language code that represents the language of the entries in your custom vocabulary.
CreateVocabularyRequest	withLanguageCode(String languageCode) The language code that represents the language of the entries in your custom vocabulary.
CreateVocabularyRequest	withPhrases(Collection<String> phrases) Use this flag to include a list of terms within your request.
CreateVocabularyRequest	withPhrases(String... phrases) Use this flag to include a list of terms within your request.
CreateVocabularyRequest	withTags(Collection<Tag> tags) Adds one or more tags, each in the form of a key:value pair, to a new custom 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 custom vocabulary at the time you create this new vocabulary.
CreateVocabularyRequest	withVocabularyFileUri(String vocabularyFileUri) The S3 location of the text file that contains your custom vocabulary.
CreateVocabularyRequest	withVocabularyName(String vocabularyName) The name of your new vocabulary.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, 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

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVocabularyRequest

public CreateVocabularyRequest()

Method Detail

setVocabularyName

public void setVocabularyName(String vocabularyName)

The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

Parameters:

vocabularyName - The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

getVocabularyName

public String getVocabularyName()

The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

Returns:

The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

withVocabularyName

public CreateVocabularyRequest withVocabularyName(String vocabularyName)

The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

Parameters:

vocabularyName - The name of your new 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 vocabulary with the same name as a previous vocabulary, you get 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 that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

Parameters:

languageCode - The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

Returns:

The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

See Also:

LanguageCode

withLanguageCode

public CreateVocabularyRequest withLanguageCode(String languageCode)

The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

Parameters:

languageCode - The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

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 that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

Parameters:

languageCode - The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

Returns:

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

See Also:

LanguageCode

getPhrases

public List<String> getPhrases()

Use this flag to include a list of terms within your request.

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

Returns:

Use this flag to include a list of terms within your request.

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

setPhrases

public void setPhrases(Collection<String> phrases)

Use this flag to include a list of terms within your request.

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

Parameters:

phrases - Use this flag to include a list of terms within your request.

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

withPhrases

public CreateVocabularyRequest withPhrases(String... phrases)

Use this flag to include a list of terms within your request.

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 setPhrases(java.util.Collection) or withPhrases(java.util.Collection) if you want to override the existing values.

Parameters:

phrases - Use this flag to include a list of terms within your request.

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

Returns:

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

withPhrases

public CreateVocabularyRequest withPhrases(Collection<String> phrases)

Use this flag to include a list of terms within your request.

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

Parameters:

phrases - Use this flag to include a list of terms within your request.

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

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 your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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.

Parameters:

vocabularyFileUri - The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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.

getVocabularyFileUri

public String getVocabularyFileUri()

The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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:

The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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.

withVocabularyFileUri

public CreateVocabularyRequest withVocabularyFileUri(String vocabularyFileUri)

The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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.

Parameters:

vocabularyFileUri - The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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:

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 custom 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 custom 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 custom 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 custom 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 custom 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 custom 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 custom 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 custom 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()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()