Class Vocabulary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Vocabulary.Builder,
Vocabulary>
Contains information about a custom vocabulary.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the custom vocabulary.static Vocabulary.Builder
builder()
final String
content()
The content of the custom vocabulary in plain-text format with a table of values.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The reason why the custom vocabulary was not created.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The identifier of the custom vocabulary.final VocabularyLanguageCode
The language code of the vocabulary entries.final String
The language code of the vocabulary entries.final Instant
The timestamp when the custom vocabulary was last modified.final String
name()
A unique name of the custom vocabulary.static Class
<? extends Vocabulary.Builder> final VocabularyState
state()
The current state of the custom vocabulary.final String
The current state of the custom vocabulary.tags()
The tags used to organize, track, or control access for this resource.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A unique name of the custom vocabulary.
- Returns:
- A unique name of the custom vocabulary.
-
id
The identifier of the custom vocabulary.
- Returns:
- The identifier of the custom vocabulary.
-
arn
The Amazon Resource Name (ARN) of the custom vocabulary.
- Returns:
- The Amazon Resource Name (ARN) of the custom vocabulary.
-
languageCode
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnVocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
- See Also:
-
languageCodeAsString
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnVocabularyLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
- See Also:
-
state
The current state of the custom vocabulary.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVocabularyState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the custom vocabulary.
- See Also:
-
stateAsString
The current state of the custom vocabulary.
If the service returns an enum value that is not available in the current SDK version,
state
will returnVocabularyState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the custom vocabulary.
- See Also:
-
lastModifiedTime
The timestamp when the custom vocabulary was last modified.
- Returns:
- The timestamp when the custom vocabulary was last modified.
-
failureReason
The reason why the custom vocabulary was not created.
- Returns:
- The reason why the custom vocabulary was not created.
-
content
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with
Phrase
,IPA
,SoundsLike
, andDisplayAs
fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.- Returns:
- The content of the custom vocabulary in plain-text format with a table of values. Each row in the table
represents a word or a phrase, described with
Phrase
,IPA
,SoundsLike
, andDisplayAs
fields. Separate the fields with TAB characters. For more information, see Create a custom vocabulary using a table.
-
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 theisEmpty()
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
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
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:
- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
-
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<Vocabulary.Builder,
Vocabulary> - 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
-