@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class KeyPhrasesDetectionJobProperties extends Object implements Serializable, Cloneable, StructuredPojo
Provides information about a key phrases detection job.
Constructor and Description |
---|
KeyPhrasesDetectionJobProperties() |
Modifier and Type | Method and Description |
---|---|
KeyPhrasesDetectionJobProperties |
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 key phrases detection job completed.
|
InputDataConfig |
getInputDataConfig()
The input data configuration that you supplied when you created the key phrases detection job.
|
String |
getJobArn()
The Amazon Resource Name (ARN) of the key phrases detection job.
|
String |
getJobId()
The identifier assigned to the key phrases detection job.
|
String |
getJobName()
The name that you assigned the key phrases detection job.
|
String |
getJobStatus()
The current status of the key phrases 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 key phrases detection job.
|
Date |
getSubmitTime()
The time that the key phrases detection job was submitted for processing.
|
String |
getVolumeKmsKeyId()
ID for the 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 key phrases 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 key phrases detection job completed.
|
void |
setInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the key phrases detection job.
|
void |
setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the key phrases detection job.
|
void |
setJobId(String jobId)
The identifier assigned to the key phrases detection job.
|
void |
setJobName(String jobName)
The name that you assigned the key phrases detection job.
|
void |
setJobStatus(String jobStatus)
The current status of the key phrases 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 key phrases detection job.
|
void |
setSubmitTime(Date submitTime)
The time that the key phrases detection job was submitted for processing.
|
void |
setVolumeKmsKeyId(String volumeKmsKeyId)
ID for the 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 key phrases detection job.
|
String |
toString()
Returns a string representation of this object.
|
KeyPhrasesDetectionJobProperties |
withDataAccessRoleArn(String dataAccessRoleArn)
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
|
KeyPhrasesDetectionJobProperties |
withEndTime(Date endTime)
The time that the key phrases detection job completed.
|
KeyPhrasesDetectionJobProperties |
withInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withJobId(String jobId)
The identifier assigned to the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withJobName(String jobName)
The name that you assigned the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withJobStatus(JobStatus jobStatus)
The current status of the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withJobStatus(String jobStatus)
The current status of the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withLanguageCode(LanguageCode languageCode)
The language code of the input documents.
|
KeyPhrasesDetectionJobProperties |
withLanguageCode(String languageCode)
The language code of the input documents.
|
KeyPhrasesDetectionJobProperties |
withMessage(String message)
A description of the status of a job.
|
KeyPhrasesDetectionJobProperties |
withOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the key phrases detection job.
|
KeyPhrasesDetectionJobProperties |
withSubmitTime(Date submitTime)
The time that the key phrases detection job was submitted for processing.
|
KeyPhrasesDetectionJobProperties |
withVolumeKmsKeyId(String volumeKmsKeyId)
ID for the 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.
|
KeyPhrasesDetectionJobProperties |
withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
your key phrases detection job.
|
public void setJobId(String jobId)
The identifier assigned to the key phrases detection job.
jobId
- The identifier assigned to the key phrases detection job.public String getJobId()
The identifier assigned to the key phrases detection job.
public KeyPhrasesDetectionJobProperties withJobId(String jobId)
The identifier assigned to the key phrases detection job.
jobId
- The identifier assigned to the key phrases detection job.public void setJobArn(String jobArn)
The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
jobArn
- The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
public String getJobArn()
The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
public KeyPhrasesDetectionJobProperties withJobArn(String jobArn)
The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
jobArn
- The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab
public void setJobName(String jobName)
The name that you assigned the key phrases detection job.
jobName
- The name that you assigned the key phrases detection job.public String getJobName()
The name that you assigned the key phrases detection job.
public KeyPhrasesDetectionJobProperties withJobName(String jobName)
The name that you assigned the key phrases detection job.
jobName
- The name that you assigned the key phrases detection job.public void setJobStatus(String jobStatus)
The current status of the key phrases detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
jobStatus
- The current status of the key phrases 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 key phrases 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 KeyPhrasesDetectionJobProperties withJobStatus(String jobStatus)
The current status of the key phrases detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
jobStatus
- The current status of the key phrases detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.JobStatus
public KeyPhrasesDetectionJobProperties withJobStatus(JobStatus jobStatus)
The current status of the key phrases detection job. If the status is FAILED
, the
Message
field shows the reason for the failure.
jobStatus
- The current status of the key phrases 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 KeyPhrasesDetectionJobProperties 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 key phrases detection job was submitted for processing.
submitTime
- The time that the key phrases detection job was submitted for processing.public Date getSubmitTime()
The time that the key phrases detection job was submitted for processing.
public KeyPhrasesDetectionJobProperties withSubmitTime(Date submitTime)
The time that the key phrases detection job was submitted for processing.
submitTime
- The time that the key phrases detection job was submitted for processing.public void setEndTime(Date endTime)
The time that the key phrases detection job completed.
endTime
- The time that the key phrases detection job completed.public Date getEndTime()
The time that the key phrases detection job completed.
public KeyPhrasesDetectionJobProperties withEndTime(Date endTime)
The time that the key phrases detection job completed.
endTime
- The time that the key phrases detection job completed.public void setInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the key phrases detection job.
inputDataConfig
- The input data configuration that you supplied when you created the key phrases detection job.public InputDataConfig getInputDataConfig()
The input data configuration that you supplied when you created the key phrases detection job.
public KeyPhrasesDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig)
The input data configuration that you supplied when you created the key phrases detection job.
inputDataConfig
- The input data configuration that you supplied when you created the key phrases detection job.public void setOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the key phrases detection job.
outputDataConfig
- The output data configuration that you supplied when you created the key phrases detection job.public OutputDataConfig getOutputDataConfig()
The output data configuration that you supplied when you created the key phrases detection job.
public KeyPhrasesDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig)
The output data configuration that you supplied when you created the key phrases detection job.
outputDataConfig
- The output data configuration that you supplied when you created the key phrases 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 KeyPhrasesDetectionJobProperties withLanguageCode(String languageCode)
The language code of the input documents.
languageCode
- The language code of the input documents.LanguageCode
public KeyPhrasesDetectionJobProperties 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 KeyPhrasesDetectionJobProperties 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 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 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 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 KeyPhrasesDetectionJobProperties withVolumeKmsKeyId(String volumeKmsKeyId)
ID for the 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 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 key phrases 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 key phrases 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 key phrases detection job. For more information, see Amazon VPC.
public KeyPhrasesDetectionJobProperties withVpcConfig(VpcConfig vpcConfig)
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases 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 key phrases detection job. For more information, see Amazon VPC.public String toString()
toString
in class Object
Object.toString()
public KeyPhrasesDetectionJobProperties clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.