1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/comprehend/Comprehend_EXPORTS.h> 8 #include <aws/core/utils/memory/stl/AWSString.h> 9 #include <aws/comprehend/model/JobStatus.h> 10 #include <utility> 11 12 namespace Aws 13 { 14 template<typename RESULT_TYPE> 15 class AmazonWebServiceResult; 16 17 namespace Utils 18 { 19 namespace Json 20 { 21 class JsonValue; 22 } // namespace Json 23 } // namespace Utils 24 namespace Comprehend 25 { 26 namespace Model 27 { 28 class AWS_COMPREHEND_API StartKeyPhrasesDetectionJobResult 29 { 30 public: 31 StartKeyPhrasesDetectionJobResult(); 32 StartKeyPhrasesDetectionJobResult(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result); 33 StartKeyPhrasesDetectionJobResult& operator=(const Aws::AmazonWebServiceResult<Aws::Utils::Json::JsonValue>& result); 34 35 36 /** 37 * <p>The identifier generated for the job. To get the status of a job, use this 38 * identifier with the operation.</p> 39 */ GetJobId()40 inline const Aws::String& GetJobId() const{ return m_jobId; } 41 42 /** 43 * <p>The identifier generated for the job. To get the status of a job, use this 44 * identifier with the operation.</p> 45 */ SetJobId(const Aws::String & value)46 inline void SetJobId(const Aws::String& value) { m_jobId = value; } 47 48 /** 49 * <p>The identifier generated for the job. To get the status of a job, use this 50 * identifier with the operation.</p> 51 */ SetJobId(Aws::String && value)52 inline void SetJobId(Aws::String&& value) { m_jobId = std::move(value); } 53 54 /** 55 * <p>The identifier generated for the job. To get the status of a job, use this 56 * identifier with the operation.</p> 57 */ SetJobId(const char * value)58 inline void SetJobId(const char* value) { m_jobId.assign(value); } 59 60 /** 61 * <p>The identifier generated for the job. To get the status of a job, use this 62 * identifier with the operation.</p> 63 */ WithJobId(const Aws::String & value)64 inline StartKeyPhrasesDetectionJobResult& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} 65 66 /** 67 * <p>The identifier generated for the job. To get the status of a job, use this 68 * identifier with the operation.</p> 69 */ WithJobId(Aws::String && value)70 inline StartKeyPhrasesDetectionJobResult& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} 71 72 /** 73 * <p>The identifier generated for the job. To get the status of a job, use this 74 * identifier with the operation.</p> 75 */ WithJobId(const char * value)76 inline StartKeyPhrasesDetectionJobResult& WithJobId(const char* value) { SetJobId(value); return *this;} 77 78 79 /** 80 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 81 * unique, fully qualified identifier for the job. It includes the AWS account, 82 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 83 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 84 * </p> <p>The following is an example job ARN:</p> <p> 85 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 86 * </p> 87 */ GetJobArn()88 inline const Aws::String& GetJobArn() const{ return m_jobArn; } 89 90 /** 91 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 92 * unique, fully qualified identifier for the job. It includes the AWS account, 93 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 94 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 95 * </p> <p>The following is an example job ARN:</p> <p> 96 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 97 * </p> 98 */ SetJobArn(const Aws::String & value)99 inline void SetJobArn(const Aws::String& value) { m_jobArn = value; } 100 101 /** 102 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 103 * unique, fully qualified identifier for the job. It includes the AWS account, 104 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 105 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 106 * </p> <p>The following is an example job ARN:</p> <p> 107 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 108 * </p> 109 */ SetJobArn(Aws::String && value)110 inline void SetJobArn(Aws::String&& value) { m_jobArn = std::move(value); } 111 112 /** 113 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 114 * unique, fully qualified identifier for the job. It includes the AWS account, 115 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 116 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 117 * </p> <p>The following is an example job ARN:</p> <p> 118 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 119 * </p> 120 */ SetJobArn(const char * value)121 inline void SetJobArn(const char* value) { m_jobArn.assign(value); } 122 123 /** 124 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 125 * unique, fully qualified identifier for the job. It includes the AWS account, 126 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 127 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 128 * </p> <p>The following is an example job ARN:</p> <p> 129 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 130 * </p> 131 */ WithJobArn(const Aws::String & value)132 inline StartKeyPhrasesDetectionJobResult& WithJobArn(const Aws::String& value) { SetJobArn(value); return *this;} 133 134 /** 135 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 136 * unique, fully qualified identifier for the job. It includes the AWS account, 137 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 138 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 139 * </p> <p>The following is an example job ARN:</p> <p> 140 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 141 * </p> 142 */ WithJobArn(Aws::String && value)143 inline StartKeyPhrasesDetectionJobResult& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); return *this;} 144 145 /** 146 * <p>The Amazon Resource Name (ARN) of the key phrase detection job. It is a 147 * unique, fully qualified identifier for the job. It includes the AWS account, 148 * Region, and the job ID. The format of the ARN is as follows:</p> <p> 149 * <code>arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id></code> 150 * </p> <p>The following is an example job ARN:</p> <p> 151 * <code>arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab</code> 152 * </p> 153 */ WithJobArn(const char * value)154 inline StartKeyPhrasesDetectionJobResult& WithJobArn(const char* value) { SetJobArn(value); return *this;} 155 156 157 /** 158 * <p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been 159 * received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon 160 * Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was 161 * successfully completed and the output is available.</p> </li> <li> <p>FAILED - 162 * The job did not complete. To get details, use the operation.</p> </li> </ul> 163 */ GetJobStatus()164 inline const JobStatus& GetJobStatus() const{ return m_jobStatus; } 165 166 /** 167 * <p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been 168 * received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon 169 * Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was 170 * successfully completed and the output is available.</p> </li> <li> <p>FAILED - 171 * The job did not complete. To get details, use the operation.</p> </li> </ul> 172 */ SetJobStatus(const JobStatus & value)173 inline void SetJobStatus(const JobStatus& value) { m_jobStatus = value; } 174 175 /** 176 * <p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been 177 * received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon 178 * Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was 179 * successfully completed and the output is available.</p> </li> <li> <p>FAILED - 180 * The job did not complete. To get details, use the operation.</p> </li> </ul> 181 */ SetJobStatus(JobStatus && value)182 inline void SetJobStatus(JobStatus&& value) { m_jobStatus = std::move(value); } 183 184 /** 185 * <p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been 186 * received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon 187 * Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was 188 * successfully completed and the output is available.</p> </li> <li> <p>FAILED - 189 * The job did not complete. To get details, use the operation.</p> </li> </ul> 190 */ WithJobStatus(const JobStatus & value)191 inline StartKeyPhrasesDetectionJobResult& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;} 192 193 /** 194 * <p>The status of the job. </p> <ul> <li> <p>SUBMITTED - The job has been 195 * received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon 196 * Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was 197 * successfully completed and the output is available.</p> </li> <li> <p>FAILED - 198 * The job did not complete. To get details, use the operation.</p> </li> </ul> 199 */ WithJobStatus(JobStatus && value)200 inline StartKeyPhrasesDetectionJobResult& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;} 201 202 private: 203 204 Aws::String m_jobId; 205 206 Aws::String m_jobArn; 207 208 JobStatus m_jobStatus; 209 }; 210 211 } // namespace Model 212 } // namespace Comprehend 213 } // namespace Aws 214