/* * 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 sentiment detection job. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SentimentDetectionJobProperties implements Serializable, Cloneable, StructuredPojo { /** *

* The identifier assigned to the sentiment detection job. *

*/ private String jobId; /** *

* The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab *

*/ private String jobArn; /** *

* The name that you assigned to the sentiment detection job *

*/ private String jobName; /** *

* The current status of the sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. *

*/ private String jobStatus; /** *

* A description of the status of a job. *

*/ private String message; /** *

* The time that the sentiment detection job was submitted for processing. *

*/ private java.util.Date submitTime; /** *

* The time that the sentiment detection job ended. *

*/ private java.util.Date endTime; /** *

* The input data configuration that you supplied when you created the sentiment detection job. *

*/ private InputDataConfig inputDataConfig; /** *

* The output data configuration that you supplied when you created the sentiment detection job. *

*/ 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 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: *

* */ private String volumeKmsKeyId; /** *

* Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for * your sentiment detection job. For more information, see Amazon VPC. *

*/ private VpcConfig vpcConfig; /** *

* The identifier assigned to the sentiment detection job. *

* * @param jobId * The identifier assigned to the sentiment detection job. */ public void setJobId(String jobId) { this.jobId = jobId; } /** *

* The identifier assigned to the sentiment detection job. *

* * @return The identifier assigned to the sentiment detection job. */ public String getJobId() { return this.jobId; } /** *

* The identifier assigned to the sentiment detection job. *

* * @param jobId * The identifier assigned to the sentiment detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withJobId(String jobId) { setJobId(jobId); return this; } /** *

* The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab *

* * @param jobArn * The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab */ public void setJobArn(String jobArn) { this.jobArn = jobArn; } /** *

* The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab *

* * @return The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab */ public String getJobArn() { return this.jobArn; } /** *

* The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab *

* * @param jobArn * The Amazon Resource Name (ARN) of the 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>:sentiment-detection-job/<job-id> *

*

* The following is an example job ARN: *

*

* arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withJobArn(String jobArn) { setJobArn(jobArn); return this; } /** *

* The name that you assigned to the sentiment detection job *

* * @param jobName * The name that you assigned to the sentiment detection job */ public void setJobName(String jobName) { this.jobName = jobName; } /** *

* The name that you assigned to the sentiment detection job *

* * @return The name that you assigned to the sentiment detection job */ public String getJobName() { return this.jobName; } /** *

* The name that you assigned to the sentiment detection job *

* * @param jobName * The name that you assigned to the sentiment detection job * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withJobName(String jobName) { setJobName(jobName); return this; } /** *

* The current status of the sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. *

* * @param jobStatus * The current status of the sentiment detection job. If the status is 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 sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. *

* * @return The current status of the sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. * @see JobStatus */ public String getJobStatus() { return this.jobStatus; } /** *

* The current status of the sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. *

* * @param jobStatus * The current status of the sentiment detection job. If the status is 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 SentimentDetectionJobProperties withJobStatus(String jobStatus) { setJobStatus(jobStatus); return this; } /** *

* The current status of the sentiment detection job. If the status is FAILED, the * Messages field shows the reason for the failure. *

* * @param jobStatus * The current status of the sentiment detection job. If the status is 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 SentimentDetectionJobProperties 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 SentimentDetectionJobProperties withMessage(String message) { setMessage(message); return this; } /** *

* The time that the sentiment detection job was submitted for processing. *

* * @param submitTime * The time that the sentiment detection job was submitted for processing. */ public void setSubmitTime(java.util.Date submitTime) { this.submitTime = submitTime; } /** *

* The time that the sentiment detection job was submitted for processing. *

* * @return The time that the sentiment detection job was submitted for processing. */ public java.util.Date getSubmitTime() { return this.submitTime; } /** *

* The time that the sentiment detection job was submitted for processing. *

* * @param submitTime * The time that the sentiment detection job was submitted for processing. * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withSubmitTime(java.util.Date submitTime) { setSubmitTime(submitTime); return this; } /** *

* The time that the sentiment detection job ended. *

* * @param endTime * The time that the sentiment detection job ended. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** *

* The time that the sentiment detection job ended. *

* * @return The time that the sentiment detection job ended. */ public java.util.Date getEndTime() { return this.endTime; } /** *

* The time that the sentiment detection job ended. *

* * @param endTime * The time that the sentiment detection job ended. * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** *

* The input data configuration that you supplied when you created the sentiment detection job. *

* * @param inputDataConfig * The input data configuration that you supplied when you created the sentiment detection job. */ public void setInputDataConfig(InputDataConfig inputDataConfig) { this.inputDataConfig = inputDataConfig; } /** *

* The input data configuration that you supplied when you created the sentiment detection job. *

* * @return The input data configuration that you supplied when you created the sentiment detection job. */ public InputDataConfig getInputDataConfig() { return this.inputDataConfig; } /** *

* The input data configuration that you supplied when you created the sentiment detection job. *

* * @param inputDataConfig * The input data configuration that you supplied when you created the sentiment detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties withInputDataConfig(InputDataConfig inputDataConfig) { setInputDataConfig(inputDataConfig); return this; } /** *

* The output data configuration that you supplied when you created the sentiment detection job. *

* * @param outputDataConfig * The output data configuration that you supplied when you created the sentiment detection job. */ public void setOutputDataConfig(OutputDataConfig outputDataConfig) { this.outputDataConfig = outputDataConfig; } /** *

* The output data configuration that you supplied when you created the sentiment detection job. *

* * @return The output data configuration that you supplied when you created the sentiment detection job. */ public OutputDataConfig getOutputDataConfig() { return this.outputDataConfig; } /** *

* The output data configuration that you supplied when you created the sentiment detection job. *

* * @param outputDataConfig * The output data configuration that you supplied when you created the sentiment detection job. * @return Returns a reference to this object so that method calls can be chained together. */ public SentimentDetectionJobProperties 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 SentimentDetectionJobProperties 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 SentimentDetectionJobProperties 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 SentimentDetectionJobProperties withDataAccessRoleArn(String dataAccessRoleArn) { setDataAccessRoleArn(dataAccessRoleArn); return this; } /** *

* 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: *

* * * @param 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:

*