AWS SDK for C++

AWS SDK for C++ Version 1.11.716

Loading...
Searching...
No Matches
ExportTask.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSStreamFwd.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/rds/RDS_EXPORTS.h>
12#include <aws/rds/model/ExportSourceType.h>
13#include <aws/rds/model/ResponseMetadata.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Utils {
19namespace Xml {
20class XmlNode;
21} // namespace Xml
22} // namespace Utils
23namespace RDS {
24namespace Model {
25
34 public:
35 AWS_RDS_API ExportTask() = default;
36 AWS_RDS_API ExportTask(const Aws::Utils::Xml::XmlNode& xmlNode);
37 AWS_RDS_API ExportTask& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
38
39 AWS_RDS_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const;
40 AWS_RDS_API void OutputToStream(Aws::OStream& oStream, const char* location) const;
41
43
47 inline const Aws::String& GetExportTaskIdentifier() const { return m_exportTaskIdentifier; }
48 inline bool ExportTaskIdentifierHasBeenSet() const { return m_exportTaskIdentifierHasBeenSet; }
49 template <typename ExportTaskIdentifierT = Aws::String>
50 void SetExportTaskIdentifier(ExportTaskIdentifierT&& value) {
51 m_exportTaskIdentifierHasBeenSet = true;
52 m_exportTaskIdentifier = std::forward<ExportTaskIdentifierT>(value);
53 }
54 template <typename ExportTaskIdentifierT = Aws::String>
55 ExportTask& WithExportTaskIdentifier(ExportTaskIdentifierT&& value) {
56 SetExportTaskIdentifier(std::forward<ExportTaskIdentifierT>(value));
57 return *this;
58 }
60
62
66 inline const Aws::String& GetSourceArn() const { return m_sourceArn; }
67 inline bool SourceArnHasBeenSet() const { return m_sourceArnHasBeenSet; }
68 template <typename SourceArnT = Aws::String>
69 void SetSourceArn(SourceArnT&& value) {
70 m_sourceArnHasBeenSet = true;
71 m_sourceArn = std::forward<SourceArnT>(value);
72 }
73 template <typename SourceArnT = Aws::String>
74 ExportTask& WithSourceArn(SourceArnT&& value) {
75 SetSourceArn(std::forward<SourceArnT>(value));
76 return *this;
77 }
79
81
93 inline const Aws::Vector<Aws::String>& GetExportOnly() const { return m_exportOnly; }
94 inline bool ExportOnlyHasBeenSet() const { return m_exportOnlyHasBeenSet; }
95 template <typename ExportOnlyT = Aws::Vector<Aws::String>>
96 void SetExportOnly(ExportOnlyT&& value) {
97 m_exportOnlyHasBeenSet = true;
98 m_exportOnly = std::forward<ExportOnlyT>(value);
99 }
100 template <typename ExportOnlyT = Aws::Vector<Aws::String>>
101 ExportTask& WithExportOnly(ExportOnlyT&& value) {
102 SetExportOnly(std::forward<ExportOnlyT>(value));
103 return *this;
104 }
105 template <typename ExportOnlyT = Aws::String>
106 ExportTask& AddExportOnly(ExportOnlyT&& value) {
107 m_exportOnlyHasBeenSet = true;
108 m_exportOnly.emplace_back(std::forward<ExportOnlyT>(value));
109 return *this;
110 }
112
114
117 inline const Aws::Utils::DateTime& GetSnapshotTime() const { return m_snapshotTime; }
118 inline bool SnapshotTimeHasBeenSet() const { return m_snapshotTimeHasBeenSet; }
119 template <typename SnapshotTimeT = Aws::Utils::DateTime>
120 void SetSnapshotTime(SnapshotTimeT&& value) {
121 m_snapshotTimeHasBeenSet = true;
122 m_snapshotTime = std::forward<SnapshotTimeT>(value);
123 }
124 template <typename SnapshotTimeT = Aws::Utils::DateTime>
125 ExportTask& WithSnapshotTime(SnapshotTimeT&& value) {
126 SetSnapshotTime(std::forward<SnapshotTimeT>(value));
127 return *this;
128 }
130
132
135 inline const Aws::Utils::DateTime& GetTaskStartTime() const { return m_taskStartTime; }
136 inline bool TaskStartTimeHasBeenSet() const { return m_taskStartTimeHasBeenSet; }
137 template <typename TaskStartTimeT = Aws::Utils::DateTime>
138 void SetTaskStartTime(TaskStartTimeT&& value) {
139 m_taskStartTimeHasBeenSet = true;
140 m_taskStartTime = std::forward<TaskStartTimeT>(value);
141 }
142 template <typename TaskStartTimeT = Aws::Utils::DateTime>
143 ExportTask& WithTaskStartTime(TaskStartTimeT&& value) {
144 SetTaskStartTime(std::forward<TaskStartTimeT>(value));
145 return *this;
146 }
148
150
153 inline const Aws::Utils::DateTime& GetTaskEndTime() const { return m_taskEndTime; }
154 inline bool TaskEndTimeHasBeenSet() const { return m_taskEndTimeHasBeenSet; }
155 template <typename TaskEndTimeT = Aws::Utils::DateTime>
156 void SetTaskEndTime(TaskEndTimeT&& value) {
157 m_taskEndTimeHasBeenSet = true;
158 m_taskEndTime = std::forward<TaskEndTimeT>(value);
159 }
160 template <typename TaskEndTimeT = Aws::Utils::DateTime>
161 ExportTask& WithTaskEndTime(TaskEndTimeT&& value) {
162 SetTaskEndTime(std::forward<TaskEndTimeT>(value));
163 return *this;
164 }
166
168
171 inline const Aws::String& GetS3Bucket() const { return m_s3Bucket; }
172 inline bool S3BucketHasBeenSet() const { return m_s3BucketHasBeenSet; }
173 template <typename S3BucketT = Aws::String>
174 void SetS3Bucket(S3BucketT&& value) {
175 m_s3BucketHasBeenSet = true;
176 m_s3Bucket = std::forward<S3BucketT>(value);
177 }
178 template <typename S3BucketT = Aws::String>
179 ExportTask& WithS3Bucket(S3BucketT&& value) {
180 SetS3Bucket(std::forward<S3BucketT>(value));
181 return *this;
182 }
184
186
190 inline const Aws::String& GetS3Prefix() const { return m_s3Prefix; }
191 inline bool S3PrefixHasBeenSet() const { return m_s3PrefixHasBeenSet; }
192 template <typename S3PrefixT = Aws::String>
193 void SetS3Prefix(S3PrefixT&& value) {
194 m_s3PrefixHasBeenSet = true;
195 m_s3Prefix = std::forward<S3PrefixT>(value);
196 }
197 template <typename S3PrefixT = Aws::String>
198 ExportTask& WithS3Prefix(S3PrefixT&& value) {
199 SetS3Prefix(std::forward<S3PrefixT>(value));
200 return *this;
201 }
203
205
209 inline const Aws::String& GetIamRoleArn() const { return m_iamRoleArn; }
210 inline bool IamRoleArnHasBeenSet() const { return m_iamRoleArnHasBeenSet; }
211 template <typename IamRoleArnT = Aws::String>
212 void SetIamRoleArn(IamRoleArnT&& value) {
213 m_iamRoleArnHasBeenSet = true;
214 m_iamRoleArn = std::forward<IamRoleArnT>(value);
215 }
216 template <typename IamRoleArnT = Aws::String>
217 ExportTask& WithIamRoleArn(IamRoleArnT&& value) {
218 SetIamRoleArn(std::forward<IamRoleArnT>(value));
219 return *this;
220 }
222
224
230 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
231 inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; }
232 template <typename KmsKeyIdT = Aws::String>
233 void SetKmsKeyId(KmsKeyIdT&& value) {
234 m_kmsKeyIdHasBeenSet = true;
235 m_kmsKeyId = std::forward<KmsKeyIdT>(value);
236 }
237 template <typename KmsKeyIdT = Aws::String>
238 ExportTask& WithKmsKeyId(KmsKeyIdT&& value) {
239 SetKmsKeyId(std::forward<KmsKeyIdT>(value));
240 return *this;
241 }
243
245
252 inline const Aws::String& GetStatus() const { return m_status; }
253 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
254 template <typename StatusT = Aws::String>
255 void SetStatus(StatusT&& value) {
256 m_statusHasBeenSet = true;
257 m_status = std::forward<StatusT>(value);
258 }
259 template <typename StatusT = Aws::String>
260 ExportTask& WithStatus(StatusT&& value) {
261 SetStatus(std::forward<StatusT>(value));
262 return *this;
263 }
265
267
270 inline int GetPercentProgress() const { return m_percentProgress; }
271 inline bool PercentProgressHasBeenSet() const { return m_percentProgressHasBeenSet; }
272 inline void SetPercentProgress(int value) {
273 m_percentProgressHasBeenSet = true;
274 m_percentProgress = value;
275 }
276 inline ExportTask& WithPercentProgress(int value) {
277 SetPercentProgress(value);
278 return *this;
279 }
281
283
286 inline int GetTotalExtractedDataInGB() const { return m_totalExtractedDataInGB; }
287 inline bool TotalExtractedDataInGBHasBeenSet() const { return m_totalExtractedDataInGBHasBeenSet; }
288 inline void SetTotalExtractedDataInGB(int value) {
289 m_totalExtractedDataInGBHasBeenSet = true;
290 m_totalExtractedDataInGB = value;
291 }
294 return *this;
295 }
297
299
302 inline const Aws::String& GetFailureCause() const { return m_failureCause; }
303 inline bool FailureCauseHasBeenSet() const { return m_failureCauseHasBeenSet; }
304 template <typename FailureCauseT = Aws::String>
305 void SetFailureCause(FailureCauseT&& value) {
306 m_failureCauseHasBeenSet = true;
307 m_failureCause = std::forward<FailureCauseT>(value);
308 }
309 template <typename FailureCauseT = Aws::String>
310 ExportTask& WithFailureCause(FailureCauseT&& value) {
311 SetFailureCause(std::forward<FailureCauseT>(value));
312 return *this;
313 }
315
317
320 inline const Aws::String& GetWarningMessage() const { return m_warningMessage; }
321 inline bool WarningMessageHasBeenSet() const { return m_warningMessageHasBeenSet; }
322 template <typename WarningMessageT = Aws::String>
323 void SetWarningMessage(WarningMessageT&& value) {
324 m_warningMessageHasBeenSet = true;
325 m_warningMessage = std::forward<WarningMessageT>(value);
326 }
327 template <typename WarningMessageT = Aws::String>
328 ExportTask& WithWarningMessage(WarningMessageT&& value) {
329 SetWarningMessage(std::forward<WarningMessageT>(value));
330 return *this;
331 }
333
335
338 inline ExportSourceType GetSourceType() const { return m_sourceType; }
339 inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; }
340 inline void SetSourceType(ExportSourceType value) {
341 m_sourceTypeHasBeenSet = true;
342 m_sourceType = value;
343 }
345 SetSourceType(value);
346 return *this;
347 }
349
351
352 inline const ResponseMetadata& GetResponseMetadata() const { return m_responseMetadata; }
353 template <typename ResponseMetadataT = ResponseMetadata>
354 void SetResponseMetadata(ResponseMetadataT&& value) {
355 m_responseMetadataHasBeenSet = true;
356 m_responseMetadata = std::forward<ResponseMetadataT>(value);
357 }
358 template <typename ResponseMetadataT = ResponseMetadata>
359 ExportTask& WithResponseMetadata(ResponseMetadataT&& value) {
360 SetResponseMetadata(std::forward<ResponseMetadataT>(value));
361 return *this;
362 }
364 private:
365 Aws::String m_exportTaskIdentifier;
366
367 Aws::String m_sourceArn;
368
369 Aws::Vector<Aws::String> m_exportOnly;
370
371 Aws::Utils::DateTime m_snapshotTime{};
372
373 Aws::Utils::DateTime m_taskStartTime{};
374
375 Aws::Utils::DateTime m_taskEndTime{};
376
377 Aws::String m_s3Bucket;
378
379 Aws::String m_s3Prefix;
380
381 Aws::String m_iamRoleArn;
382
383 Aws::String m_kmsKeyId;
384
385 Aws::String m_status;
386
387 int m_percentProgress{0};
388
389 int m_totalExtractedDataInGB{0};
390
391 Aws::String m_failureCause;
392
393 Aws::String m_warningMessage;
394
396
397 ResponseMetadata m_responseMetadata;
398 bool m_exportTaskIdentifierHasBeenSet = false;
399 bool m_sourceArnHasBeenSet = false;
400 bool m_exportOnlyHasBeenSet = false;
401 bool m_snapshotTimeHasBeenSet = false;
402 bool m_taskStartTimeHasBeenSet = false;
403 bool m_taskEndTimeHasBeenSet = false;
404 bool m_s3BucketHasBeenSet = false;
405 bool m_s3PrefixHasBeenSet = false;
406 bool m_iamRoleArnHasBeenSet = false;
407 bool m_kmsKeyIdHasBeenSet = false;
408 bool m_statusHasBeenSet = false;
409 bool m_percentProgressHasBeenSet = false;
410 bool m_totalExtractedDataInGBHasBeenSet = false;
411 bool m_failureCauseHasBeenSet = false;
412 bool m_warningMessageHasBeenSet = false;
413 bool m_sourceTypeHasBeenSet = false;
414 bool m_responseMetadataHasBeenSet = true;
415};
416
417} // namespace Model
418} // namespace RDS
419} // namespace Aws
void SetS3Prefix(S3PrefixT &&value)
Definition ExportTask.h:193
ExportTask & WithTotalExtractedDataInGB(int value)
Definition ExportTask.h:292
bool KmsKeyIdHasBeenSet() const
Definition ExportTask.h:231
void SetPercentProgress(int value)
Definition ExportTask.h:272
void SetExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:96
void SetResponseMetadata(ResponseMetadataT &&value)
Definition ExportTask.h:354
void SetSourceArn(SourceArnT &&value)
Definition ExportTask.h:69
bool IamRoleArnHasBeenSet() const
Definition ExportTask.h:210
void SetSnapshotTime(SnapshotTimeT &&value)
Definition ExportTask.h:120
bool PercentProgressHasBeenSet() const
Definition ExportTask.h:271
const Aws::String & GetStatus() const
Definition ExportTask.h:252
const Aws::String & GetExportTaskIdentifier() const
Definition ExportTask.h:47
void SetWarningMessage(WarningMessageT &&value)
Definition ExportTask.h:323
const Aws::Vector< Aws::String > & GetExportOnly() const
Definition ExportTask.h:93
ExportTask & WithIamRoleArn(IamRoleArnT &&value)
Definition ExportTask.h:217
ExportTask & WithS3Bucket(S3BucketT &&value)
Definition ExportTask.h:179
void SetTaskEndTime(TaskEndTimeT &&value)
Definition ExportTask.h:156
bool ExportTaskIdentifierHasBeenSet() const
Definition ExportTask.h:48
bool SnapshotTimeHasBeenSet() const
Definition ExportTask.h:118
ExportTask & WithResponseMetadata(ResponseMetadataT &&value)
Definition ExportTask.h:359
void SetKmsKeyId(KmsKeyIdT &&value)
Definition ExportTask.h:233
bool TotalExtractedDataInGBHasBeenSet() const
Definition ExportTask.h:287
AWS_RDS_API void OutputToStream(Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
const Aws::Utils::DateTime & GetTaskEndTime() const
Definition ExportTask.h:153
const Aws::String & GetFailureCause() const
Definition ExportTask.h:302
void SetIamRoleArn(IamRoleArnT &&value)
Definition ExportTask.h:212
ExportTask & WithExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:101
ExportTask & WithFailureCause(FailureCauseT &&value)
Definition ExportTask.h:310
AWS_RDS_API ExportTask()=default
ExportTask & WithSourceArn(SourceArnT &&value)
Definition ExportTask.h:74
void SetStatus(StatusT &&value)
Definition ExportTask.h:255
ExportTask & WithKmsKeyId(KmsKeyIdT &&value)
Definition ExportTask.h:238
bool FailureCauseHasBeenSet() const
Definition ExportTask.h:303
const Aws::Utils::DateTime & GetSnapshotTime() const
Definition ExportTask.h:117
bool S3PrefixHasBeenSet() const
Definition ExportTask.h:191
AWS_RDS_API void OutputToStream(Aws::OStream &oStream, const char *location) const
void SetExportTaskIdentifier(ExportTaskIdentifierT &&value)
Definition ExportTask.h:50
bool SourceTypeHasBeenSet() const
Definition ExportTask.h:339
bool WarningMessageHasBeenSet() const
Definition ExportTask.h:321
void SetSourceType(ExportSourceType value)
Definition ExportTask.h:340
ExportTask & WithWarningMessage(WarningMessageT &&value)
Definition ExportTask.h:328
ExportTask & WithSnapshotTime(SnapshotTimeT &&value)
Definition ExportTask.h:125
ExportTask & WithTaskStartTime(TaskStartTimeT &&value)
Definition ExportTask.h:143
void SetFailureCause(FailureCauseT &&value)
Definition ExportTask.h:305
ExportTask & WithExportTaskIdentifier(ExportTaskIdentifierT &&value)
Definition ExportTask.h:55
bool S3BucketHasBeenSet() const
Definition ExportTask.h:172
AWS_RDS_API ExportTask(const Aws::Utils::Xml::XmlNode &xmlNode)
ExportTask & WithPercentProgress(int value)
Definition ExportTask.h:276
void SetTaskStartTime(TaskStartTimeT &&value)
Definition ExportTask.h:138
bool ExportOnlyHasBeenSet() const
Definition ExportTask.h:94
const Aws::String & GetS3Bucket() const
Definition ExportTask.h:171
const Aws::String & GetIamRoleArn() const
Definition ExportTask.h:209
const Aws::String & GetWarningMessage() const
Definition ExportTask.h:320
int GetTotalExtractedDataInGB() const
Definition ExportTask.h:286
ExportTask & WithStatus(StatusT &&value)
Definition ExportTask.h:260
bool SourceArnHasBeenSet() const
Definition ExportTask.h:67
ExportSourceType GetSourceType() const
Definition ExportTask.h:338
ExportTask & WithTaskEndTime(TaskEndTimeT &&value)
Definition ExportTask.h:161
const Aws::String & GetSourceArn() const
Definition ExportTask.h:66
bool TaskStartTimeHasBeenSet() const
Definition ExportTask.h:136
void SetTotalExtractedDataInGB(int value)
Definition ExportTask.h:288
ExportTask & WithS3Prefix(S3PrefixT &&value)
Definition ExportTask.h:198
AWS_RDS_API ExportTask & operator=(const Aws::Utils::Xml::XmlNode &xmlNode)
bool TaskEndTimeHasBeenSet() const
Definition ExportTask.h:154
void SetS3Bucket(S3BucketT &&value)
Definition ExportTask.h:174
ExportTask & WithSourceType(ExportSourceType value)
Definition ExportTask.h:344
const Aws::String & GetKmsKeyId() const
Definition ExportTask.h:230
const Aws::String & GetS3Prefix() const
Definition ExportTask.h:190
const ResponseMetadata & GetResponseMetadata() const
Definition ExportTask.h:352
ExportTask & AddExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:106
const Aws::Utils::DateTime & GetTaskStartTime() const
Definition ExportTask.h:135
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
std::basic_ostream< char, std::char_traits< char > > OStream