/* * 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; /** *
* Provides information about a targeted sentiment detection job. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class TargetedSentimentDetectionJobProperties implements Serializable, Cloneable, StructuredPojo { /** ** The identifier assigned to the targeted sentiment detection job. *
*/ private String jobId; /** ** The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* The name that you assigned to the targeted sentiment detection job. *
*/ private String jobName; /** *
* The current status of the targeted sentiment detection job. If the status is FAILED
, the
* Messages
field shows the reason for the failure.
*
* A description of the status of a job. *
*/ private String message; /** ** The time that the targeted sentiment detection job was submitted for processing. *
*/ private java.util.Date submitTime; /** ** The time that the targeted sentiment detection job ended. *
*/ private java.util.Date endTime; private InputDataConfig inputDataConfig; private OutputDataConfig outputDataConfig; /** ** The language code of the input documents. *
*/ private String languageCode; /** ** 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 KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML * compute instance(s) that process the targeted sentiment detection 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"
*
* The identifier assigned to the targeted sentiment detection job. *
* * @param jobId * The identifier assigned to the targeted sentiment detection job. */ public void setJobId(String jobId) { this.jobId = jobId; } /** ** The identifier assigned to the targeted sentiment detection job. *
* * @return The identifier assigned to the targeted sentiment detection job. */ public String getJobId() { return this.jobId; } /** ** The identifier assigned to the targeted sentiment detection job. *
* * @param jobId * The identifier assigned to the targeted sentiment detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withJobId(String jobId) { setJobId(jobId); return this; } /** ** The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*/
public void setJobArn(String jobArn) {
this.jobArn = jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*/
public String getJobArn() {
return this.jobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
*
* arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id>
*
* The following is an example job ARN: *
*
* arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TargetedSentimentDetectionJobProperties withJobArn(String jobArn) {
setJobArn(jobArn);
return this;
}
/**
*
* The name that you assigned to the targeted sentiment detection job. *
* * @param jobName * The name that you assigned to the targeted sentiment detection job. */ public void setJobName(String jobName) { this.jobName = jobName; } /** ** The name that you assigned to the targeted sentiment detection job. *
* * @return The name that you assigned to the targeted sentiment detection job. */ public String getJobName() { return this.jobName; } /** ** The name that you assigned to the targeted sentiment detection job. *
* * @param jobName * The name that you assigned to the targeted sentiment detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withJobName(String jobName) { setJobName(jobName); return this; } /** *
* The current status of the targeted sentiment detection job. If the status is FAILED
, the
* Messages
field shows the reason for the failure.
*
FAILED
, the
* Messages
field shows the reason for the failure.
* @see JobStatus
*/
public void setJobStatus(String jobStatus) {
this.jobStatus = jobStatus;
}
/**
*
* The current status of the targeted sentiment detection job. If the status is FAILED
, the
* Messages
field shows the reason for the failure.
*
FAILED
, the
* Messages
field shows the reason for the failure.
* @see JobStatus
*/
public String getJobStatus() {
return this.jobStatus;
}
/**
*
* The current status of the targeted sentiment detection job. If the status is FAILED
, the
* Messages
field shows the reason for the failure.
*
FAILED
, the
* Messages
field shows the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public TargetedSentimentDetectionJobProperties withJobStatus(String jobStatus) {
setJobStatus(jobStatus);
return this;
}
/**
*
* The current status of the targeted sentiment detection job. If the status is FAILED
, the
* Messages
field shows the reason for the failure.
*
FAILED
, the
* Messages
field shows the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public TargetedSentimentDetectionJobProperties withJobStatus(JobStatus jobStatus) {
this.jobStatus = jobStatus.toString();
return this;
}
/**
* * A description of the status of a job. *
* * @param message * A description of the status of a job. */ public void setMessage(String message) { this.message = message; } /** ** A description of the status of a job. *
* * @return A description of the status of a job. */ public String getMessage() { return this.message; } /** ** A description of the status of a job. *
* * @param message * A description of the status of a job. * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withMessage(String message) { setMessage(message); return this; } /** ** The time that the targeted sentiment detection job was submitted for processing. *
* * @param submitTime * The time that the targeted sentiment detection job was submitted for processing. */ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; } /** ** The time that the targeted sentiment detection job was submitted for processing. *
* * @return The time that the targeted sentiment detection job was submitted for processing. */ public java.util.Date getSubmitTime() { return this.submitTime; } /** ** The time that the targeted sentiment detection job was submitted for processing. *
* * @param submitTime * The time that the targeted sentiment detection job was submitted for processing. * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** ** The time that the targeted sentiment detection job ended. *
* * @param endTime * The time that the targeted sentiment detection job ended. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The time that the targeted sentiment detection job ended. *
* * @return The time that the targeted sentiment detection job ended. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The time that the targeted sentiment detection job ended. *
* * @param endTime * The time that the targeted sentiment detection job ended. * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** * @param inputDataConfig */ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** * @return */ public InputDataConfig getInputDataConfig() { return this.inputDataConfig; } /** * @param inputDataConfig * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** * @param outputDataConfig */ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** * @return */ public OutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** * @param outputDataConfig * @return Returns a reference to this object so that method calls can be chained together. */ public TargetedSentimentDetectionJobProperties withOutputDataConfig(OutputDataConfig outputDataConfig) { setOutputDataConfig(outputDataConfig); return this; } /** ** The language code of the input documents. *
* * @param languageCode * The language code of the input documents. * @see LanguageCode */ public void setLanguageCode(String languageCode) { this.languageCode = languageCode; } /** ** The language code of the input documents. *
* * @return The language code of the input documents. * @see LanguageCode */ public String getLanguageCode() { return this.languageCode; } /** ** The language code of the input documents. *
* * @param languageCode * The language code of the input documents. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public TargetedSentimentDetectionJobProperties withLanguageCode(String languageCode) { setLanguageCode(languageCode); return this; } /** ** The language code of the input documents. *
* * @param languageCode * The language code of the input documents. * @return Returns a reference to this object so that method calls can be chained together. * @see LanguageCode */ public TargetedSentimentDetectionJobProperties withLanguageCode(LanguageCode languageCode) { this.languageCode = languageCode.toString(); 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 TargetedSentimentDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); return this; } /** ** ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML * compute instance(s) that process the targeted sentiment detection 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"
*
* ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML * compute instance(s) that process the targeted sentiment detection 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"
*
* ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML * compute instance(s) that process the targeted sentiment detection 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"
*