software.amazon.awssdk.services.transcribe.model

Class CreateVocabularyFilterRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateVocabularyFilterRequest.Builder,CreateVocabularyFilterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateVocabularyFilterRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateVocabularyFilterRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasWords() For responses, this returns true if the service returned a value for the Words property.
LanguageCode	languageCode() The language code of the words in the vocabulary filter.
String	languageCodeAsString() The language code of the words in the vocabulary filter.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateVocabularyFilterRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Adds one or more tags, each in the form of a key:value pair, to a new vocabulary filter at the time you create this new vocabulary filter.
CreateVocabularyFilterRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyFilterFileUri() The Amazon S3 location of a text file used as input to create the vocabulary filter.
String	vocabularyFilterName() The name of your new vocabulary filter.
List<String>	words() The words you want in your vocabulary filter.

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

vocabularyFilterName

public final String vocabularyFilterName()

The name of your new vocabulary filter.

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

Returns:

The name of your new vocabulary filter.

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

languageCode

public final LanguageCode languageCode()

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

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 words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

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 words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.

See Also:

LanguageCode

hasWords

public final boolean hasWords()

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

words

public final List<String> words()

The words you want in your vocabulary filter. Only use characters specified in the Character sets for the language you're transcribing.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; 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 hasWords() method.

Returns:

The words you want in your vocabulary filter. Only use characters specified in the Character sets for the language you're transcribing.

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

vocabularyFilterFileUri

public final String vocabularyFilterFileUri()

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

Your vocabulary filter file must be less than 50 KB in size.

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

Returns:

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

Your vocabulary filter file must be less than 50 KB in size.

Note that if you include VocabularyFilterFileUri in your request, you cannot use Words; 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 vocabulary filter at the time you create this new vocabulary filter.

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

toBuilder

public CreateVocabularyFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateVocabularyFilterRequest.Builder,CreateVocabularyFilterRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static CreateVocabularyFilterRequest.Builder builder()

serializableBuilderClass

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