Class VocabularyInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VocabularyInfo.Builder,
VocabularyInfo>
Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic VocabularyInfo.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final LanguageCode
The language code used to create your custom vocabulary.final String
The language code used to create your custom vocabulary.final Instant
The date and time the specified custom vocabulary was last modified.static Class
<? extends VocabularyInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
A unique name, chosen by you, for your custom vocabulary.final VocabularyState
The processing state of your custom vocabulary.final String
The processing state of your custom vocabulary.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
vocabularyName
A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
- Returns:
- A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
-
languageCode
The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (
en-US
), you can only apply this custom vocabulary to files that contain English audio.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in
only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (
en-US
), you can only apply this custom vocabulary to files that contain English audio. - See Also:
-
languageCodeAsString
The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (
en-US
), you can only apply this custom vocabulary to files that contain English audio.If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in
only one language.
A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (
en-US
), you can only apply this custom vocabulary to files that contain English audio. - See Also:
-
lastModifiedTime
The date and time the specified custom vocabulary was last modified.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents 12:32 PM UTC-7 on May 4, 2022.- Returns:
- The date and time the specified custom vocabulary was last modified.
Timestamps are in the format
YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC
. For example,2022-05-04T12:32:58.761000-07:00
represents 12:32 PM UTC-7 on May 4, 2022.
-
vocabularyState
The processing state of your custom vocabulary. If the state is
READY
, you can use the custom vocabulary in aStartTranscriptionJob
request.If the service returns an enum value that is not available in the current SDK version,
vocabularyState
will returnVocabularyState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyStateAsString()
.- Returns:
- The processing state of your custom vocabulary. If the state is
READY
, you can use the custom vocabulary in aStartTranscriptionJob
request. - See Also:
-
vocabularyStateAsString
The processing state of your custom vocabulary. If the state is
READY
, you can use the custom vocabulary in aStartTranscriptionJob
request.If the service returns an enum value that is not available in the current SDK version,
vocabularyState
will returnVocabularyState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyStateAsString()
.- Returns:
- The processing state of your custom vocabulary. If the state is
READY
, you can use the custom vocabulary in aStartTranscriptionJob
request. - See Also:
-
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 interfaceToCopyableBuilder<VocabularyInfo.Builder,
VocabularyInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-