AWS SDK for C++

AWS SDK for C++ Version 1.11.634

Loading...
Searching...
No Matches
DescribeServiceJobResult.h
1
6#pragma once
7#include <aws/batch/Batch_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/batch/model/LatestServiceJobAttempt.h>
11#include <aws/batch/model/ServiceJobRetryStrategy.h>
12#include <aws/batch/model/ServiceJobType.h>
13#include <aws/batch/model/ServiceJobStatus.h>
14#include <aws/core/utils/memory/stl/AWSMap.h>
15#include <aws/batch/model/ServiceJobTimeout.h>
16#include <aws/batch/model/ServiceJobAttemptDetail.h>
17#include <utility>
18
19namespace Aws
20{
21template<typename RESULT_TYPE>
22class AmazonWebServiceResult;
23
24namespace Utils
25{
26namespace Json
27{
28 class JsonValue;
29} // namespace Json
30} // namespace Utils
31namespace Batch
32{
33namespace Model
34{
36 {
37 public:
38 AWS_BATCH_API DescribeServiceJobResult() = default;
41
42
44
47 inline const Aws::Vector<ServiceJobAttemptDetail>& GetAttempts() const { return m_attempts; }
48 template<typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
49 void SetAttempts(AttemptsT&& value) { m_attemptsHasBeenSet = true; m_attempts = std::forward<AttemptsT>(value); }
50 template<typename AttemptsT = Aws::Vector<ServiceJobAttemptDetail>>
51 DescribeServiceJobResult& WithAttempts(AttemptsT&& value) { SetAttempts(std::forward<AttemptsT>(value)); return *this;}
52 template<typename AttemptsT = ServiceJobAttemptDetail>
53 DescribeServiceJobResult& AddAttempts(AttemptsT&& value) { m_attemptsHasBeenSet = true; m_attempts.emplace_back(std::forward<AttemptsT>(value)); return *this; }
55
57
61 inline long long GetCreatedAt() const { return m_createdAt; }
62 inline void SetCreatedAt(long long value) { m_createdAtHasBeenSet = true; m_createdAt = value; }
63 inline DescribeServiceJobResult& WithCreatedAt(long long value) { SetCreatedAt(value); return *this;}
65
67
70 inline bool GetIsTerminated() const { return m_isTerminated; }
71 inline void SetIsTerminated(bool value) { m_isTerminatedHasBeenSet = true; m_isTerminated = value; }
72 inline DescribeServiceJobResult& WithIsTerminated(bool value) { SetIsTerminated(value); return *this;}
74
76
79 inline const Aws::String& GetJobArn() const { return m_jobArn; }
80 template<typename JobArnT = Aws::String>
81 void SetJobArn(JobArnT&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::forward<JobArnT>(value); }
82 template<typename JobArnT = Aws::String>
83 DescribeServiceJobResult& WithJobArn(JobArnT&& value) { SetJobArn(std::forward<JobArnT>(value)); return *this;}
85
87
90 inline const Aws::String& GetJobId() const { return m_jobId; }
91 template<typename JobIdT = Aws::String>
92 void SetJobId(JobIdT&& value) { m_jobIdHasBeenSet = true; m_jobId = std::forward<JobIdT>(value); }
93 template<typename JobIdT = Aws::String>
94 DescribeServiceJobResult& WithJobId(JobIdT&& value) { SetJobId(std::forward<JobIdT>(value)); return *this;}
96
98
101 inline const Aws::String& GetJobName() const { return m_jobName; }
102 template<typename JobNameT = Aws::String>
103 void SetJobName(JobNameT&& value) { m_jobNameHasBeenSet = true; m_jobName = std::forward<JobNameT>(value); }
104 template<typename JobNameT = Aws::String>
105 DescribeServiceJobResult& WithJobName(JobNameT&& value) { SetJobName(std::forward<JobNameT>(value)); return *this;}
107
109
112 inline const Aws::String& GetJobQueue() const { return m_jobQueue; }
113 template<typename JobQueueT = Aws::String>
114 void SetJobQueue(JobQueueT&& value) { m_jobQueueHasBeenSet = true; m_jobQueue = std::forward<JobQueueT>(value); }
115 template<typename JobQueueT = Aws::String>
116 DescribeServiceJobResult& WithJobQueue(JobQueueT&& value) { SetJobQueue(std::forward<JobQueueT>(value)); return *this;}
118
120
123 inline const LatestServiceJobAttempt& GetLatestAttempt() const { return m_latestAttempt; }
124 template<typename LatestAttemptT = LatestServiceJobAttempt>
125 void SetLatestAttempt(LatestAttemptT&& value) { m_latestAttemptHasBeenSet = true; m_latestAttempt = std::forward<LatestAttemptT>(value); }
126 template<typename LatestAttemptT = LatestServiceJobAttempt>
127 DescribeServiceJobResult& WithLatestAttempt(LatestAttemptT&& value) { SetLatestAttempt(std::forward<LatestAttemptT>(value)); return *this;}
129
131
135 inline const ServiceJobRetryStrategy& GetRetryStrategy() const { return m_retryStrategy; }
136 template<typename RetryStrategyT = ServiceJobRetryStrategy>
137 void SetRetryStrategy(RetryStrategyT&& value) { m_retryStrategyHasBeenSet = true; m_retryStrategy = std::forward<RetryStrategyT>(value); }
138 template<typename RetryStrategyT = ServiceJobRetryStrategy>
139 DescribeServiceJobResult& WithRetryStrategy(RetryStrategyT&& value) { SetRetryStrategy(std::forward<RetryStrategyT>(value)); return *this;}
141
143
146 inline int GetSchedulingPriority() const { return m_schedulingPriority; }
147 inline void SetSchedulingPriority(int value) { m_schedulingPriorityHasBeenSet = true; m_schedulingPriority = value; }
150
152
156 inline const Aws::String& GetServiceRequestPayload() const { return m_serviceRequestPayload; }
157 template<typename ServiceRequestPayloadT = Aws::String>
158 void SetServiceRequestPayload(ServiceRequestPayloadT&& value) { m_serviceRequestPayloadHasBeenSet = true; m_serviceRequestPayload = std::forward<ServiceRequestPayloadT>(value); }
159 template<typename ServiceRequestPayloadT = Aws::String>
160 DescribeServiceJobResult& WithServiceRequestPayload(ServiceRequestPayloadT&& value) { SetServiceRequestPayload(std::forward<ServiceRequestPayloadT>(value)); return *this;}
162
164
168 inline ServiceJobType GetServiceJobType() const { return m_serviceJobType; }
169 inline void SetServiceJobType(ServiceJobType value) { m_serviceJobTypeHasBeenSet = true; m_serviceJobType = value; }
172
174
178 inline const Aws::String& GetShareIdentifier() const { return m_shareIdentifier; }
179 template<typename ShareIdentifierT = Aws::String>
180 void SetShareIdentifier(ShareIdentifierT&& value) { m_shareIdentifierHasBeenSet = true; m_shareIdentifier = std::forward<ShareIdentifierT>(value); }
181 template<typename ShareIdentifierT = Aws::String>
182 DescribeServiceJobResult& WithShareIdentifier(ShareIdentifierT&& value) { SetShareIdentifier(std::forward<ShareIdentifierT>(value)); return *this;}
184
186
190 inline long long GetStartedAt() const { return m_startedAt; }
191 inline void SetStartedAt(long long value) { m_startedAtHasBeenSet = true; m_startedAt = value; }
192 inline DescribeServiceJobResult& WithStartedAt(long long value) { SetStartedAt(value); return *this;}
194
196
199 inline ServiceJobStatus GetStatus() const { return m_status; }
200 inline void SetStatus(ServiceJobStatus value) { m_statusHasBeenSet = true; m_status = value; }
201 inline DescribeServiceJobResult& WithStatus(ServiceJobStatus value) { SetStatus(value); return *this;}
203
205
209 inline const Aws::String& GetStatusReason() const { return m_statusReason; }
210 template<typename StatusReasonT = Aws::String>
211 void SetStatusReason(StatusReasonT&& value) { m_statusReasonHasBeenSet = true; m_statusReason = std::forward<StatusReasonT>(value); }
212 template<typename StatusReasonT = Aws::String>
213 DescribeServiceJobResult& WithStatusReason(StatusReasonT&& value) { SetStatusReason(std::forward<StatusReasonT>(value)); return *this;}
215
217
221 inline long long GetStoppedAt() const { return m_stoppedAt; }
222 inline void SetStoppedAt(long long value) { m_stoppedAtHasBeenSet = true; m_stoppedAt = value; }
223 inline DescribeServiceJobResult& WithStoppedAt(long long value) { SetStoppedAt(value); return *this;}
225
227
233 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
234 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
235 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
236 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
237 DescribeServiceJobResult& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
238 template<typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
239 DescribeServiceJobResult& AddTags(TagsKeyT&& key, TagsValueT&& value) {
240 m_tagsHasBeenSet = true; m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value)); return *this;
241 }
243
245
248 inline const ServiceJobTimeout& GetTimeoutConfig() const { return m_timeoutConfig; }
249 template<typename TimeoutConfigT = ServiceJobTimeout>
250 void SetTimeoutConfig(TimeoutConfigT&& value) { m_timeoutConfigHasBeenSet = true; m_timeoutConfig = std::forward<TimeoutConfigT>(value); }
251 template<typename TimeoutConfigT = ServiceJobTimeout>
252 DescribeServiceJobResult& WithTimeoutConfig(TimeoutConfigT&& value) { SetTimeoutConfig(std::forward<TimeoutConfigT>(value)); return *this;}
254
256
257 inline const Aws::String& GetRequestId() const { return m_requestId; }
258 template<typename RequestIdT = Aws::String>
259 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
260 template<typename RequestIdT = Aws::String>
261 DescribeServiceJobResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
263 private:
264
266 bool m_attemptsHasBeenSet = false;
267
268 long long m_createdAt{0};
269 bool m_createdAtHasBeenSet = false;
270
271 bool m_isTerminated{false};
272 bool m_isTerminatedHasBeenSet = false;
273
274 Aws::String m_jobArn;
275 bool m_jobArnHasBeenSet = false;
276
277 Aws::String m_jobId;
278 bool m_jobIdHasBeenSet = false;
279
280 Aws::String m_jobName;
281 bool m_jobNameHasBeenSet = false;
282
283 Aws::String m_jobQueue;
284 bool m_jobQueueHasBeenSet = false;
285
286 LatestServiceJobAttempt m_latestAttempt;
287 bool m_latestAttemptHasBeenSet = false;
288
289 ServiceJobRetryStrategy m_retryStrategy;
290 bool m_retryStrategyHasBeenSet = false;
291
292 int m_schedulingPriority{0};
293 bool m_schedulingPriorityHasBeenSet = false;
294
295 Aws::String m_serviceRequestPayload;
296 bool m_serviceRequestPayloadHasBeenSet = false;
297
298 ServiceJobType m_serviceJobType{ServiceJobType::NOT_SET};
299 bool m_serviceJobTypeHasBeenSet = false;
300
301 Aws::String m_shareIdentifier;
302 bool m_shareIdentifierHasBeenSet = false;
303
304 long long m_startedAt{0};
305 bool m_startedAtHasBeenSet = false;
306
308 bool m_statusHasBeenSet = false;
309
310 Aws::String m_statusReason;
311 bool m_statusReasonHasBeenSet = false;
312
313 long long m_stoppedAt{0};
314 bool m_stoppedAtHasBeenSet = false;
315
317 bool m_tagsHasBeenSet = false;
318
319 ServiceJobTimeout m_timeoutConfig;
320 bool m_timeoutConfigHasBeenSet = false;
321
322 Aws::String m_requestId;
323 bool m_requestIdHasBeenSet = false;
324 };
325
326} // namespace Model
327} // namespace Batch
328} // 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)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
DescribeServiceJobResult & WithCreatedAt(long long value)
DescribeServiceJobResult & WithStoppedAt(long long value)
const LatestServiceJobAttempt & GetLatestAttempt() const
DescribeServiceJobResult & WithAttempts(AttemptsT &&value)
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 & WithStartedAt(long long value)
void SetServiceRequestPayload(ServiceRequestPayloadT &&value)
AWS_BATCH_API DescribeServiceJobResult()=default
DescribeServiceJobResult & AddAttempts(AttemptsT &&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