software.amazon.awssdk.services.transcribe.model

Class LanguageModel

java.lang.Object

software.amazon.awssdk.services.transcribe.model.LanguageModel

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LanguageModel.Builder,LanguageModel>

@Generated(value="software.amazon.awssdk:codegen")
public final class LanguageModel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LanguageModel.Builder,LanguageModel>

The structure used to describe a custom language model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LanguageModel.Builder

Method Summary

Modifier and Type	Method and Description
BaseModelName	baseModelName() The Amazon Transcribe standard language model, or base model used to create the custom language model.
String	baseModelNameAsString() The Amazon Transcribe standard language model, or base model used to create the custom language model.
static LanguageModel.Builder	builder()
Instant	createTime() The time the custom language model was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() The reason why the custom language model couldn't be created.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputDataConfig	inputDataConfig() The data access role and Amazon S3 prefixes for the input files used to train the custom language model.
CLMLanguageCode	languageCode() The language code you used to create your custom language model.
String	languageCodeAsString() The language code you used to create your custom language model.
Instant	lastModifiedTime() The most recent time the custom language model was modified.
String	modelName() The name of the custom language model.
ModelStatus	modelStatus() The creation status of a custom language model.
String	modelStatusAsString() The creation status of a custom language model.
List<SdkField<?>>	sdkFields()
static Class<? extends LanguageModel.Builder>	serializableBuilderClass()
LanguageModel.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	upgradeAvailability() Whether the base model used for the custom language model is up to date.

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

modelName

public final String modelName()

The name of the custom language model.

Returns:

The name of the custom language model.

createTime

public final Instant createTime()

The time the custom language model was created.

Returns:

The time the custom language model was created.

lastModifiedTime

public final Instant lastModifiedTime()

The most recent time the custom language model was modified.

Returns:

The most recent time the custom language model was modified.

languageCode

public final CLMLanguageCode languageCode()

The language code you used to create your custom language model.

If the service returns an enum value that is not available in the current SDK version, languageCode will return CLMLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code you used to create your custom language model.

See Also:

CLMLanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language code you used to create your custom language model.

If the service returns an enum value that is not available in the current SDK version, languageCode will return CLMLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language code you used to create your custom language model.

See Also:

CLMLanguageCode

baseModelName

public final BaseModelName baseModelName()

The Amazon Transcribe standard language model, or base model used to create the custom language model.

If the service returns an enum value that is not available in the current SDK version, baseModelName will return BaseModelName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseModelNameAsString().

Returns:

The Amazon Transcribe standard language model, or base model used to create the custom language model.

See Also:

BaseModelName

baseModelNameAsString

public final String baseModelNameAsString()

The Amazon Transcribe standard language model, or base model used to create the custom language model.

If the service returns an enum value that is not available in the current SDK version, baseModelName will return BaseModelName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from baseModelNameAsString().

Returns:

The Amazon Transcribe standard language model, or base model used to create the custom language model.

See Also:

BaseModelName

modelStatus

public final ModelStatus modelStatus()

The creation status of a custom language model. When the status is COMPLETED the model is ready for use.

If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

Returns:

The creation status of a custom language model. When the status is COMPLETED the model is ready for use.

See Also:

ModelStatus

modelStatusAsString

public final String modelStatusAsString()

The creation status of a custom language model. When the status is COMPLETED the model is ready for use.

If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

Returns:

The creation status of a custom language model. When the status is COMPLETED the model is ready for use.

See Also:

ModelStatus

upgradeAvailability

public final Boolean upgradeAvailability()

Whether the base model used for the custom language model is up to date. If this field is true then you are running the most up-to-date version of the base model in your custom language model.

Returns:

Whether the base model used for the custom language model is up to date. If this field is true then you are running the most up-to-date version of the base model in your custom language model.

failureReason

public final String failureReason()

The reason why the custom language model couldn't be created.

Returns:

The reason why the custom language model couldn't be created.

inputDataConfig

public final InputDataConfig inputDataConfig()

The data access role and Amazon S3 prefixes for the input files used to train the custom language model.

Returns:

The data access role and Amazon S3 prefixes for the input files used to train the custom language model.

toBuilder

public LanguageModel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LanguageModel.Builder,LanguageModel>

builder

public static LanguageModel.Builder builder()

serializableBuilderClass

public static Class<? extends LanguageModel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo