AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
DescribeBackupJobResult.h
1
6#pragma once
7#include <aws/backup/Backup_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/backup/model/BackupJobState.h>
11#include <aws/backup/model/RecoveryPointCreator.h>
12#include <aws/core/utils/memory/stl/AWSMap.h>
13#include <utility>
14
15namespace Aws
16{
17template<typename RESULT_TYPE>
18class AmazonWebServiceResult;
19
20namespace Utils
21{
22namespace Json
23{
24 class JsonValue;
25} // namespace Json
26} // namespace Utils
27namespace Backup
28{
29namespace Model
30{
32 {
33 public:
34 AWS_BACKUP_API DescribeBackupJobResult() = default;
37
38
40
43 inline const Aws::String& GetAccountId() const { return m_accountId; }
44 template<typename AccountIdT = Aws::String>
45 void SetAccountId(AccountIdT&& value) { m_accountIdHasBeenSet = true; m_accountId = std::forward<AccountIdT>(value); }
46 template<typename AccountIdT = Aws::String>
47 DescribeBackupJobResult& WithAccountId(AccountIdT&& value) { SetAccountId(std::forward<AccountIdT>(value)); return *this;}
49
51
54 inline const Aws::String& GetBackupJobId() const { return m_backupJobId; }
55 template<typename BackupJobIdT = Aws::String>
56 void SetBackupJobId(BackupJobIdT&& value) { m_backupJobIdHasBeenSet = true; m_backupJobId = std::forward<BackupJobIdT>(value); }
57 template<typename BackupJobIdT = Aws::String>
58 DescribeBackupJobResult& WithBackupJobId(BackupJobIdT&& value) { SetBackupJobId(std::forward<BackupJobIdT>(value)); return *this;}
60
62
67 inline const Aws::String& GetBackupVaultName() const { return m_backupVaultName; }
68 template<typename BackupVaultNameT = Aws::String>
69 void SetBackupVaultName(BackupVaultNameT&& value) { m_backupVaultNameHasBeenSet = true; m_backupVaultName = std::forward<BackupVaultNameT>(value); }
70 template<typename BackupVaultNameT = Aws::String>
71 DescribeBackupJobResult& WithBackupVaultName(BackupVaultNameT&& value) { SetBackupVaultName(std::forward<BackupVaultNameT>(value)); return *this;}
73
75
80 inline const Aws::String& GetBackupVaultArn() const { return m_backupVaultArn; }
81 template<typename BackupVaultArnT = Aws::String>
82 void SetBackupVaultArn(BackupVaultArnT&& value) { m_backupVaultArnHasBeenSet = true; m_backupVaultArn = std::forward<BackupVaultArnT>(value); }
83 template<typename BackupVaultArnT = Aws::String>
84 DescribeBackupJobResult& WithBackupVaultArn(BackupVaultArnT&& value) { SetBackupVaultArn(std::forward<BackupVaultArnT>(value)); return *this;}
86
88
92 inline const Aws::String& GetRecoveryPointArn() const { return m_recoveryPointArn; }
93 template<typename RecoveryPointArnT = Aws::String>
94 void SetRecoveryPointArn(RecoveryPointArnT&& value) { m_recoveryPointArnHasBeenSet = true; m_recoveryPointArn = std::forward<RecoveryPointArnT>(value); }
95 template<typename RecoveryPointArnT = Aws::String>
96 DescribeBackupJobResult& WithRecoveryPointArn(RecoveryPointArnT&& value) { SetRecoveryPointArn(std::forward<RecoveryPointArnT>(value)); return *this;}
98
100
104 inline const Aws::String& GetResourceArn() const { return m_resourceArn; }
105 template<typename ResourceArnT = Aws::String>
106 void SetResourceArn(ResourceArnT&& value) { m_resourceArnHasBeenSet = true; m_resourceArn = std::forward<ResourceArnT>(value); }
107 template<typename ResourceArnT = Aws::String>
108 DescribeBackupJobResult& WithResourceArn(ResourceArnT&& value) { SetResourceArn(std::forward<ResourceArnT>(value)); return *this;}
110
112
118 inline const Aws::Utils::DateTime& GetCreationDate() const { return m_creationDate; }
119 template<typename CreationDateT = Aws::Utils::DateTime>
120 void SetCreationDate(CreationDateT&& value) { m_creationDateHasBeenSet = true; m_creationDate = std::forward<CreationDateT>(value); }
121 template<typename CreationDateT = Aws::Utils::DateTime>
122 DescribeBackupJobResult& WithCreationDate(CreationDateT&& value) { SetCreationDate(std::forward<CreationDateT>(value)); return *this;}
124
126
132 inline const Aws::Utils::DateTime& GetCompletionDate() const { return m_completionDate; }
133 template<typename CompletionDateT = Aws::Utils::DateTime>
134 void SetCompletionDate(CompletionDateT&& value) { m_completionDateHasBeenSet = true; m_completionDate = std::forward<CompletionDateT>(value); }
135 template<typename CompletionDateT = Aws::Utils::DateTime>
136 DescribeBackupJobResult& WithCompletionDate(CompletionDateT&& value) { SetCompletionDate(std::forward<CompletionDateT>(value)); return *this;}
138
140
143 inline BackupJobState GetState() const { return m_state; }
144 inline void SetState(BackupJobState value) { m_stateHasBeenSet = true; m_state = value; }
145 inline DescribeBackupJobResult& WithState(BackupJobState value) { SetState(value); return *this;}
147
149
153 inline const Aws::String& GetStatusMessage() const { return m_statusMessage; }
154 template<typename StatusMessageT = Aws::String>
155 void SetStatusMessage(StatusMessageT&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = std::forward<StatusMessageT>(value); }
156 template<typename StatusMessageT = Aws::String>
157 DescribeBackupJobResult& WithStatusMessage(StatusMessageT&& value) { SetStatusMessage(std::forward<StatusMessageT>(value)); return *this;}
159
161
165 inline const Aws::String& GetPercentDone() const { return m_percentDone; }
166 template<typename PercentDoneT = Aws::String>
167 void SetPercentDone(PercentDoneT&& value) { m_percentDoneHasBeenSet = true; m_percentDone = std::forward<PercentDoneT>(value); }
168 template<typename PercentDoneT = Aws::String>
169 DescribeBackupJobResult& WithPercentDone(PercentDoneT&& value) { SetPercentDone(std::forward<PercentDoneT>(value)); return *this;}
171
173
194 inline long long GetBackupSizeInBytes() const { return m_backupSizeInBytes; }
195 inline void SetBackupSizeInBytes(long long value) { m_backupSizeInBytesHasBeenSet = true; m_backupSizeInBytes = value; }
196 inline DescribeBackupJobResult& WithBackupSizeInBytes(long long value) { SetBackupSizeInBytes(value); return *this;}
198
200
204 inline const Aws::String& GetIamRoleArn() const { return m_iamRoleArn; }
205 template<typename IamRoleArnT = Aws::String>
206 void SetIamRoleArn(IamRoleArnT&& value) { m_iamRoleArnHasBeenSet = true; m_iamRoleArn = std::forward<IamRoleArnT>(value); }
207 template<typename IamRoleArnT = Aws::String>
208 DescribeBackupJobResult& WithIamRoleArn(IamRoleArnT&& value) { SetIamRoleArn(std::forward<IamRoleArnT>(value)); return *this;}
210
212
218 inline const RecoveryPointCreator& GetCreatedBy() const { return m_createdBy; }
219 template<typename CreatedByT = RecoveryPointCreator>
220 void SetCreatedBy(CreatedByT&& value) { m_createdByHasBeenSet = true; m_createdBy = std::forward<CreatedByT>(value); }
221 template<typename CreatedByT = RecoveryPointCreator>
222 DescribeBackupJobResult& WithCreatedBy(CreatedByT&& value) { SetCreatedBy(std::forward<CreatedByT>(value)); return *this;}
224
226
231 inline const Aws::String& GetResourceType() const { return m_resourceType; }
232 template<typename ResourceTypeT = Aws::String>
233 void SetResourceType(ResourceTypeT&& value) { m_resourceTypeHasBeenSet = true; m_resourceType = std::forward<ResourceTypeT>(value); }
234 template<typename ResourceTypeT = Aws::String>
235 DescribeBackupJobResult& WithResourceType(ResourceTypeT&& value) { SetResourceType(std::forward<ResourceTypeT>(value)); return *this;}
237
239
243 inline long long GetBytesTransferred() const { return m_bytesTransferred; }
244 inline void SetBytesTransferred(long long value) { m_bytesTransferredHasBeenSet = true; m_bytesTransferred = value; }
245 inline DescribeBackupJobResult& WithBytesTransferred(long long value) { SetBytesTransferred(value); return *this;}
247
249
256 inline const Aws::Utils::DateTime& GetExpectedCompletionDate() const { return m_expectedCompletionDate; }
257 template<typename ExpectedCompletionDateT = Aws::Utils::DateTime>
258 void SetExpectedCompletionDate(ExpectedCompletionDateT&& value) { m_expectedCompletionDateHasBeenSet = true; m_expectedCompletionDate = std::forward<ExpectedCompletionDateT>(value); }
259 template<typename ExpectedCompletionDateT = Aws::Utils::DateTime>
260 DescribeBackupJobResult& WithExpectedCompletionDate(ExpectedCompletionDateT&& value) { SetExpectedCompletionDate(std::forward<ExpectedCompletionDateT>(value)); return *this;}
262
264
273 inline const Aws::Utils::DateTime& GetStartBy() const { return m_startBy; }
274 template<typename StartByT = Aws::Utils::DateTime>
275 void SetStartBy(StartByT&& value) { m_startByHasBeenSet = true; m_startBy = std::forward<StartByT>(value); }
276 template<typename StartByT = Aws::Utils::DateTime>
277 DescribeBackupJobResult& WithStartBy(StartByT&& value) { SetStartBy(std::forward<StartByT>(value)); return *this;}
279
281
285 inline const Aws::Map<Aws::String, Aws::String>& GetBackupOptions() const { return m_backupOptions; }
286 template<typename BackupOptionsT = Aws::Map<Aws::String, Aws::String>>
287 void SetBackupOptions(BackupOptionsT&& value) { m_backupOptionsHasBeenSet = true; m_backupOptions = std::forward<BackupOptionsT>(value); }
288 template<typename BackupOptionsT = Aws::Map<Aws::String, Aws::String>>
289 DescribeBackupJobResult& WithBackupOptions(BackupOptionsT&& value) { SetBackupOptions(std::forward<BackupOptionsT>(value)); return *this;}
290 template<typename BackupOptionsKeyT = Aws::String, typename BackupOptionsValueT = Aws::String>
291 DescribeBackupJobResult& AddBackupOptions(BackupOptionsKeyT&& key, BackupOptionsValueT&& value) {
292 m_backupOptionsHasBeenSet = true; m_backupOptions.emplace(std::forward<BackupOptionsKeyT>(key), std::forward<BackupOptionsValueT>(value)); return *this;
293 }
295
297
303 inline const Aws::String& GetBackupType() const { return m_backupType; }
304 template<typename BackupTypeT = Aws::String>
305 void SetBackupType(BackupTypeT&& value) { m_backupTypeHasBeenSet = true; m_backupType = std::forward<BackupTypeT>(value); }
306 template<typename BackupTypeT = Aws::String>
307 DescribeBackupJobResult& WithBackupType(BackupTypeT&& value) { SetBackupType(std::forward<BackupTypeT>(value)); return *this;}
309
311
314 inline const Aws::String& GetParentJobId() const { return m_parentJobId; }
315 template<typename ParentJobIdT = Aws::String>
316 void SetParentJobId(ParentJobIdT&& value) { m_parentJobIdHasBeenSet = true; m_parentJobId = std::forward<ParentJobIdT>(value); }
317 template<typename ParentJobIdT = Aws::String>
318 DescribeBackupJobResult& WithParentJobId(ParentJobIdT&& value) { SetParentJobId(std::forward<ParentJobIdT>(value)); return *this;}
320
322
326 inline bool GetIsParent() const { return m_isParent; }
327 inline void SetIsParent(bool value) { m_isParentHasBeenSet = true; m_isParent = value; }
328 inline DescribeBackupJobResult& WithIsParent(bool value) { SetIsParent(value); return *this;}
330
332
335 inline long long GetNumberOfChildJobs() const { return m_numberOfChildJobs; }
336 inline void SetNumberOfChildJobs(long long value) { m_numberOfChildJobsHasBeenSet = true; m_numberOfChildJobs = value; }
337 inline DescribeBackupJobResult& WithNumberOfChildJobs(long long value) { SetNumberOfChildJobs(value); return *this;}
339
341
344 inline const Aws::Map<BackupJobState, long long>& GetChildJobsInState() const { return m_childJobsInState; }
345 template<typename ChildJobsInStateT = Aws::Map<BackupJobState, long long>>
346 void SetChildJobsInState(ChildJobsInStateT&& value) { m_childJobsInStateHasBeenSet = true; m_childJobsInState = std::forward<ChildJobsInStateT>(value); }
347 template<typename ChildJobsInStateT = Aws::Map<BackupJobState, long long>>
348 DescribeBackupJobResult& WithChildJobsInState(ChildJobsInStateT&& value) { SetChildJobsInState(std::forward<ChildJobsInStateT>(value)); return *this;}
350 m_childJobsInStateHasBeenSet = true; m_childJobsInState.emplace(key, value); return *this;
351 }
353
355
358 inline const Aws::String& GetResourceName() const { return m_resourceName; }
359 template<typename ResourceNameT = Aws::String>
360 void SetResourceName(ResourceNameT&& value) { m_resourceNameHasBeenSet = true; m_resourceName = std::forward<ResourceNameT>(value); }
361 template<typename ResourceNameT = Aws::String>
362 DescribeBackupJobResult& WithResourceName(ResourceNameT&& value) { SetResourceName(std::forward<ResourceNameT>(value)); return *this;}
364
366
369 inline const Aws::Utils::DateTime& GetInitiationDate() const { return m_initiationDate; }
370 template<typename InitiationDateT = Aws::Utils::DateTime>
371 void SetInitiationDate(InitiationDateT&& value) { m_initiationDateHasBeenSet = true; m_initiationDate = std::forward<InitiationDateT>(value); }
372 template<typename InitiationDateT = Aws::Utils::DateTime>
373 DescribeBackupJobResult& WithInitiationDate(InitiationDateT&& value) { SetInitiationDate(std::forward<InitiationDateT>(value)); return *this;}
375
377
384 inline const Aws::String& GetMessageCategory() const { return m_messageCategory; }
385 template<typename MessageCategoryT = Aws::String>
386 void SetMessageCategory(MessageCategoryT&& value) { m_messageCategoryHasBeenSet = true; m_messageCategory = std::forward<MessageCategoryT>(value); }
387 template<typename MessageCategoryT = Aws::String>
388 DescribeBackupJobResult& WithMessageCategory(MessageCategoryT&& value) { SetMessageCategory(std::forward<MessageCategoryT>(value)); return *this;}
390
392
393 inline const Aws::String& GetRequestId() const { return m_requestId; }
394 template<typename RequestIdT = Aws::String>
395 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
396 template<typename RequestIdT = Aws::String>
397 DescribeBackupJobResult& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
399 private:
400
401 Aws::String m_accountId;
402 bool m_accountIdHasBeenSet = false;
403
404 Aws::String m_backupJobId;
405 bool m_backupJobIdHasBeenSet = false;
406
407 Aws::String m_backupVaultName;
408 bool m_backupVaultNameHasBeenSet = false;
409
410 Aws::String m_backupVaultArn;
411 bool m_backupVaultArnHasBeenSet = false;
412
413 Aws::String m_recoveryPointArn;
414 bool m_recoveryPointArnHasBeenSet = false;
415
416 Aws::String m_resourceArn;
417 bool m_resourceArnHasBeenSet = false;
418
419 Aws::Utils::DateTime m_creationDate{};
420 bool m_creationDateHasBeenSet = false;
421
422 Aws::Utils::DateTime m_completionDate{};
423 bool m_completionDateHasBeenSet = false;
424
426 bool m_stateHasBeenSet = false;
427
428 Aws::String m_statusMessage;
429 bool m_statusMessageHasBeenSet = false;
430
431 Aws::String m_percentDone;
432 bool m_percentDoneHasBeenSet = false;
433
434 long long m_backupSizeInBytes{0};
435 bool m_backupSizeInBytesHasBeenSet = false;
436
437 Aws::String m_iamRoleArn;
438 bool m_iamRoleArnHasBeenSet = false;
439
440 RecoveryPointCreator m_createdBy;
441 bool m_createdByHasBeenSet = false;
442
443 Aws::String m_resourceType;
444 bool m_resourceTypeHasBeenSet = false;
445
446 long long m_bytesTransferred{0};
447 bool m_bytesTransferredHasBeenSet = false;
448
449 Aws::Utils::DateTime m_expectedCompletionDate{};
450 bool m_expectedCompletionDateHasBeenSet = false;
451
452 Aws::Utils::DateTime m_startBy{};
453 bool m_startByHasBeenSet = false;
454
456 bool m_backupOptionsHasBeenSet = false;
457
458 Aws::String m_backupType;
459 bool m_backupTypeHasBeenSet = false;
460
461 Aws::String m_parentJobId;
462 bool m_parentJobIdHasBeenSet = false;
463
464 bool m_isParent{false};
465 bool m_isParentHasBeenSet = false;
466
467 long long m_numberOfChildJobs{0};
468 bool m_numberOfChildJobsHasBeenSet = false;
469
470 Aws::Map<BackupJobState, long long> m_childJobsInState;
471 bool m_childJobsInStateHasBeenSet = false;
472
473 Aws::String m_resourceName;
474 bool m_resourceNameHasBeenSet = false;
475
476 Aws::Utils::DateTime m_initiationDate{};
477 bool m_initiationDateHasBeenSet = false;
478
479 Aws::String m_messageCategory;
480 bool m_messageCategoryHasBeenSet = false;
481
482 Aws::String m_requestId;
483 bool m_requestIdHasBeenSet = false;
484 };
485
486} // namespace Model
487} // namespace Backup
488} // namespace Aws
DescribeBackupJobResult & WithParentJobId(ParentJobIdT &&value)
DescribeBackupJobResult & WithBytesTransferred(long long value)
const Aws::Utils::DateTime & GetInitiationDate() const
const Aws::Map< Aws::String, Aws::String > & GetBackupOptions() const
void SetRecoveryPointArn(RecoveryPointArnT &&value)
const Aws::Map< BackupJobState, long long > & GetChildJobsInState() const
DescribeBackupJobResult & WithStartBy(StartByT &&value)
DescribeBackupJobResult & WithResourceArn(ResourceArnT &&value)
void SetExpectedCompletionDate(ExpectedCompletionDateT &&value)
const RecoveryPointCreator & GetCreatedBy() const
DescribeBackupJobResult & WithCreationDate(CreationDateT &&value)
DescribeBackupJobResult & WithIamRoleArn(IamRoleArnT &&value)
DescribeBackupJobResult & WithIsParent(bool value)
AWS_BACKUP_API DescribeBackupJobResult & operator=(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
DescribeBackupJobResult & WithRecoveryPointArn(RecoveryPointArnT &&value)
const Aws::Utils::DateTime & GetExpectedCompletionDate() const
const Aws::Utils::DateTime & GetCreationDate() const
DescribeBackupJobResult & WithPercentDone(PercentDoneT &&value)
AWS_BACKUP_API DescribeBackupJobResult()=default
DescribeBackupJobResult & WithExpectedCompletionDate(ExpectedCompletionDateT &&value)
DescribeBackupJobResult & WithResourceType(ResourceTypeT &&value)
DescribeBackupJobResult & WithBackupVaultArn(BackupVaultArnT &&value)
DescribeBackupJobResult & WithBackupJobId(BackupJobIdT &&value)
DescribeBackupJobResult & WithBackupSizeInBytes(long long value)
DescribeBackupJobResult & WithBackupVaultName(BackupVaultNameT &&value)
DescribeBackupJobResult & WithResourceName(ResourceNameT &&value)
DescribeBackupJobResult & WithMessageCategory(MessageCategoryT &&value)
DescribeBackupJobResult & WithCompletionDate(CompletionDateT &&value)
DescribeBackupJobResult & AddChildJobsInState(BackupJobState key, long long value)
const Aws::Utils::DateTime & GetStartBy() const
DescribeBackupJobResult & WithCreatedBy(CreatedByT &&value)
DescribeBackupJobResult & WithAccountId(AccountIdT &&value)
const Aws::Utils::DateTime & GetCompletionDate() const
DescribeBackupJobResult & WithInitiationDate(InitiationDateT &&value)
DescribeBackupJobResult & WithRequestId(RequestIdT &&value)
void SetChildJobsInState(ChildJobsInStateT &&value)
DescribeBackupJobResult & WithNumberOfChildJobs(long long value)
DescribeBackupJobResult & WithBackupOptions(BackupOptionsT &&value)
DescribeBackupJobResult & WithBackupType(BackupTypeT &&value)
DescribeBackupJobResult & AddBackupOptions(BackupOptionsKeyT &&key, BackupOptionsValueT &&value)
DescribeBackupJobResult & WithState(BackupJobState value)
DescribeBackupJobResult & WithChildJobsInState(ChildJobsInStateT &&value)
DescribeBackupJobResult & WithStatusMessage(StatusMessageT &&value)
AWS_BACKUP_API DescribeBackupJobResult(const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
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
Aws::Utils::Json::JsonValue JsonValue