software.amazon.awssdk.services.transcribe.model

Interface CreateVocabularyRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateVocabularyRequest

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

Method Summary

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

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

vocabularyName

CreateVocabularyRequest.Builder vocabularyName(String vocabularyName)

A unique name, chosen by you, for your new custom 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 new vocabulary with the same name as an existing vocabulary, you get a ConflictException error.

Parameters:

vocabularyName - A unique name, chosen by you, for your new custom 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 new vocabulary with the same name as an existing vocabulary, you get a ConflictException error.

Returns:

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

languageCode

CreateVocabularyRequest.Builder languageCode(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.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary 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 custom vocabulary. Each vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary 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

CreateVocabularyRequest.Builder languageCode(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.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary 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 custom vocabulary. Each vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the vocabulary. For example, if you create a vocabulary using US English (en-US), you can only apply this vocabulary 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

phrases

CreateVocabularyRequest.Builder phrases(Collection<String> phrases)

Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary 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 VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; 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:

phrases - Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary 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 VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; 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.

phrases

CreateVocabularyRequest.Builder phrases(String... phrases)

Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary 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 VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; 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:

phrases - Use this parameter if you want to create your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary 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 VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; 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.

vocabularyFileUri

CreateVocabularyRequest.Builder vocabularyFileUri(String vocabularyFileUri)

The Amazon S3 location of the text file that contains your custom vocabulary. 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-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 Amazon S3 location of the text file that contains your custom vocabulary. 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-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.

tags

CreateVocabularyRequest.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 at the time you create this new vocabulary.

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 at the time you create this new vocabulary.

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

CreateVocabularyRequest.Builder tags(Tag... tags)

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

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 at the time you create this new vocabulary.

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

CreateVocabularyRequest.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 at the time you create this new vocabulary.

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateVocabularyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder