/* * 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; /** *

* Describes information about an entity recognizer. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class EntityRecognizerProperties implements Serializable, Cloneable, StructuredPojo { /** *

* The Amazon Resource Name (ARN) that identifies the entity recognizer. *

*/ private String entityRecognizerArn; /** *

* The language of the input documents. All documents must be in the same language. Only English ("en") is currently * supported. *

*/ private String languageCode; /** *

* Provides the status of the entity recognizer. *

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

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

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

* */ private String modelKmsKeyId; /** *

* The version name you assigned to the entity recognizer. *

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

*/ private String sourceModelArn; /** *

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

*/ private String flywheelArn; /** *

* Output data configuration. *

*/ private EntityRecognizerOutputDataConfig outputDataConfig; /** *

* The Amazon Resource Name (ARN) that identifies the entity recognizer. *

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

* * @return The Amazon Resource Name (ARN) that identifies the entity recognizer. */ public String getEntityRecognizerArn() { return this.entityRecognizerArn; } /** *

* The Amazon Resource Name (ARN) that identifies the entity recognizer. *

* * @param entityRecognizerArn * The Amazon Resource Name (ARN) that identifies the entity recognizer. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withEntityRecognizerArn(String entityRecognizerArn) { setEntityRecognizerArn(entityRecognizerArn); return this; } /** *

* The language of the input documents. All documents must be in the same language. Only English ("en") is currently * supported. *

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

* * @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 this.languageCode; } /** *

* The language of the input documents. All documents must be in the same language. Only English ("en") is currently * supported. *

* * @param languageCode * The language of the input documents. All documents must be in the same language. Only English ("en") is * currently supported. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public EntityRecognizerProperties withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** *

* The language of the input documents. All documents must be in the same language. Only English ("en") is currently * supported. *

* * @param languageCode * The language of the input documents. All documents must be in the same language. Only English ("en") is * currently supported. * @return Returns a reference to this 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. *

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

* * @return Provides the status of the entity recognizer. * @see ModelStatus */ public String getStatus() { return this.status; } /** *

* Provides the status of the entity recognizer. *

* * @param status * Provides the status of the entity recognizer. * @return Returns a reference to this object so that method calls can be chained together. * @see ModelStatus */ public EntityRecognizerProperties withStatus(String status) { setStatus(status); return this; } /** *

* Provides the status of the entity recognizer. *

* * @param status * Provides the status of the entity recognizer. * @return Returns a reference to this 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. *

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

* * @return A description of the status of the recognizer. */ public String getMessage() { return this.message; } /** *

* A description of the status of the recognizer. *

* * @param message * A description of the status of the recognizer. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withMessage(String message) { setMessage(message); return this; } /** *

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

* * @return The time that the recognizer was submitted for processing. */ public java.util.Date getSubmitTime() { return this.submitTime; } /** *

* The time that the recognizer was submitted for processing. *

* * @param submitTime * The time that the recognizer was submitted for processing. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** *

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

* * @return The time that the recognizer creation completed. */ public java.util.Date getEndTime() { return this.endTime; } /** *

* The time that the recognizer creation completed. *

* * @param endTime * The time that the recognizer creation completed. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** *

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

* * @return The time that training of the entity recognizer started. */ public java.util.Date getTrainingStartTime() { return this.trainingStartTime; } /** *

* The time that training of the entity recognizer started. *

* * @param trainingStartTime * The time that training of the entity recognizer started. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withTrainingStartTime(java.util.Date trainingStartTime) { setTrainingStartTime(trainingStartTime); return this; } /** *

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

* * @return The time that training of the entity recognizer was completed. */ public java.util.Date getTrainingEndTime() { return this.trainingEndTime; } /** *

* The time that training of the entity recognizer was completed. *

* * @param trainingEndTime * The time that training of the entity recognizer was completed. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withTrainingEndTime(java.util.Date trainingEndTime) { setTrainingEndTime(trainingEndTime); return this; } /** *

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

* * @return The input data properties of an entity recognizer. */ public EntityRecognizerInputDataConfig getInputDataConfig() { return this.inputDataConfig; } /** *

* The input data properties of an entity recognizer. *

* * @param inputDataConfig * The input data properties of an entity recognizer. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** *

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

* * @return Provides information about an entity recognizer. */ public EntityRecognizerMetadata getRecognizerMetadata() { return this.recognizerMetadata; } /** *

* Provides information about an entity recognizer. *

* * @param recognizerMetadata * Provides information about an entity recognizer. * @return Returns a reference to this object so that method calls can be chained together. */ public EntityRecognizerProperties withRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata) { setRecognizerMetadata(recognizerMetadata); 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 EntityRecognizerProperties 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: *

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

*