AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
JobDescriptor.h
1
6#pragma once
7#include <aws/s3control/S3Control_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/s3control/model/JobStatus.h>
10#include <aws/s3control/model/JobManifest.h>
11#include <aws/s3control/model/JobOperation.h>
12#include <aws/s3control/model/JobProgressSummary.h>
13#include <aws/core/utils/memory/stl/AWSVector.h>
14#include <aws/s3control/model/JobReport.h>
15#include <aws/core/utils/DateTime.h>
16#include <aws/s3control/model/JobManifestGenerator.h>
17#include <aws/s3control/model/S3GeneratedManifestDescriptor.h>
18#include <aws/s3control/model/JobFailure.h>
19#include <utility>
20
21namespace Aws
22{
23namespace Utils
24{
25namespace Xml
26{
27 class XmlNode;
28} // namespace Xml
29} // namespace Utils
30namespace S3Control
31{
32namespace Model
33{
34
42 {
43 public:
44 AWS_S3CONTROL_API JobDescriptor() = default;
45 AWS_S3CONTROL_API JobDescriptor(const Aws::Utils::Xml::XmlNode& xmlNode);
46 AWS_S3CONTROL_API JobDescriptor& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
47
48 AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
49
50
52
55 inline const Aws::String& GetJobId() const { return m_jobId; }
56 inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
57 template<typename JobIdT = Aws::String>
58 void SetJobId(JobIdT&& value) { m_jobIdHasBeenSet = true; m_jobId = std::forward<JobIdT>(value); }
59 template<typename JobIdT = Aws::String>
60 JobDescriptor& WithJobId(JobIdT&& value) { SetJobId(std::forward<JobIdT>(value)); return *this;}
62
64
69 inline bool GetConfirmationRequired() const { return m_confirmationRequired; }
70 inline bool ConfirmationRequiredHasBeenSet() const { return m_confirmationRequiredHasBeenSet; }
71 inline void SetConfirmationRequired(bool value) { m_confirmationRequiredHasBeenSet = true; m_confirmationRequired = value; }
72 inline JobDescriptor& WithConfirmationRequired(bool value) { SetConfirmationRequired(value); return *this;}
74
76
80 inline const Aws::String& GetDescription() const { return m_description; }
81 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
82 template<typename DescriptionT = Aws::String>
83 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
84 template<typename DescriptionT = Aws::String>
85 JobDescriptor& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
87
89
92 inline const Aws::String& GetJobArn() const { return m_jobArn; }
93 inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; }
94 template<typename JobArnT = Aws::String>
95 void SetJobArn(JobArnT&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::forward<JobArnT>(value); }
96 template<typename JobArnT = Aws::String>
97 JobDescriptor& WithJobArn(JobArnT&& value) { SetJobArn(std::forward<JobArnT>(value)); return *this;}
99
101
104 inline JobStatus GetStatus() const { return m_status; }
105 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
106 inline void SetStatus(JobStatus value) { m_statusHasBeenSet = true; m_status = value; }
107 inline JobDescriptor& WithStatus(JobStatus value) { SetStatus(value); return *this;}
109
111
114 inline const JobManifest& GetManifest() const { return m_manifest; }
115 inline bool ManifestHasBeenSet() const { return m_manifestHasBeenSet; }
116 template<typename ManifestT = JobManifest>
117 void SetManifest(ManifestT&& value) { m_manifestHasBeenSet = true; m_manifest = std::forward<ManifestT>(value); }
118 template<typename ManifestT = JobManifest>
119 JobDescriptor& WithManifest(ManifestT&& value) { SetManifest(std::forward<ManifestT>(value)); return *this;}
121
123
127 inline const JobOperation& GetOperation() const { return m_operation; }
128 inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; }
129 template<typename OperationT = JobOperation>
130 void SetOperation(OperationT&& value) { m_operationHasBeenSet = true; m_operation = std::forward<OperationT>(value); }
131 template<typename OperationT = JobOperation>
132 JobDescriptor& WithOperation(OperationT&& value) { SetOperation(std::forward<OperationT>(value)); return *this;}
134
136
139 inline int GetPriority() const { return m_priority; }
140 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
141 inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; }
142 inline JobDescriptor& WithPriority(int value) { SetPriority(value); return *this;}
144
146
150 inline const JobProgressSummary& GetProgressSummary() const { return m_progressSummary; }
151 inline bool ProgressSummaryHasBeenSet() const { return m_progressSummaryHasBeenSet; }
152 template<typename ProgressSummaryT = JobProgressSummary>
153 void SetProgressSummary(ProgressSummaryT&& value) { m_progressSummaryHasBeenSet = true; m_progressSummary = std::forward<ProgressSummaryT>(value); }
154 template<typename ProgressSummaryT = JobProgressSummary>
155 JobDescriptor& WithProgressSummary(ProgressSummaryT&& value) { SetProgressSummary(std::forward<ProgressSummaryT>(value)); return *this;}
157
159
162 inline const Aws::String& GetStatusUpdateReason() const { return m_statusUpdateReason; }
163 inline bool StatusUpdateReasonHasBeenSet() const { return m_statusUpdateReasonHasBeenSet; }
164 template<typename StatusUpdateReasonT = Aws::String>
165 void SetStatusUpdateReason(StatusUpdateReasonT&& value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason = std::forward<StatusUpdateReasonT>(value); }
166 template<typename StatusUpdateReasonT = Aws::String>
167 JobDescriptor& WithStatusUpdateReason(StatusUpdateReasonT&& value) { SetStatusUpdateReason(std::forward<StatusUpdateReasonT>(value)); return *this;}
169
171
175 inline const Aws::Vector<JobFailure>& GetFailureReasons() const { return m_failureReasons; }
176 inline bool FailureReasonsHasBeenSet() const { return m_failureReasonsHasBeenSet; }
177 template<typename FailureReasonsT = Aws::Vector<JobFailure>>
178 void SetFailureReasons(FailureReasonsT&& value) { m_failureReasonsHasBeenSet = true; m_failureReasons = std::forward<FailureReasonsT>(value); }
179 template<typename FailureReasonsT = Aws::Vector<JobFailure>>
180 JobDescriptor& WithFailureReasons(FailureReasonsT&& value) { SetFailureReasons(std::forward<FailureReasonsT>(value)); return *this;}
181 template<typename FailureReasonsT = JobFailure>
182 JobDescriptor& AddFailureReasons(FailureReasonsT&& value) { m_failureReasonsHasBeenSet = true; m_failureReasons.emplace_back(std::forward<FailureReasonsT>(value)); return *this; }
184
186
190 inline const JobReport& GetReport() const { return m_report; }
191 inline bool ReportHasBeenSet() const { return m_reportHasBeenSet; }
192 template<typename ReportT = JobReport>
193 void SetReport(ReportT&& value) { m_reportHasBeenSet = true; m_report = std::forward<ReportT>(value); }
194 template<typename ReportT = JobReport>
195 JobDescriptor& WithReport(ReportT&& value) { SetReport(std::forward<ReportT>(value)); return *this;}
197
199
202 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
203 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
204 template<typename CreationTimeT = Aws::Utils::DateTime>
205 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
206 template<typename CreationTimeT = Aws::Utils::DateTime>
207 JobDescriptor& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
209
211
215 inline const Aws::Utils::DateTime& GetTerminationDate() const { return m_terminationDate; }
216 inline bool TerminationDateHasBeenSet() const { return m_terminationDateHasBeenSet; }
217 template<typename TerminationDateT = Aws::Utils::DateTime>
218 void SetTerminationDate(TerminationDateT&& value) { m_terminationDateHasBeenSet = true; m_terminationDate = std::forward<TerminationDateT>(value); }
219 template<typename TerminationDateT = Aws::Utils::DateTime>
220 JobDescriptor& WithTerminationDate(TerminationDateT&& value) { SetTerminationDate(std::forward<TerminationDateT>(value)); return *this;}
222
224
228 inline const Aws::String& GetRoleArn() const { return m_roleArn; }
229 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
230 template<typename RoleArnT = Aws::String>
231 void SetRoleArn(RoleArnT&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::forward<RoleArnT>(value); }
232 template<typename RoleArnT = Aws::String>
233 JobDescriptor& WithRoleArn(RoleArnT&& value) { SetRoleArn(std::forward<RoleArnT>(value)); return *this;}
235
237
240 inline const Aws::Utils::DateTime& GetSuspendedDate() const { return m_suspendedDate; }
241 inline bool SuspendedDateHasBeenSet() const { return m_suspendedDateHasBeenSet; }
242 template<typename SuspendedDateT = Aws::Utils::DateTime>
243 void SetSuspendedDate(SuspendedDateT&& value) { m_suspendedDateHasBeenSet = true; m_suspendedDate = std::forward<SuspendedDateT>(value); }
244 template<typename SuspendedDateT = Aws::Utils::DateTime>
245 JobDescriptor& WithSuspendedDate(SuspendedDateT&& value) { SetSuspendedDate(std::forward<SuspendedDateT>(value)); return *this;}
247
249
255 inline const Aws::String& GetSuspendedCause() const { return m_suspendedCause; }
256 inline bool SuspendedCauseHasBeenSet() const { return m_suspendedCauseHasBeenSet; }
257 template<typename SuspendedCauseT = Aws::String>
258 void SetSuspendedCause(SuspendedCauseT&& value) { m_suspendedCauseHasBeenSet = true; m_suspendedCause = std::forward<SuspendedCauseT>(value); }
259 template<typename SuspendedCauseT = Aws::String>
260 JobDescriptor& WithSuspendedCause(SuspendedCauseT&& value) { SetSuspendedCause(std::forward<SuspendedCauseT>(value)); return *this;}
262
264
268 inline const JobManifestGenerator& GetManifestGenerator() const { return m_manifestGenerator; }
269 inline bool ManifestGeneratorHasBeenSet() const { return m_manifestGeneratorHasBeenSet; }
270 template<typename ManifestGeneratorT = JobManifestGenerator>
271 void SetManifestGenerator(ManifestGeneratorT&& value) { m_manifestGeneratorHasBeenSet = true; m_manifestGenerator = std::forward<ManifestGeneratorT>(value); }
272 template<typename ManifestGeneratorT = JobManifestGenerator>
273 JobDescriptor& WithManifestGenerator(ManifestGeneratorT&& value) { SetManifestGenerator(std::forward<ManifestGeneratorT>(value)); return *this;}
275
277
281 inline const S3GeneratedManifestDescriptor& GetGeneratedManifestDescriptor() const { return m_generatedManifestDescriptor; }
282 inline bool GeneratedManifestDescriptorHasBeenSet() const { return m_generatedManifestDescriptorHasBeenSet; }
283 template<typename GeneratedManifestDescriptorT = S3GeneratedManifestDescriptor>
284 void SetGeneratedManifestDescriptor(GeneratedManifestDescriptorT&& value) { m_generatedManifestDescriptorHasBeenSet = true; m_generatedManifestDescriptor = std::forward<GeneratedManifestDescriptorT>(value); }
285 template<typename GeneratedManifestDescriptorT = S3GeneratedManifestDescriptor>
286 JobDescriptor& WithGeneratedManifestDescriptor(GeneratedManifestDescriptorT&& value) { SetGeneratedManifestDescriptor(std::forward<GeneratedManifestDescriptorT>(value)); return *this;}
288 private:
289
290 Aws::String m_jobId;
291 bool m_jobIdHasBeenSet = false;
292
293 bool m_confirmationRequired{false};
294 bool m_confirmationRequiredHasBeenSet = false;
295
296 Aws::String m_description;
297 bool m_descriptionHasBeenSet = false;
298
299 Aws::String m_jobArn;
300 bool m_jobArnHasBeenSet = false;
301
303 bool m_statusHasBeenSet = false;
304
305 JobManifest m_manifest;
306 bool m_manifestHasBeenSet = false;
307
308 JobOperation m_operation;
309 bool m_operationHasBeenSet = false;
310
311 int m_priority{0};
312 bool m_priorityHasBeenSet = false;
313
314 JobProgressSummary m_progressSummary;
315 bool m_progressSummaryHasBeenSet = false;
316
317 Aws::String m_statusUpdateReason;
318 bool m_statusUpdateReasonHasBeenSet = false;
319
320 Aws::Vector<JobFailure> m_failureReasons;
321 bool m_failureReasonsHasBeenSet = false;
322
323 JobReport m_report;
324 bool m_reportHasBeenSet = false;
325
326 Aws::Utils::DateTime m_creationTime{};
327 bool m_creationTimeHasBeenSet = false;
328
329 Aws::Utils::DateTime m_terminationDate{};
330 bool m_terminationDateHasBeenSet = false;
331
332 Aws::String m_roleArn;
333 bool m_roleArnHasBeenSet = false;
334
335 Aws::Utils::DateTime m_suspendedDate{};
336 bool m_suspendedDateHasBeenSet = false;
337
338 Aws::String m_suspendedCause;
339 bool m_suspendedCauseHasBeenSet = false;
340
341 JobManifestGenerator m_manifestGenerator;
342 bool m_manifestGeneratorHasBeenSet = false;
343
344 S3GeneratedManifestDescriptor m_generatedManifestDescriptor;
345 bool m_generatedManifestDescriptorHasBeenSet = false;
346 };
347
348} // namespace Model
349} // namespace S3Control
350} // 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