AWS SDK for C++

AWS SDK for C++ Version 1.11.717

Loading...
Searching...
No Matches
JobDescriptor.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/s3control/S3Control_EXPORTS.h>
11#include <aws/s3control/model/JobFailure.h>
12#include <aws/s3control/model/JobManifest.h>
13#include <aws/s3control/model/JobManifestGenerator.h>
14#include <aws/s3control/model/JobOperation.h>
15#include <aws/s3control/model/JobProgressSummary.h>
16#include <aws/s3control/model/JobReport.h>
17#include <aws/s3control/model/JobStatus.h>
18#include <aws/s3control/model/S3GeneratedManifestDescriptor.h>
19
20#include <utility>
21
22namespace Aws {
23namespace Utils {
24namespace Xml {
25class XmlNode;
26} // namespace Xml
27} // namespace Utils
28namespace S3Control {
29namespace Model {
30
38 public:
39 AWS_S3CONTROL_API JobDescriptor() = default;
40 AWS_S3CONTROL_API JobDescriptor(const Aws::Utils::Xml::XmlNode& xmlNode);
41 AWS_S3CONTROL_API JobDescriptor& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
42
43 AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
44
46
49 inline const Aws::String& GetJobId() const { return m_jobId; }
50 inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
51 template <typename JobIdT = Aws::String>
52 void SetJobId(JobIdT&& value) {
53 m_jobIdHasBeenSet = true;
54 m_jobId = std::forward<JobIdT>(value);
55 }
56 template <typename JobIdT = Aws::String>
57 JobDescriptor& WithJobId(JobIdT&& value) {
58 SetJobId(std::forward<JobIdT>(value));
59 return *this;
60 }
62
64
69 inline bool GetConfirmationRequired() const { return m_confirmationRequired; }
70 inline bool ConfirmationRequiredHasBeenSet() const { return m_confirmationRequiredHasBeenSet; }
71 inline void SetConfirmationRequired(bool value) {
72 m_confirmationRequiredHasBeenSet = true;
73 m_confirmationRequired = value;
74 }
77 return *this;
78 }
80
82
86 inline const Aws::String& GetDescription() const { return m_description; }
87 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
88 template <typename DescriptionT = Aws::String>
89 void SetDescription(DescriptionT&& value) {
90 m_descriptionHasBeenSet = true;
91 m_description = std::forward<DescriptionT>(value);
92 }
93 template <typename DescriptionT = Aws::String>
94 JobDescriptor& WithDescription(DescriptionT&& value) {
95 SetDescription(std::forward<DescriptionT>(value));
96 return *this;
97 }
99
101
104 inline const Aws::String& GetJobArn() const { return m_jobArn; }
105 inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; }
106 template <typename JobArnT = Aws::String>
107 void SetJobArn(JobArnT&& value) {
108 m_jobArnHasBeenSet = true;
109 m_jobArn = std::forward<JobArnT>(value);
110 }
111 template <typename JobArnT = Aws::String>
112 JobDescriptor& WithJobArn(JobArnT&& value) {
113 SetJobArn(std::forward<JobArnT>(value));
114 return *this;
115 }
117
119
122 inline JobStatus GetStatus() const { return m_status; }
123 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
124 inline void SetStatus(JobStatus value) {
125 m_statusHasBeenSet = true;
126 m_status = value;
127 }
129 SetStatus(value);
130 return *this;
131 }
133
135
138 inline const JobManifest& GetManifest() const { return m_manifest; }
139 inline bool ManifestHasBeenSet() const { return m_manifestHasBeenSet; }
140 template <typename ManifestT = JobManifest>
141 void SetManifest(ManifestT&& value) {
142 m_manifestHasBeenSet = true;
143 m_manifest = std::forward<ManifestT>(value);
144 }
145 template <typename ManifestT = JobManifest>
146 JobDescriptor& WithManifest(ManifestT&& value) {
147 SetManifest(std::forward<ManifestT>(value));
148 return *this;
149 }
151
153
157 inline const JobOperation& GetOperation() const { return m_operation; }
158 inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; }
159 template <typename OperationT = JobOperation>
160 void SetOperation(OperationT&& value) {
161 m_operationHasBeenSet = true;
162 m_operation = std::forward<OperationT>(value);
163 }
164 template <typename OperationT = JobOperation>
165 JobDescriptor& WithOperation(OperationT&& value) {
166 SetOperation(std::forward<OperationT>(value));
167 return *this;
168 }
170
172
175 inline int GetPriority() const { return m_priority; }
176 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
177 inline void SetPriority(int value) {
178 m_priorityHasBeenSet = true;
179 m_priority = value;
180 }
181 inline JobDescriptor& WithPriority(int value) {
182 SetPriority(value);
183 return *this;
184 }
186
188
192 inline const JobProgressSummary& GetProgressSummary() const { return m_progressSummary; }
193 inline bool ProgressSummaryHasBeenSet() const { return m_progressSummaryHasBeenSet; }
194 template <typename ProgressSummaryT = JobProgressSummary>
195 void SetProgressSummary(ProgressSummaryT&& value) {
196 m_progressSummaryHasBeenSet = true;
197 m_progressSummary = std::forward<ProgressSummaryT>(value);
198 }
199 template <typename ProgressSummaryT = JobProgressSummary>
200 JobDescriptor& WithProgressSummary(ProgressSummaryT&& value) {
201 SetProgressSummary(std::forward<ProgressSummaryT>(value));
202 return *this;
203 }
205
207
210 inline const Aws::String& GetStatusUpdateReason() const { return m_statusUpdateReason; }
211 inline bool StatusUpdateReasonHasBeenSet() const { return m_statusUpdateReasonHasBeenSet; }
212 template <typename StatusUpdateReasonT = Aws::String>
213 void SetStatusUpdateReason(StatusUpdateReasonT&& value) {
214 m_statusUpdateReasonHasBeenSet = true;
215 m_statusUpdateReason = std::forward<StatusUpdateReasonT>(value);
216 }
217 template <typename StatusUpdateReasonT = Aws::String>
218 JobDescriptor& WithStatusUpdateReason(StatusUpdateReasonT&& value) {
219 SetStatusUpdateReason(std::forward<StatusUpdateReasonT>(value));
220 return *this;
221 }
223
225
229 inline const Aws::Vector<JobFailure>& GetFailureReasons() const { return m_failureReasons; }
230 inline bool FailureReasonsHasBeenSet() const { return m_failureReasonsHasBeenSet; }
231 template <typename FailureReasonsT = Aws::Vector<JobFailure>>
232 void SetFailureReasons(FailureReasonsT&& value) {
233 m_failureReasonsHasBeenSet = true;
234 m_failureReasons = std::forward<FailureReasonsT>(value);
235 }
236 template <typename FailureReasonsT = Aws::Vector<JobFailure>>
237 JobDescriptor& WithFailureReasons(FailureReasonsT&& value) {
238 SetFailureReasons(std::forward<FailureReasonsT>(value));
239 return *this;
240 }
241 template <typename FailureReasonsT = JobFailure>
242 JobDescriptor& AddFailureReasons(FailureReasonsT&& value) {
243 m_failureReasonsHasBeenSet = true;
244 m_failureReasons.emplace_back(std::forward<FailureReasonsT>(value));
245 return *this;
246 }
248
250
254 inline const JobReport& GetReport() const { return m_report; }
255 inline bool ReportHasBeenSet() const { return m_reportHasBeenSet; }
256 template <typename ReportT = JobReport>
257 void SetReport(ReportT&& value) {
258 m_reportHasBeenSet = true;
259 m_report = std::forward<ReportT>(value);
260 }
261 template <typename ReportT = JobReport>
262 JobDescriptor& WithReport(ReportT&& value) {
263 SetReport(std::forward<ReportT>(value));
264 return *this;
265 }
267
269
272 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
273 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
274 template <typename CreationTimeT = Aws::Utils::DateTime>
275 void SetCreationTime(CreationTimeT&& value) {
276 m_creationTimeHasBeenSet = true;
277 m_creationTime = std::forward<CreationTimeT>(value);
278 }
279 template <typename CreationTimeT = Aws::Utils::DateTime>
280 JobDescriptor& WithCreationTime(CreationTimeT&& value) {
281 SetCreationTime(std::forward<CreationTimeT>(value));
282 return *this;
283 }
285
287
291 inline const Aws::Utils::DateTime& GetTerminationDate() const { return m_terminationDate; }
292 inline bool TerminationDateHasBeenSet() const { return m_terminationDateHasBeenSet; }
293 template <typename TerminationDateT = Aws::Utils::DateTime>
294 void SetTerminationDate(TerminationDateT&& value) {
295 m_terminationDateHasBeenSet = true;
296 m_terminationDate = std::forward<TerminationDateT>(value);
297 }
298 template <typename TerminationDateT = Aws::Utils::DateTime>
299 JobDescriptor& WithTerminationDate(TerminationDateT&& value) {
300 SetTerminationDate(std::forward<TerminationDateT>(value));
301 return *this;
302 }
304
306
310 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
311 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
312 template <typename RoleArnT = Aws::String>
313 void SetRoleArn(RoleArnT&& value) {
314 m_roleArnHasBeenSet = true;
315 m_roleArn = std::forward<RoleArnT>(value);
316 }
317 template <typename RoleArnT = Aws::String>
318 JobDescriptor& WithRoleArn(RoleArnT&& value) {
319 SetRoleArn(std::forward<RoleArnT>(value));
320 return *this;
321 }
323
325
328 inline const Aws::Utils::DateTime& GetSuspendedDate() const { return m_suspendedDate; }
329 inline bool SuspendedDateHasBeenSet() const { return m_suspendedDateHasBeenSet; }
330 template <typename SuspendedDateT = Aws::Utils::DateTime>
331 void SetSuspendedDate(SuspendedDateT&& value) {
332 m_suspendedDateHasBeenSet = true;
333 m_suspendedDate = std::forward<SuspendedDateT>(value);
334 }
335 template <typename SuspendedDateT = Aws::Utils::DateTime>
336 JobDescriptor& WithSuspendedDate(SuspendedDateT&& value) {
337 SetSuspendedDate(std::forward<SuspendedDateT>(value));
338 return *this;
339 }
341
343
349 inline const Aws::String& GetSuspendedCause() const { return m_suspendedCause; }
350 inline bool SuspendedCauseHasBeenSet() const { return m_suspendedCauseHasBeenSet; }
351 template <typename SuspendedCauseT = Aws::String>
352 void SetSuspendedCause(SuspendedCauseT&& value) {
353 m_suspendedCauseHasBeenSet = true;
354 m_suspendedCause = std::forward<SuspendedCauseT>(value);
355 }
356 template <typename SuspendedCauseT = Aws::String>
357 JobDescriptor& WithSuspendedCause(SuspendedCauseT&& value) {
358 SetSuspendedCause(std::forward<SuspendedCauseT>(value));
359 return *this;
360 }
362
364
368 inline const JobManifestGenerator& GetManifestGenerator() const { return m_manifestGenerator; }
369 inline bool ManifestGeneratorHasBeenSet() const { return m_manifestGeneratorHasBeenSet; }
370 template <typename ManifestGeneratorT = JobManifestGenerator>
371 void SetManifestGenerator(ManifestGeneratorT&& value) {
372 m_manifestGeneratorHasBeenSet = true;
373 m_manifestGenerator = std::forward<ManifestGeneratorT>(value);
374 }
375 template <typename ManifestGeneratorT = JobManifestGenerator>
376 JobDescriptor& WithManifestGenerator(ManifestGeneratorT&& value) {
377 SetManifestGenerator(std::forward<ManifestGeneratorT>(value));
378 return *this;
379 }
381
383
387 inline const S3GeneratedManifestDescriptor& GetGeneratedManifestDescriptor() const { return m_generatedManifestDescriptor; }
388 inline bool GeneratedManifestDescriptorHasBeenSet() const { return m_generatedManifestDescriptorHasBeenSet; }
389 template <typename GeneratedManifestDescriptorT = S3GeneratedManifestDescriptor>
390 void SetGeneratedManifestDescriptor(GeneratedManifestDescriptorT&& value) {
391 m_generatedManifestDescriptorHasBeenSet = true;
392 m_generatedManifestDescriptor = std::forward<GeneratedManifestDescriptorT>(value);
393 }
394 template <typename GeneratedManifestDescriptorT = S3GeneratedManifestDescriptor>
395 JobDescriptor& WithGeneratedManifestDescriptor(GeneratedManifestDescriptorT&& value) {
396 SetGeneratedManifestDescriptor(std::forward<GeneratedManifestDescriptorT>(value));
397 return *this;
398 }
400 private:
401 Aws::String m_jobId;
402
403 bool m_confirmationRequired{false};
404
405 Aws::String m_description;
406
407 Aws::String m_jobArn;
408
410
411 JobManifest m_manifest;
412
413 JobOperation m_operation;
414
415 int m_priority{0};
416
417 JobProgressSummary m_progressSummary;
418
419 Aws::String m_statusUpdateReason;
420
421 Aws::Vector<JobFailure> m_failureReasons;
422
423 JobReport m_report;
424
425 Aws::Utils::DateTime m_creationTime{};
426
427 Aws::Utils::DateTime m_terminationDate{};
428
429 Aws::String m_roleArn;
430
431 Aws::Utils::DateTime m_suspendedDate{};
432
433 Aws::String m_suspendedCause;
434
435 JobManifestGenerator m_manifestGenerator;
436
437 S3GeneratedManifestDescriptor m_generatedManifestDescriptor;
438 bool m_jobIdHasBeenSet = false;
439 bool m_confirmationRequiredHasBeenSet = false;
440 bool m_descriptionHasBeenSet = false;
441 bool m_jobArnHasBeenSet = false;
442 bool m_statusHasBeenSet = false;
443 bool m_manifestHasBeenSet = false;
444 bool m_operationHasBeenSet = false;
445 bool m_priorityHasBeenSet = false;
446 bool m_progressSummaryHasBeenSet = false;
447 bool m_statusUpdateReasonHasBeenSet = false;
448 bool m_failureReasonsHasBeenSet = false;
449 bool m_reportHasBeenSet = false;
450 bool m_creationTimeHasBeenSet = false;
451 bool m_terminationDateHasBeenSet = false;
452 bool m_roleArnHasBeenSet = false;
453 bool m_suspendedDateHasBeenSet = false;
454 bool m_suspendedCauseHasBeenSet = false;
455 bool m_manifestGeneratorHasBeenSet = false;
456 bool m_generatedManifestDescriptorHasBeenSet = false;
457};
458
459} // namespace Model
460} // namespace S3Control
461} // namespace Aws
const Aws::Utils::DateTime & GetTerminationDate() const
AWS_S3CONTROL_API JobDescriptor & operator=(const Aws::Utils::Xml::XmlNode &xmlNode)
JobDescriptor & WithStatus(JobStatus value)
JobDescriptor & WithManifest(ManifestT &&value)
JobDescriptor & WithReport(ReportT &&value)
const Aws::String & GetRoleArn() const
void SetSuspendedCause(SuspendedCauseT &&value)
const JobManifest & GetManifest() const
JobDescriptor & WithStatusUpdateReason(StatusUpdateReasonT &&value)
AWS_S3CONTROL_API JobDescriptor(const Aws::Utils::Xml::XmlNode &xmlNode)
JobDescriptor & WithTerminationDate(TerminationDateT &&value)
const JobManifestGenerator & GetManifestGenerator() const
const JobReport & GetReport() const
const JobOperation & GetOperation() const
JobDescriptor & WithFailureReasons(FailureReasonsT &&value)
const Aws::Vector< JobFailure > & GetFailureReasons() const
void SetCreationTime(CreationTimeT &&value)
void SetManifestGenerator(ManifestGeneratorT &&value)
const Aws::Utils::DateTime & GetSuspendedDate() const
void SetSuspendedDate(SuspendedDateT &&value)
JobDescriptor & WithPriority(int value)
JobDescriptor & WithDescription(DescriptionT &&value)
void SetStatusUpdateReason(StatusUpdateReasonT &&value)
const Aws::String & GetSuspendedCause() const
AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode &parentNode) const
JobDescriptor & WithCreationTime(CreationTimeT &&value)
void SetOperation(OperationT &&value)
JobDescriptor & WithOperation(OperationT &&value)
void SetGeneratedManifestDescriptor(GeneratedManifestDescriptorT &&value)
JobDescriptor & WithConfirmationRequired(bool value)
JobDescriptor & AddFailureReasons(FailureReasonsT &&value)
JobDescriptor & WithManifestGenerator(ManifestGeneratorT &&value)
const S3GeneratedManifestDescriptor & GetGeneratedManifestDescriptor() const
const Aws::String & GetJobId() const
JobDescriptor & WithGeneratedManifestDescriptor(GeneratedManifestDescriptorT &&value)
void SetFailureReasons(FailureReasonsT &&value)
AWS_S3CONTROL_API JobDescriptor()=default
JobDescriptor & WithJobId(JobIdT &&value)
const Aws::String & GetStatusUpdateReason() const
JobDescriptor & WithRoleArn(RoleArnT &&value)
void SetManifest(ManifestT &&value)
void SetTerminationDate(TerminationDateT &&value)
const Aws::String & GetJobArn() const
void SetDescription(DescriptionT &&value)
const Aws::String & GetDescription() const
JobDescriptor & WithSuspendedCause(SuspendedCauseT &&value)
JobDescriptor & WithJobArn(JobArnT &&value)
JobDescriptor & WithProgressSummary(ProgressSummaryT &&value)
const Aws::Utils::DateTime & GetCreationTime() const
JobDescriptor & WithSuspendedDate(SuspendedDateT &&value)
const JobProgressSummary & GetProgressSummary() const
void SetProgressSummary(ProgressSummaryT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector