software.amazon.awssdk.services.transcribe.model

Interface CreateVocabularyFilterRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateVocabularyFilterRequest.Builder,CreateVocabularyFilterRequest>, SdkBuilder<CreateVocabularyFilterRequest.Builder,CreateVocabularyFilterRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder

Enclosing class:

CreateVocabularyFilterRequest

public static interface CreateVocabularyFilterRequest.Builder
extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<CreateVocabularyFilterRequest.Builder,CreateVocabularyFilterRequest>

Method Summary

Modifier and Type	Method and Description
CreateVocabularyFilterRequest.Builder	languageCode(LanguageCode languageCode) The language code that represents the language of the entries in your vocabulary filter.
CreateVocabularyFilterRequest.Builder	languageCode(String languageCode) The language code that represents the language of the entries in your vocabulary filter.
CreateVocabularyFilterRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateVocabularyFilterRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateVocabularyFilterRequest.Builder	tags(Collection<Tag> tags) Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
CreateVocabularyFilterRequest.Builder	tags(Consumer<Tag.Builder>... tags) Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
CreateVocabularyFilterRequest.Builder	tags(Tag... tags) Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new filter.
CreateVocabularyFilterRequest.Builder	vocabularyFilterFileUri(String vocabularyFilterFileUri) The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
CreateVocabularyFilterRequest.Builder	vocabularyFilterName(String vocabularyFilterName) A unique name, chosen by you, for your new custom vocabulary filter.
CreateVocabularyFilterRequest.Builder	words(Collection<String> words) Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request.
CreateVocabularyFilterRequest.Builder	words(String... words) Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request.

Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

vocabularyFilterName

CreateVocabularyFilterRequest.Builder vocabularyFilterName(String vocabularyFilterName)

A unique name, chosen by you, for your new custom vocabulary filter.

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 vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.

Parameters:

vocabularyFilterName - A unique name, chosen by you, for your new custom vocabulary filter.

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 vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.

Returns:

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

languageCode

CreateVocabularyFilterRequest.Builder languageCode(String languageCode)

The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Parameters:

languageCode - The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

CreateVocabularyFilterRequest.Builder languageCode(LanguageCode languageCode)

The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Parameters:

languageCode - The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Returns:

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

See Also:

LanguageCode, LanguageCode

words

CreateVocabularyFilterRequest.Builder words(Collection<String> words)

Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

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

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Parameters:

words - Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

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

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Returns:

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

words

CreateVocabularyFilterRequest.Builder words(String... words)

Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

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

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Parameters:

words - Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFilterFileUri parameter.

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

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

Returns:

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

vocabularyFilterFileUri

CreateVocabularyFilterRequest.Builder vocabularyFilterFileUri(String vocabularyFilterFileUri)

The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located 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-filter-file.txt

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

Parameters:

vocabularyFilterFileUri - The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located 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-filter-file.txt

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

Returns:

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

tags

CreateVocabularyFilterRequest.Builder tags(Collection<Tag> tags)

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

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Parameters:

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

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Returns:

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

tags

CreateVocabularyFilterRequest.Builder tags(Tag... tags)

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

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Parameters:

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

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Returns:

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

tags

CreateVocabularyFilterRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateVocabularyFilterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateVocabularyFilterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder