public class EntitiesDetectionJobProperties
extends java.lang.Object
implements java.io.Serializable
Provides information about an entities detection job.
Constructor and Description |
---|
EntitiesDetectionJobProperties() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
|
java.util.Date |
getEndTime()
The time that the entities detection job completed
|
java.lang.String |
getEntityRecognizerArn()
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
InputDataConfig |
getInputDataConfig()
The input data configuration that you supplied when you created the
entities detection job.
|
java.lang.String |
getJobId()
The identifier assigned to the entities detection job.
|
java.lang.String |
getJobName()
The name that you assigned the entities detection job.
|
java.lang.String |
getJobStatus()
The current status of the entities detection job.
|
java.lang.String |
getLanguageCode()
The language code of the input documents.
|
java.lang.String |
getMessage()
A description of the status of a job.
|
OutputDataConfig |
getOutputDataConfig()
The output data configuration that you supplied when you created the
entities detection job.
|
java.util.Date |
getSubmitTime()
The time that the entities detection job was submitted for processing.
|
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 entity detection job.
|
int |
hashCode() |
void |
setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
|
void |
setEndTime(java.util.Date endTime)
The time that the entities detection job completed
|
void |
setEntityRecognizerArn(java.lang.String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
void |
setInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the
entities detection job.
|
void |
setJobId(java.lang.String jobId)
The identifier assigned to the entities detection job.
|
void |
setJobName(java.lang.String jobName)
The name that you assigned the entities detection job.
|
void |
setJobStatus(JobStatus jobStatus)
The current status of the entities detection job.
|
void |
setJobStatus(java.lang.String jobStatus)
The current status of the entities detection job.
|
void |
setLanguageCode(LanguageCode languageCode)
The language code of the input documents.
|
void |
setLanguageCode(java.lang.String languageCode)
The language code of the input documents.
|
void |
setMessage(java.lang.String message)
A description of the status of a job.
|
void |
setOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the
entities detection job.
|
void |
setSubmitTime(java.util.Date submitTime)
The time that the entities detection job was submitted for processing.
|
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 entity detection job.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
EntitiesDetectionJobProperties |
withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access
to your input data.
|
EntitiesDetectionJobProperties |
withEndTime(java.util.Date endTime)
The time that the entities detection job completed
|
EntitiesDetectionJobProperties |
withEntityRecognizerArn(java.lang.String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
EntitiesDetectionJobProperties |
withInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the
entities detection job.
|
EntitiesDetectionJobProperties |
withJobId(java.lang.String jobId)
The identifier assigned to the entities detection job.
|
EntitiesDetectionJobProperties |
withJobName(java.lang.String jobName)
The name that you assigned the entities detection job.
|
EntitiesDetectionJobProperties |
withJobStatus(JobStatus jobStatus)
The current status of the entities detection job.
|
EntitiesDetectionJobProperties |
withJobStatus(java.lang.String jobStatus)
The current status of the entities detection job.
|
EntitiesDetectionJobProperties |
withLanguageCode(LanguageCode languageCode)
The language code of the input documents.
|
EntitiesDetectionJobProperties |
withLanguageCode(java.lang.String languageCode)
The language code of the input documents.
|
EntitiesDetectionJobProperties |
withMessage(java.lang.String message)
A description of the status of a job.
|
EntitiesDetectionJobProperties |
withOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the
entities detection job.
|
EntitiesDetectionJobProperties |
withSubmitTime(java.util.Date submitTime)
The time that the entities detection job was submitted for processing.
|
EntitiesDetectionJobProperties |
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.
|
EntitiesDetectionJobProperties |
withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC)
containing the resources you are using for your entity detection job.
|
public java.lang.String getJobId()
The identifier assigned to the entities detection job.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
The identifier assigned to the entities detection job.
public void setJobId(java.lang.String jobId)
The identifier assigned to the entities detection job.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobId
- The identifier assigned to the entities detection job.
public EntitiesDetectionJobProperties withJobId(java.lang.String jobId)
The identifier assigned to the entities detection job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 32
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobId
- The identifier assigned to the entities detection job.
public java.lang.String getJobName()
The name that you assigned the entities detection job.
Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
The name that you assigned the entities detection job.
public void setJobName(java.lang.String jobName)
The name that you assigned the entities detection job.
Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobName
- The name that you assigned the entities detection job.
public EntitiesDetectionJobProperties withJobName(java.lang.String jobName)
The name that you assigned the entities detection job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$
jobName
- The name that you assigned the entities detection job.
public java.lang.String getJobStatus()
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for
the failure.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
STOP_REQUESTED, STOPPED
The current status of the entities detection job. If the status
is FAILED
, the Message
field shows the
reason for the failure.
JobStatus
public void setJobStatus(java.lang.String jobStatus)
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for
the failure.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
STOP_REQUESTED, STOPPED
jobStatus
-
The current status of the entities detection job. If the
status is FAILED
, the Message
field
shows the reason for the failure.
JobStatus
public EntitiesDetectionJobProperties withJobStatus(java.lang.String jobStatus)
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for
the failure.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
STOP_REQUESTED, STOPPED
jobStatus
-
The current status of the entities detection job. If the
status is FAILED
, the Message
field
shows the reason for the failure.
JobStatus
public void setJobStatus(JobStatus jobStatus)
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for
the failure.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
STOP_REQUESTED, STOPPED
jobStatus
-
The current status of the entities detection job. If the
status is FAILED
, the Message
field
shows the reason for the failure.
JobStatus
public EntitiesDetectionJobProperties withJobStatus(JobStatus jobStatus)
The current status of the entities detection job. If the status is
FAILED
, the Message
field shows the reason for
the failure.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: SUBMITTED, IN_PROGRESS, COMPLETED, FAILED,
STOP_REQUESTED, STOPPED
jobStatus
-
The current status of the entities detection job. If the
status is FAILED
, the Message
field
shows the reason for the failure.
JobStatus
public java.lang.String getMessage()
A description of the status of a job.
A description of the status of a job.
public void setMessage(java.lang.String message)
A description of the status of a job.
message
- A description of the status of a job.
public EntitiesDetectionJobProperties withMessage(java.lang.String message)
A description of the status of a job.
Returns a reference to this object so that method calls can be chained together.
message
- A description of the status of a job.
public java.util.Date getSubmitTime()
The time that the entities detection job was submitted for processing.
The time that the entities detection job was submitted for processing.
public void setSubmitTime(java.util.Date submitTime)
The time that the entities detection job was submitted for processing.
submitTime
- The time that the entities detection job was submitted for processing.
public EntitiesDetectionJobProperties withSubmitTime(java.util.Date submitTime)
The time that the entities detection job was submitted for processing.
Returns a reference to this object so that method calls can be chained together.
submitTime
- The time that the entities detection job was submitted for processing.
public java.util.Date getEndTime()
The time that the entities detection job completed
The time that the entities detection job completed
public void setEndTime(java.util.Date endTime)
The time that the entities detection job completed
endTime
- The time that the entities detection job completed
public EntitiesDetectionJobProperties withEndTime(java.util.Date endTime)
The time that the entities detection job completed
Returns a reference to this object so that method calls can be chained together.
endTime
- The time that the entities detection job completed
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 EntitiesDetectionJobProperties 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 InputDataConfig getInputDataConfig()
The input data configuration that you supplied when you created the entities detection job.
The input data configuration that you supplied when you created the entities detection job.
public void setInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the entities detection job.
inputDataConfig
- The input data configuration that you supplied when you created the entities detection job.
public EntitiesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the entities detection job.
Returns a reference to this object so that method calls can be chained together.
inputDataConfig
- The input data configuration that you supplied when you created the entities detection job.
public OutputDataConfig getOutputDataConfig()
The output data configuration that you supplied when you created the entities detection job.
The output data configuration that you supplied when you created the entities detection job.
public void setOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the entities detection job.
outputDataConfig
- The output data configuration that you supplied when you created the entities detection job.
public EntitiesDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the entities detection job.
Returns a reference to this object so that method calls can be chained together.
outputDataConfig
- The output data configuration that you supplied when you created the entities detection job.
public java.lang.String getLanguageCode()
The language code of the input documents.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
The language code of the input documents.
LanguageCode
public void setLanguageCode(java.lang.String languageCode)
The language code of the input documents.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- The language code of the input documents.
LanguageCode
public EntitiesDetectionJobProperties withLanguageCode(java.lang.String languageCode)
The language code of the input documents.
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 code of the input documents.
LanguageCode
public void setLanguageCode(LanguageCode languageCode)
The language code of the input documents.
Constraints:
Allowed Values: en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
languageCode
- The language code of the input documents.
LanguageCode
public EntitiesDetectionJobProperties withLanguageCode(LanguageCode languageCode)
The language code of the input documents.
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 code of the input documents.
LanguageCode
public java.lang.String getDataAccessRoleArn()
The Amazon Resource Name (ARN) that gives 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) that gives Amazon Comprehend read access to your input data.
public void setDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) that gives 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) that gives Amazon Comprehend read access to your input data.
public EntitiesDetectionJobProperties withDataAccessRoleArn(java.lang.String dataAccessRoleArn)
The Amazon Resource Name (ARN) that gives 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) that gives 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 EntitiesDetectionJobProperties 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 entity detection job. For more information, see Amazon VPC.
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. 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 entity detection job. For more information, see Amazon VPC.
vpcConfig
- Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
public EntitiesDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. 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 entity detection job. 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.