EntityRecognizerProperties (AWS Java SDK :: Services :: Amazon Comprehend 2.20.110 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EntityRecognizerProperties.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EntityRecognizerProperties.Builder`	`builder()`
`String`	`dataAccessRoleArn()` The Amazon Resource Name (ARN) of the 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flywheelArn()` The Amazon Resource Number (ARN) of the flywheel
`<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.
`String`	`modelKmsKeyId()` ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
`EntityRecognizerOutputDataConfig`	`outputDataConfig()` Output data configuration.
`EntityRecognizerMetadata`	`recognizerMetadata()` Provides information about an entity recognizer.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends EntityRecognizerProperties.Builder>`	`serializableBuilderClass()`
`String`	`sourceModelArn()` The Amazon Resource Name (ARN) of the source model.
`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()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`trainingEndTime()` The time that training of the entity recognizer was completed.
`Instant`	`trainingStartTime()` The time that training of the entity recognizer started.
`String`	`versionName()` The version name you assigned to the entity recognizer.
`String`	`volumeKmsKeyId()` ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.
`VpcConfig`	`vpcConfig()` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.

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
  - entityRecognizerArn
```
public final 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 final 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 final 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 final 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 final 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 final String message()
```
    A description of the status of the recognizer.
    
    Returns:
    
    A description of the status of the recognizer.
  - submitTime
```
public final Instant submitTime()
```
    The time that the recognizer was submitted for processing.
    
    Returns:
    
    The time that the recognizer was submitted for processing.
  - endTime
```
public final Instant endTime()
```
    The time that the recognizer creation completed.
    
    Returns:
    
    The time that the recognizer creation completed.
  - trainingStartTime
```
public final Instant trainingStartTime()
```
    The time that training of the entity recognizer started.
    
    Returns:
    
    The time that training of the entity recognizer started.
  - trainingEndTime
```
public final 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 final EntityRecognizerInputDataConfig inputDataConfig()
```
    The input data properties of an entity recognizer.
    
    Returns:
    
    The input data properties of an entity recognizer.
  - recognizerMetadata
```
public final EntityRecognizerMetadata recognizerMetadata()
```
    Provides information about an entity recognizer.
    
    Returns:
    
    Provides information about an entity recognizer.
  - dataAccessRoleArn
```
public final String dataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
  - volumeKmsKeyId
```
public final String volumeKmsKeyId()
```
    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Returns:
    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - vpcConfig
```
public final VpcConfig vpcConfig()
```
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
    
    Returns:
    
    Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
  - modelKmsKeyId
```
public final String modelKmsKeyId()
```
    ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Returns:
    ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either of the following formats:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - versionName
```
public final String versionName()
```
    The version name you assigned to the entity recognizer.
    
    Returns:
    
    The version name you assigned to the entity recognizer.
  - sourceModelArn
```
public final String sourceModelArn()
```
    The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
  - flywheelArn
```
public final String flywheelArn()
```
    The Amazon Resource Number (ARN) of the flywheel
    
    Returns:
    
    The Amazon Resource Number (ARN) of the flywheel
  - outputDataConfig
```
public final EntityRecognizerOutputDataConfig outputDataConfig()
```
    Output data configuration.
    
    Returns:
    
    Output data configuration.
  - toBuilder
```
public EntityRecognizerProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<EntityRecognizerProperties.Builder,EntityRecognizerProperties>
  - builder
```
public static EntityRecognizerProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends EntityRecognizerProperties.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

Class EntityRecognizerProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

entityRecognizerArn

languageCode

languageCodeAsString

status

statusAsString

message

submitTime

endTime

trainingStartTime

trainingEndTime

inputDataConfig

recognizerMetadata

dataAccessRoleArn

volumeKmsKeyId

vpcConfig

modelKmsKeyId

versionName

sourceModelArn

flywheelArn

outputDataConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields