/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace Comprehend { namespace Model { class StartSentimentDetectionJobResult { public: AWS_COMPREHEND_API StartSentimentDetectionJobResult(); AWS_COMPREHEND_API StartSentimentDetectionJobResult(const Aws::AmazonWebServiceResult& result); AWS_COMPREHEND_API StartSentimentDetectionJobResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline void SetJobId(const Aws::String& value) { m_jobId = value; } /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline void SetJobId(Aws::String&& value) { m_jobId = std::move(value); } /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline void SetJobId(const char* value) { m_jobId.assign(value); } /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline StartSentimentDetectionJobResult& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline StartSentimentDetectionJobResult& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The identifier generated for the job. To get the status of a job, use this * identifier with the operation.

*/ inline StartSentimentDetectionJobResult& WithJobId(const char* value) { SetJobId(value); 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 *

*/ inline const Aws::String& GetJobArn() const{ return m_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 *

*/ inline void SetJobArn(const Aws::String& value) { m_jobArn = value; } /** *

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 *

*/ inline void SetJobArn(Aws::String&& value) { m_jobArn = std::move(value); } /** *

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 *

*/ inline void SetJobArn(const char* value) { m_jobArn.assign(value); } /** *

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 *

*/ inline StartSentimentDetectionJobResult& WithJobArn(const Aws::String& value) { SetJobArn(value); 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 *

*/ inline StartSentimentDetectionJobResult& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); 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 *

*/ inline StartSentimentDetectionJobResult& WithJobArn(const char* value) { SetJobArn(value); return *this;} /** *

The status of the job.

  • SUBMITTED - The job has been * received and is queued for processing.

  • IN_PROGRESS - Amazon * Comprehend is processing the job.

  • COMPLETED - The job was * successfully completed and the output is available.

  • FAILED - * The job did not complete. To get details, use the operation.

*/ inline const JobStatus& GetJobStatus() const{ return m_jobStatus; } /** *

The status of the job.

  • SUBMITTED - The job has been * received and is queued for processing.

  • IN_PROGRESS - Amazon * Comprehend is processing the job.

  • COMPLETED - The job was * successfully completed and the output is available.

  • FAILED - * The job did not complete. To get details, use the operation.

*/ inline void SetJobStatus(const JobStatus& value) { m_jobStatus = value; } /** *

The status of the job.

  • SUBMITTED - The job has been * received and is queued for processing.

  • IN_PROGRESS - Amazon * Comprehend is processing the job.

  • COMPLETED - The job was * successfully completed and the output is available.

  • FAILED - * The job did not complete. To get details, use the operation.

*/ inline void SetJobStatus(JobStatus&& value) { m_jobStatus = std::move(value); } /** *

The status of the job.

  • SUBMITTED - The job has been * received and is queued for processing.

  • IN_PROGRESS - Amazon * Comprehend is processing the job.

  • COMPLETED - The job was * successfully completed and the output is available.

  • FAILED - * The job did not complete. To get details, use the operation.

*/ inline StartSentimentDetectionJobResult& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} /** *

The status of the job.

  • SUBMITTED - The job has been * received and is queued for processing.

  • IN_PROGRESS - Amazon * Comprehend is processing the job.

  • COMPLETED - The job was * successfully completed and the output is available.

  • FAILED - * The job did not complete. To get details, use the operation.

*/ inline StartSentimentDetectionJobResult& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline StartSentimentDetectionJobResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline StartSentimentDetectionJobResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline StartSentimentDetectionJobResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: Aws::String m_jobId; Aws::String m_jobArn; JobStatus m_jobStatus; Aws::String m_requestId; }; } // namespace Model } // namespace Comprehend } // namespace Aws