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)
<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.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
LanguageCode	languageCode() The language code that represents the language of the entries in your custom vocabulary.
String	languageCodeAsString() The language code that represents the language of the entries in your custom vocabulary.
List<String>	phrases() Use this flag to include a list of terms within your request.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVocabularyRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Adds one or more 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	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyFileUri() The S3 location of the text file that contains your custom vocabulary.
String	vocabularyName() The name of your new vocabulary.

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 your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

Returns:

The name of your new 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 vocabulary with the same name as a previous vocabulary, you get a ConflictException error.

languageCode

public final 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. For a list of languages and their corresponding language codes, see Supported languages.

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 that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

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 that represents the language of the entries in your custom vocabulary. Each vocabulary must contain terms in only one language. For a list of languages and their corresponding language codes, see Supported languages.

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()

Use this flag to include a list of terms within your request.

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

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:

Use this flag to include a list of terms within your request.

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

vocabularyFileUri

public final String vocabularyFileUri()

The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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:

The S3 location of the text file that contains your custom vocabulary. The URI must be located in the same region as the API endpoint you're calling.

Here's an example URI path:

https://s3.us-east-1.amazonaws.com/my-s3-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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

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

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 hasTags() method.

Returns:

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

toBuilder

public CreateVocabularyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>

Specified by:

toBuilder in class TranscribeRequest

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)

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