Package software.amazon.awssdk.services.comprehend.model

Class DocumentClassifierProperties

java.lang.Object
software.amazon.awssdk.services.comprehend.model.DocumentClassifierProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>
@Generated("software.amazon.awssdk:codegen") public final class DocumentClassifierProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>

Provides information about a document classifier.

See Also:

  • Method Details

    • documentClassifierArn

      public final String documentClassifierArn()

      The Amazon Resource Name (ARN) that identifies the document classifier.

      Returns:
      The Amazon Resource Name (ARN) that identifies the document classifier.

    • languageCode

      public final LanguageCode languageCode()

      The language code for the language of the documents that the classifier was trained on.

      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 for the language of the documents that the classifier was trained on.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

      The language code for the language of the documents that the classifier was trained on.

      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 for the language of the documents that the classifier was trained on.
      See Also:

    • status

      public final ModelStatus status()

      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      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:
      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      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:
      The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is TRAINED_WITH_WARNINGS the classifier training succeeded, but you should review the warnings returned in the CreateDocumentClassifier response.

      If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

      See Also:

    • message

      public final String message()

      Additional information about the status of the classifier.

      Returns:
      Additional information about the status of the classifier.

    • submitTime

      public final Instant submitTime()

      The time that the document classifier was submitted for training.

      Returns:
      The time that the document classifier was submitted for training.

    • endTime

      public final Instant endTime()

      The time that training the document classifier completed.

      Returns:
      The time that training the document classifier completed.

    • trainingStartTime

      public final Instant trainingStartTime()

      Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

      Returns:
      Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

    • trainingEndTime

      public final Instant trainingEndTime()

      The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

      Returns:
      The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

    • inputDataConfig

      public final DocumentClassifierInputDataConfig inputDataConfig()

      The input data configuration that you supplied when you created the document classifier for training.

      Returns:
      The input data configuration that you supplied when you created the document classifier for training.

    • outputDataConfig

      public final DocumentClassifierOutputDataConfig outputDataConfig()

      Provides output results configuration parameters for custom classifier jobs.

      Returns:
      Provides output results configuration parameters for custom classifier jobs.

    • classifierMetadata

      public final ClassifierMetadata classifierMetadata()

      Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

      Returns:
      Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

    • 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 classifier. 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 classifier. For more information, see Amazon VPC.

    • mode

      public final DocumentClassifierMode mode()

      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

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

      Returns:
      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
      See Also:

    • modeAsString

      public final String modeAsString()

      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

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

      Returns:
      Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.
      See Also:

    • 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 that you assigned to the document classifier.

      Returns:
      The version name that you assigned to the document classifier.

    • 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 document classifier 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 document classifier 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

    • toBuilder

      public DocumentClassifierProperties.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<DocumentClassifierProperties.Builder,DocumentClassifierProperties>
      Returns:
      a builder for type T

    • builder

      public static DocumentClassifierProperties.Builder builder()

    • serializableBuilderClass

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