AWS SDK for C++  1.9.108
AWS SDK for C++
DescribeDBSnapshotsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/rds/RDS_EXPORTS.h>
8 #include <aws/rds/RDSRequest.h>
11 #include <aws/rds/model/Filter.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace RDS
17 {
18 namespace Model
19 {
20 
27  {
28  public:
30 
31  // Service request name is the Operation name which will send this request out,
32  // each operation should has unique request name, so that we can get operation's name from this request.
33  // Note: this is not true for response, multiple operations may have the same response name,
34  // so we can not get operation's name from response.
35  inline virtual const char* GetServiceRequestName() const override { return "DescribeDBSnapshots"; }
36 
37  Aws::String SerializePayload() const override;
38 
39  protected:
40  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
41 
42  public:
43 
50  inline const Aws::String& GetDBInstanceIdentifier() const{ return m_dBInstanceIdentifier; }
51 
58  inline bool DBInstanceIdentifierHasBeenSet() const { return m_dBInstanceIdentifierHasBeenSet; }
59 
66  inline void SetDBInstanceIdentifier(const Aws::String& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = value; }
67 
74  inline void SetDBInstanceIdentifier(Aws::String&& value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier = std::move(value); }
75 
82  inline void SetDBInstanceIdentifier(const char* value) { m_dBInstanceIdentifierHasBeenSet = true; m_dBInstanceIdentifier.assign(value); }
83 
90  inline DescribeDBSnapshotsRequest& WithDBInstanceIdentifier(const Aws::String& value) { SetDBInstanceIdentifier(value); return *this;}
91 
98  inline DescribeDBSnapshotsRequest& WithDBInstanceIdentifier(Aws::String&& value) { SetDBInstanceIdentifier(std::move(value)); return *this;}
99 
106  inline DescribeDBSnapshotsRequest& WithDBInstanceIdentifier(const char* value) { SetDBInstanceIdentifier(value); return *this;}
107 
108 
117  inline const Aws::String& GetDBSnapshotIdentifier() const{ return m_dBSnapshotIdentifier; }
118 
127  inline bool DBSnapshotIdentifierHasBeenSet() const { return m_dBSnapshotIdentifierHasBeenSet; }
128 
137  inline void SetDBSnapshotIdentifier(const Aws::String& value) { m_dBSnapshotIdentifierHasBeenSet = true; m_dBSnapshotIdentifier = value; }
138 
147  inline void SetDBSnapshotIdentifier(Aws::String&& value) { m_dBSnapshotIdentifierHasBeenSet = true; m_dBSnapshotIdentifier = std::move(value); }
148 
157  inline void SetDBSnapshotIdentifier(const char* value) { m_dBSnapshotIdentifierHasBeenSet = true; m_dBSnapshotIdentifier.assign(value); }
158 
167  inline DescribeDBSnapshotsRequest& WithDBSnapshotIdentifier(const Aws::String& value) { SetDBSnapshotIdentifier(value); return *this;}
168 
177  inline DescribeDBSnapshotsRequest& WithDBSnapshotIdentifier(Aws::String&& value) { SetDBSnapshotIdentifier(std::move(value)); return *this;}
178 
187  inline DescribeDBSnapshotsRequest& WithDBSnapshotIdentifier(const char* value) { SetDBSnapshotIdentifier(value); return *this;}
188 
189 
217  inline const Aws::String& GetSnapshotType() const{ return m_snapshotType; }
218 
246  inline bool SnapshotTypeHasBeenSet() const { return m_snapshotTypeHasBeenSet; }
247 
275  inline void SetSnapshotType(const Aws::String& value) { m_snapshotTypeHasBeenSet = true; m_snapshotType = value; }
276 
304  inline void SetSnapshotType(Aws::String&& value) { m_snapshotTypeHasBeenSet = true; m_snapshotType = std::move(value); }
305 
333  inline void SetSnapshotType(const char* value) { m_snapshotTypeHasBeenSet = true; m_snapshotType.assign(value); }
334 
362  inline DescribeDBSnapshotsRequest& WithSnapshotType(const Aws::String& value) { SetSnapshotType(value); return *this;}
363 
391  inline DescribeDBSnapshotsRequest& WithSnapshotType(Aws::String&& value) { SetSnapshotType(std::move(value)); return *this;}
392 
420  inline DescribeDBSnapshotsRequest& WithSnapshotType(const char* value) { SetSnapshotType(value); return *this;}
421 
422 
433  inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
434 
445  inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
446 
457  inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
458 
469  inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
470 
481  inline DescribeDBSnapshotsRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
482 
493  inline DescribeDBSnapshotsRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
494 
505  inline DescribeDBSnapshotsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
506 
517  inline DescribeDBSnapshotsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
518 
519 
527  inline int GetMaxRecords() const{ return m_maxRecords; }
528 
536  inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; }
537 
545  inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; }
546 
554  inline DescribeDBSnapshotsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;}
555 
556 
563  inline const Aws::String& GetMarker() const{ return m_marker; }
564 
571  inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; }
572 
579  inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; }
580 
587  inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); }
588 
595  inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); }
596 
603  inline DescribeDBSnapshotsRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;}
604 
611  inline DescribeDBSnapshotsRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;}
612 
619  inline DescribeDBSnapshotsRequest& WithMarker(const char* value) { SetMarker(value); return *this;}
620 
621 
630  inline bool GetIncludeShared() const{ return m_includeShared; }
631 
640  inline bool IncludeSharedHasBeenSet() const { return m_includeSharedHasBeenSet; }
641 
650  inline void SetIncludeShared(bool value) { m_includeSharedHasBeenSet = true; m_includeShared = value; }
651 
660  inline DescribeDBSnapshotsRequest& WithIncludeShared(bool value) { SetIncludeShared(value); return *this;}
661 
662 
669  inline bool GetIncludePublic() const{ return m_includePublic; }
670 
677  inline bool IncludePublicHasBeenSet() const { return m_includePublicHasBeenSet; }
678 
685  inline void SetIncludePublic(bool value) { m_includePublicHasBeenSet = true; m_includePublic = value; }
686 
693  inline DescribeDBSnapshotsRequest& WithIncludePublic(bool value) { SetIncludePublic(value); return *this;}
694 
695 
699  inline const Aws::String& GetDbiResourceId() const{ return m_dbiResourceId; }
700 
704  inline bool DbiResourceIdHasBeenSet() const { return m_dbiResourceIdHasBeenSet; }
705 
709  inline void SetDbiResourceId(const Aws::String& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = value; }
710 
714  inline void SetDbiResourceId(Aws::String&& value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId = std::move(value); }
715 
719  inline void SetDbiResourceId(const char* value) { m_dbiResourceIdHasBeenSet = true; m_dbiResourceId.assign(value); }
720 
724  inline DescribeDBSnapshotsRequest& WithDbiResourceId(const Aws::String& value) { SetDbiResourceId(value); return *this;}
725 
729  inline DescribeDBSnapshotsRequest& WithDbiResourceId(Aws::String&& value) { SetDbiResourceId(std::move(value)); return *this;}
730 
734  inline DescribeDBSnapshotsRequest& WithDbiResourceId(const char* value) { SetDbiResourceId(value); return *this;}
735 
736  private:
737 
738  Aws::String m_dBInstanceIdentifier;
739  bool m_dBInstanceIdentifierHasBeenSet;
740 
741  Aws::String m_dBSnapshotIdentifier;
742  bool m_dBSnapshotIdentifierHasBeenSet;
743 
744  Aws::String m_snapshotType;
745  bool m_snapshotTypeHasBeenSet;
746 
747  Aws::Vector<Filter> m_filters;
748  bool m_filtersHasBeenSet;
749 
750  int m_maxRecords;
751  bool m_maxRecordsHasBeenSet;
752 
753  Aws::String m_marker;
754  bool m_markerHasBeenSet;
755 
756  bool m_includeShared;
757  bool m_includeSharedHasBeenSet;
758 
759  bool m_includePublic;
760  bool m_includePublicHasBeenSet;
761 
762  Aws::String m_dbiResourceId;
763  bool m_dbiResourceIdHasBeenSet;
764  };
765 
766 } // namespace Model
767 } // namespace RDS
768 } // namespace Aws
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier
void SetDBSnapshotIdentifier(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:137
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetFilters
void SetFilters(const Aws::Vector< Filter > &value)
Definition: DescribeDBSnapshotsRequest.h:457
Aws::RDS::Model::DescribeDBSnapshotsRequest::IncludeSharedHasBeenSet
bool IncludeSharedHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:640
Aws::Http::URI
Definition: URI.h:32
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier
void SetDBSnapshotIdentifier(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:147
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithSnapshotType
DescribeDBSnapshotsRequest & WithSnapshotType(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:362
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeDBSnapshotsRequest.h:35
Aws::RDS::Model::DescribeDBSnapshotsRequest::AddFilters
DescribeDBSnapshotsRequest & AddFilters(Filter &&value)
Definition: DescribeDBSnapshotsRequest.h:517
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier
DescribeDBSnapshotsRequest & WithDBSnapshotIdentifier(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:177
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithFilters
DescribeDBSnapshotsRequest & WithFilters(Aws::Vector< Filter > &&value)
Definition: DescribeDBSnapshotsRequest.h:493
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetSnapshotType
void SetSnapshotType(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:275
Aws::ApplicationInsights::Model::CloudWatchEventSource::NOT_SET
@ NOT_SET
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId
void SetDbiResourceId(const char *value)
Definition: DescribeDBSnapshotsRequest.h:719
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetMarker
void SetMarker(const char *value)
Definition: DescribeDBSnapshotsRequest.h:595
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBInstanceIdentifier
DescribeDBSnapshotsRequest & WithDBInstanceIdentifier(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:90
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetIncludeShared
bool GetIncludeShared() const
Definition: DescribeDBSnapshotsRequest.h:630
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetMarker
void SetMarker(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:587
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::RDS::Model::DescribeDBSnapshotsRequest::FiltersHasBeenSet
bool FiltersHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:445
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithIncludeShared
DescribeDBSnapshotsRequest & WithIncludeShared(bool value)
Definition: DescribeDBSnapshotsRequest.h:660
Aws::RDS::Model::DescribeDBSnapshotsRequest::DescribeDBSnapshotsRequest
DescribeDBSnapshotsRequest()
AWSVector.h
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId
DescribeDBSnapshotsRequest & WithDbiResourceId(const char *value)
Definition: DescribeDBSnapshotsRequest.h:734
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetIncludeShared
void SetIncludeShared(bool value)
Definition: DescribeDBSnapshotsRequest.h:650
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithMarker
DescribeDBSnapshotsRequest & WithMarker(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:611
Aws::RDS::Model::DescribeDBSnapshotsRequest::DBSnapshotIdentifierHasBeenSet
bool DBSnapshotIdentifierHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:127
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetDbiResourceId
const Aws::String & GetDbiResourceId() const
Definition: DescribeDBSnapshotsRequest.h:699
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBSnapshotIdentifier
void SetDBSnapshotIdentifier(const char *value)
Definition: DescribeDBSnapshotsRequest.h:157
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetIncludePublic
void SetIncludePublic(bool value)
Definition: DescribeDBSnapshotsRequest.h:685
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithMarker
DescribeDBSnapshotsRequest & WithMarker(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:603
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBInstanceIdentifier
void SetDBInstanceIdentifier(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:66
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetSnapshotType
void SetSnapshotType(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:304
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetMarker
const Aws::String & GetMarker() const
Definition: DescribeDBSnapshotsRequest.h:563
Aws::RDS::Model::DescribeDBSnapshotsRequest::MarkerHasBeenSet
bool MarkerHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:571
RDS_EXPORTS.h
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetIncludePublic
bool GetIncludePublic() const
Definition: DescribeDBSnapshotsRequest.h:669
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetSnapshotType
const Aws::String & GetSnapshotType() const
Definition: DescribeDBSnapshotsRequest.h:217
Aws::RDS::Model::Filter
Definition: Filter.h:43
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBInstanceIdentifier
void SetDBInstanceIdentifier(const char *value)
Definition: DescribeDBSnapshotsRequest.h:82
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId
void SetDbiResourceId(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:709
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDBInstanceIdentifier
void SetDBInstanceIdentifier(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:74
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetDBInstanceIdentifier
const Aws::String & GetDBInstanceIdentifier() const
Definition: DescribeDBSnapshotsRequest.h:50
Aws::RDS::Model::DescribeDBSnapshotsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier
DescribeDBSnapshotsRequest & WithDBSnapshotIdentifier(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:167
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithFilters
DescribeDBSnapshotsRequest & WithFilters(const Aws::Vector< Filter > &value)
Definition: DescribeDBSnapshotsRequest.h:481
AWSString.h
Filter.h
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetMaxRecords
int GetMaxRecords() const
Definition: DescribeDBSnapshotsRequest.h:527
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetFilters
const Aws::Vector< Filter > & GetFilters() const
Definition: DescribeDBSnapshotsRequest.h:433
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBSnapshotIdentifier
DescribeDBSnapshotsRequest & WithDBSnapshotIdentifier(const char *value)
Definition: DescribeDBSnapshotsRequest.h:187
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithMaxRecords
DescribeDBSnapshotsRequest & WithMaxRecords(int value)
Definition: DescribeDBSnapshotsRequest.h:554
AWS_RDS_API
#define AWS_RDS_API
Definition: RDS_EXPORTS.h:28
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBInstanceIdentifier
DescribeDBSnapshotsRequest & WithDBInstanceIdentifier(const char *value)
Definition: DescribeDBSnapshotsRequest.h:106
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetMaxRecords
void SetMaxRecords(int value)
Definition: DescribeDBSnapshotsRequest.h:545
Aws::RDS::Model::DescribeDBSnapshotsRequest
Definition: DescribeDBSnapshotsRequest.h:27
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithSnapshotType
DescribeDBSnapshotsRequest & WithSnapshotType(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:391
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId
DescribeDBSnapshotsRequest & WithDbiResourceId(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:724
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDBInstanceIdentifier
DescribeDBSnapshotsRequest & WithDBInstanceIdentifier(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:98
Aws
Definition: AccessManagementClient.h:15
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetFilters
void SetFilters(Aws::Vector< Filter > &&value)
Definition: DescribeDBSnapshotsRequest.h:469
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithDbiResourceId
DescribeDBSnapshotsRequest & WithDbiResourceId(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:729
Aws::RDS::Model::DescribeDBSnapshotsRequest::AddFilters
DescribeDBSnapshotsRequest & AddFilters(const Filter &value)
Definition: DescribeDBSnapshotsRequest.h:505
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithIncludePublic
DescribeDBSnapshotsRequest & WithIncludePublic(bool value)
Definition: DescribeDBSnapshotsRequest.h:693
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetDbiResourceId
void SetDbiResourceId(Aws::String &&value)
Definition: DescribeDBSnapshotsRequest.h:714
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithSnapshotType
DescribeDBSnapshotsRequest & WithSnapshotType(const char *value)
Definition: DescribeDBSnapshotsRequest.h:420
Aws::RDS::Model::DescribeDBSnapshotsRequest::GetDBSnapshotIdentifier
const Aws::String & GetDBSnapshotIdentifier() const
Definition: DescribeDBSnapshotsRequest.h:117
RDSRequest.h
Aws::RDS::Model::DescribeDBSnapshotsRequest::DBInstanceIdentifierHasBeenSet
bool DBInstanceIdentifierHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:58
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetMarker
void SetMarker(const Aws::String &value)
Definition: DescribeDBSnapshotsRequest.h:579
Aws::RDS::Model::DescribeDBSnapshotsRequest::SetSnapshotType
void SetSnapshotType(const char *value)
Definition: DescribeDBSnapshotsRequest.h:333
Aws::RDS::Model::DescribeDBSnapshotsRequest::IncludePublicHasBeenSet
bool IncludePublicHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:677
Aws::RDS::Model::DescribeDBSnapshotsRequest::MaxRecordsHasBeenSet
bool MaxRecordsHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:536
Aws::RDS::RDSRequest
Definition: RDSRequest.h:17
Aws::RDS::Model::DescribeDBSnapshotsRequest::DbiResourceIdHasBeenSet
bool DbiResourceIdHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:704
Aws::RDS::Model::DescribeDBSnapshotsRequest::WithMarker
DescribeDBSnapshotsRequest & WithMarker(const char *value)
Definition: DescribeDBSnapshotsRequest.h:619
Aws::RDS::Model::DescribeDBSnapshotsRequest::SnapshotTypeHasBeenSet
bool SnapshotTypeHasBeenSet() const
Definition: DescribeDBSnapshotsRequest.h:246
Aws::RDS::Model::DescribeDBSnapshotsRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override