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	hasWords() Returns true if the Words 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 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()
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 vocabulary filter name.
List<String>	words() The words to use in the 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 String vocabularyFilterName()

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

Returns:

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a vocabulary filter with the same name as another vocabulary filter, you get a ConflictException error.

languageCode

public 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 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 boolean hasWords()

Returns true if the Words 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.

words

public List<String> words()

The words to use in 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.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

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

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

Returns:

The words to use in 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.

If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.

vocabularyFilterFileUri

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

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

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.

The specified file must be less than 50 KB of UTF-8 characters.

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.

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

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo