AWS SDK for C++

AWS SDK for C++ Version 1.11.440

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();
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 inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
58 inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); }
59 inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
60 inline JobDescriptor& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
61 inline JobDescriptor& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}
62 inline JobDescriptor& WithJobId(const char* value) { SetJobId(value); return *this;}
64
66
71 inline bool GetConfirmationRequired() const{ return m_confirmationRequired; }
72 inline bool ConfirmationRequiredHasBeenSet() const { return m_confirmationRequiredHasBeenSet; }
73 inline void SetConfirmationRequired(bool value) { m_confirmationRequiredHasBeenSet = true; m_confirmationRequired = value; }
74 inline JobDescriptor& WithConfirmationRequired(bool value) { SetConfirmationRequired(value); return *this;}
76
78
82 inline const Aws::String& GetDescription() const{ return m_description; }
83 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
84 inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
85 inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
86 inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
87 inline JobDescriptor& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
88 inline JobDescriptor& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
89 inline JobDescriptor& WithDescription(const char* value) { SetDescription(value); return *this;}
91
93
96 inline const Aws::String& GetJobArn() const{ return m_jobArn; }
97 inline bool JobArnHasBeenSet() const { return m_jobArnHasBeenSet; }
98 inline void SetJobArn(const Aws::String& value) { m_jobArnHasBeenSet = true; m_jobArn = value; }
99 inline void SetJobArn(Aws::String&& value) { m_jobArnHasBeenSet = true; m_jobArn = std::move(value); }
100 inline void SetJobArn(const char* value) { m_jobArnHasBeenSet = true; m_jobArn.assign(value); }
101 inline JobDescriptor& WithJobArn(const Aws::String& value) { SetJobArn(value); return *this;}
102 inline JobDescriptor& WithJobArn(Aws::String&& value) { SetJobArn(std::move(value)); return *this;}
103 inline JobDescriptor& WithJobArn(const char* value) { SetJobArn(value); return *this;}
105
107
110 inline const JobStatus& GetStatus() const{ return m_status; }
111 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
112 inline void SetStatus(const JobStatus& value) { m_statusHasBeenSet = true; m_status = value; }
113 inline void SetStatus(JobStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
114 inline JobDescriptor& WithStatus(const JobStatus& value) { SetStatus(value); return *this;}
115 inline JobDescriptor& WithStatus(JobStatus&& value) { SetStatus(std::move(value)); return *this;}
117
119
122 inline const JobManifest& GetManifest() const{ return m_manifest; }
123 inline bool ManifestHasBeenSet() const { return m_manifestHasBeenSet; }
124 inline void SetManifest(const JobManifest& value) { m_manifestHasBeenSet = true; m_manifest = value; }
125 inline void SetManifest(JobManifest&& value) { m_manifestHasBeenSet = true; m_manifest = std::move(value); }
126 inline JobDescriptor& WithManifest(const JobManifest& value) { SetManifest(value); return *this;}
127 inline JobDescriptor& WithManifest(JobManifest&& value) { SetManifest(std::move(value)); return *this;}
129
131
135 inline const JobOperation& GetOperation() const{ return m_operation; }
136 inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; }
137 inline void SetOperation(const JobOperation& value) { m_operationHasBeenSet = true; m_operation = value; }
138 inline void SetOperation(JobOperation&& value) { m_operationHasBeenSet = true; m_operation = std::move(value); }
139 inline JobDescriptor& WithOperation(const JobOperation& value) { SetOperation(value); return *this;}
140 inline JobDescriptor& WithOperation(JobOperation&& value) { SetOperation(std::move(value)); return *this;}
142
144
147 inline int GetPriority() const{ return m_priority; }
148 inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
149 inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; }
150 inline JobDescriptor& WithPriority(int value) { SetPriority(value); return *this;}
152
154
158 inline const JobProgressSummary& GetProgressSummary() const{ return m_progressSummary; }
159 inline bool ProgressSummaryHasBeenSet() const { return m_progressSummaryHasBeenSet; }
160 inline void SetProgressSummary(const JobProgressSummary& value) { m_progressSummaryHasBeenSet = true; m_progressSummary = value; }
161 inline void SetProgressSummary(JobProgressSummary&& value) { m_progressSummaryHasBeenSet = true; m_progressSummary = std::move(value); }
162 inline JobDescriptor& WithProgressSummary(const JobProgressSummary& value) { SetProgressSummary(value); return *this;}
163 inline JobDescriptor& WithProgressSummary(JobProgressSummary&& value) { SetProgressSummary(std::move(value)); return *this;}
165
167
170 inline const Aws::String& GetStatusUpdateReason() const{ return m_statusUpdateReason; }
171 inline bool StatusUpdateReasonHasBeenSet() const { return m_statusUpdateReasonHasBeenSet; }
172 inline void SetStatusUpdateReason(const Aws::String& value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason = value; }
173 inline void SetStatusUpdateReason(Aws::String&& value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason = std::move(value); }
174 inline void SetStatusUpdateReason(const char* value) { m_statusUpdateReasonHasBeenSet = true; m_statusUpdateReason.assign(value); }
175 inline JobDescriptor& WithStatusUpdateReason(const Aws::String& value) { SetStatusUpdateReason(value); return *this;}
176 inline JobDescriptor& WithStatusUpdateReason(Aws::String&& value) { SetStatusUpdateReason(std::move(value)); return *this;}
177 inline JobDescriptor& WithStatusUpdateReason(const char* value) { SetStatusUpdateReason(value); return *this;}
179
181
185 inline const Aws::Vector<JobFailure>& GetFailureReasons() const{ return m_failureReasons; }
186 inline bool FailureReasonsHasBeenSet() const { return m_failureReasonsHasBeenSet; }
187 inline void SetFailureReasons(const Aws::Vector<JobFailure>& value) { m_failureReasonsHasBeenSet = true; m_failureReasons = value; }
188 inline void SetFailureReasons(Aws::Vector<JobFailure>&& value) { m_failureReasonsHasBeenSet = true; m_failureReasons = std::move(value); }
189 inline JobDescriptor& WithFailureReasons(const Aws::Vector<JobFailure>& value) { SetFailureReasons(value); return *this;}
190 inline JobDescriptor& WithFailureReasons(Aws::Vector<JobFailure>&& value) { SetFailureReasons(std::move(value)); return *this;}
191 inline JobDescriptor& AddFailureReasons(const JobFailure& value) { m_failureReasonsHasBeenSet = true; m_failureReasons.push_back(value); return *this; }
192 inline JobDescriptor& AddFailureReasons(JobFailure&& value) { m_failureReasonsHasBeenSet = true; m_failureReasons.push_back(std::move(value)); return *this; }
194
196
200 inline const JobReport& GetReport() const{ return m_report; }
201 inline bool ReportHasBeenSet() const { return m_reportHasBeenSet; }
202 inline void SetReport(const JobReport& value) { m_reportHasBeenSet = true; m_report = value; }
203 inline void SetReport(JobReport&& value) { m_reportHasBeenSet = true; m_report = std::move(value); }
204 inline JobDescriptor& WithReport(const JobReport& value) { SetReport(value); return *this;}
205 inline JobDescriptor& WithReport(JobReport&& value) { SetReport(std::move(value)); return *this;}
207
209
212 inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; }
213 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
214 inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; }
215 inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); }
216 inline JobDescriptor& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;}
217 inline JobDescriptor& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;}
219
221
225 inline const Aws::Utils::DateTime& GetTerminationDate() const{ return m_terminationDate; }
226 inline bool TerminationDateHasBeenSet() const { return m_terminationDateHasBeenSet; }
227 inline void SetTerminationDate(const Aws::Utils::DateTime& value) { m_terminationDateHasBeenSet = true; m_terminationDate = value; }
228 inline void SetTerminationDate(Aws::Utils::DateTime&& value) { m_terminationDateHasBeenSet = true; m_terminationDate = std::move(value); }
229 inline JobDescriptor& WithTerminationDate(const Aws::Utils::DateTime& value) { SetTerminationDate(value); return *this;}
230 inline JobDescriptor& WithTerminationDate(Aws::Utils::DateTime&& value) { SetTerminationDate(std::move(value)); return *this;}
232
234
238 inline const Aws::String& GetRoleArn() const{ return m_roleArn; }
239 inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; }
240 inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; }
241 inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); }
242 inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); }
243 inline JobDescriptor& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;}
244 inline JobDescriptor& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;}
245 inline JobDescriptor& WithRoleArn(const char* value) { SetRoleArn(value); return *this;}
247
249
252 inline const Aws::Utils::DateTime& GetSuspendedDate() const{ return m_suspendedDate; }
253 inline bool SuspendedDateHasBeenSet() const { return m_suspendedDateHasBeenSet; }
254 inline void SetSuspendedDate(const Aws::Utils::DateTime& value) { m_suspendedDateHasBeenSet = true; m_suspendedDate = value; }
255 inline void SetSuspendedDate(Aws::Utils::DateTime&& value) { m_suspendedDateHasBeenSet = true; m_suspendedDate = std::move(value); }
256 inline JobDescriptor& WithSuspendedDate(const Aws::Utils::DateTime& value) { SetSuspendedDate(value); return *this;}
257 inline JobDescriptor& WithSuspendedDate(Aws::Utils::DateTime&& value) { SetSuspendedDate(std::move(value)); return *this;}
259
261
267 inline const Aws::String& GetSuspendedCause() const{ return m_suspendedCause; }
268 inline bool SuspendedCauseHasBeenSet() const { return m_suspendedCauseHasBeenSet; }
269 inline void SetSuspendedCause(const Aws::String& value) { m_suspendedCauseHasBeenSet = true; m_suspendedCause = value; }
270 inline void SetSuspendedCause(Aws::String&& value) { m_suspendedCauseHasBeenSet = true; m_suspendedCause = std::move(value); }
271 inline void SetSuspendedCause(const char* value) { m_suspendedCauseHasBeenSet = true; m_suspendedCause.assign(value); }
272 inline JobDescriptor& WithSuspendedCause(const Aws::String& value) { SetSuspendedCause(value); return *this;}
273 inline JobDescriptor& WithSuspendedCause(Aws::String&& value) { SetSuspendedCause(std::move(value)); return *this;}
274 inline JobDescriptor& WithSuspendedCause(const char* value) { SetSuspendedCause(value); return *this;}
276
278
282 inline const JobManifestGenerator& GetManifestGenerator() const{ return m_manifestGenerator; }
283 inline bool ManifestGeneratorHasBeenSet() const { return m_manifestGeneratorHasBeenSet; }
284 inline void SetManifestGenerator(const JobManifestGenerator& value) { m_manifestGeneratorHasBeenSet = true; m_manifestGenerator = value; }
285 inline void SetManifestGenerator(JobManifestGenerator&& value) { m_manifestGeneratorHasBeenSet = true; m_manifestGenerator = std::move(value); }
287 inline JobDescriptor& WithManifestGenerator(JobManifestGenerator&& value) { SetManifestGenerator(std::move(value)); return *this;}
289
291
295 inline const S3GeneratedManifestDescriptor& GetGeneratedManifestDescriptor() const{ return m_generatedManifestDescriptor; }
296 inline bool GeneratedManifestDescriptorHasBeenSet() const { return m_generatedManifestDescriptorHasBeenSet; }
297 inline void SetGeneratedManifestDescriptor(const S3GeneratedManifestDescriptor& value) { m_generatedManifestDescriptorHasBeenSet = true; m_generatedManifestDescriptor = value; }
298 inline void SetGeneratedManifestDescriptor(S3GeneratedManifestDescriptor&& value) { m_generatedManifestDescriptorHasBeenSet = true; m_generatedManifestDescriptor = std::move(value); }
302 private:
303
304 Aws::String m_jobId;
305 bool m_jobIdHasBeenSet = false;
306
307 bool m_confirmationRequired;
308 bool m_confirmationRequiredHasBeenSet = false;
309
310 Aws::String m_description;
311 bool m_descriptionHasBeenSet = false;
312
313 Aws::String m_jobArn;
314 bool m_jobArnHasBeenSet = false;
315
316 JobStatus m_status;
317 bool m_statusHasBeenSet = false;
318
319 JobManifest m_manifest;
320 bool m_manifestHasBeenSet = false;
321
322 JobOperation m_operation;
323 bool m_operationHasBeenSet = false;
324
325 int m_priority;
326 bool m_priorityHasBeenSet = false;
327
328 JobProgressSummary m_progressSummary;
329 bool m_progressSummaryHasBeenSet = false;
330
331 Aws::String m_statusUpdateReason;
332 bool m_statusUpdateReasonHasBeenSet = false;
333
334 Aws::Vector<JobFailure> m_failureReasons;
335 bool m_failureReasonsHasBeenSet = false;
336
337 JobReport m_report;
338 bool m_reportHasBeenSet = false;
339
340 Aws::Utils::DateTime m_creationTime;
341 bool m_creationTimeHasBeenSet = false;
342
343 Aws::Utils::DateTime m_terminationDate;
344 bool m_terminationDateHasBeenSet = false;
345
346 Aws::String m_roleArn;
347 bool m_roleArnHasBeenSet = false;
348
349 Aws::Utils::DateTime m_suspendedDate;
350 bool m_suspendedDateHasBeenSet = false;
351
352 Aws::String m_suspendedCause;
353 bool m_suspendedCauseHasBeenSet = false;
354
355 JobManifestGenerator m_manifestGenerator;
356 bool m_manifestGeneratorHasBeenSet = false;
357
358 S3GeneratedManifestDescriptor m_generatedManifestDescriptor;
359 bool m_generatedManifestDescriptorHasBeenSet = false;
360 };
361
362} // namespace Model
363} // namespace S3Control
364} // namespace Aws
JobDescriptor & WithTerminationDate(const Aws::Utils::DateTime &value)
const Aws::Utils::DateTime & GetTerminationDate() const
JobDescriptor & AddFailureReasons(const JobFailure &value)
const JobStatus & GetStatus() const
AWS_S3CONTROL_API JobDescriptor & operator=(const Aws::Utils::Xml::XmlNode &xmlNode)
JobDescriptor & WithJobArn(const char *value)
const Aws::String & GetRoleArn() const
const JobManifest & GetManifest() const
JobDescriptor & WithDescription(const Aws::String &value)
void SetFailureReasons(Aws::Vector< JobFailure > &&value)
AWS_S3CONTROL_API JobDescriptor(const Aws::Utils::Xml::XmlNode &xmlNode)
void SetManifest(const JobManifest &value)
JobDescriptor & WithJobId(Aws::String &&value)
void SetManifest(JobManifest &&value)
JobDescriptor & AddFailureReasons(JobFailure &&value)
const JobManifestGenerator & GetManifestGenerator() const
const JobReport & GetReport() const
const JobOperation & GetOperation() const
void SetFailureReasons(const Aws::Vector< JobFailure > &value)
JobDescriptor & WithJobId(const char *value)
void SetStatusUpdateReason(const Aws::String &value)
const Aws::Vector< JobFailure > & GetFailureReasons() const
void SetOperation(JobOperation &&value)
void SetSuspendedCause(const char *value)
void SetStatusUpdateReason(Aws::String &&value)
JobDescriptor & WithStatusUpdateReason(const Aws::String &value)
const Aws::Utils::DateTime & GetSuspendedDate() const
JobDescriptor & WithPriority(int value)
void SetOperation(const JobOperation &value)
void SetGeneratedManifestDescriptor(const S3GeneratedManifestDescriptor &value)
JobDescriptor & WithGeneratedManifestDescriptor(S3GeneratedManifestDescriptor &&value)
const Aws::String & GetSuspendedCause() const
AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode &parentNode) const
JobDescriptor & WithStatusUpdateReason(Aws::String &&value)
JobDescriptor & WithOperation(JobOperation &&value)
JobDescriptor & WithReport(JobReport &&value)
void SetGeneratedManifestDescriptor(S3GeneratedManifestDescriptor &&value)
JobDescriptor & WithConfirmationRequired(bool value)
JobDescriptor & WithRoleArn(Aws::String &&value)
const S3GeneratedManifestDescriptor & GetGeneratedManifestDescriptor() const
void SetManifestGenerator(JobManifestGenerator &&value)
JobDescriptor & WithManifestGenerator(const JobManifestGenerator &value)
JobDescriptor & WithProgressSummary(const JobProgressSummary &value)
void SetRoleArn(const char *value)
JobDescriptor & WithFailureReasons(const Aws::Vector< JobFailure > &value)
void SetRoleArn(const Aws::String &value)
const Aws::String & GetJobId() const
void SetSuspendedCause(const Aws::String &value)
JobDescriptor & WithStatusUpdateReason(const char *value)
JobDescriptor & WithProgressSummary(JobProgressSummary &&value)
void SetJobId(Aws::String &&value)
void SetJobId(const Aws::String &value)
void SetSuspendedDate(Aws::Utils::DateTime &&value)
void SetTerminationDate(const Aws::Utils::DateTime &value)
JobDescriptor & WithRoleArn(const Aws::String &value)
void SetReport(const JobReport &value)
JobDescriptor & WithStatus(const JobStatus &value)
JobDescriptor & WithCreationTime(const Aws::Utils::DateTime &value)
void SetRoleArn(Aws::String &&value)
void SetDescription(const char *value)
void SetSuspendedCause(Aws::String &&value)
JobDescriptor & WithManifest(const JobManifest &value)
void SetStatus(JobStatus &&value)
JobDescriptor & WithSuspendedDate(const Aws::Utils::DateTime &value)
JobDescriptor & WithSuspendedCause(const char *value)
JobDescriptor & WithSuspendedCause(Aws::String &&value)
void SetStatusUpdateReason(const char *value)
void SetManifestGenerator(const JobManifestGenerator &value)
void SetProgressSummary(const JobProgressSummary &value)
JobDescriptor & WithOperation(const JobOperation &value)
JobDescriptor & WithSuspendedDate(Aws::Utils::DateTime &&value)
JobDescriptor & WithManifestGenerator(JobManifestGenerator &&value)
void SetJobArn(const Aws::String &value)
JobDescriptor & WithStatus(JobStatus &&value)
JobDescriptor & WithJobArn(Aws::String &&value)
void SetSuspendedDate(const Aws::Utils::DateTime &value)
JobDescriptor & WithFailureReasons(Aws::Vector< JobFailure > &&value)
JobDescriptor & WithReport(const JobReport &value)
const Aws::String & GetStatusUpdateReason() const
void SetJobId(const char *value)
JobDescriptor & WithJobId(const Aws::String &value)
JobDescriptor & WithTerminationDate(Aws::Utils::DateTime &&value)
void SetProgressSummary(JobProgressSummary &&value)
void SetCreationTime(Aws::Utils::DateTime &&value)
const Aws::String & GetJobArn() const
JobDescriptor & WithJobArn(const Aws::String &value)
void SetStatus(const JobStatus &value)
void SetDescription(const Aws::String &value)
const Aws::String & GetDescription() const
JobDescriptor & WithDescription(const char *value)
JobDescriptor & WithDescription(Aws::String &&value)
JobDescriptor & WithCreationTime(Aws::Utils::DateTime &&value)
JobDescriptor & WithGeneratedManifestDescriptor(const S3GeneratedManifestDescriptor &value)
JobDescriptor & WithSuspendedCause(const Aws::String &value)
void SetJobArn(const char *value)
void SetCreationTime(const Aws::Utils::DateTime &value)
const Aws::Utils::DateTime & GetCreationTime() const
void SetTerminationDate(Aws::Utils::DateTime &&value)
void SetJobArn(Aws::String &&value)
JobDescriptor & WithRoleArn(const char *value)
JobDescriptor & WithManifest(JobManifest &&value)
void SetDescription(Aws::String &&value)
const JobProgressSummary & GetProgressSummary() const
void SetReport(JobReport &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector