com.amazonaws.services.transcribe.model

Class UpdateVocabularyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.UpdateVocabularyRequest

All Implemented Interfaces:

Serializable, Cloneable

public class UpdateVocabularyRequest
extends AmazonWebServiceRequest
implements Serializable

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateVocabularyRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLanguageCode() The language code of the vocabulary entries.
List<String>	getPhrases() An array of strings containing the vocabulary entries.
String	getVocabularyFileUri() The S3 location of the text file that contains the definition of the custom vocabulary.
String	getVocabularyName() The name of the vocabulary to update.
int	hashCode()
void	setLanguageCode(LanguageCode languageCode) The language code of the vocabulary entries.
void	setLanguageCode(String languageCode) The language code of the vocabulary entries.
void	setPhrases(Collection<String> phrases) An array of strings containing the vocabulary entries.
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 to update.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateVocabularyRequest	withLanguageCode(LanguageCode languageCode) The language code of the vocabulary entries.
UpdateVocabularyRequest	withLanguageCode(String languageCode) The language code of the vocabulary entries.
UpdateVocabularyRequest	withPhrases(Collection<String> phrases) An array of strings containing the vocabulary entries.
UpdateVocabularyRequest	withPhrases(String... phrases) An array of strings containing the vocabulary entries.
UpdateVocabularyRequest	withVocabularyFileUri(String vocabularyFileUri) The S3 location of the text file that contains the definition of the custom vocabulary.
UpdateVocabularyRequest	withVocabularyName(String vocabularyName) The name of the vocabulary to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateVocabularyRequest

public UpdateVocabularyRequest()

Method Detail

getVocabularyName

public String getVocabularyName()

The name of the vocabulary to update. The name is case-sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

The name of the vocabulary to update. The name is case-sensitive.

setVocabularyName

public void setVocabularyName(String vocabularyName)

The name of the vocabulary to update. The name is case-sensitive.

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

The name of the vocabulary to update. The name is case-sensitive.

withVocabularyName

public UpdateVocabularyRequest withVocabularyName(String vocabularyName)

The name of the vocabulary to update. The name is case-sensitive.

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

vocabularyName -

The name of the vocabulary to update. The name is case-sensitive.

Returns:

A reference to this updated object so that method calls can be chained together.

getLanguageCode

public String getLanguageCode()

The language code of the vocabulary entries.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Returns:

The language code of the vocabulary entries.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(String languageCode)

The language code of the vocabulary entries.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code of the vocabulary entries.

See Also:

LanguageCode

withLanguageCode

public UpdateVocabularyRequest withLanguageCode(String languageCode)

The language code of the vocabulary entries.

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

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code of the vocabulary entries.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

The language code of the vocabulary entries.

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code of the vocabulary entries.

See Also:

LanguageCode

withLanguageCode

public UpdateVocabularyRequest withLanguageCode(LanguageCode languageCode)

The language code of the vocabulary entries.

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

Constraints:
Allowed Values: en-US, es-US, en-AU, fr-CA, en-GB, de-DE, pt-BR, fr-FR, it-IT, ko-KR

Parameters:

languageCode -

The language code of the vocabulary entries.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getPhrases

public List<String> getPhrases()

An array of strings containing the vocabulary entries.

Returns:

An array of strings containing the vocabulary entries.

setPhrases

public void setPhrases(Collection<String> phrases)

An array of strings containing the vocabulary entries.

Parameters:

phrases -

An array of strings containing the vocabulary entries.

withPhrases

public UpdateVocabularyRequest withPhrases(String... phrases)

An array of strings containing the vocabulary entries.

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

Parameters:

phrases -

An array of strings containing the vocabulary entries.

Returns:

A reference to this updated object so that method calls can be chained together.

withPhrases

public UpdateVocabularyRequest withPhrases(Collection<String> phrases)

An array of strings containing the vocabulary entries.

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

Parameters:

phrases -

An array of strings containing the vocabulary entries.

Returns:

A reference to this updated object so that method calls can be chained together.

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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

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

Constraints:
Length: 1 - 2000

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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

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

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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

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

Constraints:
Length: 1 - 2000

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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/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 UpdateVocabularyRequest 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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3-us-east-1.amazonaws.com/examplebucket/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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2000

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-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

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

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object