@Generated(value="software.amazon.awssdk:codegen") public final class CreateVocabularyRequest extends TranscribeRequest implements ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateVocabularyRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateVocabularyRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasPhrases()
Returns true if the Phrases 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 vocabulary entries.
|
String |
languageCodeAsString()
The language code of the vocabulary entries.
|
List<String> |
phrases()
An array of strings that contains the vocabulary entries.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateVocabularyRequest.Builder> |
serializableBuilderClass() |
CreateVocabularyRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
vocabularyFileUri()
The S3 location of the text file that contains the definition of the custom vocabulary.
|
String |
vocabularyName()
The name of the vocabulary.
|
overrideConfiguration
copy
public final String vocabularyName()
The name of the vocabulary. The name must be unique within an AWS account. The name is case sensitive. If you try
to create a vocabulary with the same name as a previous vocabulary you will receive a
ConflictException
error.
ConflictException
error.public final LanguageCode languageCode()
The language code of the vocabulary entries.
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()
.
LanguageCode
public final String languageCodeAsString()
The language code of the vocabulary entries.
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()
.
LanguageCode
public final boolean hasPhrases()
public final List<String> phrases()
An array of strings that contains the vocabulary entries.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasPhrases()
to see if a value was sent in this field.
public final String vocabularyFileUri()
The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies, see Custom Vocabularies.
public CreateVocabularyRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateVocabularyRequest.Builder,CreateVocabularyRequest>
toBuilder
in class TranscribeRequest
public static CreateVocabularyRequest.Builder builder()
public static Class<? extends CreateVocabularyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.