/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.comprehend.model; import java.io.Serializable; /** *

* Provides information about a document classifier. *

*/ public class DocumentClassifierProperties implements Serializable { /** *

* 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])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*/ private String documentClassifierArn; /** *

* 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 */ private String languageCode; /** *

* 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. *

*

* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, * STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING */ private String status; /** *

* Additional information about the status of the classifier. *

*/ private String message; /** *

* The time that the document classifier was submitted for training. *

*/ private java.util.Date submitTime; /** *

* The time that training the document classifier completed. *

*/ private java.util.Date endTime; /** *

* 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. *

*/ private java.util.Date trainingStartTime; /** *

* 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. *

*/ private java.util.Date trainingEndTime; /** *

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

*/ private DocumentClassifierInputDataConfig inputDataConfig; /** *

* Provides output results configuration parameters for custom classifier * jobs. *

*/ private DocumentClassifierOutputDataConfig outputDataConfig; /** *

* 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. *

*/ private ClassifierMetadata classifierMetadata; /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
*/ private String dataAccessRoleArn; /** *

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

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
*/ private String volumeKmsKeyId; /** *

* 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. *

*/ private VpcConfig vpcConfig; /** *

* 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 */ private String mode; /** *

* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom * models. The ModelKmsKeyId can be either of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
*/ private String modelKmsKeyId; /** *

* The version name that you assigned to the document classifier. *

*

* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
*/ private String versionName; /** *

* 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. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*/ private String sourceModelArn; /** *

* The Amazon Resource Number (ARN) of the flywheel *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel * /[a-zA-Z0-9](-*[a-zA-Z0-9])*
*/ private String flywheelArn; /** *

* 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])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @return

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

*/ public String getDocumentClassifierArn() { return 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])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param documentClassifierArn

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

*/ public void setDocumentClassifierArn(String documentClassifierArn) { this.documentClassifierArn = 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])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param documentClassifierArn

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

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withDocumentClassifierArn(String documentClassifierArn) { this.documentClassifierArn = documentClassifierArn; return this; } /** *

* 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 * * @return

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

* @see LanguageCode */ public String getLanguageCode() { return 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 * * @param languageCode

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

* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.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 * * @param languageCode

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

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public DocumentClassifierProperties withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** *

* 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 * * @param languageCode

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

* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** *

* 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 * * @param languageCode

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

* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public DocumentClassifierProperties withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, * STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING * * @return

* 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 ModelStatus */ public String getStatus() { return 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. *

*

* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, * STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING * * @param 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. *

* @see ModelStatus */ public void setStatus(String status) { this.status = 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. *

*

* 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, TRAINED_WITH_WARNING * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ModelStatus */ public DocumentClassifierProperties withStatus(String status) { this.status = status; return this; } /** *

* 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. *

*

* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, * STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING * * @param 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. *

* @see ModelStatus */ public void setStatus(ModelStatus status) { this.status = status.toString(); } /** *

* 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. *

*

* 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, TRAINED_WITH_WARNING * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see ModelStatus */ public DocumentClassifierProperties withStatus(ModelStatus status) { this.status = status.toString(); return this; } /** *

* Additional information about the status of the classifier. *

* * @return

* Additional information about the status of the classifier. *

*/ public String getMessage() { return message; } /** *

* Additional information about the status of the classifier. *

* * @param message

* Additional information about the status of the classifier. *

*/ public void setMessage(String message) { this.message = message; } /** *

* Additional information about the status of the classifier. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param message

* Additional information about the status of the classifier. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withMessage(String message) { this.message = message; return this; } /** *

* The time that the document classifier was submitted for training. *

* * @return

* The time that the document classifier was submitted for training. *

*/ public java.util.Date getSubmitTime() { return submitTime; } /** *

* The time that the document classifier was submitted for training. *

* * @param submitTime

* The time that the document classifier was submitted for * training. *

*/ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = 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. * * @param submitTime

* The time that the document classifier was submitted for * training. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; return this; } /** *

* The time that training the document classifier completed. *

* * @return

* The time that training the document classifier completed. *

*/ public java.util.Date getEndTime() { return endTime; } /** *

* The time that training the document classifier completed. *

* * @param endTime

* The time that training the document classifier completed. *

*/ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** *

* The time that training the document classifier completed. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param endTime

* The time that training the document classifier completed. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** *

* 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. *

* * @return

* 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 java.util.Date getTrainingStartTime() { return 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. *

* * @param 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 setTrainingStartTime(java.util.Date trainingStartTime) { this.trainingStartTime = 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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withTrainingStartTime(java.util.Date trainingStartTime) { this.trainingStartTime = trainingStartTime; return this; } /** *

* 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. *

* * @return

* 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 java.util.Date getTrainingEndTime() { return 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. *

* * @param 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 setTrainingEndTime(java.util.Date trainingEndTime) { this.trainingEndTime = 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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withTrainingEndTime(java.util.Date trainingEndTime) { this.trainingEndTime = trainingEndTime; return this; } /** *

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

* * @return

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

*/ public DocumentClassifierInputDataConfig getInputDataConfig() { return inputDataConfig; } /** *

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

* * @param inputDataConfig

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

*/ public void setInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig) { this.inputDataConfig = 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. * * @param inputDataConfig

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

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withInputDataConfig( DocumentClassifierInputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; return this; } /** *

* Provides output results configuration parameters for custom classifier * jobs. *

* * @return

* Provides output results configuration parameters for custom * classifier jobs. *

*/ public DocumentClassifierOutputDataConfig getOutputDataConfig() { return outputDataConfig; } /** *

* Provides output results configuration parameters for custom classifier * jobs. *

* * @param outputDataConfig

* Provides output results configuration parameters for custom * classifier jobs. *

*/ public void setOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** *

* Provides output results configuration parameters for custom classifier * jobs. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param outputDataConfig

* Provides output results configuration parameters for custom * classifier jobs. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withOutputDataConfig( DocumentClassifierOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; return this; } /** *

* 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. *

* * @return

* 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() { return 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. *

* * @param 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 setClassifierMetadata(ClassifierMetadata classifierMetadata) { this.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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withClassifierMetadata(ClassifierMetadata classifierMetadata) { this.classifierMetadata = classifierMetadata; return this; } /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
* * @return

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *

*/ public String getDataAccessRoleArn() { return dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of the IAM role that grants Amazon * Comprehend read access to your input data. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. *

*/ public void setDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; } /** *

* The Amazon Resource Name (ARN) of the 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/.+
* * @param dataAccessRoleArn

* The Amazon Resource Name (ARN) of the IAM role that grants * Amazon Comprehend read access to your input data. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; return this; } /** *

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

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @return

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

* */ public String getVolumeKmsKeyId() { return 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: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param 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: *

* */ public void setVolumeKmsKeyId(String volumeKmsKeyId) { this.volumeKmsKeyId = 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: *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param 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: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withVolumeKmsKeyId(String volumeKmsKeyId) { this.volumeKmsKeyId = volumeKmsKeyId; return this; } /** *

* 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. *

* * @return

* 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() { return 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. *

* * @param 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 void setVpcConfig(VpcConfig vpcConfig) { this.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. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withVpcConfig(VpcConfig vpcConfig) { this.vpcConfig = vpcConfig; return this; } /** *

* 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 * * @return

* 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 DocumentClassifierMode */ public String getMode() { return 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 * * @param 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 DocumentClassifierMode */ public void setMode(String mode) { this.mode = 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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see DocumentClassifierMode */ public DocumentClassifierProperties withMode(String mode) { this.mode = mode; return this; } /** *

* 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 * * @param 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 DocumentClassifierMode */ public void setMode(DocumentClassifierMode mode) { this.mode = mode.toString(); } /** *

* 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 * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. * @see DocumentClassifierMode */ public DocumentClassifierProperties withMode(DocumentClassifierMode mode) { this.mode = mode.toString(); return this; } /** *

* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom * models. The ModelKmsKeyId can be either of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @return

* ID for the KMS key that Amazon Comprehend uses to encrypt trained * custom models. The ModelKmsKeyId can be either of the following * formats: *

* */ public String getModelKmsKeyId() { return modelKmsKeyId; } /** *

* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom * models. The ModelKmsKeyId can be either of the following formats: *

* *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param modelKmsKeyId

* ID for the KMS key that Amazon Comprehend uses to encrypt * trained custom models. The ModelKmsKeyId can be either of the * following formats: *

* */ public void setModelKmsKeyId(String modelKmsKeyId) { this.modelKmsKeyId = modelKmsKeyId; } /** *

* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom * models. The ModelKmsKeyId can be either of the following formats: *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
* * @param modelKmsKeyId

* ID for the KMS key that Amazon Comprehend uses to encrypt * trained custom models. The ModelKmsKeyId can be either of the * following formats: *

* * @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withModelKmsKeyId(String modelKmsKeyId) { this.modelKmsKeyId = modelKmsKeyId; return this; } /** *

* The version name that you assigned to the document classifier. *

*

* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
* * @return

* The version name that you assigned to the document classifier. *

*/ public String getVersionName() { return versionName; } /** *

* The version name that you assigned to the document classifier. *

*

* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
* * @param versionName

* The version name that you assigned to the document classifier. *

*/ public void setVersionName(String versionName) { this.versionName = versionName; } /** *

* The version name that you assigned to the document classifier. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
* * @param versionName

* The version name that you assigned to the document classifier. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withVersionName(String versionName) { this.versionName = versionName; return this; } /** *

* 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. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @return

* 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. *

*/ public String getSourceModelArn() { return 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. *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document * -classifier * /[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param 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. *

*/ public void setSourceModelArn(String sourceModelArn) { this.sourceModelArn = 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 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])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withSourceModelArn(String sourceModelArn) { this.sourceModelArn = sourceModelArn; return this; } /** *

* The Amazon Resource Number (ARN) of the flywheel *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel * /[a-zA-Z0-9](-*[a-zA-Z0-9])*
* * @return

* The Amazon Resource Number (ARN) of the flywheel *

*/ public String getFlywheelArn() { return flywheelArn; } /** *

* The Amazon Resource Number (ARN) of the flywheel *

*

* Constraints:
* Length: - 256
* Pattern: * arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel * /[a-zA-Z0-9](-*[a-zA-Z0-9])*
* * @param flywheelArn

* The Amazon Resource Number (ARN) of the flywheel *

*/ public void setFlywheelArn(String flywheelArn) { this.flywheelArn = flywheelArn; } /** *

* The Amazon Resource Number (ARN) of the flywheel *

*

* 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}:flywheel * /[a-zA-Z0-9](-*[a-zA-Z0-9])*
* * @param flywheelArn

* The Amazon Resource Number (ARN) of the flywheel *

* @return A reference to this updated object so that method calls can be * chained together. */ public DocumentClassifierProperties withFlywheelArn(String flywheelArn) { this.flywheelArn = flywheelArn; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDocumentClassifierArn() != null) sb.append("DocumentClassifierArn: " + getDocumentClassifierArn() + ","); if (getLanguageCode() != null) sb.append("LanguageCode: " + getLanguageCode() + ","); if (getStatus() != null) sb.append("Status: " + getStatus() + ","); if (getMessage() != null) sb.append("Message: " + getMessage() + ","); if (getSubmitTime() != null) sb.append("SubmitTime: " + getSubmitTime() + ","); if (getEndTime() != null) sb.append("EndTime: " + getEndTime() + ","); if (getTrainingStartTime() != null) sb.append("TrainingStartTime: " + getTrainingStartTime() + ","); if (getTrainingEndTime() != null) sb.append("TrainingEndTime: " + getTrainingEndTime() + ","); if (getInputDataConfig() != null) sb.append("InputDataConfig: " + getInputDataConfig() + ","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: " + getOutputDataConfig() + ","); if (getClassifierMetadata() != null) sb.append("ClassifierMetadata: " + getClassifierMetadata() + ","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: " + getDataAccessRoleArn() + ","); if (getVolumeKmsKeyId() != null) sb.append("VolumeKmsKeyId: " + getVolumeKmsKeyId() + ","); if (getVpcConfig() != null) sb.append("VpcConfig: " + getVpcConfig() + ","); if (getMode() != null) sb.append("Mode: " + getMode() + ","); if (getModelKmsKeyId() != null) sb.append("ModelKmsKeyId: " + getModelKmsKeyId() + ","); if (getVersionName() != null) sb.append("VersionName: " + getVersionName() + ","); if (getSourceModelArn() != null) sb.append("SourceModelArn: " + getSourceModelArn() + ","); if (getFlywheelArn() != null) sb.append("FlywheelArn: " + getFlywheelArn()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDocumentClassifierArn() == null) ? 0 : getDocumentClassifierArn().hashCode()); hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getMessage() == null) ? 0 : getMessage().hashCode()); hashCode = prime * hashCode + ((getSubmitTime() == null) ? 0 : getSubmitTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); hashCode = prime * hashCode + ((getTrainingStartTime() == null) ? 0 : getTrainingStartTime().hashCode()); hashCode = prime * hashCode + ((getTrainingEndTime() == null) ? 0 : getTrainingEndTime().hashCode()); hashCode = prime * hashCode + ((getInputDataConfig() == null) ? 0 : getInputDataConfig().hashCode()); hashCode = prime * hashCode + ((getOutputDataConfig() == null) ? 0 : getOutputDataConfig().hashCode()); hashCode = prime * hashCode + ((getClassifierMetadata() == null) ? 0 : getClassifierMetadata().hashCode()); hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode()); hashCode = prime * hashCode + ((getVolumeKmsKeyId() == null) ? 0 : getVolumeKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getVpcConfig() == null) ? 0 : getVpcConfig().hashCode()); hashCode = prime * hashCode + ((getMode() == null) ? 0 : getMode().hashCode()); hashCode = prime * hashCode + ((getModelKmsKeyId() == null) ? 0 : getModelKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode()); hashCode = prime * hashCode + ((getSourceModelArn() == null) ? 0 : getSourceModelArn().hashCode()); hashCode = prime * hashCode + ((getFlywheelArn() == null) ? 0 : getFlywheelArn().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DocumentClassifierProperties == false) return false; DocumentClassifierProperties other = (DocumentClassifierProperties) obj; if (other.getDocumentClassifierArn() == null ^ this.getDocumentClassifierArn() == null) return false; if (other.getDocumentClassifierArn() != null && other.getDocumentClassifierArn().equals(this.getDocumentClassifierArn()) == false) return false; if (other.getLanguageCode() == null ^ this.getLanguageCode() == null) return false; if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getMessage() == null ^ this.getMessage() == null) return false; if (other.getMessage() != null && other.getMessage().equals(this.getMessage()) == false) return false; if (other.getSubmitTime() == null ^ this.getSubmitTime() == null) return false; if (other.getSubmitTime() != null && other.getSubmitTime().equals(this.getSubmitTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; if (other.getTrainingStartTime() == null ^ this.getTrainingStartTime() == null) return false; if (other.getTrainingStartTime() != null && other.getTrainingStartTime().equals(this.getTrainingStartTime()) == false) return false; if (other.getTrainingEndTime() == null ^ this.getTrainingEndTime() == null) return false; if (other.getTrainingEndTime() != null && other.getTrainingEndTime().equals(this.getTrainingEndTime()) == false) return false; if (other.getInputDataConfig() == null ^ this.getInputDataConfig() == null) return false; if (other.getInputDataConfig() != null && other.getInputDataConfig().equals(this.getInputDataConfig()) == false) return false; if (other.getOutputDataConfig() == null ^ this.getOutputDataConfig() == null) return false; if (other.getOutputDataConfig() != null && other.getOutputDataConfig().equals(this.getOutputDataConfig()) == false) return false; if (other.getClassifierMetadata() == null ^ this.getClassifierMetadata() == null) return false; if (other.getClassifierMetadata() != null && other.getClassifierMetadata().equals(this.getClassifierMetadata()) == false) return false; if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null) return false; if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false) return false; if (other.getVolumeKmsKeyId() == null ^ this.getVolumeKmsKeyId() == null) return false; if (other.getVolumeKmsKeyId() != null && other.getVolumeKmsKeyId().equals(this.getVolumeKmsKeyId()) == false) return false; if (other.getVpcConfig() == null ^ this.getVpcConfig() == null) return false; if (other.getVpcConfig() != null && other.getVpcConfig().equals(this.getVpcConfig()) == false) return false; if (other.getMode() == null ^ this.getMode() == null) return false; if (other.getMode() != null && other.getMode().equals(this.getMode()) == false) return false; if (other.getModelKmsKeyId() == null ^ this.getModelKmsKeyId() == null) return false; if (other.getModelKmsKeyId() != null && other.getModelKmsKeyId().equals(this.getModelKmsKeyId()) == false) return false; if (other.getVersionName() == null ^ this.getVersionName() == null) return false; if (other.getVersionName() != null && other.getVersionName().equals(this.getVersionName()) == false) return false; if (other.getSourceModelArn() == null ^ this.getSourceModelArn() == null) return false; if (other.getSourceModelArn() != null && other.getSourceModelArn().equals(this.getSourceModelArn()) == false) return false; if (other.getFlywheelArn() == null ^ this.getFlywheelArn() == null) return false; if (other.getFlywheelArn() != null && other.getFlywheelArn().equals(this.getFlywheelArn()) == false) return false; return true; } }