AWS SDK for C++

AWS SDK for C++ Version 1.11.788

Loading...
Searching...
No Matches
DescribeFlowResult.h
1
6#pragma once
7#include <aws/appflow/Appflow_EXPORTS.h>
8#include <aws/appflow/model/DestinationFlowConfig.h>
9#include <aws/appflow/model/ExecutionDetails.h>
10#include <aws/appflow/model/FlowStatus.h>
11#include <aws/appflow/model/MetadataCatalogConfig.h>
12#include <aws/appflow/model/MetadataCatalogDetail.h>
13#include <aws/appflow/model/SourceFlowConfig.h>
14#include <aws/appflow/model/Task.h>
15#include <aws/appflow/model/TriggerConfig.h>
16#include <aws/core/http/HttpResponse.h>
17#include <aws/core/utils/DateTime.h>
18#include <aws/core/utils/memory/stl/AWSMap.h>
19#include <aws/core/utils/memory/stl/AWSString.h>
20#include <aws/core/utils/memory/stl/AWSVector.h>
21
22#include <utility>
23
24namespace Aws {
25template <typename RESULT_TYPE>
26class AmazonWebServiceResult;
27
28namespace Utils {
29namespace Json {
30class JsonValue;
31} // namespace Json
32} // namespace Utils
33namespace Appflow {
34namespace Model {
36 public:
37 AWS_APPFLOW_API DescribeFlowResult() = default;
40
42
45 inline const Aws::String& GetFlowArn() const { return m_flowArn; }
46 template <typename FlowArnT = Aws::String>
47 void SetFlowArn(FlowArnT&& value) {
48 m_flowArnHasBeenSet = true;
49 m_flowArn = std::forward<FlowArnT>(value);
50 }
51 template <typename FlowArnT = Aws::String>
52 DescribeFlowResult& WithFlowArn(FlowArnT&& value) {
53 SetFlowArn(std::forward<FlowArnT>(value));
54 return *this;
55 }
57
59
62 inline const Aws::String& GetDescription() const { return m_description; }
63 template <typename DescriptionT = Aws::String>
64 void SetDescription(DescriptionT&& value) {
65 m_descriptionHasBeenSet = true;
66 m_description = std::forward<DescriptionT>(value);
67 }
68 template <typename DescriptionT = Aws::String>
69 DescribeFlowResult& WithDescription(DescriptionT&& value) {
70 SetDescription(std::forward<DescriptionT>(value));
71 return *this;
72 }
74
76
80 inline const Aws::String& GetFlowName() const { return m_flowName; }
81 template <typename FlowNameT = Aws::String>
82 void SetFlowName(FlowNameT&& value) {
83 m_flowNameHasBeenSet = true;
84 m_flowName = std::forward<FlowNameT>(value);
85 }
86 template <typename FlowNameT = Aws::String>
87 DescribeFlowResult& WithFlowName(FlowNameT&& value) {
88 SetFlowName(std::forward<FlowNameT>(value));
89 return *this;
90 }
92
94
100 inline const Aws::String& GetKmsArn() const { return m_kmsArn; }
101 template <typename KmsArnT = Aws::String>
102 void SetKmsArn(KmsArnT&& value) {
103 m_kmsArnHasBeenSet = true;
104 m_kmsArn = std::forward<KmsArnT>(value);
105 }
106 template <typename KmsArnT = Aws::String>
107 DescribeFlowResult& WithKmsArn(KmsArnT&& value) {
108 SetKmsArn(std::forward<KmsArnT>(value));
109 return *this;
110 }
112
114
117 inline FlowStatus GetFlowStatus() const { return m_flowStatus; }
118 inline void SetFlowStatus(FlowStatus value) {
119 m_flowStatusHasBeenSet = true;
120 m_flowStatus = value;
121 }
123 SetFlowStatus(value);
124 return *this;
125 }
127
129
133 inline const Aws::String& GetFlowStatusMessage() const { return m_flowStatusMessage; }
134 template <typename FlowStatusMessageT = Aws::String>
135 void SetFlowStatusMessage(FlowStatusMessageT&& value) {
136 m_flowStatusMessageHasBeenSet = true;
137 m_flowStatusMessage = std::forward<FlowStatusMessageT>(value);
138 }
139 template <typename FlowStatusMessageT = Aws::String>
140 DescribeFlowResult& WithFlowStatusMessage(FlowStatusMessageT&& value) {
141 SetFlowStatusMessage(std::forward<FlowStatusMessageT>(value));
142 return *this;
143 }
145
147
151 inline const SourceFlowConfig& GetSourceFlowConfig() const { return m_sourceFlowConfig; }
152 template <typename SourceFlowConfigT = SourceFlowConfig>
153 void SetSourceFlowConfig(SourceFlowConfigT&& value) {
154 m_sourceFlowConfigHasBeenSet = true;
155 m_sourceFlowConfig = std::forward<SourceFlowConfigT>(value);
156 }
157 template <typename SourceFlowConfigT = SourceFlowConfig>
158 DescribeFlowResult& WithSourceFlowConfig(SourceFlowConfigT&& value) {
159 SetSourceFlowConfig(std::forward<SourceFlowConfigT>(value));
160 return *this;
161 }
163
165
169 inline const Aws::Vector<DestinationFlowConfig>& GetDestinationFlowConfigList() const { return m_destinationFlowConfigList; }
170 template <typename DestinationFlowConfigListT = Aws::Vector<DestinationFlowConfig>>
171 void SetDestinationFlowConfigList(DestinationFlowConfigListT&& value) {
172 m_destinationFlowConfigListHasBeenSet = true;
173 m_destinationFlowConfigList = std::forward<DestinationFlowConfigListT>(value);
174 }
175 template <typename DestinationFlowConfigListT = Aws::Vector<DestinationFlowConfig>>
176 DescribeFlowResult& WithDestinationFlowConfigList(DestinationFlowConfigListT&& value) {
177 SetDestinationFlowConfigList(std::forward<DestinationFlowConfigListT>(value));
178 return *this;
179 }
180 template <typename DestinationFlowConfigListT = DestinationFlowConfig>
181 DescribeFlowResult& AddDestinationFlowConfigList(DestinationFlowConfigListT&& value) {
182 m_destinationFlowConfigListHasBeenSet = true;
183 m_destinationFlowConfigList.emplace_back(std::forward<DestinationFlowConfigListT>(value));
184 return *this;
185 }
187
189
192 inline const ExecutionDetails& GetLastRunExecutionDetails() const { return m_lastRunExecutionDetails; }
193 template <typename LastRunExecutionDetailsT = ExecutionDetails>
194 void SetLastRunExecutionDetails(LastRunExecutionDetailsT&& value) {
195 m_lastRunExecutionDetailsHasBeenSet = true;
196 m_lastRunExecutionDetails = std::forward<LastRunExecutionDetailsT>(value);
197 }
198 template <typename LastRunExecutionDetailsT = ExecutionDetails>
199 DescribeFlowResult& WithLastRunExecutionDetails(LastRunExecutionDetailsT&& value) {
200 SetLastRunExecutionDetails(std::forward<LastRunExecutionDetailsT>(value));
201 return *this;
202 }
204
206
209 inline const TriggerConfig& GetTriggerConfig() const { return m_triggerConfig; }
210 template <typename TriggerConfigT = TriggerConfig>
211 void SetTriggerConfig(TriggerConfigT&& value) {
212 m_triggerConfigHasBeenSet = true;
213 m_triggerConfig = std::forward<TriggerConfigT>(value);
214 }
215 template <typename TriggerConfigT = TriggerConfig>
216 DescribeFlowResult& WithTriggerConfig(TriggerConfigT&& value) {
217 SetTriggerConfig(std::forward<TriggerConfigT>(value));
218 return *this;
219 }
221
223
227 inline const Aws::Vector<Task>& GetTasks() const { return m_tasks; }
228 template <typename TasksT = Aws::Vector<Task>>
229 void SetTasks(TasksT&& value) {
230 m_tasksHasBeenSet = true;
231 m_tasks = std::forward<TasksT>(value);
232 }
233 template <typename TasksT = Aws::Vector<Task>>
234 DescribeFlowResult& WithTasks(TasksT&& value) {
235 SetTasks(std::forward<TasksT>(value));
236 return *this;
237 }
238 template <typename TasksT = Task>
239 DescribeFlowResult& AddTasks(TasksT&& value) {
240 m_tasksHasBeenSet = true;
241 m_tasks.emplace_back(std::forward<TasksT>(value));
242 return *this;
243 }
245
247
250 inline const Aws::Utils::DateTime& GetCreatedAt() const { return m_createdAt; }
251 template <typename CreatedAtT = Aws::Utils::DateTime>
252 void SetCreatedAt(CreatedAtT&& value) {
253 m_createdAtHasBeenSet = true;
254 m_createdAt = std::forward<CreatedAtT>(value);
255 }
256 template <typename CreatedAtT = Aws::Utils::DateTime>
257 DescribeFlowResult& WithCreatedAt(CreatedAtT&& value) {
258 SetCreatedAt(std::forward<CreatedAtT>(value));
259 return *this;
260 }
262
264
267 inline const Aws::Utils::DateTime& GetLastUpdatedAt() const { return m_lastUpdatedAt; }
268 template <typename LastUpdatedAtT = Aws::Utils::DateTime>
269 void SetLastUpdatedAt(LastUpdatedAtT&& value) {
270 m_lastUpdatedAtHasBeenSet = true;
271 m_lastUpdatedAt = std::forward<LastUpdatedAtT>(value);
272 }
273 template <typename LastUpdatedAtT = Aws::Utils::DateTime>
274 DescribeFlowResult& WithLastUpdatedAt(LastUpdatedAtT&& value) {
275 SetLastUpdatedAt(std::forward<LastUpdatedAtT>(value));
276 return *this;
277 }
279
281
284 inline const Aws::String& GetCreatedBy() const { return m_createdBy; }
285 template <typename CreatedByT = Aws::String>
286 void SetCreatedBy(CreatedByT&& value) {
287 m_createdByHasBeenSet = true;
288 m_createdBy = std::forward<CreatedByT>(value);
289 }
290 template <typename CreatedByT = Aws::String>
291 DescribeFlowResult& WithCreatedBy(CreatedByT&& value) {
292 SetCreatedBy(std::forward<CreatedByT>(value));
293 return *this;
294 }
296
298
302 inline const Aws::String& GetLastUpdatedBy() const { return m_lastUpdatedBy; }
303 template <typename LastUpdatedByT = Aws::String>
304 void SetLastUpdatedBy(LastUpdatedByT&& value) {
305 m_lastUpdatedByHasBeenSet = true;
306 m_lastUpdatedBy = std::forward<LastUpdatedByT>(value);
307 }
308 template <typename LastUpdatedByT = Aws::String>
309 DescribeFlowResult& WithLastUpdatedBy(LastUpdatedByT&& value) {
310 SetLastUpdatedBy(std::forward<LastUpdatedByT>(value));
311 return *this;
312 }
314
316
319 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
320 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
321 void SetTags(TagsT&& value) {
322 m_tagsHasBeenSet = true;
323 m_tags = std::forward<TagsT>(value);
324 }
325 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
326 DescribeFlowResult& WithTags(TagsT&& value) {
327 SetTags(std::forward<TagsT>(value));
328 return *this;
329 }
330 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
331 DescribeFlowResult& AddTags(TagsKeyT&& key, TagsValueT&& value) {
332 m_tagsHasBeenSet = true;
333 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
334 return *this;
335 }
337
339
344 inline const MetadataCatalogConfig& GetMetadataCatalogConfig() const { return m_metadataCatalogConfig; }
345 template <typename MetadataCatalogConfigT = MetadataCatalogConfig>
346 void SetMetadataCatalogConfig(MetadataCatalogConfigT&& value) {
347 m_metadataCatalogConfigHasBeenSet = true;
348 m_metadataCatalogConfig = std::forward<MetadataCatalogConfigT>(value);
349 }
350 template <typename MetadataCatalogConfigT = MetadataCatalogConfig>
351 DescribeFlowResult& WithMetadataCatalogConfig(MetadataCatalogConfigT&& value) {
352 SetMetadataCatalogConfig(std::forward<MetadataCatalogConfigT>(value));
353 return *this;
354 }
356
358
362 inline const Aws::Vector<MetadataCatalogDetail>& GetLastRunMetadataCatalogDetails() const { return m_lastRunMetadataCatalogDetails; }
363 template <typename LastRunMetadataCatalogDetailsT = Aws::Vector<MetadataCatalogDetail>>
364 void SetLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT&& value) {
365 m_lastRunMetadataCatalogDetailsHasBeenSet = true;
366 m_lastRunMetadataCatalogDetails = std::forward<LastRunMetadataCatalogDetailsT>(value);
367 }
368 template <typename LastRunMetadataCatalogDetailsT = Aws::Vector<MetadataCatalogDetail>>
369 DescribeFlowResult& WithLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT&& value) {
370 SetLastRunMetadataCatalogDetails(std::forward<LastRunMetadataCatalogDetailsT>(value));
371 return *this;
372 }
373 template <typename LastRunMetadataCatalogDetailsT = MetadataCatalogDetail>
374 DescribeFlowResult& AddLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT&& value) {
375 m_lastRunMetadataCatalogDetailsHasBeenSet = true;
376 m_lastRunMetadataCatalogDetails.emplace_back(std::forward<LastRunMetadataCatalogDetailsT>(value));
377 return *this;
378 }
380
382
389 inline long long GetSchemaVersion() const { return m_schemaVersion; }
390 inline void SetSchemaVersion(long long value) {
391 m_schemaVersionHasBeenSet = true;
392 m_schemaVersion = value;
393 }
394 inline DescribeFlowResult& WithSchemaVersion(long long value) {
395 SetSchemaVersion(value);
396 return *this;
397 }
399
401
402 inline const Aws::String& GetRequestId() const { return m_requestId; }
403 template <typename RequestIdT = Aws::String>
404 void SetRequestId(RequestIdT&& value) {
405 m_requestIdHasBeenSet = true;
406 m_requestId = std::forward<RequestIdT>(value);
407 }
408 template <typename RequestIdT = Aws::String>
409 DescribeFlowResult& WithRequestId(RequestIdT&& value) {
410 SetRequestId(std::forward<RequestIdT>(value));
411 return *this;
412 }
414 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
415
416 private:
417 Aws::String m_flowArn;
418
419 Aws::String m_description;
420
421 Aws::String m_flowName;
422
423 Aws::String m_kmsArn;
424
425 FlowStatus m_flowStatus{FlowStatus::NOT_SET};
426
427 Aws::String m_flowStatusMessage;
428
429 SourceFlowConfig m_sourceFlowConfig;
430
431 Aws::Vector<DestinationFlowConfig> m_destinationFlowConfigList;
432
433 ExecutionDetails m_lastRunExecutionDetails;
434
435 TriggerConfig m_triggerConfig;
436
437 Aws::Vector<Task> m_tasks;
438
439 Aws::Utils::DateTime m_createdAt{};
440
441 Aws::Utils::DateTime m_lastUpdatedAt{};
442
443 Aws::String m_createdBy;
444
445 Aws::String m_lastUpdatedBy;
446
448
449 MetadataCatalogConfig m_metadataCatalogConfig;
450
451 Aws::Vector<MetadataCatalogDetail> m_lastRunMetadataCatalogDetails;
452
453 long long m_schemaVersion{0};
454
455 Aws::String m_requestId;
456 Aws::Http::HttpResponseCode m_HttpResponseCode;
457 bool m_flowArnHasBeenSet = false;
458 bool m_descriptionHasBeenSet = false;
459 bool m_flowNameHasBeenSet = false;
460 bool m_kmsArnHasBeenSet = false;
461 bool m_flowStatusHasBeenSet = false;
462 bool m_flowStatusMessageHasBeenSet = false;
463 bool m_sourceFlowConfigHasBeenSet = false;
464 bool m_destinationFlowConfigListHasBeenSet = false;
465 bool m_lastRunExecutionDetailsHasBeenSet = false;
466 bool m_triggerConfigHasBeenSet = false;
467 bool m_tasksHasBeenSet = false;
468 bool m_createdAtHasBeenSet = false;
469 bool m_lastUpdatedAtHasBeenSet = false;
470 bool m_createdByHasBeenSet = false;
471 bool m_lastUpdatedByHasBeenSet = false;
472 bool m_tagsHasBeenSet = false;
473 bool m_metadataCatalogConfigHasBeenSet = false;
474 bool m_lastRunMetadataCatalogDetailsHasBeenSet = false;
475 bool m_schemaVersionHasBeenSet = false;
476 bool m_requestIdHasBeenSet = false;
477};
478
479} // namespace Model
480} // namespace Appflow
481} // namespace Aws
DescribeFlowResult & WithTags(TagsT &&value)
const Aws::Vector< Task > & GetTasks() const
const Aws::Utils::DateTime & GetLastUpdatedAt() const
void SetDescription(DescriptionT &&value)
DescribeFlowResult & AddDestinationFlowConfigList(DestinationFlowConfigListT &&value)
DescribeFlowResult & WithMetadataCatalogConfig(MetadataCatalogConfigT &&value)
const Aws::Vector< DestinationFlowConfig > & GetDestinationFlowConfigList() const
DescribeFlowResult & WithDescription(DescriptionT &&value)
void SetLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT &&value)
const Aws::Map< Aws::String, Aws::String > & GetTags() const
const Aws::String & GetFlowStatusMessage() const
void SetLastRunExecutionDetails(LastRunExecutionDetailsT &&value)
void SetDestinationFlowConfigList(DestinationFlowConfigListT &&value)
DescribeFlowResult & WithCreatedAt(CreatedAtT &&value)
void SetSourceFlowConfig(SourceFlowConfigT &&value)
DescribeFlowResult & WithCreatedBy(CreatedByT &&value)
AWS_APPFLOW_API DescribeFlowResult()=default
void SetFlowStatusMessage(FlowStatusMessageT &&value)
DescribeFlowResult & WithFlowArn(FlowArnT &&value)
void SetLastUpdatedBy(LastUpdatedByT &&value)
const Aws::Vector< MetadataCatalogDetail > & GetLastRunMetadataCatalogDetails() const
const TriggerConfig & GetTriggerConfig() const
DescribeFlowResult & WithFlowStatusMessage(FlowStatusMessageT &&value)
AWS_APPFLOW_API DescribeFlowResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeFlowResult & WithDestinationFlowConfigList(DestinationFlowConfigListT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
const ExecutionDetails & GetLastRunExecutionDetails() const
DescribeFlowResult & WithLastRunExecutionDetails(LastRunExecutionDetailsT &&value)
const Aws::String & GetDescription() const
AWS_APPFLOW_API DescribeFlowResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeFlowResult & WithFlowName(FlowNameT &&value)
void SetLastUpdatedAt(LastUpdatedAtT &&value)
const Aws::String & GetFlowName() const
const MetadataCatalogConfig & GetMetadataCatalogConfig() const
DescribeFlowResult & WithKmsArn(KmsArnT &&value)
DescribeFlowResult & AddTags(TagsKeyT &&key, TagsValueT &&value)
void SetTriggerConfig(TriggerConfigT &&value)
DescribeFlowResult & WithFlowStatus(FlowStatus value)
void SetMetadataCatalogConfig(MetadataCatalogConfigT &&value)
DescribeFlowResult & WithSchemaVersion(long long value)
DescribeFlowResult & AddTasks(TasksT &&value)
DescribeFlowResult & WithLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT &&value)
DescribeFlowResult & WithLastUpdatedAt(LastUpdatedAtT &&value)
DescribeFlowResult & WithTasks(TasksT &&value)
DescribeFlowResult & WithTriggerConfig(TriggerConfigT &&value)
DescribeFlowResult & WithRequestId(RequestIdT &&value)
const SourceFlowConfig & GetSourceFlowConfig() const
DescribeFlowResult & WithLastUpdatedBy(LastUpdatedByT &&value)
const Aws::String & GetLastUpdatedBy() const
const Aws::Utils::DateTime & GetCreatedAt() const
DescribeFlowResult & WithSourceFlowConfig(SourceFlowConfigT &&value)
DescribeFlowResult & AddLastRunMetadataCatalogDetails(LastRunMetadataCatalogDetailsT &&value)
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue