/* * Copyright 2018-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; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Provides information about a document classifier. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DocumentClassifierProperties implements Serializable, Cloneable, StructuredPojo { /** ** The Amazon Resource Name (ARN) that identifies the document classifier. *
*/ private String documentClassifierArn; /** ** The language code for the language of the documents that the classifier was trained on. *
*/ 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.
*
* 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. *
*/ 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: *
*
* 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"
*
* 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. *
*/ 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: *
*
* 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"
*
* The version name that you assigned to the document classifier. *
*/ 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. *
*/ private String sourceModelArn; /** ** The Amazon Resource Number (ARN) of the flywheel *
*/ private String flywheelArn; /** ** The Amazon Resource Name (ARN) that identifies the document classifier. *
* * @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. *
* * @return The Amazon Resource Name (ARN) that identifies the document classifier. */ public String getDocumentClassifierArn() { return this.documentClassifierArn; } /** ** The Amazon Resource Name (ARN) that identifies the document classifier. *
* * @param documentClassifierArn * The Amazon Resource Name (ARN) that identifies the document classifier. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withDocumentClassifierArn(String documentClassifierArn) { setDocumentClassifierArn(documentClassifierArn); return this; } /** ** The language code for the language of the documents that the classifier was trained on. *
* * @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. *
* * @return The language code for the language of the documents that the classifier was trained on. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** ** The language code for the language of the documents that the classifier was trained on. *
* * @param languageCode * The language code for the language of the documents that the classifier was trained on. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public DocumentClassifierProperties withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** ** The language code for the language of the documents that the classifier was trained on. *
* * @param languageCode * The language code for the language of the documents that the classifier was trained on. * @return Returns a reference to this 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.
*
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.
*
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 this.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.
*
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 Returns a reference to this object so that method calls can be chained together.
* @see ModelStatus
*/
public DocumentClassifierProperties withStatus(String status) {
setStatus(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.
*
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 Returns a reference to this 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. *
* * @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. *
* * @return Additional information about the status of the classifier. */ public String getMessage() { return this.message; } /** ** Additional information about the status of the classifier. *
* * @param message * Additional information about the status of the classifier. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withMessage(String message) { setMessage(message); return this; } /** ** 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. *
* * @return The time that the document classifier was submitted for training. */ public java.util.Date getSubmitTime() { return this.submitTime; } /** ** The time that the document classifier was submitted for training. *
* * @param submitTime * The time that the document classifier was submitted for training. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** ** 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. *
* * @return The time that training the document classifier completed. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The time that training the document classifier completed. *
* * @param endTime * The time that training the document classifier completed. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withEndTime(java.util.Date endTime) { setEndTime(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. *
* * @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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withTrainingStartTime(java.util.Date trainingStartTime) { setTrainingStartTime(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. *
* * @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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withTrainingEndTime(java.util.Date trainingEndTime) { setTrainingEndTime(trainingEndTime); return this; } /** ** 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. *
* * @return The input data configuration that you supplied when you created the document classifier for training. */ public DocumentClassifierInputDataConfig getInputDataConfig() { return this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withInputDataConfig(DocumentClassifierInputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** ** 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. *
* * @return Provides output results configuration parameters for custom classifier jobs. */ public DocumentClassifierOutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** ** Provides output results configuration parameters for custom classifier jobs. *
* * @param outputDataConfig * Provides output results configuration parameters for custom classifier jobs. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withOutputDataConfig(DocumentClassifierOutputDataConfig outputDataConfig) { setOutputDataConfig(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. *
* * @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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withClassifierMetadata(ClassifierMetadata classifierMetadata) { setClassifierMetadata(classifierMetadata); return this; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *
* * @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. *
* * @return The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input * data. */ public String getDataAccessRoleArn() { return this.dataAccessRoleArn; } /** ** The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. *
* * @param dataAccessRoleArn * The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input * data. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(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: *
*
* 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"
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on * the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can * be either of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* 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"
*
* ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on * the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can * be either of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* 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"
*
* 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. *
* * @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 this.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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withVpcConfig(VpcConfig vpcConfig) { setVpcConfig(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. *
* * @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. *
* * @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 this.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. *
* * @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 Returns a reference to this object so that method calls can be chained together. * @see DocumentClassifierMode */ public DocumentClassifierProperties withMode(String mode) { setMode(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. *
* * @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 Returns a reference to this 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: *
*
* 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"
*
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either * of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* 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"
*
* ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId can be either * of the following formats: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* 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"
*
* The version name that you assigned to the document classifier. *
* * @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. *
* * @return The version name that you assigned to the document classifier. */ public String getVersionName() { return this.versionName; } /** ** The version name that you assigned to the document classifier. *
* * @param versionName * The version name that you assigned to the document classifier. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withVersionName(String versionName) { setVersionName(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. *
* * @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. *
* * @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 this.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. *
* * @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 Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withSourceModelArn(String sourceModelArn) { setSourceModelArn(sourceModelArn); return this; } /** ** The Amazon Resource Number (ARN) of the flywheel *
* * @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 *
* * @return The Amazon Resource Number (ARN) of the flywheel */ public String getFlywheelArn() { return this.flywheelArn; } /** ** The Amazon Resource Number (ARN) of the flywheel *
* * @param flywheelArn * The Amazon Resource Number (ARN) of the flywheel * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentClassifierProperties withFlywheelArn(String flywheelArn) { setFlywheelArn(flywheelArn); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getDocumentClassifierArn()).append(","); if (getLanguageCode() != null) sb.append("LanguageCode: ").append(getLanguageCode()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getMessage() != null) sb.append("Message: ").append(getMessage()).append(","); if (getSubmitTime() != null) sb.append("SubmitTime: ").append(getSubmitTime()).append(","); if (getEndTime() != null) sb.append("EndTime: ").append(getEndTime()).append(","); if (getTrainingStartTime() != null) sb.append("TrainingStartTime: ").append(getTrainingStartTime()).append(","); if (getTrainingEndTime() != null) sb.append("TrainingEndTime: ").append(getTrainingEndTime()).append(","); if (getInputDataConfig() != null) sb.append("InputDataConfig: ").append(getInputDataConfig()).append(","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: ").append(getOutputDataConfig()).append(","); if (getClassifierMetadata() != null) sb.append("ClassifierMetadata: ").append("***Sensitive Data Redacted***").append(","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: ").append(getDataAccessRoleArn()).append(","); if (getVolumeKmsKeyId() != null) sb.append("VolumeKmsKeyId: ").append(getVolumeKmsKeyId()).append(","); if (getVpcConfig() != null) sb.append("VpcConfig: ").append(getVpcConfig()).append(","); if (getMode() != null) sb.append("Mode: ").append(getMode()).append(","); if (getModelKmsKeyId() != null) sb.append("ModelKmsKeyId: ").append(getModelKmsKeyId()).append(","); if (getVersionName() != null) sb.append("VersionName: ").append(getVersionName()).append(","); if (getSourceModelArn() != null) sb.append("SourceModelArn: ").append(getSourceModelArn()).append(","); if (getFlywheelArn() != null) sb.append("FlywheelArn: ").append(getFlywheelArn()); sb.append("}"); return sb.toString(); } @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; } @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 DocumentClassifierProperties clone() { try { return (DocumentClassifierProperties) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.comprehend.model.transform.DocumentClassifierPropertiesMarshaller.getInstance().marshall(this, protocolMarshaller); } }