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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DocumentClassifierProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentClassifierProperties.Builder`	`builder()`
`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.
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`String`	`documentClassifierArn()`	The Amazon Resource Name (ARN) that identifies the document classifier.
`Instant`	`endTime()`	The time that training the document classifier completed.
`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()`
`DocumentClassifierInputDataConfig`	`inputDataConfig()`	The input data configuration that you supplied when you created the document classifier for training.
`LanguageCode`	`languageCode()`	The language code for the language of the documents that the classifier was trained on.
`String`	`languageCodeAsString()`	The language code for the language of the documents that the classifier was trained on.
`String`	`message()`	Additional information about the status of the classifier.
`DocumentClassifierMode`	`mode()`	Indicates the mode in which the specific classifier was trained.
`String`	`modeAsString()`	Indicates the mode in which the specific classifier was trained.
`String`	`modelKmsKeyId()`	ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
`DocumentClassifierOutputDataConfig`	`outputDataConfig()`	Provides output results configuration parameters for custom classifier jobs.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DocumentClassifierProperties.Builder>`	`serializableBuilderClass()`
`String`	`sourceModelArn()`	The Amazon Resource Name (ARN) of the source model.
`ModelStatus`	`status()`	The status of the document classifier.
`String`	`statusAsString()`	The status of the document classifier.
`Instant`	`submitTime()`	The time that the document classifier was submitted for training.
`DocumentClassifierProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`trainingEndTime()`	The time that training of the document classifier was completed.
`Instant`	`trainingStartTime()`	Indicates the time when the training starts on documentation classifiers.
`String`	`versionName()`	The version name that you assigned to the document classifier.
`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 classifier.

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
  - 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:
    
    LanguageCode
  - 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:
    
    LanguageCode
  - 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:
    
    ModelStatus
  - 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:
    
    ModelStatus
  - 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:
    
    DocumentClassifierMode
  - 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:
    
    DocumentClassifierMode
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DocumentClassifierProperties.Builder,DocumentClassifierProperties>
  - 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)
```
    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 DocumentClassifierProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

documentClassifierArn

languageCode

languageCodeAsString

status

statusAsString

message

submitTime

endTime

trainingStartTime

trainingEndTime

inputDataConfig

outputDataConfig

classifierMetadata

dataAccessRoleArn

volumeKmsKeyId

vpcConfig

mode

modeAsString

modelKmsKeyId

versionName

sourceModelArn

flywheelArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields