software.amazon.awssdk.services.transcribe.model

Class UpdateVocabularyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transcribe.model.TranscribeRequest

software.amazon.awssdk.services.transcribe.model.UpdateVocabularyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateVocabularyRequest
extends TranscribeRequest
implements ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateVocabularyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateVocabularyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPhrases() For responses, this returns true if the service returned a value for the Phrases property.
LanguageCode	languageCode() The language code of the vocabulary entries.
String	languageCodeAsString() The language code of the vocabulary entries.
List<String>	phrases() An array of strings containing the vocabulary entries.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateVocabularyRequest.Builder>	serializableBuilderClass()
UpdateVocabularyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyFileUri() The S3 location of the text file that contains the definition of the custom vocabulary.
String	vocabularyName() The name of the vocabulary to update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

vocabularyName

public final String vocabularyName()

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Returns:

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

languageCode

public final LanguageCode languageCode()

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see transcribe-whatis.

See Also:

LanguageCode

hasPhrases

public final boolean hasPhrases()

For responses, this returns true if the service returned a value for the Phrases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

phrases

public final List<String> phrases()

An array of strings containing the vocabulary entries.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPhrases() method.

Returns:

An array of strings containing the vocabulary entries.

vocabularyFileUri

public final 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

For example:

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:

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

For example:

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.

toBuilder

public UpdateVocabularyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static UpdateVocabularyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateVocabularyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo