com.amazonaws.services.transcribe.model

Class CreateVocabularyFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.CreateVocabularyFilterRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateVocabularyFilterRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateVocabularyFilterRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getLanguageCode() The language code of the words in the vocabulary filter.
java.lang.String	getVocabularyFilterFileUri() The Amazon S3 location of a text file used as input to create the vocabulary filter.
java.lang.String	getVocabularyFilterName() The vocabulary filter name.
java.util.List<java.lang.String>	getWords() The words to use in the vocabulary filter.
int	hashCode()
void	setLanguageCode(LanguageCode languageCode) The language code of the words in the vocabulary filter.
void	setLanguageCode(java.lang.String languageCode) The language code of the words in the vocabulary filter.
void	setVocabularyFilterFileUri(java.lang.String vocabularyFilterFileUri) The Amazon S3 location of a text file used as input to create the vocabulary filter.
void	setVocabularyFilterName(java.lang.String vocabularyFilterName) The vocabulary filter name.
void	setWords(java.util.Collection<java.lang.String> words) The words to use in the vocabulary filter.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateVocabularyFilterRequest	withLanguageCode(LanguageCode languageCode) The language code of the words in the vocabulary filter.
CreateVocabularyFilterRequest	withLanguageCode(java.lang.String languageCode) The language code of the words in the vocabulary filter.
CreateVocabularyFilterRequest	withVocabularyFilterFileUri(java.lang.String vocabularyFilterFileUri) The Amazon S3 location of a text file used as input to create the vocabulary filter.
CreateVocabularyFilterRequest	withVocabularyFilterName(java.lang.String vocabularyFilterName) The vocabulary filter name.
CreateVocabularyFilterRequest	withWords(java.util.Collection<java.lang.String> words) The words to use in the vocabulary filter.
CreateVocabularyFilterRequest	withWords(java.lang.String... words) The words to use in the vocabulary filter.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateVocabularyFilterRequest

public CreateVocabularyFilterRequest()

Method Detail

getVocabularyFilterName

public java.lang.String getVocabularyFilterName()

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

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

Returns:

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

setVocabularyFilterName

public void setVocabularyFilterName(java.lang.String vocabularyFilterName)

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

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

Parameters:

vocabularyFilterName -

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

withVocabularyFilterName

public CreateVocabularyFilterRequest withVocabularyFilterName(java.lang.String vocabularyFilterName)

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, 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._-]+

Parameters:

vocabularyFilterName -

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

Returns:

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

getLanguageCode

public java.lang.String getLanguageCode()

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, 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, ga-IE, gd-GB, 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

Returns:

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, 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, ga-IE, gd-GB, 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

Parameters:

languageCode -

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

See Also:

LanguageCode

withLanguageCode

public CreateVocabularyFilterRequest withLanguageCode(java.lang.String languageCode)

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

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

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, 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, ga-IE, gd-GB, 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

Parameters:

languageCode -

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

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 words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, 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, ga-IE, gd-GB, 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

Parameters:

languageCode -

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

See Also:

LanguageCode

withLanguageCode

public CreateVocabularyFilterRequest withLanguageCode(LanguageCode languageCode)

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

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

Constraints:
Allowed Values: af-ZA, ar-AE, ar-SA, cy-GB, 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, ga-IE, gd-GB, 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

Parameters:

languageCode -

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

Returns:

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

See Also:

LanguageCode

getWords

public java.util.List<java.lang.String> getWords()

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

Returns:

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

setWords

public void setWords(java.util.Collection<java.lang.String> words)

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

Parameters:

words -

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

withWords

public CreateVocabularyFilterRequest withWords(java.lang.String... words)

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

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

Parameters:

words -

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

Returns:

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

withWords

public CreateVocabularyFilterRequest withWords(java.util.Collection<java.lang.String> words)

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

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

Parameters:

words -

The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

Returns:

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

getVocabularyFilterFileUri

public java.lang.String getVocabularyFilterFileUri()

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

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

Returns:

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

setVocabularyFilterFileUri

public void setVocabularyFilterFileUri(java.lang.String vocabularyFilterFileUri)

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

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

Parameters:

vocabularyFilterFileUri -

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

withVocabularyFilterFileUri

public CreateVocabularyFilterRequest withVocabularyFilterFileUri(java.lang.String vocabularyFilterFileUri)

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

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

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

Parameters:

vocabularyFilterFileUri -

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object