Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.