AWS SDK for C++

AWS SDK for C++ Version 1.11.788

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/ServiceJobPreemptionConfiguration.h>
12#include <aws/batch/model/ServiceJobPreemptionSummary.h>
13#include <aws/batch/model/ServiceJobRetryStrategy.h>
14#include <aws/batch/model/ServiceJobStatus.h>
15#include <aws/batch/model/ServiceJobTimeout.h>
16#include <aws/batch/model/ServiceJobType.h>
17#include <aws/core/http/HttpResponse.h>
18#include <aws/core/utils/memory/stl/AWSMap.h>
19#include <aws/core/utils/memory/stl/AWSString.h>
20#include <aws/core/utils/memory/stl/AWSVector.h>
21
22#include <utility>
23
24namespace Aws {
25template <typename RESULT_TYPE>
26class AmazonWebServiceResult;
27
28namespace Utils {
29namespace Json {
30class JsonValue;
31} // namespace Json
32} // namespace Utils
33namespace Batch {
34namespace Model {
36 public:
37 AWS_BATCH_API DescribeServiceJobResult() = default;
40
42
45 inline const Aws::Vector<ServiceJobAttemptDetail>& GetAttempts() const { return m_attempts; }
46 template <typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
47 void SetAttempts(AttemptsT&& value) {
48 m_attemptsHasBeenSet = true;
49 m_attempts = std::forward<AttemptsT>(value);
50 }
51 template <typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
53 SetAttempts(std::forward<AttemptsT>(value));
54 return *this;
55 }
56 template <typename AttemptsT = ServiceJobAttemptDetail>
58 m_attemptsHasBeenSet = true;
59 m_attempts.emplace_back(std::forward<AttemptsT>(value));
60 return *this;
61 }
63
65
70 inline const Aws::Vector<ServiceJobCapacityUsageDetail>& GetCapacityUsage() const { return m_capacityUsage; }
71 template <typename CapacityUsageT = Aws::Vector<ServiceJobCapacityUsageDetail>>
72 void SetCapacityUsage(CapacityUsageT&& value) {
73 m_capacityUsageHasBeenSet = true;
74 m_capacityUsage = std::forward<CapacityUsageT>(value);
75 }
76 template <typename CapacityUsageT = Aws::Vector<ServiceJobCapacityUsageDetail>>
78 SetCapacityUsage(std::forward<CapacityUsageT>(value));
79 return *this;
80 }
81 template <typename CapacityUsageT = ServiceJobCapacityUsageDetail>
82 DescribeServiceJobResult& AddCapacityUsage(CapacityUsageT&& value) {
83 m_capacityUsageHasBeenSet = true;
84 m_capacityUsage.emplace_back(std::forward<CapacityUsageT>(value));
85 return *this;
86 }
88
90
94 inline long long GetCreatedAt() const { return m_createdAt; }
95 inline void SetCreatedAt(long long value) {
96 m_createdAtHasBeenSet = true;
97 m_createdAt = value;
98 }
99 inline DescribeServiceJobResult& WithCreatedAt(long long value) {
100 SetCreatedAt(value);
101 return *this;
102 }
104
106
109 inline bool GetIsTerminated() const { return m_isTerminated; }
110 inline void SetIsTerminated(bool value) {
111 m_isTerminatedHasBeenSet = true;
112 m_isTerminated = value;
113 }
115 SetIsTerminated(value);
116 return *this;
117 }
119
121
124 inline const Aws::String& GetJobArn() const { return m_jobArn; }
125 template <typename JobArnT = Aws::String>
126 void SetJobArn(JobArnT&& value) {
127 m_jobArnHasBeenSet = true;
128 m_jobArn = std::forward<JobArnT>(value);
129 }
130 template <typename JobArnT = Aws::String>
132 SetJobArn(std::forward<JobArnT>(value));
133 return *this;
134 }
136
138
141 inline const Aws::String& GetJobId() const { return m_jobId; }
142 template <typename JobIdT = Aws::String>
143 void SetJobId(JobIdT&& value) {
144 m_jobIdHasBeenSet = true;
145 m_jobId = std::forward<JobIdT>(value);
146 }
147 template <typename JobIdT = Aws::String>
149 SetJobId(std::forward<JobIdT>(value));
150 return *this;
151 }
153
155
158 inline const Aws::String& GetJobName() const { return m_jobName; }
159 template <typename JobNameT = Aws::String>
160 void SetJobName(JobNameT&& value) {
161 m_jobNameHasBeenSet = true;
162 m_jobName = std::forward<JobNameT>(value);
163 }
164 template <typename JobNameT = Aws::String>
166 SetJobName(std::forward<JobNameT>(value));
167 return *this;
168 }
170
172
175 inline const Aws::String& GetJobQueue() const { return m_jobQueue; }
176 template <typename JobQueueT = Aws::String>
177 void SetJobQueue(JobQueueT&& value) {
178 m_jobQueueHasBeenSet = true;
179 m_jobQueue = std::forward<JobQueueT>(value);
180 }
181 template <typename JobQueueT = Aws::String>
183 SetJobQueue(std::forward<JobQueueT>(value));
184 return *this;
185 }
187
189
192 inline const LatestServiceJobAttempt& GetLatestAttempt() const { return m_latestAttempt; }
193 template <typename LatestAttemptT = LatestServiceJobAttempt>
194 void SetLatestAttempt(LatestAttemptT&& value) {
195 m_latestAttemptHasBeenSet = true;
196 m_latestAttempt = std::forward<LatestAttemptT>(value);
197 }
198 template <typename LatestAttemptT = LatestServiceJobAttempt>
200 SetLatestAttempt(std::forward<LatestAttemptT>(value));
201 return *this;
202 }
204
206
210 inline const ServiceJobRetryStrategy& GetRetryStrategy() const { return m_retryStrategy; }
211 template <typename RetryStrategyT = ServiceJobRetryStrategy>
212 void SetRetryStrategy(RetryStrategyT&& value) {
213 m_retryStrategyHasBeenSet = true;
214 m_retryStrategy = std::forward<RetryStrategyT>(value);
215 }
216 template <typename RetryStrategyT = ServiceJobRetryStrategy>
218 SetRetryStrategy(std::forward<RetryStrategyT>(value));
219 return *this;
220 }
222
224
229 inline long long GetScheduledAt() const { return m_scheduledAt; }
230 inline void SetScheduledAt(long long value) {
231 m_scheduledAtHasBeenSet = true;
232 m_scheduledAt = value;
233 }
234 inline DescribeServiceJobResult& WithScheduledAt(long long value) {
235 SetScheduledAt(value);
236 return *this;
237 }
239
241
244 inline int GetSchedulingPriority() const { return m_schedulingPriority; }
245 inline void SetSchedulingPriority(int value) {
246 m_schedulingPriorityHasBeenSet = true;
247 m_schedulingPriority = value;
248 }
251 return *this;
252 }
254
256
260 inline const Aws::String& GetServiceRequestPayload() const { return m_serviceRequestPayload; }
261 template <typename ServiceRequestPayloadT = Aws::String>
262 void SetServiceRequestPayload(ServiceRequestPayloadT&& value) {
263 m_serviceRequestPayloadHasBeenSet = true;
264 m_serviceRequestPayload = std::forward<ServiceRequestPayloadT>(value);
265 }
266 template <typename ServiceRequestPayloadT = Aws::String>
267 DescribeServiceJobResult& WithServiceRequestPayload(ServiceRequestPayloadT&& value) {
268 SetServiceRequestPayload(std::forward<ServiceRequestPayloadT>(value));
269 return *this;
270 }
272
274
278 inline ServiceJobType GetServiceJobType() const { return m_serviceJobType; }
280 m_serviceJobTypeHasBeenSet = true;
281 m_serviceJobType = value;
282 }
284 SetServiceJobType(value);
285 return *this;
286 }
288
290
294 inline const Aws::String& GetShareIdentifier() const { return m_shareIdentifier; }
295 template <typename ShareIdentifierT = Aws::String>
296 void SetShareIdentifier(ShareIdentifierT&& value) {
297 m_shareIdentifierHasBeenSet = true;
298 m_shareIdentifier = std::forward<ShareIdentifierT>(value);
299 }
300 template <typename ShareIdentifierT = Aws::String>
302 SetShareIdentifier(std::forward<ShareIdentifierT>(value));
303 return *this;
304 }
306
308
311 inline const Aws::String& GetQuotaShareName() const { return m_quotaShareName; }
312 template <typename QuotaShareNameT = Aws::String>
313 void SetQuotaShareName(QuotaShareNameT&& value) {
314 m_quotaShareNameHasBeenSet = true;
315 m_quotaShareName = std::forward<QuotaShareNameT>(value);
316 }
317 template <typename QuotaShareNameT = Aws::String>
319 SetQuotaShareName(std::forward<QuotaShareNameT>(value));
320 return *this;
321 }
323
325
328 inline const ServiceJobPreemptionConfiguration& GetPreemptionConfiguration() const { return m_preemptionConfiguration; }
329 template <typename PreemptionConfigurationT = ServiceJobPreemptionConfiguration>
330 void SetPreemptionConfiguration(PreemptionConfigurationT&& value) {
331 m_preemptionConfigurationHasBeenSet = true;
332 m_preemptionConfiguration = std::forward<PreemptionConfigurationT>(value);
333 }
334 template <typename PreemptionConfigurationT = ServiceJobPreemptionConfiguration>
335 DescribeServiceJobResult& WithPreemptionConfiguration(PreemptionConfigurationT&& value) {
336 SetPreemptionConfiguration(std::forward<PreemptionConfigurationT>(value));
337 return *this;
338 }
340
342
346 inline const ServiceJobPreemptionSummary& GetPreemptionSummary() const { return m_preemptionSummary; }
347 template <typename PreemptionSummaryT = ServiceJobPreemptionSummary>
348 void SetPreemptionSummary(PreemptionSummaryT&& value) {
349 m_preemptionSummaryHasBeenSet = true;
350 m_preemptionSummary = std::forward<PreemptionSummaryT>(value);
351 }
352 template <typename PreemptionSummaryT = ServiceJobPreemptionSummary>
353 DescribeServiceJobResult& WithPreemptionSummary(PreemptionSummaryT&& value) {
354 SetPreemptionSummary(std::forward<PreemptionSummaryT>(value));
355 return *this;
356 }
358
360
364 inline long long GetStartedAt() const { return m_startedAt; }
365 inline void SetStartedAt(long long value) {
366 m_startedAtHasBeenSet = true;
367 m_startedAt = value;
368 }
369 inline DescribeServiceJobResult& WithStartedAt(long long value) {
370 SetStartedAt(value);
371 return *this;
372 }
374
376
379 inline ServiceJobStatus GetStatus() const { return m_status; }
380 inline void SetStatus(ServiceJobStatus value) {
381 m_statusHasBeenSet = true;
382 m_status = value;
383 }
385 SetStatus(value);
386 return *this;
387 }
389
391
395 inline const Aws::String& GetStatusReason() const { return m_statusReason; }
396 template <typename StatusReasonT = Aws::String>
397 void SetStatusReason(StatusReasonT&& value) {
398 m_statusReasonHasBeenSet = true;
399 m_statusReason = std::forward<StatusReasonT>(value);
400 }
401 template <typename StatusReasonT = Aws::String>
403 SetStatusReason(std::forward<StatusReasonT>(value));
404 return *this;
405 }
407
409
413 inline long long GetStoppedAt() const { return m_stoppedAt; }
414 inline void SetStoppedAt(long long value) {
415 m_stoppedAtHasBeenSet = true;
416 m_stoppedAt = value;
417 }
418 inline DescribeServiceJobResult& WithStoppedAt(long long value) {
419 SetStoppedAt(value);
420 return *this;
421 }
423
425
431 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
432 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
433 void SetTags(TagsT&& value) {
434 m_tagsHasBeenSet = true;
435 m_tags = std::forward<TagsT>(value);
436 }
437 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
439 SetTags(std::forward<TagsT>(value));
440 return *this;
441 }
442 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
443 DescribeServiceJobResult& AddTags(TagsKeyT&& key, TagsValueT&& value) {
444 m_tagsHasBeenSet = true;
445 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
446 return *this;
447 }
449
451
454 inline const ServiceJobTimeout& GetTimeoutConfig() const { return m_timeoutConfig; }
455 template <typename TimeoutConfigT = ServiceJobTimeout>
456 void SetTimeoutConfig(TimeoutConfigT&& value) {
457 m_timeoutConfigHasBeenSet = true;
458 m_timeoutConfig = std::forward<TimeoutConfigT>(value);
459 }
460 template <typename TimeoutConfigT = ServiceJobTimeout>
462 SetTimeoutConfig(std::forward<TimeoutConfigT>(value));
463 return *this;
464 }
466
468
469 inline const Aws::String& GetRequestId() const { return m_requestId; }
470 template <typename RequestIdT = Aws::String>
471 void SetRequestId(RequestIdT&& value) {
472 m_requestIdHasBeenSet = true;
473 m_requestId = std::forward<RequestIdT>(value);
474 }
475 template <typename RequestIdT = Aws::String>
477 SetRequestId(std::forward<RequestIdT>(value));
478 return *this;
479 }
481 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
482
483 private:
485
487
488 long long m_createdAt{0};
489
490 bool m_isTerminated{false};
491
492 Aws::String m_jobArn;
493
494 Aws::String m_jobId;
495
496 Aws::String m_jobName;
497
498 Aws::String m_jobQueue;
499
500 LatestServiceJobAttempt m_latestAttempt;
501
502 ServiceJobRetryStrategy m_retryStrategy;
503
504 long long m_scheduledAt{0};
505
506 int m_schedulingPriority{0};
507
508 Aws::String m_serviceRequestPayload;
509
510 ServiceJobType m_serviceJobType{ServiceJobType::NOT_SET};
511
512 Aws::String m_shareIdentifier;
513
514 Aws::String m_quotaShareName;
515
516 ServiceJobPreemptionConfiguration m_preemptionConfiguration;
517
518 ServiceJobPreemptionSummary m_preemptionSummary;
519
520 long long m_startedAt{0};
521
523
524 Aws::String m_statusReason;
525
526 long long m_stoppedAt{0};
527
529
530 ServiceJobTimeout m_timeoutConfig;
531
532 Aws::String m_requestId;
533 Aws::Http::HttpResponseCode m_HttpResponseCode;
534 bool m_attemptsHasBeenSet = false;
535 bool m_capacityUsageHasBeenSet = false;
536 bool m_createdAtHasBeenSet = false;
537 bool m_isTerminatedHasBeenSet = false;
538 bool m_jobArnHasBeenSet = false;
539 bool m_jobIdHasBeenSet = false;
540 bool m_jobNameHasBeenSet = false;
541 bool m_jobQueueHasBeenSet = false;
542 bool m_latestAttemptHasBeenSet = false;
543 bool m_retryStrategyHasBeenSet = false;
544 bool m_scheduledAtHasBeenSet = false;
545 bool m_schedulingPriorityHasBeenSet = false;
546 bool m_serviceRequestPayloadHasBeenSet = false;
547 bool m_serviceJobTypeHasBeenSet = false;
548 bool m_shareIdentifierHasBeenSet = false;
549 bool m_quotaShareNameHasBeenSet = false;
550 bool m_preemptionConfigurationHasBeenSet = false;
551 bool m_preemptionSummaryHasBeenSet = false;
552 bool m_startedAtHasBeenSet = false;
553 bool m_statusHasBeenSet = false;
554 bool m_statusReasonHasBeenSet = false;
555 bool m_stoppedAtHasBeenSet = false;
556 bool m_tagsHasBeenSet = false;
557 bool m_timeoutConfigHasBeenSet = false;
558 bool m_requestIdHasBeenSet = false;
559};
560
561} // namespace Model
562} // namespace Batch
563} // 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 & WithPreemptionConfiguration(PreemptionConfigurationT &&value)
DescribeServiceJobResult & WithTags(TagsT &&value)
DescribeServiceJobResult & WithIsTerminated(bool value)
DescribeServiceJobResult & WithStatus(ServiceJobStatus value)
DescribeServiceJobResult & WithJobArn(JobArnT &&value)
const ServiceJobPreemptionSummary & GetPreemptionSummary() const
DescribeServiceJobResult & WithQuotaShareName(QuotaShareNameT &&value)
const ServiceJobPreemptionConfiguration & GetPreemptionConfiguration() const
DescribeServiceJobResult & WithRetryStrategy(RetryStrategyT &&value)
void SetPreemptionConfiguration(PreemptionConfigurationT &&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
void SetPreemptionSummary(PreemptionSummaryT &&value)
const LatestServiceJobAttempt & GetLatestAttempt() const
DescribeServiceJobResult & WithPreemptionSummary(PreemptionSummaryT &&value)
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