AWS SDK for C++  1.9.1
AWS SDK for C++
ListBackupJobsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace Http
17 {
18  class URI;
19 } //namespace Http
20 namespace Backup
21 {
22 namespace Model
23 {
24 
28  {
29  public:
31 
32  // Service request name is the Operation name which will send this request out,
33  // each operation should has unique request name, so that we can get operation's name from this request.
34  // Note: this is not true for response, multiple operations may have the same response name,
35  // so we can not get operation's name from response.
36  inline virtual const char* GetServiceRequestName() const override { return "ListBackupJobs"; }
37 
38  Aws::String SerializePayload() const override;
39 
40  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
41 
42 
49  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
50 
57  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
58 
65  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
66 
73  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
74 
81  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
82 
89  inline ListBackupJobsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
90 
97  inline ListBackupJobsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
98 
105  inline ListBackupJobsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
106 
107 
111  inline int GetMaxResults() const{ return m_maxResults; }
112 
116  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
117 
121  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
122 
126  inline ListBackupJobsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
127 
128 
133  inline const Aws::String& GetByResourceArn() const{ return m_byResourceArn; }
134 
139  inline bool ByResourceArnHasBeenSet() const { return m_byResourceArnHasBeenSet; }
140 
145  inline void SetByResourceArn(const Aws::String& value) { m_byResourceArnHasBeenSet = true; m_byResourceArn = value; }
146 
151  inline void SetByResourceArn(Aws::String&& value) { m_byResourceArnHasBeenSet = true; m_byResourceArn = std::move(value); }
152 
157  inline void SetByResourceArn(const char* value) { m_byResourceArnHasBeenSet = true; m_byResourceArn.assign(value); }
158 
163  inline ListBackupJobsRequest& WithByResourceArn(const Aws::String& value) { SetByResourceArn(value); return *this;}
164 
169  inline ListBackupJobsRequest& WithByResourceArn(Aws::String&& value) { SetByResourceArn(std::move(value)); return *this;}
170 
175  inline ListBackupJobsRequest& WithByResourceArn(const char* value) { SetByResourceArn(value); return *this;}
176 
177 
181  inline const BackupJobState& GetByState() const{ return m_byState; }
182 
186  inline bool ByStateHasBeenSet() const { return m_byStateHasBeenSet; }
187 
191  inline void SetByState(const BackupJobState& value) { m_byStateHasBeenSet = true; m_byState = value; }
192 
196  inline void SetByState(BackupJobState&& value) { m_byStateHasBeenSet = true; m_byState = std::move(value); }
197 
201  inline ListBackupJobsRequest& WithByState(const BackupJobState& value) { SetByState(value); return *this;}
202 
206  inline ListBackupJobsRequest& WithByState(BackupJobState&& value) { SetByState(std::move(value)); return *this;}
207 
208 
215  inline const Aws::String& GetByBackupVaultName() const{ return m_byBackupVaultName; }
216 
223  inline bool ByBackupVaultNameHasBeenSet() const { return m_byBackupVaultNameHasBeenSet; }
224 
231  inline void SetByBackupVaultName(const Aws::String& value) { m_byBackupVaultNameHasBeenSet = true; m_byBackupVaultName = value; }
232 
239  inline void SetByBackupVaultName(Aws::String&& value) { m_byBackupVaultNameHasBeenSet = true; m_byBackupVaultName = std::move(value); }
240 
247  inline void SetByBackupVaultName(const char* value) { m_byBackupVaultNameHasBeenSet = true; m_byBackupVaultName.assign(value); }
248 
255  inline ListBackupJobsRequest& WithByBackupVaultName(const Aws::String& value) { SetByBackupVaultName(value); return *this;}
256 
263  inline ListBackupJobsRequest& WithByBackupVaultName(Aws::String&& value) { SetByBackupVaultName(std::move(value)); return *this;}
264 
271  inline ListBackupJobsRequest& WithByBackupVaultName(const char* value) { SetByBackupVaultName(value); return *this;}
272 
273 
277  inline const Aws::Utils::DateTime& GetByCreatedBefore() const{ return m_byCreatedBefore; }
278 
282  inline bool ByCreatedBeforeHasBeenSet() const { return m_byCreatedBeforeHasBeenSet; }
283 
287  inline void SetByCreatedBefore(const Aws::Utils::DateTime& value) { m_byCreatedBeforeHasBeenSet = true; m_byCreatedBefore = value; }
288 
292  inline void SetByCreatedBefore(Aws::Utils::DateTime&& value) { m_byCreatedBeforeHasBeenSet = true; m_byCreatedBefore = std::move(value); }
293 
297  inline ListBackupJobsRequest& WithByCreatedBefore(const Aws::Utils::DateTime& value) { SetByCreatedBefore(value); return *this;}
298 
302  inline ListBackupJobsRequest& WithByCreatedBefore(Aws::Utils::DateTime&& value) { SetByCreatedBefore(std::move(value)); return *this;}
303 
304 
308  inline const Aws::Utils::DateTime& GetByCreatedAfter() const{ return m_byCreatedAfter; }
309 
313  inline bool ByCreatedAfterHasBeenSet() const { return m_byCreatedAfterHasBeenSet; }
314 
318  inline void SetByCreatedAfter(const Aws::Utils::DateTime& value) { m_byCreatedAfterHasBeenSet = true; m_byCreatedAfter = value; }
319 
323  inline void SetByCreatedAfter(Aws::Utils::DateTime&& value) { m_byCreatedAfterHasBeenSet = true; m_byCreatedAfter = std::move(value); }
324 
328  inline ListBackupJobsRequest& WithByCreatedAfter(const Aws::Utils::DateTime& value) { SetByCreatedAfter(value); return *this;}
329 
333  inline ListBackupJobsRequest& WithByCreatedAfter(Aws::Utils::DateTime&& value) { SetByCreatedAfter(std::move(value)); return *this;}
334 
335 
345  inline const Aws::String& GetByResourceType() const{ return m_byResourceType; }
346 
356  inline bool ByResourceTypeHasBeenSet() const { return m_byResourceTypeHasBeenSet; }
357 
367  inline void SetByResourceType(const Aws::String& value) { m_byResourceTypeHasBeenSet = true; m_byResourceType = value; }
368 
378  inline void SetByResourceType(Aws::String&& value) { m_byResourceTypeHasBeenSet = true; m_byResourceType = std::move(value); }
379 
389  inline void SetByResourceType(const char* value) { m_byResourceTypeHasBeenSet = true; m_byResourceType.assign(value); }
390 
400  inline ListBackupJobsRequest& WithByResourceType(const Aws::String& value) { SetByResourceType(value); return *this;}
401 
411  inline ListBackupJobsRequest& WithByResourceType(Aws::String&& value) { SetByResourceType(std::move(value)); return *this;}
412 
422  inline ListBackupJobsRequest& WithByResourceType(const char* value) { SetByResourceType(value); return *this;}
423 
424 
431  inline const Aws::String& GetByAccountId() const{ return m_byAccountId; }
432 
439  inline bool ByAccountIdHasBeenSet() const { return m_byAccountIdHasBeenSet; }
440 
447  inline void SetByAccountId(const Aws::String& value) { m_byAccountIdHasBeenSet = true; m_byAccountId = value; }
448 
455  inline void SetByAccountId(Aws::String&& value) { m_byAccountIdHasBeenSet = true; m_byAccountId = std::move(value); }
456 
463  inline void SetByAccountId(const char* value) { m_byAccountIdHasBeenSet = true; m_byAccountId.assign(value); }
464 
471  inline ListBackupJobsRequest& WithByAccountId(const Aws::String& value) { SetByAccountId(value); return *this;}
472 
479  inline ListBackupJobsRequest& WithByAccountId(Aws::String&& value) { SetByAccountId(std::move(value)); return *this;}
480 
487  inline ListBackupJobsRequest& WithByAccountId(const char* value) { SetByAccountId(value); return *this;}
488 
489  private:
490 
491  Aws::String m_nextToken;
492  bool m_nextTokenHasBeenSet;
493 
494  int m_maxResults;
495  bool m_maxResultsHasBeenSet;
496 
497  Aws::String m_byResourceArn;
498  bool m_byResourceArnHasBeenSet;
499 
500  BackupJobState m_byState;
501  bool m_byStateHasBeenSet;
502 
503  Aws::String m_byBackupVaultName;
504  bool m_byBackupVaultNameHasBeenSet;
505 
506  Aws::Utils::DateTime m_byCreatedBefore;
507  bool m_byCreatedBeforeHasBeenSet;
508 
509  Aws::Utils::DateTime m_byCreatedAfter;
510  bool m_byCreatedAfterHasBeenSet;
511 
512  Aws::String m_byResourceType;
513  bool m_byResourceTypeHasBeenSet;
514 
515  Aws::String m_byAccountId;
516  bool m_byAccountIdHasBeenSet;
517  };
518 
519 } // namespace Model
520 } // namespace Backup
521 } // namespace Aws
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::Backup::Model::ListBackupJobsRequest::SetByBackupVaultName
void SetByBackupVaultName(const Aws::String &value)
Definition: ListBackupJobsRequest.h:231
Aws::Backup::Model::ListBackupJobsRequest::ByAccountIdHasBeenSet
bool ByAccountIdHasBeenSet() const
Definition: ListBackupJobsRequest.h:439
Aws::Http::URI
Definition: URI.h:32
Aws::Backup::Model::ListBackupJobsRequest::WithByState
ListBackupJobsRequest & WithByState(BackupJobState &&value)
Definition: ListBackupJobsRequest.h:206
Aws::Backup::Model::ListBackupJobsRequest::WithByBackupVaultName
ListBackupJobsRequest & WithByBackupVaultName(Aws::String &&value)
Definition: ListBackupJobsRequest.h:263
Aws::Backup::Model::ListBackupJobsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: ListBackupJobsRequest.h:73
Aws::Backup::Model::ListBackupJobsRequest::SetByCreatedAfter
void SetByCreatedAfter(const Aws::Utils::DateTime &value)
Definition: ListBackupJobsRequest.h:318
Aws::Backup::Model::ListBackupJobsRequest::WithMaxResults
ListBackupJobsRequest & WithMaxResults(int value)
Definition: ListBackupJobsRequest.h:126
Aws::Backup::Model::ListBackupJobsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: ListBackupJobsRequest.h:81
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceArn
void SetByResourceArn(const Aws::String &value)
Definition: ListBackupJobsRequest.h:145
Aws::Backup::Model::ListBackupJobsRequest::ListBackupJobsRequest
ListBackupJobsRequest()
Aws::Backup::Model::ListBackupJobsRequest::SetByCreatedAfter
void SetByCreatedAfter(Aws::Utils::DateTime &&value)
Definition: ListBackupJobsRequest.h:323
Aws::Backup::Model::ListBackupJobsRequest::WithByAccountId
ListBackupJobsRequest & WithByAccountId(Aws::String &&value)
Definition: ListBackupJobsRequest.h:479
Aws::Backup::Model::ListBackupJobsRequest::ByResourceTypeHasBeenSet
bool ByResourceTypeHasBeenSet() const
Definition: ListBackupJobsRequest.h:356
AWS_BACKUP_API
#define AWS_BACKUP_API
Definition: Backup_EXPORTS.h:28
Aws::Backup::Model::ListBackupJobsRequest::ByBackupVaultNameHasBeenSet
bool ByBackupVaultNameHasBeenSet() const
Definition: ListBackupJobsRequest.h:223
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceType
void SetByResourceType(Aws::String &&value)
Definition: ListBackupJobsRequest.h:378
DateTime.h
Aws::Backup::Model::ListBackupJobsRequest::WithByAccountId
ListBackupJobsRequest & WithByAccountId(const char *value)
Definition: ListBackupJobsRequest.h:487
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceType
void SetByResourceType(const Aws::String &value)
Definition: ListBackupJobsRequest.h:367
Aws::Backup::Model::ListBackupJobsRequest::WithByBackupVaultName
ListBackupJobsRequest & WithByBackupVaultName(const char *value)
Definition: ListBackupJobsRequest.h:271
Aws::Backup::Model::ListBackupJobsRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: ListBackupJobsRequest.h:116
Aws::Backup::Model::ListBackupJobsRequest::GetByAccountId
const Aws::String & GetByAccountId() const
Definition: ListBackupJobsRequest.h:431
Aws::Backup::Model::ListBackupJobsRequest::ByCreatedAfterHasBeenSet
bool ByCreatedAfterHasBeenSet() const
Definition: ListBackupJobsRequest.h:313
Aws::Backup::Model::ListBackupJobsRequest::WithByCreatedAfter
ListBackupJobsRequest & WithByCreatedAfter(Aws::Utils::DateTime &&value)
Definition: ListBackupJobsRequest.h:333
Aws::Backup::Model::ListBackupJobsRequest::WithByAccountId
ListBackupJobsRequest & WithByAccountId(const Aws::String &value)
Definition: ListBackupJobsRequest.h:471
Aws::Backup::Model::ListBackupJobsRequest::GetByState
const BackupJobState & GetByState() const
Definition: ListBackupJobsRequest.h:181
Aws::Backup::Model::ListBackupJobsRequest::GetByCreatedBefore
const Aws::Utils::DateTime & GetByCreatedBefore() const
Definition: ListBackupJobsRequest.h:277
BackupRequest.h
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceType
ListBackupJobsRequest & WithByResourceType(const Aws::String &value)
Definition: ListBackupJobsRequest.h:400
Aws::Backup::Model::ListBackupJobsRequest::SetByCreatedBefore
void SetByCreatedBefore(const Aws::Utils::DateTime &value)
Definition: ListBackupJobsRequest.h:287
Aws::Backup::Model::ListBackupJobsRequest::GetByCreatedAfter
const Aws::Utils::DateTime & GetByCreatedAfter() const
Definition: ListBackupJobsRequest.h:308
Aws::Backup::Model::ListBackupJobsRequest::SetByBackupVaultName
void SetByBackupVaultName(Aws::String &&value)
Definition: ListBackupJobsRequest.h:239
Aws::Backup::Model::ListBackupJobsRequest::WithByCreatedBefore
ListBackupJobsRequest & WithByCreatedBefore(const Aws::Utils::DateTime &value)
Definition: ListBackupJobsRequest.h:297
Aws::Backup::Model::ListBackupJobsRequest::SetByState
void SetByState(const BackupJobState &value)
Definition: ListBackupJobsRequest.h:191
Aws::Backup::Model::ListBackupJobsRequest::GetByResourceArn
const Aws::String & GetByResourceArn() const
Definition: ListBackupJobsRequest.h:133
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceArn
ListBackupJobsRequest & WithByResourceArn(const char *value)
Definition: ListBackupJobsRequest.h:175
Aws::Backup::Model::ListBackupJobsRequest::ByStateHasBeenSet
bool ByStateHasBeenSet() const
Definition: ListBackupJobsRequest.h:186
Aws::Backup::Model::ListBackupJobsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: ListBackupJobsRequest.h:65
Aws::Backup::Model::ListBackupJobsRequest::SetMaxResults
void SetMaxResults(int value)
Definition: ListBackupJobsRequest.h:121
Aws::Backup::Model::ListBackupJobsRequest::GetByBackupVaultName
const Aws::String & GetByBackupVaultName() const
Definition: ListBackupJobsRequest.h:215
Aws::Backup::BackupRequest
Definition: BackupRequest.h:17
Aws::Backup::Model::ListBackupJobsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: ListBackupJobsRequest.h:49
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceType
void SetByResourceType(const char *value)
Definition: ListBackupJobsRequest.h:389
Aws::Backup::Model::ListBackupJobsRequest::ByCreatedBeforeHasBeenSet
bool ByCreatedBeforeHasBeenSet() const
Definition: ListBackupJobsRequest.h:282
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceArn
ListBackupJobsRequest & WithByResourceArn(const Aws::String &value)
Definition: ListBackupJobsRequest.h:163
AWSString.h
Aws::Backup::Model::ListBackupJobsRequest::GetByResourceType
const Aws::String & GetByResourceType() const
Definition: ListBackupJobsRequest.h:345
BackupJobState.h
Aws::Backup::Model::ListBackupJobsRequest::SetByBackupVaultName
void SetByBackupVaultName(const char *value)
Definition: ListBackupJobsRequest.h:247
Aws::Backup::Model::ListBackupJobsRequest::WithNextToken
ListBackupJobsRequest & WithNextToken(const char *value)
Definition: ListBackupJobsRequest.h:105
Aws::Backup::Model::ListBackupJobsRequest::ByResourceArnHasBeenSet
bool ByResourceArnHasBeenSet() const
Definition: ListBackupJobsRequest.h:139
Aws::Backup::Model::BackupJobState
BackupJobState
Definition: BackupJobState.h:17
Aws::Backup::Model::ListBackupJobsRequest::GetMaxResults
int GetMaxResults() const
Definition: ListBackupJobsRequest.h:111
Aws::Backup::Model::ListBackupJobsRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
Aws::Backup::Model::ListBackupJobsRequest::SetByAccountId
void SetByAccountId(Aws::String &&value)
Definition: ListBackupJobsRequest.h:455
Aws::Backup::Model::ListBackupJobsRequest::WithByState
ListBackupJobsRequest & WithByState(const BackupJobState &value)
Definition: ListBackupJobsRequest.h:201
Aws::Backup::Model::ListBackupJobsRequest::SetByState
void SetByState(BackupJobState &&value)
Definition: ListBackupJobsRequest.h:196
Aws::Backup::Model::ListBackupJobsRequest::WithNextToken
ListBackupJobsRequest & WithNextToken(Aws::String &&value)
Definition: ListBackupJobsRequest.h:97
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceArn
void SetByResourceArn(Aws::String &&value)
Definition: ListBackupJobsRequest.h:151
Backup_EXPORTS.h
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceType
ListBackupJobsRequest & WithByResourceType(const char *value)
Definition: ListBackupJobsRequest.h:422
Aws::Backup::Model::ListBackupJobsRequest::SetByResourceArn
void SetByResourceArn(const char *value)
Definition: ListBackupJobsRequest.h:157
Aws::Backup::Model::ListBackupJobsRequest::WithNextToken
ListBackupJobsRequest & WithNextToken(const Aws::String &value)
Definition: ListBackupJobsRequest.h:89
Aws
Definition: AccessManagementClient.h:15
Aws::Backup::Model::ListBackupJobsRequest::WithByCreatedAfter
ListBackupJobsRequest & WithByCreatedAfter(const Aws::Utils::DateTime &value)
Definition: ListBackupJobsRequest.h:328
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Backup::Model::ListBackupJobsRequest
Definition: ListBackupJobsRequest.h:28
Aws::Backup::Model::ListBackupJobsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: ListBackupJobsRequest.h:36
Aws::Backup::Model::ListBackupJobsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: ListBackupJobsRequest.h:57
Aws::Backup::Model::ListBackupJobsRequest::WithByCreatedBefore
ListBackupJobsRequest & WithByCreatedBefore(Aws::Utils::DateTime &&value)
Definition: ListBackupJobsRequest.h:302
Aws::Backup::Model::ListBackupJobsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Backup::Model::ListBackupJobsRequest::SetByCreatedBefore
void SetByCreatedBefore(Aws::Utils::DateTime &&value)
Definition: ListBackupJobsRequest.h:292
Aws::Backup::Model::ListBackupJobsRequest::WithByBackupVaultName
ListBackupJobsRequest & WithByBackupVaultName(const Aws::String &value)
Definition: ListBackupJobsRequest.h:255
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceType
ListBackupJobsRequest & WithByResourceType(Aws::String &&value)
Definition: ListBackupJobsRequest.h:411
Aws::Backup::Model::ListBackupJobsRequest::SetByAccountId
void SetByAccountId(const char *value)
Definition: ListBackupJobsRequest.h:463
Aws::Backup::Model::ListBackupJobsRequest::WithByResourceArn
ListBackupJobsRequest & WithByResourceArn(Aws::String &&value)
Definition: ListBackupJobsRequest.h:169
Aws::Backup::Model::ListBackupJobsRequest::SetByAccountId
void SetByAccountId(const Aws::String &value)
Definition: ListBackupJobsRequest.h:447