AWS SDK for C++

AWS SDK for C++ Version 1.11.835

Loading...
Searching...
No Matches
DescribeJobResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/sagemaker/SageMaker_EXPORTS.h>
12#include <aws/sagemaker/model/JobCategory.h>
13#include <aws/sagemaker/model/JobSecondaryStatus.h>
14#include <aws/sagemaker/model/JobSecondaryStatusTransition.h>
15#include <aws/sagemaker/model/JobStatus.h>
16#include <aws/sagemaker/model/Tag.h>
17
18#include <utility>
19
20namespace Aws {
21template <typename RESULT_TYPE>
22class AmazonWebServiceResult;
23
24namespace Utils {
25namespace Json {
26class JsonValue;
27} // namespace Json
28} // namespace Utils
29namespace SageMaker {
30namespace Model {
32 public:
33 AWS_SAGEMAKER_API DescribeJobResult() = default;
36
38
41 inline const Aws::String& GetJobName() const { return m_jobName; }
42 template <typename JobNameT = Aws::String>
43 void SetJobName(JobNameT&& value) {
44 m_jobNameHasBeenSet = true;
45 m_jobName = std::forward<JobNameT>(value);
46 }
47 template <typename JobNameT = Aws::String>
48 DescribeJobResult& WithJobName(JobNameT&& value) {
49 SetJobName(std::forward<JobNameT>(value));
50 return *this;
51 }
53
55
58 inline const Aws::String& GetJobArn() const { return m_jobArn; }
59 template <typename JobArnT = Aws::String>
60 void SetJobArn(JobArnT&& value) {
61 m_jobArnHasBeenSet = true;
62 m_jobArn = std::forward<JobArnT>(value);
63 }
64 template <typename JobArnT = Aws::String>
65 DescribeJobResult& WithJobArn(JobArnT&& value) {
66 SetJobArn(std::forward<JobArnT>(value));
67 return *this;
68 }
70
72
75 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
76 template <typename RoleArnT = Aws::String>
77 void SetRoleArn(RoleArnT&& value) {
78 m_roleArnHasBeenSet = true;
79 m_roleArn = std::forward<RoleArnT>(value);
80 }
81 template <typename RoleArnT = Aws::String>
82 DescribeJobResult& WithRoleArn(RoleArnT&& value) {
83 SetRoleArn(std::forward<RoleArnT>(value));
84 return *this;
85 }
87
89
92 inline JobCategory GetJobCategory() const { return m_jobCategory; }
93 inline void SetJobCategory(JobCategory value) {
94 m_jobCategoryHasBeenSet = true;
95 m_jobCategory = value;
96 }
98 SetJobCategory(value);
99 return *this;
100 }
102
104
107 inline const Aws::String& GetJobConfigSchemaVersion() const { return m_jobConfigSchemaVersion; }
108 template <typename JobConfigSchemaVersionT = Aws::String>
109 void SetJobConfigSchemaVersion(JobConfigSchemaVersionT&& value) {
110 m_jobConfigSchemaVersionHasBeenSet = true;
111 m_jobConfigSchemaVersion = std::forward<JobConfigSchemaVersionT>(value);
112 }
113 template <typename JobConfigSchemaVersionT = Aws::String>
114 DescribeJobResult& WithJobConfigSchemaVersion(JobConfigSchemaVersionT&& value) {
115 SetJobConfigSchemaVersion(std::forward<JobConfigSchemaVersionT>(value));
116 return *this;
117 }
119
121
124 inline const Aws::String& GetJobConfigDocument() const { return m_jobConfigDocument; }
125 template <typename JobConfigDocumentT = Aws::String>
126 void SetJobConfigDocument(JobConfigDocumentT&& value) {
127 m_jobConfigDocumentHasBeenSet = true;
128 m_jobConfigDocument = std::forward<JobConfigDocumentT>(value);
129 }
130 template <typename JobConfigDocumentT = Aws::String>
131 DescribeJobResult& WithJobConfigDocument(JobConfigDocumentT&& value) {
132 SetJobConfigDocument(std::forward<JobConfigDocumentT>(value));
133 return *this;
134 }
136
138
141 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
142 template <typename CreationTimeT = Aws::Utils::DateTime>
143 void SetCreationTime(CreationTimeT&& value) {
144 m_creationTimeHasBeenSet = true;
145 m_creationTime = std::forward<CreationTimeT>(value);
146 }
147 template <typename CreationTimeT = Aws::Utils::DateTime>
148 DescribeJobResult& WithCreationTime(CreationTimeT&& value) {
149 SetCreationTime(std::forward<CreationTimeT>(value));
150 return *this;
151 }
153
155
158 inline const Aws::Utils::DateTime& GetLastModifiedTime() const { return m_lastModifiedTime; }
159 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
160 void SetLastModifiedTime(LastModifiedTimeT&& value) {
161 m_lastModifiedTimeHasBeenSet = true;
162 m_lastModifiedTime = std::forward<LastModifiedTimeT>(value);
163 }
164 template <typename LastModifiedTimeT = Aws::Utils::DateTime>
165 DescribeJobResult& WithLastModifiedTime(LastModifiedTimeT&& value) {
166 SetLastModifiedTime(std::forward<LastModifiedTimeT>(value));
167 return *this;
168 }
170
172
175 inline const Aws::Utils::DateTime& GetEndTime() const { return m_endTime; }
176 template <typename EndTimeT = Aws::Utils::DateTime>
177 void SetEndTime(EndTimeT&& value) {
178 m_endTimeHasBeenSet = true;
179 m_endTime = std::forward<EndTimeT>(value);
180 }
181 template <typename EndTimeT = Aws::Utils::DateTime>
182 DescribeJobResult& WithEndTime(EndTimeT&& value) {
183 SetEndTime(std::forward<EndTimeT>(value));
184 return *this;
185 }
187
189
192 inline JobStatus GetJobStatus() const { return m_jobStatus; }
193 inline void SetJobStatus(JobStatus value) {
194 m_jobStatusHasBeenSet = true;
195 m_jobStatus = value;
196 }
198 SetJobStatus(value);
199 return *this;
200 }
202
204
208 inline JobSecondaryStatus GetSecondaryStatus() const { return m_secondaryStatus; }
210 m_secondaryStatusHasBeenSet = true;
211 m_secondaryStatus = value;
212 }
214 SetSecondaryStatus(value);
215 return *this;
216 }
218
220
224 inline const Aws::Vector<JobSecondaryStatusTransition>& GetSecondaryStatusTransitions() const { return m_secondaryStatusTransitions; }
225 template <typename SecondaryStatusTransitionsT = Aws::Vector<JobSecondaryStatusTransition>>
226 void SetSecondaryStatusTransitions(SecondaryStatusTransitionsT&& value) {
227 m_secondaryStatusTransitionsHasBeenSet = true;
228 m_secondaryStatusTransitions = std::forward<SecondaryStatusTransitionsT>(value);
229 }
230 template <typename SecondaryStatusTransitionsT = Aws::Vector<JobSecondaryStatusTransition>>
231 DescribeJobResult& WithSecondaryStatusTransitions(SecondaryStatusTransitionsT&& value) {
232 SetSecondaryStatusTransitions(std::forward<SecondaryStatusTransitionsT>(value));
233 return *this;
234 }
235 template <typename SecondaryStatusTransitionsT = JobSecondaryStatusTransition>
236 DescribeJobResult& AddSecondaryStatusTransitions(SecondaryStatusTransitionsT&& value) {
237 m_secondaryStatusTransitionsHasBeenSet = true;
238 m_secondaryStatusTransitions.emplace_back(std::forward<SecondaryStatusTransitionsT>(value));
239 return *this;
240 }
242
244
247 inline const Aws::String& GetFailureReason() const { return m_failureReason; }
248 template <typename FailureReasonT = Aws::String>
249 void SetFailureReason(FailureReasonT&& value) {
250 m_failureReasonHasBeenSet = true;
251 m_failureReason = std::forward<FailureReasonT>(value);
252 }
253 template <typename FailureReasonT = Aws::String>
254 DescribeJobResult& WithFailureReason(FailureReasonT&& value) {
255 SetFailureReason(std::forward<FailureReasonT>(value));
256 return *this;
257 }
259
261
264 inline const Aws::Vector<Tag>& GetTags() const { return m_tags; }
265 template <typename TagsT = Aws::Vector<Tag>>
266 void SetTags(TagsT&& value) {
267 m_tagsHasBeenSet = true;
268 m_tags = std::forward<TagsT>(value);
269 }
270 template <typename TagsT = Aws::Vector<Tag>>
271 DescribeJobResult& WithTags(TagsT&& value) {
272 SetTags(std::forward<TagsT>(value));
273 return *this;
274 }
275 template <typename TagsT = Tag>
276 DescribeJobResult& AddTags(TagsT&& value) {
277 m_tagsHasBeenSet = true;
278 m_tags.emplace_back(std::forward<TagsT>(value));
279 return *this;
280 }
282
284
285 inline const Aws::String& GetRequestId() const { return m_requestId; }
286 template <typename RequestIdT = Aws::String>
287 void SetRequestId(RequestIdT&& value) {
288 m_requestIdHasBeenSet = true;
289 m_requestId = std::forward<RequestIdT>(value);
290 }
291 template <typename RequestIdT = Aws::String>
292 DescribeJobResult& WithRequestId(RequestIdT&& value) {
293 SetRequestId(std::forward<RequestIdT>(value));
294 return *this;
295 }
297 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
298
299 private:
300 Aws::String m_jobName;
301
302 Aws::String m_jobArn;
303
304 Aws::String m_roleArn;
305
306 JobCategory m_jobCategory{JobCategory::NOT_SET};
307
308 Aws::String m_jobConfigSchemaVersion;
309
310 Aws::String m_jobConfigDocument;
311
312 Aws::Utils::DateTime m_creationTime{};
313
314 Aws::Utils::DateTime m_lastModifiedTime{};
315
316 Aws::Utils::DateTime m_endTime{};
317
318 JobStatus m_jobStatus{JobStatus::NOT_SET};
319
321
322 Aws::Vector<JobSecondaryStatusTransition> m_secondaryStatusTransitions;
323
324 Aws::String m_failureReason;
325
326 Aws::Vector<Tag> m_tags;
327
328 Aws::String m_requestId;
329 Aws::Http::HttpResponseCode m_HttpResponseCode;
330 bool m_jobNameHasBeenSet = false;
331 bool m_jobArnHasBeenSet = false;
332 bool m_roleArnHasBeenSet = false;
333 bool m_jobCategoryHasBeenSet = false;
334 bool m_jobConfigSchemaVersionHasBeenSet = false;
335 bool m_jobConfigDocumentHasBeenSet = false;
336 bool m_creationTimeHasBeenSet = false;
337 bool m_lastModifiedTimeHasBeenSet = false;
338 bool m_endTimeHasBeenSet = false;
339 bool m_jobStatusHasBeenSet = false;
340 bool m_secondaryStatusHasBeenSet = false;
341 bool m_secondaryStatusTransitionsHasBeenSet = false;
342 bool m_failureReasonHasBeenSet = false;
343 bool m_tagsHasBeenSet = false;
344 bool m_requestIdHasBeenSet = false;
345};
346
347} // namespace Model
348} // namespace SageMaker
349} // namespace Aws
DescribeJobResult & WithTags(TagsT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
DescribeJobResult & WithJobCategory(JobCategory value)
DescribeJobResult & WithSecondaryStatusTransitions(SecondaryStatusTransitionsT &&value)
DescribeJobResult & WithJobName(JobNameT &&value)
DescribeJobResult & AddTags(TagsT &&value)
DescribeJobResult & WithJobConfigSchemaVersion(JobConfigSchemaVersionT &&value)
DescribeJobResult & WithFailureReason(FailureReasonT &&value)
DescribeJobResult & WithSecondaryStatus(JobSecondaryStatus value)
DescribeJobResult & WithJobStatus(JobStatus value)
const Aws::String & GetJobConfigDocument() const
void SetFailureReason(FailureReasonT &&value)
const Aws::String & GetJobConfigSchemaVersion() const
DescribeJobResult & WithJobConfigDocument(JobConfigDocumentT &&value)
AWS_SAGEMAKER_API DescribeJobResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeJobResult & WithRequestId(RequestIdT &&value)
const Aws::Vector< JobSecondaryStatusTransition > & GetSecondaryStatusTransitions() const
AWS_SAGEMAKER_API DescribeJobResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
void SetSecondaryStatus(JobSecondaryStatus value)
const Aws::Utils::DateTime & GetCreationTime() const
void SetSecondaryStatusTransitions(SecondaryStatusTransitionsT &&value)
const Aws::Vector< Tag > & GetTags() const
AWS_SAGEMAKER_API DescribeJobResult()=default
JobSecondaryStatus GetSecondaryStatus() const
void SetJobConfigDocument(JobConfigDocumentT &&value)
DescribeJobResult & AddSecondaryStatusTransitions(SecondaryStatusTransitionsT &&value)
DescribeJobResult & WithLastModifiedTime(LastModifiedTimeT &&value)
const Aws::Utils::DateTime & GetEndTime() const
DescribeJobResult & WithJobArn(JobArnT &&value)
void SetCreationTime(CreationTimeT &&value)
void SetJobConfigSchemaVersion(JobConfigSchemaVersionT &&value)
const Aws::Utils::DateTime & GetLastModifiedTime() const
void SetLastModifiedTime(LastModifiedTimeT &&value)
DescribeJobResult & WithRoleArn(RoleArnT &&value)
const Aws::String & GetFailureReason() const
DescribeJobResult & WithEndTime(EndTimeT &&value)
DescribeJobResult & WithCreationTime(CreationTimeT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue