public class EntityRecognizerProperties
extends java.lang.Object
implements java.io.Serializable
Describes information about an entity recognizer.
Constructor and Description |
---|
EntityRecognizerProperties() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
java.util.Date |
getEndTime()
The time that the recognizer creation completed.
|
java.lang.String |
getEntityRecognizerArn()
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
EntityRecognizerInputDataConfig |
getInputDataConfig()
The input data properties of an entity recognizer.
|
java.lang.String |
getLanguageCode()
The language of the input documents.
|
java.lang.String |
getMessage()
A description of the status of the recognizer.
|
EntityRecognizerMetadata |
getRecognizerMetadata()
Provides information about an entity recognizer.
|
java.lang.String |
getStatus()
Provides the status of the entity recognizer.
|
java.util.Date |
getSubmitTime()
The time that the recognizer was submitted for processing.
|
java.util.Date |
getTrainingEndTime()
The time that training of the entity recognizer was completed.
|
java.util.Date |
getTrainingStartTime()
The time that training of the entity recognizer started.
|
java.lang.String |
getVolumeKmsKeyId()
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job.
|
VpcConfig |
getVpcConfig()
Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your custom entity recognizer.
|
int |
hashCode() |
void |
setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
void |
setEndTime(java.util.Date endTime)
The time that the recognizer creation completed.
|
void |
setEntityRecognizerArn(java.lang.String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
void |
setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
The input data properties of an entity recognizer.
|
void |
setLanguageCode(LanguageCode languageCode)
The language of the input documents.
|
void |
setLanguageCode(java.lang.String languageCode)
The language of the input documents.
|
void |
setMessage(java.lang.String message)
A description of the status of the recognizer.
|
void |
setRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
Provides information about an entity recognizer.
|
void |
setStatus(ModelStatus status)
Provides the status of the entity recognizer.
|
void |
setStatus(java.lang.String status)
Provides the status of the entity recognizer.
|
void |
setSubmitTime(java.util.Date submitTime)
The time that the recognizer was submitted for processing.
|
void |
setTrainingEndTime(java.util.Date trainingEndTime)
The time that training of the entity recognizer was completed.
|
void |
setTrainingStartTime(java.util.Date trainingStartTime)
The time that training of the entity recognizer started.
|
void |
setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job.
|
void |
setVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your custom entity recognizer.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EntityRecognizerProperties |
withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM)
role that grants Amazon Comprehend read access to your input data.
|
EntityRecognizerProperties |
withEndTime(java.util.Date endTime)
The time that the recognizer creation completed.
|
EntityRecognizerProperties |
withEntityRecognizerArn(java.lang.String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
EntityRecognizerProperties |
withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
The input data properties of an entity recognizer.
|
EntityRecognizerProperties |
withLanguageCode(LanguageCode languageCode)
The language of the input documents.
|
EntityRecognizerProperties |
withLanguageCode(java.lang.String languageCode)
The language of the input documents.
|
EntityRecognizerProperties |
withMessage(java.lang.String message)
A description of the status of the recognizer.
|
EntityRecognizerProperties |
withRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
Provides information about an entity recognizer.
|
EntityRecognizerProperties |
withStatus(ModelStatus status)
Provides the status of the entity recognizer.
|
EntityRecognizerProperties |
withStatus(java.lang.String status)
Provides the status of the entity recognizer.
|
EntityRecognizerProperties |
withSubmitTime(java.util.Date submitTime)
The time that the recognizer was submitted for processing.
|
EntityRecognizerProperties |
withTrainingEndTime(java.util.Date trainingEndTime)
The time that training of the entity recognizer was completed.
|
EntityRecognizerProperties |
withTrainingStartTime(java.util.Date trainingStartTime)
The time that training of the entity recognizer started.
|
EntityRecognizerProperties |
withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend
uses to encrypt data on the storage volume attached to the ML compute
instance(s) that process the analysis job.
|
EntityRecognizerProperties |
withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your custom entity recognizer.
|
public java.lang.String getEntityRecognizerArn()
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])*
The Amazon Resource Name (ARN) that identifies the entity recognizer.
public void setEntityRecognizerArn(java.lang.String 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])*
entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.
public EntityRecognizerProperties withEntityRecognizerArn(java.lang.String 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])*
entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.
public java.lang.String getLanguageCode()
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
The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
LanguageCode
public void setLanguageCode(java.lang.String 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
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
LanguageCode
public EntityRecognizerProperties withLanguageCode(java.lang.String 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
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
LanguageCode
public void setLanguageCode(LanguageCode 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
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
LanguageCode
public EntityRecognizerProperties withLanguageCode(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
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.
LanguageCode
public java.lang.String getStatus()
Provides the status of the entity recognizer.
Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
STOPPED, IN_ERROR, TRAINED
Provides the status of the entity recognizer.
ModelStatus
public void setStatus(java.lang.String status)
Provides the status of the entity recognizer.
Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
STOPPED, IN_ERROR, TRAINED
status
- Provides the status of the entity recognizer.
ModelStatus
public EntityRecognizerProperties withStatus(java.lang.String 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
status
- Provides the status of the entity recognizer.
ModelStatus
public void setStatus(ModelStatus status)
Provides the status of the entity recognizer.
Constraints:
Allowed Values: SUBMITTED, TRAINING, DELETING, STOP_REQUESTED,
STOPPED, IN_ERROR, TRAINED
status
- Provides the status of the entity recognizer.
ModelStatus
public EntityRecognizerProperties withStatus(ModelStatus 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
status
- Provides the status of the entity recognizer.
ModelStatus
public java.lang.String getMessage()
A description of the status of the recognizer.
A description of the status of the recognizer.
public void setMessage(java.lang.String message)
A description of the status of the recognizer.
message
- A description of the status of the recognizer.
public EntityRecognizerProperties withMessage(java.lang.String message)
A description of the status of the recognizer.
Returns a reference to this object so that method calls can be chained together.
message
- A description of the status of the recognizer.
public java.util.Date getSubmitTime()
The time that the recognizer was submitted for processing.
The time that the recognizer was submitted for processing.
public void setSubmitTime(java.util.Date submitTime)
The time that the recognizer was submitted for processing.
submitTime
- The time that the recognizer was submitted for processing.
public EntityRecognizerProperties withSubmitTime(java.util.Date submitTime)
The time that the recognizer was submitted for processing.
Returns a reference to this object so that method calls can be chained together.
submitTime
- The time that the recognizer was submitted for processing.
public java.util.Date getEndTime()
The time that the recognizer creation completed.
The time that the recognizer creation completed.
public void setEndTime(java.util.Date endTime)
The time that the recognizer creation completed.
endTime
- The time that the recognizer creation completed.
public EntityRecognizerProperties withEndTime(java.util.Date endTime)
The time that the recognizer creation completed.
Returns a reference to this object so that method calls can be chained together.
endTime
- The time that the recognizer creation completed.
public java.util.Date getTrainingStartTime()
The time that training of the entity recognizer started.
The time that training of the entity recognizer started.
public void setTrainingStartTime(java.util.Date trainingStartTime)
The time that training of the entity recognizer started.
trainingStartTime
- The time that training of the entity recognizer started.
public EntityRecognizerProperties withTrainingStartTime(java.util.Date trainingStartTime)
The time that training of the entity recognizer started.
Returns a reference to this object so that method calls can be chained together.
trainingStartTime
- The time that training of the entity recognizer started.
public java.util.Date getTrainingEndTime()
The time that training of the entity recognizer was completed.
The time that training of the entity recognizer was completed.
public void setTrainingEndTime(java.util.Date trainingEndTime)
The time that training of the entity recognizer was completed.
trainingEndTime
- The time that training of the entity recognizer was completed.
public EntityRecognizerProperties withTrainingEndTime(java.util.Date 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.
trainingEndTime
- The time that training of the entity recognizer was completed.
public EntityRecognizerInputDataConfig getInputDataConfig()
The input data properties of an entity recognizer.
The input data properties of an entity recognizer.
public void setInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
The input data properties of an entity recognizer.
inputDataConfig
- The input data properties of an entity recognizer.
public EntityRecognizerProperties withInputDataConfig(EntityRecognizerInputDataConfig inputDataConfig)
The input data properties of an entity recognizer.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig
- The input data properties of an entity recognizer.
public EntityRecognizerMetadata getRecognizerMetadata()
Provides information about an entity recognizer.
Provides information about an entity recognizer.
public void setRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
Provides information about an entity recognizer.
recognizerMetadata
- Provides information about an entity recognizer.
public EntityRecognizerProperties withRecognizerMetadata(EntityRecognizerMetadata recognizerMetadata)
Provides information about an entity recognizer.
Returns a reference to this object so that method calls can be chained together.
recognizerMetadata
- Provides information about an entity recognizer.
public java.lang.String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
Constraints:
Length: 20 - 2048
Pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public EntityRecognizerProperties withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
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/.+
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
public java.lang.String getVolumeKmsKeyId()
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Constraints:
Length: - 2048
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
public void setVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Constraints:
Length: - 2048
volumeKmsKeyId
- ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
public EntityRecognizerProperties withVolumeKmsKeyId(java.lang.String volumeKmsKeyId)
ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: - 2048
volumeKmsKeyId
- ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
public VpcConfig getVpcConfig()
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.
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)
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.
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 EntityRecognizerProperties withVpcConfig(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.
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.