AWS SDK for C++

AWS SDK for C++ Version 1.11.786

Loading...
Searching...
No Matches
DescribeTaskResult.h
1
6#pragma once
7#include <aws/core/http/HttpResponse.h>
8#include <aws/core/utils/DateTime.h>
9#include <aws/core/utils/memory/stl/AWSString.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/datasync/DataSync_EXPORTS.h>
12#include <aws/datasync/model/FilterRule.h>
13#include <aws/datasync/model/ManifestConfig.h>
14#include <aws/datasync/model/Options.h>
15#include <aws/datasync/model/TaskMode.h>
16#include <aws/datasync/model/TaskReportConfig.h>
17#include <aws/datasync/model/TaskSchedule.h>
18#include <aws/datasync/model/TaskScheduleDetails.h>
19#include <aws/datasync/model/TaskStatus.h>
20
21#include <utility>
22
23namespace Aws {
24template <typename RESULT_TYPE>
25class AmazonWebServiceResult;
26
27namespace Utils {
28namespace Json {
29class JsonValue;
30} // namespace Json
31} // namespace Utils
32namespace DataSync {
33namespace Model {
40 public:
41 AWS_DATASYNC_API DescribeTaskResult() = default;
44
46
49 inline const Aws::String& GetTaskArn() const { return m_taskArn; }
50 template <typename TaskArnT = Aws::String>
51 void SetTaskArn(TaskArnT&& value) {
52 m_taskArnHasBeenSet = true;
53 m_taskArn = std::forward<TaskArnT>(value);
54 }
55 template <typename TaskArnT = Aws::String>
56 DescribeTaskResult& WithTaskArn(TaskArnT&& value) {
57 SetTaskArn(std::forward<TaskArnT>(value));
58 return *this;
59 }
61
63
68 inline TaskStatus GetStatus() const { return m_status; }
69 inline void SetStatus(TaskStatus value) {
70 m_statusHasBeenSet = true;
71 m_status = value;
72 }
74 SetStatus(value);
75 return *this;
76 }
78
80
83 inline const Aws::String& GetName() const { return m_name; }
84 template <typename NameT = Aws::String>
85 void SetName(NameT&& value) {
86 m_nameHasBeenSet = true;
87 m_name = std::forward<NameT>(value);
88 }
89 template <typename NameT = Aws::String>
90 DescribeTaskResult& WithName(NameT&& value) {
91 SetName(std::forward<NameT>(value));
92 return *this;
93 }
95
97
100 inline const Aws::String& GetCurrentTaskExecutionArn() const { return m_currentTaskExecutionArn; }
101 template <typename CurrentTaskExecutionArnT = Aws::String>
102 void SetCurrentTaskExecutionArn(CurrentTaskExecutionArnT&& value) {
103 m_currentTaskExecutionArnHasBeenSet = true;
104 m_currentTaskExecutionArn = std::forward<CurrentTaskExecutionArnT>(value);
105 }
106 template <typename CurrentTaskExecutionArnT = Aws::String>
107 DescribeTaskResult& WithCurrentTaskExecutionArn(CurrentTaskExecutionArnT&& value) {
108 SetCurrentTaskExecutionArn(std::forward<CurrentTaskExecutionArnT>(value));
109 return *this;
110 }
112
114
117 inline const Aws::String& GetSourceLocationArn() const { return m_sourceLocationArn; }
118 template <typename SourceLocationArnT = Aws::String>
119 void SetSourceLocationArn(SourceLocationArnT&& value) {
120 m_sourceLocationArnHasBeenSet = true;
121 m_sourceLocationArn = std::forward<SourceLocationArnT>(value);
122 }
123 template <typename SourceLocationArnT = Aws::String>
124 DescribeTaskResult& WithSourceLocationArn(SourceLocationArnT&& value) {
125 SetSourceLocationArn(std::forward<SourceLocationArnT>(value));
126 return *this;
127 }
129
131
134 inline const Aws::String& GetDestinationLocationArn() const { return m_destinationLocationArn; }
135 template <typename DestinationLocationArnT = Aws::String>
136 void SetDestinationLocationArn(DestinationLocationArnT&& value) {
137 m_destinationLocationArnHasBeenSet = true;
138 m_destinationLocationArn = std::forward<DestinationLocationArnT>(value);
139 }
140 template <typename DestinationLocationArnT = Aws::String>
141 DescribeTaskResult& WithDestinationLocationArn(DestinationLocationArnT&& value) {
142 SetDestinationLocationArn(std::forward<DestinationLocationArnT>(value));
143 return *this;
144 }
146
148
154 inline const Aws::String& GetCloudWatchLogGroupArn() const { return m_cloudWatchLogGroupArn; }
155 template <typename CloudWatchLogGroupArnT = Aws::String>
156 void SetCloudWatchLogGroupArn(CloudWatchLogGroupArnT&& value) {
157 m_cloudWatchLogGroupArnHasBeenSet = true;
158 m_cloudWatchLogGroupArn = std::forward<CloudWatchLogGroupArnT>(value);
159 }
160 template <typename CloudWatchLogGroupArnT = Aws::String>
161 DescribeTaskResult& WithCloudWatchLogGroupArn(CloudWatchLogGroupArnT&& value) {
162 SetCloudWatchLogGroupArn(std::forward<CloudWatchLogGroupArnT>(value));
163 return *this;
164 }
166
168
173 inline const Aws::Vector<Aws::String>& GetSourceNetworkInterfaceArns() const { return m_sourceNetworkInterfaceArns; }
174 template <typename SourceNetworkInterfaceArnsT = Aws::Vector<Aws::String>>
175 void SetSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT&& value) {
176 m_sourceNetworkInterfaceArnsHasBeenSet = true;
177 m_sourceNetworkInterfaceArns = std::forward<SourceNetworkInterfaceArnsT>(value);
178 }
179 template <typename SourceNetworkInterfaceArnsT = Aws::Vector<Aws::String>>
180 DescribeTaskResult& WithSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT&& value) {
181 SetSourceNetworkInterfaceArns(std::forward<SourceNetworkInterfaceArnsT>(value));
182 return *this;
183 }
184 template <typename SourceNetworkInterfaceArnsT = Aws::String>
185 DescribeTaskResult& AddSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT&& value) {
186 m_sourceNetworkInterfaceArnsHasBeenSet = true;
187 m_sourceNetworkInterfaceArns.emplace_back(std::forward<SourceNetworkInterfaceArnsT>(value));
188 return *this;
189 }
191
193
198 inline const Aws::Vector<Aws::String>& GetDestinationNetworkInterfaceArns() const { return m_destinationNetworkInterfaceArns; }
199 template <typename DestinationNetworkInterfaceArnsT = Aws::Vector<Aws::String>>
200 void SetDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT&& value) {
201 m_destinationNetworkInterfaceArnsHasBeenSet = true;
202 m_destinationNetworkInterfaceArns = std::forward<DestinationNetworkInterfaceArnsT>(value);
203 }
204 template <typename DestinationNetworkInterfaceArnsT = Aws::Vector<Aws::String>>
205 DescribeTaskResult& WithDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT&& value) {
206 SetDestinationNetworkInterfaceArns(std::forward<DestinationNetworkInterfaceArnsT>(value));
207 return *this;
208 }
209 template <typename DestinationNetworkInterfaceArnsT = Aws::String>
210 DescribeTaskResult& AddDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT&& value) {
211 m_destinationNetworkInterfaceArnsHasBeenSet = true;
212 m_destinationNetworkInterfaceArns.emplace_back(std::forward<DestinationNetworkInterfaceArnsT>(value));
213 return *this;
214 }
216
218
223 inline const Options& GetOptions() const { return m_options; }
224 template <typename OptionsT = Options>
225 void SetOptions(OptionsT&& value) {
226 m_optionsHasBeenSet = true;
227 m_options = std::forward<OptionsT>(value);
228 }
229 template <typename OptionsT = Options>
230 DescribeTaskResult& WithOptions(OptionsT&& value) {
231 SetOptions(std::forward<OptionsT>(value));
232 return *this;
233 }
235
237
244 inline const Aws::Vector<FilterRule>& GetExcludes() const { return m_excludes; }
245 template <typename ExcludesT = Aws::Vector<FilterRule>>
246 void SetExcludes(ExcludesT&& value) {
247 m_excludesHasBeenSet = true;
248 m_excludes = std::forward<ExcludesT>(value);
249 }
250 template <typename ExcludesT = Aws::Vector<FilterRule>>
251 DescribeTaskResult& WithExcludes(ExcludesT&& value) {
252 SetExcludes(std::forward<ExcludesT>(value));
253 return *this;
254 }
255 template <typename ExcludesT = FilterRule>
256 DescribeTaskResult& AddExcludes(ExcludesT&& value) {
257 m_excludesHasBeenSet = true;
258 m_excludes.emplace_back(std::forward<ExcludesT>(value));
259 return *this;
260 }
262
264
269 inline const TaskSchedule& GetSchedule() const { return m_schedule; }
270 template <typename ScheduleT = TaskSchedule>
271 void SetSchedule(ScheduleT&& value) {
272 m_scheduleHasBeenSet = true;
273 m_schedule = std::forward<ScheduleT>(value);
274 }
275 template <typename ScheduleT = TaskSchedule>
276 DescribeTaskResult& WithSchedule(ScheduleT&& value) {
277 SetSchedule(std::forward<ScheduleT>(value));
278 return *this;
279 }
281
283
289 inline const Aws::String& GetErrorCode() const { return m_errorCode; }
290 template <typename ErrorCodeT = Aws::String>
291 void SetErrorCode(ErrorCodeT&& value) {
292 m_errorCodeHasBeenSet = true;
293 m_errorCode = std::forward<ErrorCodeT>(value);
294 }
295 template <typename ErrorCodeT = Aws::String>
296 DescribeTaskResult& WithErrorCode(ErrorCodeT&& value) {
297 SetErrorCode(std::forward<ErrorCodeT>(value));
298 return *this;
299 }
301
303
309 inline const Aws::String& GetErrorDetail() const { return m_errorDetail; }
310 template <typename ErrorDetailT = Aws::String>
311 void SetErrorDetail(ErrorDetailT&& value) {
312 m_errorDetailHasBeenSet = true;
313 m_errorDetail = std::forward<ErrorDetailT>(value);
314 }
315 template <typename ErrorDetailT = Aws::String>
316 DescribeTaskResult& WithErrorDetail(ErrorDetailT&& value) {
317 SetErrorDetail(std::forward<ErrorDetailT>(value));
318 return *this;
319 }
321
323
326 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
327 template <typename CreationTimeT = Aws::Utils::DateTime>
328 void SetCreationTime(CreationTimeT&& value) {
329 m_creationTimeHasBeenSet = true;
330 m_creationTime = std::forward<CreationTimeT>(value);
331 }
332 template <typename CreationTimeT = Aws::Utils::DateTime>
333 DescribeTaskResult& WithCreationTime(CreationTimeT&& value) {
334 SetCreationTime(std::forward<CreationTimeT>(value));
335 return *this;
336 }
338
340
347 inline const Aws::Vector<FilterRule>& GetIncludes() const { return m_includes; }
348 template <typename IncludesT = Aws::Vector<FilterRule>>
349 void SetIncludes(IncludesT&& value) {
350 m_includesHasBeenSet = true;
351 m_includes = std::forward<IncludesT>(value);
352 }
353 template <typename IncludesT = Aws::Vector<FilterRule>>
354 DescribeTaskResult& WithIncludes(IncludesT&& value) {
355 SetIncludes(std::forward<IncludesT>(value));
356 return *this;
357 }
358 template <typename IncludesT = FilterRule>
359 DescribeTaskResult& AddIncludes(IncludesT&& value) {
360 m_includesHasBeenSet = true;
361 m_includes.emplace_back(std::forward<IncludesT>(value));
362 return *this;
363 }
365
367
373 inline const ManifestConfig& GetManifestConfig() const { return m_manifestConfig; }
374 template <typename ManifestConfigT = ManifestConfig>
375 void SetManifestConfig(ManifestConfigT&& value) {
376 m_manifestConfigHasBeenSet = true;
377 m_manifestConfig = std::forward<ManifestConfigT>(value);
378 }
379 template <typename ManifestConfigT = ManifestConfig>
380 DescribeTaskResult& WithManifestConfig(ManifestConfigT&& value) {
381 SetManifestConfig(std::forward<ManifestConfigT>(value));
382 return *this;
383 }
385
387
393 inline const TaskReportConfig& GetTaskReportConfig() const { return m_taskReportConfig; }
394 template <typename TaskReportConfigT = TaskReportConfig>
395 void SetTaskReportConfig(TaskReportConfigT&& value) {
396 m_taskReportConfigHasBeenSet = true;
397 m_taskReportConfig = std::forward<TaskReportConfigT>(value);
398 }
399 template <typename TaskReportConfigT = TaskReportConfig>
400 DescribeTaskResult& WithTaskReportConfig(TaskReportConfigT&& value) {
401 SetTaskReportConfig(std::forward<TaskReportConfigT>(value));
402 return *this;
403 }
405
407
412 inline const TaskScheduleDetails& GetScheduleDetails() const { return m_scheduleDetails; }
413 template <typename ScheduleDetailsT = TaskScheduleDetails>
414 void SetScheduleDetails(ScheduleDetailsT&& value) {
415 m_scheduleDetailsHasBeenSet = true;
416 m_scheduleDetails = std::forward<ScheduleDetailsT>(value);
417 }
418 template <typename ScheduleDetailsT = TaskScheduleDetails>
419 DescribeTaskResult& WithScheduleDetails(ScheduleDetailsT&& value) {
420 SetScheduleDetails(std::forward<ScheduleDetailsT>(value));
421 return *this;
422 }
424
426
431 inline TaskMode GetTaskMode() const { return m_taskMode; }
432 inline void SetTaskMode(TaskMode value) {
433 m_taskModeHasBeenSet = true;
434 m_taskMode = value;
435 }
437 SetTaskMode(value);
438 return *this;
439 }
441
443
444 inline const Aws::String& GetRequestId() const { return m_requestId; }
445 template <typename RequestIdT = Aws::String>
446 void SetRequestId(RequestIdT&& value) {
447 m_requestIdHasBeenSet = true;
448 m_requestId = std::forward<RequestIdT>(value);
449 }
450 template <typename RequestIdT = Aws::String>
451 DescribeTaskResult& WithRequestId(RequestIdT&& value) {
452 SetRequestId(std::forward<RequestIdT>(value));
453 return *this;
454 }
456 inline Aws::Http::HttpResponseCode GetHttpResponseCode() const { return m_HttpResponseCode; }
457
458 private:
459 Aws::String m_taskArn;
460
462
463 Aws::String m_name;
464
465 Aws::String m_currentTaskExecutionArn;
466
467 Aws::String m_sourceLocationArn;
468
469 Aws::String m_destinationLocationArn;
470
471 Aws::String m_cloudWatchLogGroupArn;
472
473 Aws::Vector<Aws::String> m_sourceNetworkInterfaceArns;
474
475 Aws::Vector<Aws::String> m_destinationNetworkInterfaceArns;
476
477 Options m_options;
478
479 Aws::Vector<FilterRule> m_excludes;
480
481 TaskSchedule m_schedule;
482
483 Aws::String m_errorCode;
484
485 Aws::String m_errorDetail;
486
487 Aws::Utils::DateTime m_creationTime{};
488
489 Aws::Vector<FilterRule> m_includes;
490
491 ManifestConfig m_manifestConfig;
492
493 TaskReportConfig m_taskReportConfig;
494
495 TaskScheduleDetails m_scheduleDetails;
496
497 TaskMode m_taskMode{TaskMode::NOT_SET};
498
499 Aws::String m_requestId;
500 Aws::Http::HttpResponseCode m_HttpResponseCode;
501 bool m_taskArnHasBeenSet = false;
502 bool m_statusHasBeenSet = false;
503 bool m_nameHasBeenSet = false;
504 bool m_currentTaskExecutionArnHasBeenSet = false;
505 bool m_sourceLocationArnHasBeenSet = false;
506 bool m_destinationLocationArnHasBeenSet = false;
507 bool m_cloudWatchLogGroupArnHasBeenSet = false;
508 bool m_sourceNetworkInterfaceArnsHasBeenSet = false;
509 bool m_destinationNetworkInterfaceArnsHasBeenSet = false;
510 bool m_optionsHasBeenSet = false;
511 bool m_excludesHasBeenSet = false;
512 bool m_scheduleHasBeenSet = false;
513 bool m_errorCodeHasBeenSet = false;
514 bool m_errorDetailHasBeenSet = false;
515 bool m_creationTimeHasBeenSet = false;
516 bool m_includesHasBeenSet = false;
517 bool m_manifestConfigHasBeenSet = false;
518 bool m_taskReportConfigHasBeenSet = false;
519 bool m_scheduleDetailsHasBeenSet = false;
520 bool m_taskModeHasBeenSet = false;
521 bool m_requestIdHasBeenSet = false;
522};
523
524} // namespace Model
525} // namespace DataSync
526} // namespace Aws
DescribeTaskResult & WithDestinationLocationArn(DestinationLocationArnT &&value)
void SetDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT &&value)
const Aws::Vector< FilterRule > & GetExcludes() const
DescribeTaskResult & AddSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT &&value)
DescribeTaskResult & WithTaskReportConfig(TaskReportConfigT &&value)
DescribeTaskResult & WithOptions(OptionsT &&value)
DescribeTaskResult & WithManifestConfig(ManifestConfigT &&value)
const Aws::String & GetDestinationLocationArn() const
const Aws::Vector< Aws::String > & GetDestinationNetworkInterfaceArns() const
DescribeTaskResult & WithName(NameT &&value)
DescribeTaskResult & AddExcludes(ExcludesT &&value)
DescribeTaskResult & WithErrorCode(ErrorCodeT &&value)
void SetSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT &&value)
const TaskScheduleDetails & GetScheduleDetails() const
DescribeTaskResult & WithSourceLocationArn(SourceLocationArnT &&value)
DescribeTaskResult & WithCloudWatchLogGroupArn(CloudWatchLogGroupArnT &&value)
void SetTaskReportConfig(TaskReportConfigT &&value)
AWS_DATASYNC_API DescribeTaskResult()=default
DescribeTaskResult & WithExcludes(ExcludesT &&value)
DescribeTaskResult & WithStatus(TaskStatus value)
const Aws::Vector< Aws::String > & GetSourceNetworkInterfaceArns() const
DescribeTaskResult & WithCurrentTaskExecutionArn(CurrentTaskExecutionArnT &&value)
void SetScheduleDetails(ScheduleDetailsT &&value)
AWS_DATASYNC_API DescribeTaskResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeTaskResult & WithScheduleDetails(ScheduleDetailsT &&value)
DescribeTaskResult & WithErrorDetail(ErrorDetailT &&value)
const ManifestConfig & GetManifestConfig() const
const Aws::String & GetCurrentTaskExecutionArn() const
DescribeTaskResult & WithIncludes(IncludesT &&value)
DescribeTaskResult & WithCreationTime(CreationTimeT &&value)
void SetManifestConfig(ManifestConfigT &&value)
void SetDestinationLocationArn(DestinationLocationArnT &&value)
void SetCurrentTaskExecutionArn(CurrentTaskExecutionArnT &&value)
void SetCloudWatchLogGroupArn(CloudWatchLogGroupArnT &&value)
Aws::Http::HttpResponseCode GetHttpResponseCode() const
void SetSourceLocationArn(SourceLocationArnT &&value)
void SetCreationTime(CreationTimeT &&value)
DescribeTaskResult & WithSchedule(ScheduleT &&value)
const Aws::Vector< FilterRule > & GetIncludes() const
const Aws::String & GetCloudWatchLogGroupArn() const
DescribeTaskResult & WithDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT &&value)
DescribeTaskResult & AddIncludes(IncludesT &&value)
AWS_DATASYNC_API DescribeTaskResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeTaskResult & WithRequestId(RequestIdT &&value)
const TaskReportConfig & GetTaskReportConfig() const
DescribeTaskResult & WithSourceNetworkInterfaceArns(SourceNetworkInterfaceArnsT &&value)
const Aws::Utils::DateTime & GetCreationTime() const
DescribeTaskResult & AddDestinationNetworkInterfaceArns(DestinationNetworkInterfaceArnsT &&value)
const Aws::String & GetSourceLocationArn() const
DescribeTaskResult & WithTaskMode(TaskMode value)
DescribeTaskResult & WithTaskArn(TaskArnT &&value)
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue