software.amazon.awssdk.services.transcribe.model

Class CreateVocabularyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVocabularyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateVocabularyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasPhrases() Returns true if the Phrases property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 that contains the vocabulary entries.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVocabularyRequest.Builder>	serializableBuilderClass()
CreateVocabularyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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.

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

overrideConfiguration

Methods inherited from class java.lang.Object

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. The name must be unique within an AWS account. The name is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.

Returns:

The name of the vocabulary. The name must be unique within an AWS account. The name is case sensitive. If you try to create 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.

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.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of the vocabulary entries.

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.

See Also:

LanguageCode

hasPhrases

public final boolean hasPhrases()

Returns true if the Phrases property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

phrases

public final List<String> phrases()

An array of strings that contains the vocabulary entries.

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

You can use hasPhrases() to see if a value was sent in this field.

Returns:

An array of strings that contains 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 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 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 CreateVocabularyRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

Specified by:

toBuilder in class TranscribeRequest

Returns:

a builder for type T

builder

public static CreateVocabularyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateVocabularyRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.