software.amazon.awssdk.services.comprehend.model

Class EntityRecognizerProperties

java.lang.Object

software.amazon.awssdk.services.comprehend.model.EntityRecognizerProperties

All Implemented Interfaces:

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

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

Describes information about an entity recognizer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityRecognizerProperties.Builder

Method Summary

Modifier and Type	Method and Description
static EntityRecognizerProperties.Builder	builder()
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Instant	endTime() The time that the recognizer creation completed.
String	entityRecognizerArn() The Amazon Resource Name (ARN) that identifies the entity recognizer.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EntityRecognizerInputDataConfig	inputDataConfig() The input data properties of an entity recognizer.
LanguageCode	languageCode() The language of the input documents.
String	languageCodeAsString() The language of the input documents.
String	message() A description of the status of the recognizer.
EntityRecognizerMetadata	recognizerMetadata() Provides information about an entity recognizer.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityRecognizerProperties.Builder>	serializableBuilderClass()
ModelStatus	status() Provides the status of the entity recognizer.
String	statusAsString() Provides the status of the entity recognizer.
Instant	submitTime() The time that the recognizer was submitted for processing.
EntityRecognizerProperties.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Instant	trainingEndTime() The time that training of the entity recognizer was completed.
Instant	trainingStartTime() The time that training of the entity recognizer started.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

entityRecognizerArn

public String entityRecognizerArn()

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

The Amazon Resource Name (ARN) that identifies the entity recognizer.

languageCode

public LanguageCode languageCode()

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

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 of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

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 of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

See Also:

LanguageCode

status

public ModelStatus status()

Provides the status of the entity recognizer.

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

Returns:

Provides the status of the entity recognizer.

See Also:

ModelStatus

statusAsString

public String statusAsString()

Provides the status of the entity recognizer.

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

Returns:

Provides the status of the entity recognizer.

See Also:

ModelStatus

message

public String message()

A description of the status of the recognizer.

Returns:

A description of the status of the recognizer.

submitTime

public Instant submitTime()

The time that the recognizer was submitted for processing.

Returns:

The time that the recognizer was submitted for processing.

endTime

public Instant endTime()

The time that the recognizer creation completed.

Returns:

The time that the recognizer creation completed.

trainingStartTime

public Instant trainingStartTime()

The time that training of the entity recognizer started.

Returns:

The time that training of the entity recognizer started.

trainingEndTime

public Instant trainingEndTime()

The time that training of the entity recognizer was completed.

Returns:

The time that training of the entity recognizer was completed.

inputDataConfig

public EntityRecognizerInputDataConfig inputDataConfig()

The input data properties of an entity recognizer.

Returns:

The input data properties of an entity recognizer.

recognizerMetadata

public EntityRecognizerMetadata recognizerMetadata()

Provides information about an entity recognizer.

Returns:

Provides information about an entity recognizer.

dataAccessRoleArn

public String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

toBuilder

public EntityRecognizerProperties.Builder 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 interface ToCopyableBuilder<EntityRecognizerProperties.Builder,EntityRecognizerProperties>

Returns:

a builder for type T

builder

public static EntityRecognizerProperties.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.