software.amazon.awssdk.services.transcribe.model

Class CreateMedicalVocabularyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateMedicalVocabularyRequest.Builder,CreateMedicalVocabularyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateMedicalVocabularyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateMedicalVocabularyRequest.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.
LanguageCode	languageCode() The language code that represents the language of the entries in your custom vocabulary.
String	languageCodeAsString() The language code that represents the language of the entries in your custom vocabulary.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateMedicalVocabularyRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Adds one or more custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.
CreateMedicalVocabularyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vocabularyFileUri() The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary.
String	vocabularyName() A unique name, chosen by you, for your new custom medical vocabulary.

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

vocabularyName

public final String vocabularyName()

A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new medical vocabulary with the same name as an existing medical vocabulary, you get a ConflictException error.

Returns:

A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new medical vocabulary with the same name as an existing medical vocabulary, you get a ConflictException error.

languageCode

public final LanguageCode languageCode()

The language code that represents the language of the entries in your custom vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

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 that represents the language of the entries in your custom vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code that represents the language of the entries in your custom vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

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 that represents the language of the entries in your custom vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

See Also:

LanguageCode

vocabularyFileUri

public final String vocabularyFileUri()

The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Returns:

The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

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 custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

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 custom tags, each in the form of a key:value pair, to a new medical vocabulary at the time you create this new vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

toBuilder

public CreateMedicalVocabularyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateMedicalVocabularyRequest.Builder,CreateMedicalVocabularyRequest>

Specified by:

toBuilder in class TranscribeRequest

builder

public static CreateMedicalVocabularyRequest.Builder builder()

serializableBuilderClass

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