/* * 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; /** *
* Describes information about an entity recognizer. *
*/ public class EntityRecognizerProperties implements Serializable { /** ** The Amazon Resource Name (ARN) that identifies the entity recognizer. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*/
private String entityRecognizerArn;
/**
*
* The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*/
private String languageCode;
/**
*
* Provides the status of the entity recognizer. *
*
* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
* STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
*/
private String status;
/**
*
* A description of the status of the recognizer. *
*/ private String message; /** ** The time that the recognizer was submitted for processing. *
*/ private java.util.Date submitTime; /** ** The time that the recognizer creation completed. *
*/ private java.util.Date endTime; /** ** The time that training of the entity recognizer started. *
*/ private java.util.Date trainingStartTime; /** ** The time that training of the entity recognizer was completed. *
*/ private java.util.Date trainingEndTime; /** ** The input data properties of an entity recognizer. *
*/ private EntityRecognizerInputDataConfig inputDataConfig; /** ** Provides information about an entity recognizer. *
*/ private EntityRecognizerMetadata recognizerMetadata; /** ** 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: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
*/
private String volumeKmsKeyId;
/**
*
* Configuration parameters for a private Virtual Private Cloud (VPC) * containing the resources you are using for your custom entity recognizer. * For more information, see Amazon VPC. *
*/ private VpcConfig vpcConfig; /** ** 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"
*
* Constraints:
* Length: - 2048
* Pattern: ^\p{ASCII}+$
*/
private String modelKmsKeyId;
/**
*
* The version name you assigned to the entity recognizer. *
*
* 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 * entity recognizer model in your Amazon Web Services account. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [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;
/**
*
* Output data configuration. *
*/ private EntityRecognizerOutputDataConfig outputDataConfig; /** ** The Amazon Resource Name (ARN) that identifies the entity recognizer. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [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 entity * recognizer. *
*/ public String getEntityRecognizerArn() { return entityRecognizerArn; } /** ** The Amazon Resource Name (ARN) that identifies the entity recognizer. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*
* @param entityRecognizerArn
* The Amazon Resource Name (ARN) that identifies the entity * recognizer. *
*/ public void setEntityRecognizerArn(String entityRecognizerArn) { this.entityRecognizerArn = entityRecognizerArn; } /** ** The Amazon Resource Name (ARN) that identifies the entity recognizer. *
** 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}:entity
* -recognizer/
* [a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
*
* @param entityRecognizerArn
* The Amazon Resource Name (ARN) that identifies the entity * recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withEntityRecognizerArn(String entityRecognizerArn) { this.entityRecognizerArn = entityRecognizerArn; return this; } /** ** The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @return
* The language of the input documents. All documents must be in the * same language. Only English ("en") is currently supported. *
* @see LanguageCode */ public String getLanguageCode() { return languageCode; } /** ** The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language of the input documents. All documents must be in * the same language. Only English ("en") is currently supported. *
* @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
** 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 of the input documents. All documents must be in * the same language. Only English ("en") is currently supported. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public EntityRecognizerProperties withLanguageCode(String languageCode) { this.languageCode = languageCode; return this; } /** ** The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
*
* Constraints:
* Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
*
* @param languageCode
* The language of the input documents. All documents must be in * the same language. Only English ("en") is currently supported. *
* @see LanguageCode */ public void setLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); } /** ** The language of the input documents. All documents must be in the same * language. Only English ("en") is currently supported. *
** 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 of the input documents. All documents must be in * the same language. Only English ("en") is currently supported. *
* @return A reference to this updated object so that method calls can be * chained together. * @see LanguageCode */ public EntityRecognizerProperties withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); return this; } /** ** Provides the status of the entity recognizer. *
*
* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
* STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
*
* @return
* Provides the status of the entity recognizer. *
* @see ModelStatus */ public String getStatus() { return status; } /** ** Provides the status of the entity recognizer. *
*
* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
* STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
*
* @param status
* Provides the status of the entity recognizer. *
* @see ModelStatus */ public void setStatus(String status) { this.status = status; } /** ** Provides the status of the entity recognizer. *
** 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
* Provides the status of the entity recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ModelStatus */ public EntityRecognizerProperties withStatus(String status) { this.status = status; return this; } /** ** Provides the status of the entity recognizer. *
*
* Constraints:
* Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
* STOPPED, IN_ERROR, TRAINED, TRAINED_WITH_WARNING
*
* @param status
* Provides the status of the entity recognizer. *
* @see ModelStatus */ public void setStatus(ModelStatus status) { this.status = status.toString(); } /** ** Provides the status of the entity recognizer. *
** 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
* Provides the status of the entity recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. * @see ModelStatus */ public EntityRecognizerProperties withStatus(ModelStatus status) { this.status = status.toString(); return this; } /** ** A description of the status of the recognizer. *
* * @return* A description of the status of the recognizer. *
*/ public String getMessage() { return message; } /** ** A description of the status of the recognizer. *
* * @param message* A description of the status of the recognizer. *
*/ public void setMessage(String message) { this.message = message; } /** ** A description of the status of the recognizer. *
** Returns a reference to this object so that method calls can be chained * together. * * @param message
* A description of the status of the recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withMessage(String message) { this.message = message; return this; } /** ** The time that the recognizer was submitted for processing. *
* * @return* The time that the recognizer was submitted for processing. *
*/ public java.util.Date getSubmitTime() { return submitTime; } /** ** The time that the recognizer was submitted for processing. *
* * @param submitTime* The time that the recognizer was submitted for processing. *
*/ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; } /** ** The time that the recognizer was submitted for processing. *
** Returns a reference to this object so that method calls can be chained * together. * * @param submitTime
* The time that the recognizer was submitted for processing. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; return this; } /** ** The time that the recognizer creation completed. *
* * @return* The time that the recognizer creation completed. *
*/ public java.util.Date getEndTime() { return endTime; } /** ** The time that the recognizer creation completed. *
* * @param endTime* The time that the recognizer creation completed. *
*/ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The time that the recognizer creation completed. *
** Returns a reference to this object so that method calls can be chained * together. * * @param endTime
* The time that the recognizer creation completed. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** ** The time that training of the entity recognizer started. *
* * @return* The time that training of the entity recognizer started. *
*/ public java.util.Date getTrainingStartTime() { return trainingStartTime; } /** ** The time that training of the entity recognizer started. *
* * @param trainingStartTime* The time that training of the entity recognizer started. *
*/ public void setTrainingStartTime(java.util.Date trainingStartTime) { this.trainingStartTime = trainingStartTime; } /** ** The time that training of the entity recognizer started. *
** Returns a reference to this object so that method calls can be chained * together. * * @param trainingStartTime
* The time that training of the entity recognizer started. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withTrainingStartTime(java.util.Date trainingStartTime) { this.trainingStartTime = trainingStartTime; return this; } /** ** The time that training of the entity recognizer was completed. *
* * @return* The time that training of the entity recognizer was completed. *
*/ public java.util.Date getTrainingEndTime() { return trainingEndTime; } /** ** The time that training of the entity recognizer was completed. *
* * @param trainingEndTime* The time that training of the entity recognizer was completed. *
*/ public void setTrainingEndTime(java.util.Date trainingEndTime) { this.trainingEndTime = trainingEndTime; } /** ** The time that training of the entity recognizer was completed. *
** Returns a reference to this object so that method calls can be chained * together. * * @param trainingEndTime
* The time that training of the entity recognizer was completed. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withTrainingEndTime(java.util.Date trainingEndTime) { this.trainingEndTime = trainingEndTime; return this; } /** ** The input data properties of an entity recognizer. *
* * @return* The input data properties of an entity recognizer. *
*/ public EntityRecognizerInputDataConfig getInputDataConfig() { return inputDataConfig; } /** ** The input data properties of an entity recognizer. *
* * @param inputDataConfig* The input data properties of an entity recognizer. *
*/ public void setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** ** The input data properties of an entity recognizer. *
** Returns a reference to this object so that method calls can be chained * together. * * @param inputDataConfig
* The input data properties of an entity recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withInputDataConfig( EntityRecognizerInputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; return this; } /** ** Provides information about an entity recognizer. *
* * @return* Provides information about an entity recognizer. *
*/ public EntityRecognizerMetadata getRecognizerMetadata() { return recognizerMetadata; } /** ** Provides information about an entity recognizer. *
* * @param recognizerMetadata* Provides information about an entity recognizer. *
*/ public void setRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata) { this.recognizerMetadata = recognizerMetadata; } /** ** Provides information about an entity recognizer. *
** Returns a reference to this object so that method calls can be chained * together. * * @param recognizerMetadata
* Provides information about an entity recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withRecognizerMetadata( EntityRecognizerMetadata recognizerMetadata) { this.recognizerMetadata = recognizerMetadata; 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 EntityRecognizerProperties 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: *
*
* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Amazon Resource Name (ARN) of a KMS Key:
* "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
*
* Constraints:
* Length: - 2048
* 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: *
*
* 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"
*
* 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: *
*
* 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"
*
* 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: *
*
* 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 entity recognizer. * 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 * entity recognizer. 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 entity recognizer. * 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 * entity recognizer. 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 entity recognizer. * 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 * entity recognizer. For more information, see Amazon VPC. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withVpcConfig(VpcConfig vpcConfig) { this.vpcConfig = vpcConfig; 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"
*
* 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: *
*
* 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"
*
* 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: *
*
* 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"
*
* 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: *
*
* 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 you assigned to the entity recognizer. *
*
* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
*
* @return
* The version name you assigned to the entity recognizer. *
*/ public String getVersionName() { return versionName; } /** ** The version name you assigned to the entity recognizer. *
*
* Constraints:
* Length: - 63
* Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
*
* @param versionName
* The version name you assigned to the entity recognizer. *
*/ public void setVersionName(String versionName) { this.versionName = versionName; } /** ** The version name you assigned to the entity recognizer. *
** 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 you assigned to the entity recognizer. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties 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 * entity recognizer model in your Amazon Web Services account. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [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 entity recognizer 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 * entity recognizer model in your Amazon Web Services account. *
*
* Constraints:
* Length: - 256
* Pattern:
* arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity
* -recognizer/
* [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 entity recognizer 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 * entity recognizer 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}:entity
* -recognizer/
* [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 entity recognizer model in your Amazon Web Services * account. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties 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 EntityRecognizerProperties withFlywheelArn(String flywheelArn) { this.flywheelArn = flywheelArn; return this; } /** ** Output data configuration. *
* * @return* Output data configuration. *
*/ public EntityRecognizerOutputDataConfig getOutputDataConfig() { return outputDataConfig; } /** ** Output data configuration. *
* * @param outputDataConfig* Output data configuration. *
*/ public void setOutputDataConfig(EntityRecognizerOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** ** Output data configuration. *
** Returns a reference to this object so that method calls can be chained * together. * * @param outputDataConfig
* Output data configuration. *
* @return A reference to this updated object so that method calls can be * chained together. */ public EntityRecognizerProperties withOutputDataConfig( EntityRecognizerOutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; 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 (getEntityRecognizerArn() != null) sb.append("EntityRecognizerArn: " + getEntityRecognizerArn() + ","); 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 (getRecognizerMetadata() != null) sb.append("RecognizerMetadata: " + getRecognizerMetadata() + ","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: " + getDataAccessRoleArn() + ","); if (getVolumeKmsKeyId() != null) sb.append("VolumeKmsKeyId: " + getVolumeKmsKeyId() + ","); if (getVpcConfig() != null) sb.append("VpcConfig: " + getVpcConfig() + ","); 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() + ","); if (getOutputDataConfig() != null) sb.append("OutputDataConfig: " + getOutputDataConfig()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getEntityRecognizerArn() == null) ? 0 : getEntityRecognizerArn().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 + ((getRecognizerMetadata() == null) ? 0 : getRecognizerMetadata().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 + ((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()); hashCode = prime * hashCode + ((getOutputDataConfig() == null) ? 0 : getOutputDataConfig().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EntityRecognizerProperties == false) return false; EntityRecognizerProperties other = (EntityRecognizerProperties) obj; if (other.getEntityRecognizerArn() == null ^ this.getEntityRecognizerArn() == null) return false; if (other.getEntityRecognizerArn() != null && other.getEntityRecognizerArn().equals(this.getEntityRecognizerArn()) == 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.getRecognizerMetadata() == null ^ this.getRecognizerMetadata() == null) return false; if (other.getRecognizerMetadata() != null && other.getRecognizerMetadata().equals(this.getRecognizerMetadata()) == 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.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; if (other.getOutputDataConfig() == null ^ this.getOutputDataConfig() == null) return false; if (other.getOutputDataConfig() != null && other.getOutputDataConfig().equals(this.getOutputDataConfig()) == false) return false; return true; } }