AWS SDK for C++

AWS SDK for C++ Version 1.11.761

Loading...
Searching...
No Matches
DescribeServiceJobResult.h
1
6#pragma once
7#include <aws/batch/Batch_EXPORTS.h>
8#include <aws/batch/model/LatestServiceJobAttempt.h>
9#include <aws/batch/model/ServiceJobAttemptDetail.h>
10#include <aws/batch/model/ServiceJobCapacityUsageDetail.h>
11#include <aws/batch/model/ServiceJobRetryStrategy.h>
12#include <aws/batch/model/ServiceJobStatus.h>
13#include <aws/batch/model/ServiceJobTimeout.h>
14#include <aws/batch/model/ServiceJobType.h>
15#include <aws/core/http/HttpResponse.h>
16#include <aws/core/utils/memory/stl/AWSMap.h>
17#include <aws/core/utils/memory/stl/AWSString.h>
18#include <aws/core/utils/memory/stl/AWSVector.h>
19
20#include <utility>
21
22namespace Aws {
23template <typename RESULT_TYPE>
24class AmazonWebServiceResult;
25
26namespace Utils {
27namespace Json {
28class JsonValue;
29} // namespace Json
30} // namespace Utils
31namespace Batch {
32namespace Model {
34 public:
35 AWS_BATCH_API DescribeServiceJobResult() = default;
38
40
43 inline const Aws::Vector<ServiceJobAttemptDetail>& GetAttempts() const { return m_attempts; }
44 template <typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
45 void SetAttempts(AttemptsT&& value) {
46 m_attemptsHasBeenSet = true;
47 m_attempts = std::forward<AttemptsT>(value);
48 }
49 template <typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
51 SetAttempts(std::forward<AttemptsT>(value));
52 return *this;
53 }
54 template <typename AttemptsT = ServiceJobAttemptDetail>
56 m_attemptsHasBeenSet = true;
57 m_attempts.emplace_back(std::forward<AttemptsT>(value));
58 return *this;
59 }
61
63
68 inline const Aws::Vector<ServiceJobCapacityUsageDetail>& GetCapacityUsage() const { return m_capacityUsage; }
69 template <typename CapacityUsageT = Aws::Vector<ServiceJobCapacityUsageDetail>>
70 void SetCapacityUsage(CapacityUsageT&& value) {
71 m_capacityUsageHasBeenSet = true;
72 m_capacityUsage = std::forward<CapacityUsageT>(value);
73 }
74 template <typename CapacityUsageT = Aws::Vector<ServiceJobCapacityUsageDetail>>
76 SetCapacityUsage(std::forward<CapacityUsageT>(value));
77 return *this;
78 }
79 template <typename CapacityUsageT = ServiceJobCapacityUsageDetail>
80 DescribeServiceJobResult& AddCapacityUsage(CapacityUsageT&& value) {
81 m_capacityUsageHasBeenSet = true;
82 m_capacityUsage.emplace_back(std::forward<CapacityUsageT>(value));
83 return *this;
84 }
86
88
92 inline long long GetCreatedAt() const { return m_createdAt; }
93 inline void SetCreatedAt(long long value) {
94 m_createdAtHasBeenSet = true;
95 m_createdAt = value;
96 }
97 inline DescribeServiceJobResult& WithCreatedAt(long long value) {
98 SetCreatedAt(value);
99 return *this;
100 }
102
104
107 inline bool GetIsTerminated() const { return m_isTerminated; }
108 inline void SetIsTerminated(bool value) {
109 m_isTerminatedHasBeenSet = true;
110 m_isTerminated = value;
111 }
113 SetIsTerminated(value);
114 return *this;
115 }
117
119
122 inline const Aws::String& GetJobArn() const { return m_jobArn; }
123 template <typename JobArnT = Aws::String>
124 void SetJobArn(JobArnT&& value) {
125 m_jobArnHasBeenSet = true;
126 m_jobArn = std::forward<JobArnT>(value);
127 }
128 template <typename JobArnT = Aws::String>
130 SetJobArn(std::forward<JobArnT>(value));
131 return *this;
132 }
134
136
139 inline const Aws::String& GetJobId() const { return m_jobId; }
140 template <typename JobIdT = Aws::String>
141 void SetJobId(JobIdT&& value) {
142 m_jobIdHasBeenSet = true;
143 m_jobId = std::forward<JobIdT>(value);
144 }
145 template <typename JobIdT = Aws::String>
147 SetJobId(std::forward<JobIdT>(value));
148 return *this;
149 }
151
153
156 inline const Aws::String& GetJobName() const { return m_jobName; }
157 template <typename JobNameT = Aws::String>
158 void SetJobName(JobNameT&& value) {
159 m_jobNameHasBeenSet = true;
160 m_jobName = std::forward<JobNameT>(value);
161 }
162 template <typename JobNameT = Aws::String>
164 SetJobName(std::forward<JobNameT>(value));
165 return *this;
166 }
168
170
173 inline const Aws::String& GetJobQueue() const { return m_jobQueue; }
174 template <typename JobQueueT = Aws::String>
175 void SetJobQueue(JobQueueT&& value) {
176 m_jobQueueHasBeenSet = true;
177 m_jobQueue = std::forward<JobQueueT>(value);
178 }
179 template <typename JobQueueT = Aws::String>
181 SetJobQueue(std::forward<JobQueueT>(value));
182 return *this;
183 }
185
187
190 inline const LatestServiceJobAttempt& GetLatestAttempt() const { return m_latestAttempt; }
191 template <typename LatestAttemptT = LatestServiceJobAttempt>
192 void SetLatestAttempt(LatestAttemptT&& value) {
193 m_latestAttemptHasBeenSet = true;
194 m_latestAttempt = std::forward<LatestAttemptT>(value);
195 }
196 template <typename LatestAttemptT = LatestServiceJobAttempt>
198 SetLatestAttempt(std::forward<LatestAttemptT>(value));
199 return *this;
200 }
202
204
208 inline const ServiceJobRetryStrategy& GetRetryStrategy() const { return m_retryStrategy; }
209 template <typename RetryStrategyT = ServiceJobRetryStrategy>
210 void SetRetryStrategy(RetryStrategyT&& value) {
211 m_retryStrategyHasBeenSet = true;
212 m_retryStrategy = std::forward<RetryStrategyT>(value);
213 }
214 template <typename RetryStrategyT = ServiceJobRetryStrategy>
216 SetRetryStrategy(std::forward<RetryStrategyT>(value));
217 return *this;
218 }
220
222
227 inline long long GetScheduledAt() const { return m_scheduledAt; }
228 inline void SetScheduledAt(long long value) {
229 m_scheduledAtHasBeenSet = true;
230 m_scheduledAt = value;
231 }
232 inline DescribeServiceJobResult& WithScheduledAt(long long value) {
233 SetScheduledAt(value);
234 return *this;
235 }
237
239
242 inline int GetSchedulingPriority() const { return m_schedulingPriority; }
243 inline void SetSchedulingPriority(int value) {
244 m_schedulingPriorityHasBeenSet = true;
245 m_schedulingPriority = value;
246 }
249 return *this;
250 }
252
254
258 inline const Aws::String& GetServiceRequestPayload() const { return m_serviceRequestPayload; }
259 template <typename ServiceRequestPayloadT = Aws::String>
260 void SetServiceRequestPayload(ServiceRequestPayloadT&& value) {
261 m_serviceRequestPayloadHasBeenSet = true;
262 m_serviceRequestPayload = std::forward<ServiceRequestPayloadT>(value);
263 }
264 template <typename ServiceRequestPayloadT = Aws::String>
265 DescribeServiceJobResult& WithServiceRequestPayload(ServiceRequestPayloadT&& value) {
266 SetServiceRequestPayload(std::forward<ServiceRequestPayloadT>(value));
267 return *this;
268 }
270
272
276 inline ServiceJobType GetServiceJobType() const { return m_serviceJobType; }
278 m_serviceJobTypeHasBeenSet = true;
279 m_serviceJobType = value;
280 }
282 SetServiceJobType(value);
283 return *this;
284 }
286
288
292 inline const Aws::String& GetShareIdentifier() const { return m_shareIdentifier; }
293 template <typename ShareIdentifierT = Aws::String>
294 void SetShareIdentifier(ShareIdentifierT&& value) {
295 m_shareIdentifierHasBeenSet = true;
296 m_shareIdentifier = std::forward<ShareIdentifierT>(value);
297 }
298 template <typename ShareIdentifierT = Aws::String>
300 SetShareIdentifier(std::forward<ShareIdentifierT>(value));
301 return *this;
302 }
304
306
310 inline long long GetStartedAt() const { return m_startedAt; }
311 inline void SetStartedAt(long long value) {
312 m_startedAtHasBeenSet = true;
313 m_startedAt = value;
314 }
315 inline DescribeServiceJobResult& WithStartedAt(long long value) {
316 SetStartedAt(value);
317 return *this;
318 }
320
322
325 inline ServiceJobStatus GetStatus() const { return m_status; }
326 inline void SetStatus(ServiceJobStatus value) {
327 m_statusHasBeenSet = true;
328 m_status = value;
329 }
331 SetStatus(value);
332 return *this;
333 }
335
337
341 inline const Aws::String& GetStatusReason() const { return m_statusReason; }
342 template <typename StatusReasonT = Aws::String>
343 void SetStatusReason(StatusReasonT&& value) {
344 m_statusReasonHasBeenSet = true;
345 m_statusReason = std::forward<StatusReasonT>(value);
346 }
347 template <typename StatusReasonT = Aws::String>
349 SetStatusReason(std::forward<StatusReasonT>(value));
350 return *this;
351 }
353
355
359 inline long long GetStoppedAt() const { return m_stoppedAt; }
360 inline void SetStoppedAt(long long value) {
361 m_stoppedAtHasBeenSet = true;
362 m_stoppedAt = value;
363 }
364 inline DescribeServiceJobResult& WithStoppedAt(long long value) {
365 SetStoppedAt(value);
366 return *this;
367 }
369
371
377 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
378 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
379 void SetTags(TagsT&& value) {
380 m_tagsHasBeenSet = true;
381 m_tags = std::forward<TagsT>(value);
382 }
383 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
385 SetTags(std::forward<TagsT>(value));
386 return *this;
387 }
388 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
389 DescribeServiceJobResult& AddTags(TagsKeyT&& key, TagsValueT&& value) {
390 m_tagsHasBeenSet = true;
391 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
392 return *this;
393 }
395
397
400 inline const ServiceJobTimeout& GetTimeoutConfig() const { return m_timeoutConfig; }
401 template <typename TimeoutConfigT = ServiceJobTimeout>
402 void SetTimeoutConfig(TimeoutConfigT&& value) {
403 m_timeoutConfigHasBeenSet = true;
404 m_timeoutConfig = std::forward<TimeoutConfigT>(value);
405 }
406 template <typename TimeoutConfigT = ServiceJobTimeout>
408 SetTimeoutConfig(std::forward<TimeoutConfigT>(value));
409 return *this;
410 }
412
414
415 inline const Aws::String& GetRequestId() const { return m_requestId; }
416 template <typename RequestIdT = Aws::String>
417 void SetRequestId(RequestIdT&& value) {
418 m_requestIdHasBeenSet = true;
419 m_requestId = std::forward<RequestIdT>(value);
420 }
421 template <typename RequestIdT = Aws::String>
423 SetRequestId(std::forward<RequestIdT>(value));
424 return *this;
425 }
427 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
428
429 private:
431
433
434 long long m_createdAt{0};
435
436 bool m_isTerminated{false};
437
438 Aws::String m_jobArn;
439
440 Aws::String m_jobId;
441
442 Aws::String m_jobName;
443
444 Aws::String m_jobQueue;
445
446 LatestServiceJobAttempt m_latestAttempt;
447
448 ServiceJobRetryStrategy m_retryStrategy;
449
450 long long m_scheduledAt{0};
451
452 int m_schedulingPriority{0};
453
454 Aws::String m_serviceRequestPayload;
455
456 ServiceJobType m_serviceJobType{ServiceJobType::NOT_SET};
457
458 Aws::String m_shareIdentifier;
459
460 long long m_startedAt{0};
461
463
464 Aws::String m_statusReason;
465
466 long long m_stoppedAt{0};
467
469
470 ServiceJobTimeout m_timeoutConfig;
471
472 Aws::String m_requestId;
473 Aws::Http::HttpResponseCode m_HttpResponseCode;
474 bool m_attemptsHasBeenSet = false;
475 bool m_capacityUsageHasBeenSet = false;
476 bool m_createdAtHasBeenSet = false;
477 bool m_isTerminatedHasBeenSet = false;
478 bool m_jobArnHasBeenSet = false;
479 bool m_jobIdHasBeenSet = false;
480 bool m_jobNameHasBeenSet = false;
481 bool m_jobQueueHasBeenSet = false;
482 bool m_latestAttemptHasBeenSet = false;
483 bool m_retryStrategyHasBeenSet = false;
484 bool m_scheduledAtHasBeenSet = false;
485 bool m_schedulingPriorityHasBeenSet = false;
486 bool m_serviceRequestPayloadHasBeenSet = false;
487 bool m_serviceJobTypeHasBeenSet = false;
488 bool m_shareIdentifierHasBeenSet = false;
489 bool m_startedAtHasBeenSet = false;
490 bool m_statusHasBeenSet = false;
491 bool m_statusReasonHasBeenSet = false;
492 bool m_stoppedAtHasBeenSet = false;
493 bool m_tagsHasBeenSet = false;
494 bool m_timeoutConfigHasBeenSet = false;
495 bool m_requestIdHasBeenSet = false;
496};
497
498} // namespace Model
499} // namespace Batch
500} // namespace Aws
DescribeServiceJobResult & WithLatestAttempt(LatestAttemptT &&value)
const ServiceJobTimeout & GetTimeoutConfig() const
DescribeServiceJobResult & WithSchedulingPriority(int value)
DescribeServiceJobResult & WithShareIdentifier(ShareIdentifierT &&value)
const ServiceJobRetryStrategy & GetRetryStrategy() const
AWS_BATCH_API DescribeServiceJobResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeServiceJobResult & WithTags(TagsT &&value)
DescribeServiceJobResult & WithIsTerminated(bool value)
DescribeServiceJobResult & WithStatus(ServiceJobStatus value)
DescribeServiceJobResult & WithJobArn(JobArnT &&value)
DescribeServiceJobResult & WithRetryStrategy(RetryStrategyT &&value)
DescribeServiceJobResult & WithRequestId(RequestIdT &&value)
DescribeServiceJobResult & WithScheduledAt(long long value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
DescribeServiceJobResult & WithCreatedAt(long long value)
DescribeServiceJobResult & WithStoppedAt(long long value)
const Aws::Vector< ServiceJobCapacityUsageDetail > & GetCapacityUsage() const
const LatestServiceJobAttempt & GetLatestAttempt() const
DescribeServiceJobResult & WithAttempts(AttemptsT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
AWS_BATCH_API DescribeServiceJobResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeServiceJobResult & WithJobId(JobIdT &&value)
DescribeServiceJobResult & WithJobName(JobNameT &&value)
DescribeServiceJobResult & WithJobQueue(JobQueueT &&value)
DescribeServiceJobResult & WithStatusReason(StatusReasonT &&value)
DescribeServiceJobResult & WithTimeoutConfig(TimeoutConfigT &&value)
DescribeServiceJobResult & AddCapacityUsage(CapacityUsageT &&value)
DescribeServiceJobResult & WithStartedAt(long long value)
void SetServiceRequestPayload(ServiceRequestPayloadT &&value)
AWS_BATCH_API DescribeServiceJobResult()=default
DescribeServiceJobResult & AddAttempts(AttemptsT &&value)
DescribeServiceJobResult & WithCapacityUsage(CapacityUsageT &&value)
DescribeServiceJobResult & WithServiceRequestPayload(ServiceRequestPayloadT &&value)
DescribeServiceJobResult & AddTags(TagsKeyT &&key, TagsValueT &&value)
const Aws::Vector< ServiceJobAttemptDetail > & GetAttempts() const
DescribeServiceJobResult & WithServiceJobType(ServiceJobType value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue