@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DocumentClassifierProperties extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about a document classifier.
Constructor and Description |
---|
DocumentClassifierProperties() |
Modifier and Type | Method and Description |
---|---|
DocumentClassifierProperties |
clone() |
boolean |
equals(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.
|
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.
|
String |
getDocumentClassifierArn()
The Amazon Resource Name (ARN) that identifies the document classifier.
|
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.
|
String |
getLanguageCode()
The language code for the language of the documents that the classifier was trained on.
|
String |
getMessage()
Additional information about the status of the classifier.
|
DocumentClassifierOutputDataConfig |
getOutputDataConfig()
Provides output results configuration parameters for custom classifier jobs.
|
String |
getStatus()
The status of the document classifier.
|
Date |
getSubmitTime()
The time that the document classifier was submitted for training.
|
Date |
getTrainingEndTime()
The time that training of the document classifier was completed.
|
Date |
getTrainingStartTime()
Indicates the time when the training starts on documentation classifiers.
|
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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(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(String documentClassifierArn)
The Amazon Resource Name (ARN) that identifies the document classifier.
|
void |
setEndTime(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(String languageCode)
The language code for the language of the documents that the classifier was trained on.
|
void |
setMessage(String message)
Additional information about the status of the classifier.
|
void |
setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Provides output results configuration parameters for custom classifier jobs.
|
void |
setStatus(String status)
The status of the document classifier.
|
void |
setSubmitTime(Date submitTime)
The time that the document classifier was submitted for training.
|
void |
setTrainingEndTime(Date trainingEndTime)
The time that training of the document classifier was completed.
|
void |
setTrainingStartTime(Date trainingStartTime)
Indicates the time when the training starts on documentation classifiers.
|
void |
setVolumeKmsKeyId(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.
|
String |
toString()
Returns a string representation of this object.
|
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(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(String documentClassifierArn)
The Amazon Resource Name (ARN) that identifies the document classifier.
|
DocumentClassifierProperties |
withEndTime(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(String languageCode)
The language code for the language of the documents that the classifier was trained on.
|
DocumentClassifierProperties |
withMessage(String message)
Additional information about the status of the classifier.
|
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(String status)
The status of the document classifier.
|
DocumentClassifierProperties |
withSubmitTime(Date submitTime)
The time that the document classifier was submitted for training.
|
DocumentClassifierProperties |
withTrainingEndTime(Date trainingEndTime)
The time that training of the document classifier was completed.
|
DocumentClassifierProperties |
withTrainingStartTime(Date trainingStartTime)
Indicates the time when the training starts on documentation classifiers.
|
DocumentClassifierProperties |
withVolumeKmsKeyId(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.
|
public void setDocumentClassifierArn(String documentClassifierArn)
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassifierArn
- The Amazon Resource Name (ARN) that identifies the document classifier.public String getDocumentClassifierArn()
The Amazon Resource Name (ARN) that identifies the document classifier.
public DocumentClassifierProperties withDocumentClassifierArn(String documentClassifierArn)
The Amazon Resource Name (ARN) that identifies the document classifier.
documentClassifierArn
- The Amazon Resource Name (ARN) that identifies the document classifier.public void setLanguageCode(String languageCode)
The language code for the language of the documents that the classifier was trained on.
languageCode
- The language code for the language of the documents that the classifier was trained on.LanguageCode
public String getLanguageCode()
The language code for the language of the documents that the classifier was trained on.
LanguageCode
public DocumentClassifierProperties withLanguageCode(String languageCode)
The language code for the language of the documents that the classifier was trained on.
languageCode
- The language code for the language of the documents that the classifier was trained on.LanguageCode
public DocumentClassifierProperties withLanguageCode(LanguageCode languageCode)
The language code for the language of the documents that the classifier was trained on.
languageCode
- The language code for the language of the documents that the classifier was trained on.LanguageCode
public void setStatus(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.
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.ModelStatus
public 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.
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.ModelStatus
public DocumentClassifierProperties withStatus(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.
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.ModelStatus
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.
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.ModelStatus
public void setMessage(String message)
Additional information about the status of the classifier.
message
- Additional information about the status of the classifier.public String getMessage()
Additional information about the status of the classifier.
public DocumentClassifierProperties withMessage(String message)
Additional information about the status of the classifier.
message
- Additional information about the status of the classifier.public void setSubmitTime(Date submitTime)
The time that the document classifier was submitted for training.
submitTime
- The time that the document classifier was submitted for training.public Date getSubmitTime()
The time that the document classifier was submitted for training.
public DocumentClassifierProperties withSubmitTime(Date submitTime)
The time that the document classifier was submitted for training.
submitTime
- The time that the document classifier was submitted for training.public void setEndTime(Date endTime)
The time that training the document classifier completed.
endTime
- The time that training the document classifier completed.public Date getEndTime()
The time that training the document classifier completed.
public DocumentClassifierProperties withEndTime(Date endTime)
The time that training the document classifier completed.
endTime
- The time that training the document classifier completed.public void setTrainingStartTime(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.
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.public 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.
public DocumentClassifierProperties withTrainingStartTime(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.
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.public void setTrainingEndTime(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.
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.public 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.
public DocumentClassifierProperties withTrainingEndTime(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.
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.public void setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the document classifier for training.
inputDataConfig
- The input data configuration that you supplied when you created the document classifier for training.public DocumentClassifierInputDataConfig getInputDataConfig()
The input data configuration that you supplied when you created the document classifier for training.
public DocumentClassifierProperties withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the document classifier for training.
inputDataConfig
- The input data configuration that you supplied when you created the document classifier for training.public void setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Provides output results configuration parameters for custom classifier jobs.
outputDataConfig
- Provides output results configuration parameters for custom classifier jobs.public DocumentClassifierOutputDataConfig getOutputDataConfig()
Provides output results configuration parameters for custom classifier jobs.
public DocumentClassifierProperties withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig)
Provides output results configuration parameters for custom classifier jobs.
outputDataConfig
- Provides output results configuration parameters for custom classifier jobs.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.
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.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.
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.
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.public void setDataAccessRoleArn(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.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend
read access to your input data.public 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.
public DocumentClassifierProperties withDataAccessRoleArn(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.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend
read access to your input data.public void setVolumeKmsKeyId(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"
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"
public 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"
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"
public DocumentClassifierProperties withVolumeKmsKeyId(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"
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"
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.
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.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.
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.
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.public String toString()
toString
in class Object
Object.toString()
public DocumentClassifierProperties clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.