DocumentClassifierProperties (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.DocumentClassifierProperties

All Implemented Interfaces:

java.io.Serializable
```
public class DocumentClassifierProperties
extends java.lang.Object
implements java.io.Serializable
```
Provides information about a document classifier.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentClassifierProperties()

Constructors
Constructor and Description
`DocumentClassifierProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`ClassifierMetadata`	`getClassifierMetadata()` 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.
`java.lang.String`	`getDataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
`java.lang.String`	`getDocumentClassifierArn()` The Amazon Resource Name (ARN) that identifies the document classifier.
`java.util.Date`	`getEndTime()` The time that training the document classifier completed.
`DocumentClassifierInputDataConfig`	`getInputDataConfig()` The input data configuration that you supplied when you created the document classifier for training.
`java.lang.String`	`getLanguageCode()` The language code for the language of the documents that the classifier was trained on.
`java.lang.String`	`getMessage()` Additional information about the status of the classifier.
`java.lang.String`	`getMode()` Indicates the mode in which the specific classifier was trained.
`DocumentClassifierOutputDataConfig`	`getOutputDataConfig()` Provides output results configuration parameters for custom classifier jobs.
`java.lang.String`	`getStatus()` The status of the document classifier.
`java.util.Date`	`getSubmitTime()` The time that the document classifier was submitted for training.
`java.util.Date`	`getTrainingEndTime()` The time that training of the document classifier was completed.
`java.util.Date`	`getTrainingStartTime()` Indicates the time when the training starts on documentation classifiers.
`java.lang.String`	`getVolumeKmsKeyId()` ID for the AWS 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`	`getVpcConfig()` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
`int`	`hashCode()`
`void`	`setClassifierMetadata(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.
`void`	`setDataAccessRoleArn(java.lang.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.
`void`	`setDocumentClassifierArn(java.lang.String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`void`	`setEndTime(java.util.Date endTime)` The time that training the document classifier completed.
`void`	`setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classifier for training.
`void`	`setLanguageCode(LanguageCode languageCode)` The language code for the language of the documents that the classifier was trained on.
`void`	`setLanguageCode(java.lang.String languageCode)` The language code for the language of the documents that the classifier was trained on.
`void`	`setMessage(java.lang.String message)` Additional information about the status of the classifier.
`void`	`setMode(DocumentClassifierMode mode)` Indicates the mode in which the specific classifier was trained.
`void`	`setMode(java.lang.String mode)` Indicates the mode in which the specific classifier was trained.
`void`	`setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)` Provides output results configuration parameters for custom classifier jobs.
`void`	`setStatus(ModelStatus status)` The status of the document classifier.
`void`	`setStatus(java.lang.String status)` The status of the document classifier.
`void`	`setSubmitTime(java.util.Date submitTime)` The time that the document classifier was submitted for training.
`void`	`setTrainingEndTime(java.util.Date trainingEndTime)` The time that training of the document classifier was completed.
`void`	`setTrainingStartTime(java.util.Date trainingStartTime)` Indicates the time when the training starts on documentation classifiers.
`void`	`setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)` ID for the AWS 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.
`void`	`setVpcConfig(VpcConfig vpcConfig)` Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DocumentClassifierProperties`	`withClassifierMetadata(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.
`DocumentClassifierProperties`	`withDataAccessRoleArn(java.lang.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.
`DocumentClassifierProperties`	`withDocumentClassifierArn(java.lang.String documentClassifierArn)` The Amazon Resource Name (ARN) that identifies the document classifier.
`DocumentClassifierProperties`	`withEndTime(java.util.Date endTime)` The time that training the document classifier completed.
`DocumentClassifierProperties`	`withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)` The input data configuration that you supplied when you created the document classifier for training.
`DocumentClassifierProperties`	`withLanguageCode(LanguageCode languageCode)` The language code for the language of the documents that the classifier was trained on.
`DocumentClassifierProperties`	`withLanguageCode(java.lang.String languageCode)` The language code for the language of the documents that the classifier was trained on.
`DocumentClassifierProperties`	`withMessage(java.lang.String message)` Additional information about the status of the classifier.
`DocumentClassifierProperties`	`withMode(DocumentClassifierMode mode)` Indicates the mode in which the specific classifier was trained.
`DocumentClassifierProperties`	`withMode(java.lang.String mode)` Indicates the mode in which the specific classifier was trained.
`DocumentClassifierProperties`	`withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)` Provides output results configuration parameters for custom classifier jobs.
`DocumentClassifierProperties`	`withStatus(ModelStatus status)` The status of the document classifier.
`DocumentClassifierProperties`	`withStatus(java.lang.String status)` The status of the document classifier.
`DocumentClassifierProperties`	`withSubmitTime(java.util.Date submitTime)` The time that the document classifier was submitted for training.
`DocumentClassifierProperties`	`withTrainingEndTime(java.util.Date trainingEndTime)` The time that training of the document classifier was completed.
`DocumentClassifierProperties`	`withTrainingStartTime(java.util.Date trainingStartTime)` Indicates the time when the training starts on documentation classifiers.
`DocumentClassifierProperties`	`withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)` ID for the AWS 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.
`DocumentClassifierProperties`	`withVpcConfig(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentClassifierProperties
```
public DocumentClassifierProperties()
```
- Method Detail
  - getDocumentClassifierArn
```
public java.lang.String getDocumentClassifierArn()
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Constraints:
    Length: - 256
    Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - setDocumentClassifierArn
```
public void setDocumentClassifierArn(java.lang.String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Constraints:
    Length: - 256
    Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    documentClassifierArn -
    The Amazon Resource Name (ARN) that identifies the document classifier.
  - withDocumentClassifierArn
```
public DocumentClassifierProperties withDocumentClassifierArn(java.lang.String documentClassifierArn)
```
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 256
    Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document -classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*
    
    Parameters:
    
    documentClassifierArn -
    The Amazon Resource Name (ARN) that identifies the document classifier.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLanguageCode
```
public java.lang.String getLanguageCode()
```
    The language code for the language of the documents that the classifier was trained on.
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Returns:
    
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(java.lang.String languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public DocumentClassifierProperties withLanguageCode(java.lang.String languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code for the language of the documents that the classifier was trained on.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setLanguageCode
```
public void setLanguageCode(LanguageCode languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code for the language of the documents that the classifier was trained on.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public DocumentClassifierProperties withLanguageCode(LanguageCode languageCode)
```
    The language code for the language of the documents that the classifier was trained on.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
    
    Parameters:
    
    languageCode -
    The language code for the language of the documents that the classifier was trained on.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - getStatus
```
public java.lang.String getStatus()
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    
    Returns:
    
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    See Also:
    
    ModelStatus
  - setStatus
```
public void setStatus(java.lang.String status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    
    Parameters:
    
    status -
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public DocumentClassifierProperties withStatus(java.lang.String status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    
    Parameters:
    
    status -
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - setStatus
```
public void setStatus(ModelStatus status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Constraints:
    Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    
    Parameters:
    
    status -
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    See Also:
    
    ModelStatus
  - withStatus
```
public DocumentClassifierProperties withStatus(ModelStatus status)
```
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
    
    Parameters:
    
    status -
    The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    ModelStatus
  - getMessage
```
public java.lang.String getMessage()
```
    Additional information about the status of the classifier.
    
    Returns:
    
    Additional information about the status of the classifier.
  - setMessage
```
public void setMessage(java.lang.String message)
```
    Additional information about the status of the classifier.
    
    Parameters:
    
    message -
    Additional information about the status of the classifier.
  - withMessage
```
public DocumentClassifierProperties withMessage(java.lang.String message)
```
    Additional information about the status of the classifier.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    message -
    Additional information about the status of the classifier.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSubmitTime
```
public java.util.Date getSubmitTime()
```
    The time that the document classifier was submitted for training.
    
    Returns:
    
    The time that the document classifier was submitted for training.
  - setSubmitTime
```
public void setSubmitTime(java.util.Date submitTime)
```
    The time that the document classifier was submitted for training.
    
    Parameters:
    
    submitTime -
    The time that the document classifier was submitted for training.
  - withSubmitTime
```
public DocumentClassifierProperties withSubmitTime(java.util.Date submitTime)
```
    The time that the document classifier was submitted for training.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    submitTime -
    The time that the document classifier was submitted for training.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public java.util.Date getEndTime()
```
    The time that training the document classifier completed.
    
    Returns:
    
    The time that training the document classifier completed.
  - setEndTime
```
public void setEndTime(java.util.Date endTime)
```
    The time that training the document classifier completed.
    
    Parameters:
    
    endTime -
    The time that training the document classifier completed.
  - withEndTime
```
public DocumentClassifierProperties withEndTime(java.util.Date endTime)
```
    The time that training the document classifier completed.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endTime -
    The time that training the document classifier completed.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTrainingStartTime
```
public java.util.Date getTrainingStartTime()
```
    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.
  - setTrainingStartTime
```
public void setTrainingStartTime(java.util.Date 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.
    
    Parameters:
    
    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.
  - withTrainingStartTime
```
public DocumentClassifierProperties withTrainingStartTime(java.util.Date 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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getTrainingEndTime
```
public java.util.Date getTrainingEndTime()
```
    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.
  - setTrainingEndTime
```
public void setTrainingEndTime(java.util.Date 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.
    
    Parameters:
    
    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.
  - withTrainingEndTime
```
public DocumentClassifierProperties withTrainingEndTime(java.util.Date 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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getInputDataConfig
```
public DocumentClassifierInputDataConfig getInputDataConfig()
```
    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.
  - setInputDataConfig
```
public void setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the document classifier for training.
    
    Parameters:
    
    inputDataConfig -
    The input data configuration that you supplied when you created the document classifier for training.
  - withInputDataConfig
```
public DocumentClassifierProperties withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
```
    The input data configuration that you supplied when you created the document classifier for training.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    inputDataConfig -
    The input data configuration that you supplied when you created the document classifier for training.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOutputDataConfig
```
public DocumentClassifierOutputDataConfig getOutputDataConfig()
```
    Provides output results configuration parameters for custom classifier jobs.
    
    Returns:
    
    Provides output results configuration parameters for custom classifier jobs.
  - setOutputDataConfig
```
public void setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
```
    Provides output results configuration parameters for custom classifier jobs.
    
    Parameters:
    
    outputDataConfig -
    Provides output results configuration parameters for custom classifier jobs.
  - withOutputDataConfig
```
public DocumentClassifierProperties withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
```
    Provides output results configuration parameters for custom classifier jobs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    outputDataConfig -
    Provides output results configuration parameters for custom classifier jobs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClassifierMetadata
```
public ClassifierMetadata getClassifierMetadata()
```
    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.
  - setClassifierMetadata
```
public void setClassifierMetadata(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.
    
    Parameters:
    
    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.
  - withClassifierMetadata
```
public DocumentClassifierProperties withClassifierMetadata(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getDataAccessRoleArn
```
public java.lang.String getDataAccessRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - setDataAccessRoleArn
```
public void setDataAccessRoleArn(java.lang.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.
    
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    dataAccessRoleArn -
    The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
  - withDataAccessRoleArn
```
public DocumentClassifierProperties withDataAccessRoleArn(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 20 - 2048
    Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getVolumeKmsKeyId
```
public java.lang.String getVolumeKmsKeyId()
```
    ID for the AWS 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"
    Constraints:
    Length: - 2048
    Returns:
    ID for the AWS 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"
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
```
    ID for the AWS 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"
    Constraints:
    Length: - 2048
    Parameters:
    volumeKmsKeyId -
    ID for the AWS 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"
  - withVolumeKmsKeyId
```
public DocumentClassifierProperties withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
```
    ID for the AWS 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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 2048
    Parameters:
    volumeKmsKeyId -
    ID for the AWS 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:
    
    A reference to this updated object so that method calls can be chained together.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    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.
  - setVpcConfig
```
public void setVpcConfig(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.
    
    Parameters:
    
    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.
  - withVpcConfig
```
public DocumentClassifierProperties withVpcConfig(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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getMode
```
public java.lang.String getMode()
```
    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.
    
    Constraints:
    Allowed Values: MULTI_CLASS, MULTI_LABEL
    
    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
  - setMode
```
public void setMode(java.lang.String 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.
    
    Constraints:
    Allowed Values: MULTI_CLASS, MULTI_LABEL
    
    Parameters:
    
    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.
    
    See Also:
    
    DocumentClassifierMode
  - withMode
```
public DocumentClassifierProperties withMode(java.lang.String 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: MULTI_CLASS, MULTI_LABEL
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierMode
  - setMode
```
public void setMode(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.
    
    Constraints:
    Allowed Values: MULTI_CLASS, MULTI_LABEL
    
    Parameters:
    
    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.
    
    See Also:
    
    DocumentClassifierMode
  - withMode
```
public DocumentClassifierProperties withMode(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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: MULTI_CLASS, MULTI_LABEL
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DocumentClassifierMode
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DocumentClassifierProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentClassifierProperties

Method Detail

getDocumentClassifierArn

setDocumentClassifierArn

withDocumentClassifierArn

getLanguageCode

setLanguageCode

withLanguageCode

setLanguageCode

withLanguageCode

getStatus

setStatus

withStatus

setStatus

withStatus

getMessage

setMessage

withMessage

getSubmitTime

setSubmitTime

withSubmitTime

getEndTime

setEndTime

withEndTime

getTrainingStartTime

setTrainingStartTime

withTrainingStartTime

getTrainingEndTime

setTrainingEndTime

withTrainingEndTime

getInputDataConfig

setInputDataConfig

withInputDataConfig

getOutputDataConfig

setOutputDataConfig

withOutputDataConfig

getClassifierMetadata

setClassifierMetadata

withClassifierMetadata

getDataAccessRoleArn

setDataAccessRoleArn

withDataAccessRoleArn

getVolumeKmsKeyId

setVolumeKmsKeyId

withVolumeKmsKeyId

getVpcConfig

setVpcConfig

withVpcConfig

getMode

setMode

withMode

setMode

withMode

toString

hashCode

equals