@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class EntitiesDetectionJobProperties extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about an entities detection job.
Constructor and Description |
---|
EntitiesDetectionJobProperties() |
Modifier and Type | Method and Description |
---|---|
EntitiesDetectionJobProperties |
clone() |
boolean |
equals(Object obj) |
String |
getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
Date |
getEndTime()
The time that the entities detection job completed
|
String |
getEntityRecognizerArn()
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
String |
getFlywheelArn()
The Amazon Resource Name (ARN) of the flywheel associated with this job.
|
InputDataConfig |
getInputDataConfig()
The input data configuration that you supplied when you created the entities detection job.
|
String |
getJobArn()
The Amazon Resource Name (ARN) of the entities detection job.
|
String |
getJobId()
The identifier assigned to the entities detection job.
|
String |
getJobName()
The name that you assigned the entities detection job.
|
String |
getJobStatus()
The current status of the entities detection job.
|
String |
getLanguageCode()
The language code of the input documents.
|
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.
|
Date |
getSubmitTime()
The time that the entities detection job was submitted for processing.
|
String |
getVolumeKmsKeyId()
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.
|
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
void |
setEndTime(Date endTime)
The time that the entities detection job completed
|
void |
setEntityRecognizerArn(String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
void |
setFlywheelArn(String flywheelArn)
The Amazon Resource Name (ARN) of the flywheel associated with this job.
|
void |
setInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the entities detection job.
|
void |
setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the entities detection job.
|
void |
setJobId(String jobId)
The identifier assigned to the entities detection job.
|
void |
setJobName(String jobName)
The name that you assigned the entities detection job.
|
void |
setJobStatus(String jobStatus)
The current status of the entities detection job.
|
void |
setLanguageCode(String languageCode)
The language code of the input documents.
|
void |
setMessage(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(Date submitTime)
The time that the entities detection job was submitted for processing.
|
void |
setVolumeKmsKeyId(String 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.
|
void |
setVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
your entity detection job.
|
String |
toString()
Returns a string representation of this object.
|
EntitiesDetectionJobProperties |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
EntitiesDetectionJobProperties |
withEndTime(Date endTime)
The time that the entities detection job completed
|
EntitiesDetectionJobProperties |
withEntityRecognizerArn(String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
|
EntitiesDetectionJobProperties |
withFlywheelArn(String flywheelArn)
The Amazon Resource Name (ARN) of the flywheel associated with this job.
|
EntitiesDetectionJobProperties |
withInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the entities detection job.
|
EntitiesDetectionJobProperties |
withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the entities detection job.
|
EntitiesDetectionJobProperties |
withJobId(String jobId)
The identifier assigned to the entities detection job.
|
EntitiesDetectionJobProperties |
withJobName(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(String jobStatus)
The current status of the entities detection job.
|
EntitiesDetectionJobProperties |
withLanguageCode(LanguageCode languageCode)
The language code of the input documents.
|
EntitiesDetectionJobProperties |
withLanguageCode(String languageCode)
The language code of the input documents.
|
EntitiesDetectionJobProperties |
withMessage(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(Date submitTime)
The time that the entities detection job was submitted for processing.
|
EntitiesDetectionJobProperties |
withVolumeKmsKeyId(String 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.
|
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 void setJobId(String jobId)
The identifier assigned to the entities detection job.
jobId
- The identifier assigned to the entities detection job.public String getJobId()
The identifier assigned to the entities detection job.
public EntitiesDetectionJobProperties withJobId(String jobId)
The identifier assigned to the entities detection job.
jobId
- The identifier assigned to the entities detection job.public void setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
jobArn
- The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier
for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
public String getJobArn()
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
public EntitiesDetectionJobProperties withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
jobArn
- The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier
for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab
public void setJobName(String jobName)
The name that you assigned the entities detection job.
jobName
- The name that you assigned the entities detection job.public String getJobName()
The name that you assigned the entities detection job.
public EntitiesDetectionJobProperties withJobName(String jobName)
The name that you assigned the entities detection job.
jobName
- The name that you assigned the entities detection job.public void setJobStatus(String jobStatus)
The current status of the entities detection job. If the status is FAILED
, the Message
field shows the reason for the failure.
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 String getJobStatus()
The current status of the entities detection job. If the status is FAILED
, the Message
field shows the reason for the failure.
FAILED
, the
Message
field shows the reason for the failure.JobStatus
public EntitiesDetectionJobProperties withJobStatus(String jobStatus)
The current status of the entities detection job. If the status is FAILED
, the Message
field shows the reason for the failure.
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.
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 setMessage(String message)
A description of the status of a job.
message
- A description of the status of a job.public String getMessage()
A description of the status of a job.
public EntitiesDetectionJobProperties withMessage(String message)
A description of the status of a job.
message
- A description of the status of a job.public void setSubmitTime(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 Date getSubmitTime()
The time that the entities detection job was submitted for processing.
public EntitiesDetectionJobProperties withSubmitTime(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 void setEndTime(Date endTime)
The time that the entities detection job completed
endTime
- The time that the entities detection job completedpublic Date getEndTime()
The time that the entities detection job completed
public EntitiesDetectionJobProperties withEndTime(Date endTime)
The time that the entities detection job completed
endTime
- The time that the entities detection job completedpublic void setEntityRecognizerArn(String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.public String getEntityRecognizerArn()
The Amazon Resource Name (ARN) that identifies the entity recognizer.
public EntitiesDetectionJobProperties withEntityRecognizerArn(String entityRecognizerArn)
The Amazon Resource Name (ARN) that identifies the entity recognizer.
entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.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 InputDataConfig getInputDataConfig()
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.
inputDataConfig
- The input 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 OutputDataConfig getOutputDataConfig()
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.
outputDataConfig
- The output data configuration that you supplied when you created the entities detection job.public void setLanguageCode(String languageCode)
The language code of the input documents.
languageCode
- The language code of the input documents.LanguageCode
public String getLanguageCode()
The language code of the input documents.
LanguageCode
public EntitiesDetectionJobProperties withLanguageCode(String languageCode)
The language code of the input documents.
languageCode
- The language code of the input documents.LanguageCode
public EntitiesDetectionJobProperties withLanguageCode(LanguageCode languageCode)
The language code of the input documents.
languageCode
- The language code of the input documents.LanguageCode
public void setDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
data.public String getDataAccessRoleArn()
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
public EntitiesDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input
data.public void setVolumeKmsKeyId(String 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"
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"
public String getVolumeKmsKeyId()
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
public EntitiesDetectionJobProperties withVolumeKmsKeyId(String 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"
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"
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 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.
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.
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 void setFlywheelArn(String flywheelArn)
The Amazon Resource Name (ARN) of the flywheel associated with this job.
flywheelArn
- The Amazon Resource Name (ARN) of the flywheel associated with this job.public String getFlywheelArn()
The Amazon Resource Name (ARN) of the flywheel associated with this job.
public EntitiesDetectionJobProperties withFlywheelArn(String flywheelArn)
The Amazon Resource Name (ARN) of the flywheel associated with this job.
flywheelArn
- The Amazon Resource Name (ARN) of the flywheel associated with this job.public String toString()
toString
in class Object
Object.toString()
public EntitiesDetectionJobProperties clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.