software.amazon.awssdk.services.transcribe.model

Interface UpdateVocabularyRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateVocabularyRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateVocabularyRequest.Builder	languageCode(LanguageCode languageCode) The language code that represents the language of the entries in the custom vocabulary you want to update.
UpdateVocabularyRequest.Builder	languageCode(String languageCode) The language code that represents the language of the entries in the custom vocabulary you want to update.
UpdateVocabularyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateVocabularyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateVocabularyRequest.Builder	phrases(Collection<String> phrases) Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request.
UpdateVocabularyRequest.Builder	phrases(String... phrases) Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request.
UpdateVocabularyRequest.Builder	vocabularyFileUri(String vocabularyFileUri) The Amazon S3 location of the text file that contains your custom vocabulary.
UpdateVocabularyRequest.Builder	vocabularyName(String vocabularyName) The name of the custom vocabulary you want to update.

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

UpdateVocabularyRequest.Builder vocabularyName(String vocabularyName)

The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

Parameters:

vocabularyName - The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

Returns:

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

languageCode

UpdateVocabularyRequest.Builder languageCode(String languageCode)

The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

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

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

UpdateVocabularyRequest.Builder languageCode(LanguageCode languageCode)

The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

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

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

UpdateVocabularyRequest.Builder phrases(Collection<String> phrases)

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

UpdateVocabularyRequest.Builder phrases(String... phrases)

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

UpdateVocabularyRequest.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.

overrideConfiguration

UpdateVocabularyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder