AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
ExportTask.h
1
6#pragma once
7#include <aws/rds/RDS_EXPORTS.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/core/utils/DateTime.h>
12#include <aws/rds/model/ExportSourceType.h>
13#include <aws/rds/model/ResponseMetadata.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Utils
19{
20namespace Xml
21{
22 class XmlNode;
23} // namespace Xml
24} // namespace Utils
25namespace RDS
26{
27namespace Model
28{
29
38 {
39 public:
40 AWS_RDS_API ExportTask() = default;
41 AWS_RDS_API ExportTask(const Aws::Utils::Xml::XmlNode& xmlNode);
42 AWS_RDS_API ExportTask& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
43
44 AWS_RDS_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const;
45 AWS_RDS_API void OutputToStream(Aws::OStream& oStream, const char* location) const;
46
47
49
53 inline const Aws::String& GetExportTaskIdentifier() const { return m_exportTaskIdentifier; }
54 inline bool ExportTaskIdentifierHasBeenSet() const { return m_exportTaskIdentifierHasBeenSet; }
55 template<typename ExportTaskIdentifierT = Aws::String>
56 void SetExportTaskIdentifier(ExportTaskIdentifierT&& value) { m_exportTaskIdentifierHasBeenSet = true; m_exportTaskIdentifier = std::forward<ExportTaskIdentifierT>(value); }
57 template<typename ExportTaskIdentifierT = Aws::String>
58 ExportTask& WithExportTaskIdentifier(ExportTaskIdentifierT&& value) { SetExportTaskIdentifier(std::forward<ExportTaskIdentifierT>(value)); return *this;}
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) { m_sourceArnHasBeenSet = true; m_sourceArn = std::forward<SourceArnT>(value); }
70 template<typename SourceArnT = Aws::String>
71 ExportTask& WithSourceArn(SourceArnT&& value) { SetSourceArn(std::forward<SourceArnT>(value)); return *this;}
73
75
87 inline const Aws::Vector<Aws::String>& GetExportOnly() const { return m_exportOnly; }
88 inline bool ExportOnlyHasBeenSet() const { return m_exportOnlyHasBeenSet; }
89 template<typename ExportOnlyT = Aws::Vector<Aws::String>>
90 void SetExportOnly(ExportOnlyT&& value) { m_exportOnlyHasBeenSet = true; m_exportOnly = std::forward<ExportOnlyT>(value); }
91 template<typename ExportOnlyT = Aws::Vector<Aws::String>>
92 ExportTask& WithExportOnly(ExportOnlyT&& value) { SetExportOnly(std::forward<ExportOnlyT>(value)); return *this;}
93 template<typename ExportOnlyT = Aws::String>
94 ExportTask& AddExportOnly(ExportOnlyT&& value) { m_exportOnlyHasBeenSet = true; m_exportOnly.emplace_back(std::forward<ExportOnlyT>(value)); return *this; }
96
98
101 inline const Aws::Utils::DateTime& GetSnapshotTime() const { return m_snapshotTime; }
102 inline bool SnapshotTimeHasBeenSet() const { return m_snapshotTimeHasBeenSet; }
103 template<typename SnapshotTimeT = Aws::Utils::DateTime>
104 void SetSnapshotTime(SnapshotTimeT&& value) { m_snapshotTimeHasBeenSet = true; m_snapshotTime = std::forward<SnapshotTimeT>(value); }
105 template<typename SnapshotTimeT = Aws::Utils::DateTime>
106 ExportTask& WithSnapshotTime(SnapshotTimeT&& value) { SetSnapshotTime(std::forward<SnapshotTimeT>(value)); return *this;}
108
110
113 inline const Aws::Utils::DateTime& GetTaskStartTime() const { return m_taskStartTime; }
114 inline bool TaskStartTimeHasBeenSet() const { return m_taskStartTimeHasBeenSet; }
115 template<typename TaskStartTimeT = Aws::Utils::DateTime>
116 void SetTaskStartTime(TaskStartTimeT&& value) { m_taskStartTimeHasBeenSet = true; m_taskStartTime = std::forward<TaskStartTimeT>(value); }
117 template<typename TaskStartTimeT = Aws::Utils::DateTime>
118 ExportTask& WithTaskStartTime(TaskStartTimeT&& value) { SetTaskStartTime(std::forward<TaskStartTimeT>(value)); return *this;}
120
122
125 inline const Aws::Utils::DateTime& GetTaskEndTime() const { return m_taskEndTime; }
126 inline bool TaskEndTimeHasBeenSet() const { return m_taskEndTimeHasBeenSet; }
127 template<typename TaskEndTimeT = Aws::Utils::DateTime>
128 void SetTaskEndTime(TaskEndTimeT&& value) { m_taskEndTimeHasBeenSet = true; m_taskEndTime = std::forward<TaskEndTimeT>(value); }
129 template<typename TaskEndTimeT = Aws::Utils::DateTime>
130 ExportTask& WithTaskEndTime(TaskEndTimeT&& value) { SetTaskEndTime(std::forward<TaskEndTimeT>(value)); return *this;}
132
134
137 inline const Aws::String& GetS3Bucket() const { return m_s3Bucket; }
138 inline bool S3BucketHasBeenSet() const { return m_s3BucketHasBeenSet; }
139 template<typename S3BucketT = Aws::String>
140 void SetS3Bucket(S3BucketT&& value) { m_s3BucketHasBeenSet = true; m_s3Bucket = std::forward<S3BucketT>(value); }
141 template<typename S3BucketT = Aws::String>
142 ExportTask& WithS3Bucket(S3BucketT&& value) { SetS3Bucket(std::forward<S3BucketT>(value)); return *this;}
144
146
150 inline const Aws::String& GetS3Prefix() const { return m_s3Prefix; }
151 inline bool S3PrefixHasBeenSet() const { return m_s3PrefixHasBeenSet; }
152 template<typename S3PrefixT = Aws::String>
153 void SetS3Prefix(S3PrefixT&& value) { m_s3PrefixHasBeenSet = true; m_s3Prefix = std::forward<S3PrefixT>(value); }
154 template<typename S3PrefixT = Aws::String>
155 ExportTask& WithS3Prefix(S3PrefixT&& value) { SetS3Prefix(std::forward<S3PrefixT>(value)); return *this;}
157
159
163 inline const Aws::String& GetIamRoleArn() const { return m_iamRoleArn; }
164 inline bool IamRoleArnHasBeenSet() const { return m_iamRoleArnHasBeenSet; }
165 template<typename IamRoleArnT = Aws::String>
166 void SetIamRoleArn(IamRoleArnT&& value) { m_iamRoleArnHasBeenSet = true; m_iamRoleArn = std::forward<IamRoleArnT>(value); }
167 template<typename IamRoleArnT = Aws::String>
168 ExportTask& WithIamRoleArn(IamRoleArnT&& value) { SetIamRoleArn(std::forward<IamRoleArnT>(value)); return *this;}
170
172
178 inline const Aws::String& GetKmsKeyId() const { return m_kmsKeyId; }
179 inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; }
180 template<typename KmsKeyIdT = Aws::String>
181 void SetKmsKeyId(KmsKeyIdT&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::forward<KmsKeyIdT>(value); }
182 template<typename KmsKeyIdT = Aws::String>
183 ExportTask& WithKmsKeyId(KmsKeyIdT&& value) { SetKmsKeyId(std::forward<KmsKeyIdT>(value)); return *this;}
185
187
194 inline const Aws::String& GetStatus() const { return m_status; }
195 inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
196 template<typename StatusT = Aws::String>
197 void SetStatus(StatusT&& value) { m_statusHasBeenSet = true; m_status = std::forward<StatusT>(value); }
198 template<typename StatusT = Aws::String>
199 ExportTask& WithStatus(StatusT&& value) { SetStatus(std::forward<StatusT>(value)); return *this;}
201
203
206 inline int GetPercentProgress() const { return m_percentProgress; }
207 inline bool PercentProgressHasBeenSet() const { return m_percentProgressHasBeenSet; }
208 inline void SetPercentProgress(int value) { m_percentProgressHasBeenSet = true; m_percentProgress = value; }
209 inline ExportTask& WithPercentProgress(int value) { SetPercentProgress(value); return *this;}
211
213
216 inline int GetTotalExtractedDataInGB() const { return m_totalExtractedDataInGB; }
217 inline bool TotalExtractedDataInGBHasBeenSet() const { return m_totalExtractedDataInGBHasBeenSet; }
218 inline void SetTotalExtractedDataInGB(int value) { m_totalExtractedDataInGBHasBeenSet = true; m_totalExtractedDataInGB = value; }
219 inline ExportTask& WithTotalExtractedDataInGB(int value) { SetTotalExtractedDataInGB(value); return *this;}
221
223
226 inline const Aws::String& GetFailureCause() const { return m_failureCause; }
227 inline bool FailureCauseHasBeenSet() const { return m_failureCauseHasBeenSet; }
228 template<typename FailureCauseT = Aws::String>
229 void SetFailureCause(FailureCauseT&& value) { m_failureCauseHasBeenSet = true; m_failureCause = std::forward<FailureCauseT>(value); }
230 template<typename FailureCauseT = Aws::String>
231 ExportTask& WithFailureCause(FailureCauseT&& value) { SetFailureCause(std::forward<FailureCauseT>(value)); return *this;}
233
235
238 inline const Aws::String& GetWarningMessage() const { return m_warningMessage; }
239 inline bool WarningMessageHasBeenSet() const { return m_warningMessageHasBeenSet; }
240 template<typename WarningMessageT = Aws::String>
241 void SetWarningMessage(WarningMessageT&& value) { m_warningMessageHasBeenSet = true; m_warningMessage = std::forward<WarningMessageT>(value); }
242 template<typename WarningMessageT = Aws::String>
243 ExportTask& WithWarningMessage(WarningMessageT&& value) { SetWarningMessage(std::forward<WarningMessageT>(value)); return *this;}
245
247
250 inline ExportSourceType GetSourceType() const { return m_sourceType; }
251 inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; }
252 inline void SetSourceType(ExportSourceType value) { m_sourceTypeHasBeenSet = true; m_sourceType = value; }
253 inline ExportTask& WithSourceType(ExportSourceType value) { SetSourceType(value); return *this;}
255
257
258 inline const ResponseMetadata& GetResponseMetadata() const { return m_responseMetadata; }
259 template<typename ResponseMetadataT = ResponseMetadata>
260 void SetResponseMetadata(ResponseMetadataT&& value) { m_responseMetadataHasBeenSet = true; m_responseMetadata = std::forward<ResponseMetadataT>(value); }
261 template<typename ResponseMetadataT = ResponseMetadata>
262 ExportTask& WithResponseMetadata(ResponseMetadataT&& value) { SetResponseMetadata(std::forward<ResponseMetadataT>(value)); return *this;}
264 private:
265
266 Aws::String m_exportTaskIdentifier;
267 bool m_exportTaskIdentifierHasBeenSet = false;
268
269 Aws::String m_sourceArn;
270 bool m_sourceArnHasBeenSet = false;
271
272 Aws::Vector<Aws::String> m_exportOnly;
273 bool m_exportOnlyHasBeenSet = false;
274
275 Aws::Utils::DateTime m_snapshotTime{};
276 bool m_snapshotTimeHasBeenSet = false;
277
278 Aws::Utils::DateTime m_taskStartTime{};
279 bool m_taskStartTimeHasBeenSet = false;
280
281 Aws::Utils::DateTime m_taskEndTime{};
282 bool m_taskEndTimeHasBeenSet = false;
283
284 Aws::String m_s3Bucket;
285 bool m_s3BucketHasBeenSet = false;
286
287 Aws::String m_s3Prefix;
288 bool m_s3PrefixHasBeenSet = false;
289
290 Aws::String m_iamRoleArn;
291 bool m_iamRoleArnHasBeenSet = false;
292
293 Aws::String m_kmsKeyId;
294 bool m_kmsKeyIdHasBeenSet = false;
295
296 Aws::String m_status;
297 bool m_statusHasBeenSet = false;
298
299 int m_percentProgress{0};
300 bool m_percentProgressHasBeenSet = false;
301
302 int m_totalExtractedDataInGB{0};
303 bool m_totalExtractedDataInGBHasBeenSet = false;
304
305 Aws::String m_failureCause;
306 bool m_failureCauseHasBeenSet = false;
307
308 Aws::String m_warningMessage;
309 bool m_warningMessageHasBeenSet = false;
310
312 bool m_sourceTypeHasBeenSet = false;
313
314 ResponseMetadata m_responseMetadata;
315 bool m_responseMetadataHasBeenSet = true;
316 };
317
318} // namespace Model
319} // namespace RDS
320} // namespace Aws
void SetS3Prefix(S3PrefixT &&value)
Definition ExportTask.h:153
ExportTask & WithTotalExtractedDataInGB(int value)
Definition ExportTask.h:219
bool KmsKeyIdHasBeenSet() const
Definition ExportTask.h:179
void SetPercentProgress(int value)
Definition ExportTask.h:208
void SetExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:90
void SetResponseMetadata(ResponseMetadataT &&value)
Definition ExportTask.h:260
void SetSourceArn(SourceArnT &&value)
Definition ExportTask.h:69
bool IamRoleArnHasBeenSet() const
Definition ExportTask.h:164
void SetSnapshotTime(SnapshotTimeT &&value)
Definition ExportTask.h:104
bool PercentProgressHasBeenSet() const
Definition ExportTask.h:207
const Aws::String & GetStatus() const
Definition ExportTask.h:194
const Aws::String & GetExportTaskIdentifier() const
Definition ExportTask.h:53
void SetWarningMessage(WarningMessageT &&value)
Definition ExportTask.h:241
const Aws::Vector< Aws::String > & GetExportOnly() const
Definition ExportTask.h:87
ExportTask & WithIamRoleArn(IamRoleArnT &&value)
Definition ExportTask.h:168
ExportTask & WithS3Bucket(S3BucketT &&value)
Definition ExportTask.h:142
void SetTaskEndTime(TaskEndTimeT &&value)
Definition ExportTask.h:128
bool ExportTaskIdentifierHasBeenSet() const
Definition ExportTask.h:54
bool SnapshotTimeHasBeenSet() const
Definition ExportTask.h:102
ExportTask & WithResponseMetadata(ResponseMetadataT &&value)
Definition ExportTask.h:262
void SetKmsKeyId(KmsKeyIdT &&value)
Definition ExportTask.h:181
bool TotalExtractedDataInGBHasBeenSet() const
Definition ExportTask.h:217
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:125
const Aws::String & GetFailureCause() const
Definition ExportTask.h:226
void SetIamRoleArn(IamRoleArnT &&value)
Definition ExportTask.h:166
ExportTask & WithExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:92
ExportTask & WithFailureCause(FailureCauseT &&value)
Definition ExportTask.h:231
AWS_RDS_API ExportTask()=default
ExportTask & WithSourceArn(SourceArnT &&value)
Definition ExportTask.h:71
void SetStatus(StatusT &&value)
Definition ExportTask.h:197
ExportTask & WithKmsKeyId(KmsKeyIdT &&value)
Definition ExportTask.h:183
bool FailureCauseHasBeenSet() const
Definition ExportTask.h:227
const Aws::Utils::DateTime & GetSnapshotTime() const
Definition ExportTask.h:101
bool S3PrefixHasBeenSet() const
Definition ExportTask.h:151
AWS_RDS_API void OutputToStream(Aws::OStream &oStream, const char *location) const
void SetExportTaskIdentifier(ExportTaskIdentifierT &&value)
Definition ExportTask.h:56
bool SourceTypeHasBeenSet() const
Definition ExportTask.h:251
bool WarningMessageHasBeenSet() const
Definition ExportTask.h:239
void SetSourceType(ExportSourceType value)
Definition ExportTask.h:252
ExportTask & WithWarningMessage(WarningMessageT &&value)
Definition ExportTask.h:243
ExportTask & WithSnapshotTime(SnapshotTimeT &&value)
Definition ExportTask.h:106
ExportTask & WithTaskStartTime(TaskStartTimeT &&value)
Definition ExportTask.h:118
void SetFailureCause(FailureCauseT &&value)
Definition ExportTask.h:229
ExportTask & WithExportTaskIdentifier(ExportTaskIdentifierT &&value)
Definition ExportTask.h:58
bool S3BucketHasBeenSet() const
Definition ExportTask.h:138
AWS_RDS_API ExportTask(const Aws::Utils::Xml::XmlNode &xmlNode)
ExportTask & WithPercentProgress(int value)
Definition ExportTask.h:209
void SetTaskStartTime(TaskStartTimeT &&value)
Definition ExportTask.h:116
bool ExportOnlyHasBeenSet() const
Definition ExportTask.h:88
const Aws::String & GetS3Bucket() const
Definition ExportTask.h:137
const Aws::String & GetIamRoleArn() const
Definition ExportTask.h:163
const Aws::String & GetWarningMessage() const
Definition ExportTask.h:238
int GetTotalExtractedDataInGB() const
Definition ExportTask.h:216
ExportTask & WithStatus(StatusT &&value)
Definition ExportTask.h:199
bool SourceArnHasBeenSet() const
Definition ExportTask.h:67
ExportSourceType GetSourceType() const
Definition ExportTask.h:250
ExportTask & WithTaskEndTime(TaskEndTimeT &&value)
Definition ExportTask.h:130
const Aws::String & GetSourceArn() const
Definition ExportTask.h:66
bool TaskStartTimeHasBeenSet() const
Definition ExportTask.h:114
void SetTotalExtractedDataInGB(int value)
Definition ExportTask.h:218
ExportTask & WithS3Prefix(S3PrefixT &&value)
Definition ExportTask.h:155
AWS_RDS_API ExportTask & operator=(const Aws::Utils::Xml::XmlNode &xmlNode)
bool TaskEndTimeHasBeenSet() const
Definition ExportTask.h:126
void SetS3Bucket(S3BucketT &&value)
Definition ExportTask.h:140
ExportTask & WithSourceType(ExportSourceType value)
Definition ExportTask.h:253
const Aws::String & GetKmsKeyId() const
Definition ExportTask.h:178
const Aws::String & GetS3Prefix() const
Definition ExportTask.h:150
const ResponseMetadata & GetResponseMetadata() const
Definition ExportTask.h:258
ExportTask & AddExportOnly(ExportOnlyT &&value)
Definition ExportTask.h:94
const Aws::Utils::DateTime & GetTaskStartTime() const
Definition ExportTask.h:113
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