AWS SDK for C++  1.9.129
AWS SDK for C++
DescribeVolumesRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/ec2/EC2_EXPORTS.h>
8 #include <aws/ec2/EC2Request.h>
11 #include <aws/ec2/model/Filter.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace EC2
17 {
18 namespace Model
19 {
20 
24  {
25  public:
27 
28  // Service request name is the Operation name which will send this request out,
29  // each operation should has unique request name, so that we can get operation's name from this request.
30  // Note: this is not true for response, multiple operations may have the same response name,
31  // so we can not get operation's name from response.
32  inline virtual const char* GetServiceRequestName() const override { return "DescribeVolumes"; }
33 
34  Aws::String SerializePayload() const override;
35 
36  protected:
37  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
38 
39  public:
40 
77  inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
78 
115  inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
116 
153  inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
154 
191  inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
192 
229  inline DescribeVolumesRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
230 
267  inline DescribeVolumesRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
268 
305  inline DescribeVolumesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
306 
343  inline DescribeVolumesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
344 
345 
349  inline const Aws::Vector<Aws::String>& GetVolumeIds() const{ return m_volumeIds; }
350 
354  inline bool VolumeIdsHasBeenSet() const { return m_volumeIdsHasBeenSet; }
355 
359  inline void SetVolumeIds(const Aws::Vector<Aws::String>& value) { m_volumeIdsHasBeenSet = true; m_volumeIds = value; }
360 
364  inline void SetVolumeIds(Aws::Vector<Aws::String>&& value) { m_volumeIdsHasBeenSet = true; m_volumeIds = std::move(value); }
365 
369  inline DescribeVolumesRequest& WithVolumeIds(const Aws::Vector<Aws::String>& value) { SetVolumeIds(value); return *this;}
370 
374  inline DescribeVolumesRequest& WithVolumeIds(Aws::Vector<Aws::String>&& value) { SetVolumeIds(std::move(value)); return *this;}
375 
379  inline DescribeVolumesRequest& AddVolumeIds(const Aws::String& value) { m_volumeIdsHasBeenSet = true; m_volumeIds.push_back(value); return *this; }
380 
384  inline DescribeVolumesRequest& AddVolumeIds(Aws::String&& value) { m_volumeIdsHasBeenSet = true; m_volumeIds.push_back(std::move(value)); return *this; }
385 
389  inline DescribeVolumesRequest& AddVolumeIds(const char* value) { m_volumeIdsHasBeenSet = true; m_volumeIds.push_back(value); return *this; }
390 
391 
398  inline bool GetDryRun() const{ return m_dryRun; }
399 
406  inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
407 
414  inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
415 
422  inline DescribeVolumesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
423 
424 
437  inline int GetMaxResults() const{ return m_maxResults; }
438 
451  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
452 
465  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
466 
479  inline DescribeVolumesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
480 
481 
489  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
490 
498  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
499 
507  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
508 
516  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
517 
525  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
526 
534  inline DescribeVolumesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
535 
543  inline DescribeVolumesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
544 
552  inline DescribeVolumesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
553 
554  private:
555 
556  Aws::Vector<Filter> m_filters;
557  bool m_filtersHasBeenSet;
558 
559  Aws::Vector<Aws::String> m_volumeIds;
560  bool m_volumeIdsHasBeenSet;
561 
562  bool m_dryRun;
563  bool m_dryRunHasBeenSet;
564 
565  int m_maxResults;
566  bool m_maxResultsHasBeenSet;
567 
568  Aws::String m_nextToken;
569  bool m_nextTokenHasBeenSet;
570  };
571 
572 } // namespace Model
573 } // namespace EC2
574 } // namespace Aws
Aws::EC2::Model::DescribeVolumesRequest::VolumeIdsHasBeenSet
bool VolumeIdsHasBeenSet() const
Definition: DescribeVolumesRequest.h:354
Aws::EC2::Model::DescribeVolumesRequest::FiltersHasBeenSet
bool FiltersHasBeenSet() const
Definition: DescribeVolumesRequest.h:115
Aws::Http::URI
Definition: URI.h:32
Aws::EC2::Model::DescribeVolumesRequest::AddFilters
DescribeVolumesRequest & AddFilters(Filter &&value)
Definition: DescribeVolumesRequest.h:343
Aws::EC2::Model::DescribeVolumesRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: DescribeVolumesRequest.h:451
Aws::EC2::Model::DescribeVolumesRequest::SetNextToken
void SetNextToken(const char *value)
Definition: DescribeVolumesRequest.h:525
Aws::EC2::Model::DescribeVolumesRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds
DescribeVolumesRequest & AddVolumeIds(const Aws::String &value)
Definition: DescribeVolumesRequest.h:379
Aws::EC2::Model::DescribeVolumesRequest::DryRunHasBeenSet
bool DryRunHasBeenSet() const
Definition: DescribeVolumesRequest.h:406
Aws::EC2::Model::DescribeVolumesRequest::AddFilters
DescribeVolumesRequest & AddFilters(const Filter &value)
Definition: DescribeVolumesRequest.h:305
Aws::EC2::Model::DescribeVolumesRequest::WithNextToken
DescribeVolumesRequest & WithNextToken(Aws::String &&value)
Definition: DescribeVolumesRequest.h:543
Aws::EC2::Model::DescribeVolumesRequest::WithDryRun
DescribeVolumesRequest & WithDryRun(bool value)
Definition: DescribeVolumesRequest.h:422
Aws::EC2::Model::DescribeVolumesRequest::WithNextToken
DescribeVolumesRequest & WithNextToken(const Aws::String &value)
Definition: DescribeVolumesRequest.h:534
Aws::EC2::Model::DescribeVolumesRequest
Definition: DescribeVolumesRequest.h:24
Aws::EC2::Model::DescribeVolumesRequest::WithNextToken
DescribeVolumesRequest & WithNextToken(const char *value)
Definition: DescribeVolumesRequest.h:552
AWS_EC2_API
#define AWS_EC2_API
Definition: EC2_EXPORTS.h:28
Aws::EC2::Model::DescribeVolumesRequest::WithFilters
DescribeVolumesRequest & WithFilters(Aws::Vector< Filter > &&value)
Definition: DescribeVolumesRequest.h:267
Aws::EC2::Model::Filter
Definition: Filter.h:36
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::EC2::Model::DescribeVolumesRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: DescribeVolumesRequest.h:489
Aws::EC2::Model::DescribeVolumesRequest::SetVolumeIds
void SetVolumeIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeVolumesRequest.h:364
Aws::EC2::Model::DescribeVolumesRequest::GetDryRun
bool GetDryRun() const
Definition: DescribeVolumesRequest.h:398
Aws::EC2::Model::DescribeVolumesRequest::GetMaxResults
int GetMaxResults() const
Definition: DescribeVolumesRequest.h:437
Aws::EC2::Model::DescribeVolumesRequest::SetDryRun
void SetDryRun(bool value)
Definition: DescribeVolumesRequest.h:414
AWSVector.h
Filter.h
Aws::EC2::Model::DescribeVolumesRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: DescribeVolumesRequest.h:507
Aws::EC2::Model::DescribeVolumesRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: DescribeVolumesRequest.h:498
Aws::EC2::Model::DescribeVolumesRequest::GetFilters
const Aws::Vector< Filter > & GetFilters() const
Definition: DescribeVolumesRequest.h:77
Aws::EC2::Model::DescribeVolumesRequest::WithVolumeIds
DescribeVolumesRequest & WithVolumeIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeVolumesRequest.h:374
Aws::EC2::Model::DescribeVolumesRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeVolumesRequest.h:32
EC2Request.h
Aws::EC2::Model::DescribeVolumesRequest::SetVolumeIds
void SetVolumeIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeVolumesRequest.h:359
AWSString.h
Aws::EC2::Model::DescribeVolumesRequest::WithMaxResults
DescribeVolumesRequest & WithMaxResults(int value)
Definition: DescribeVolumesRequest.h:479
Aws::EC2::Model::DescribeVolumesRequest::DescribeVolumesRequest
DescribeVolumesRequest()
Aws::EC2::Model::DescribeVolumesRequest::WithFilters
DescribeVolumesRequest & WithFilters(const Aws::Vector< Filter > &value)
Definition: DescribeVolumesRequest.h:229
Aws::EC2::Model::DescribeVolumesRequest::SetMaxResults
void SetMaxResults(int value)
Definition: DescribeVolumesRequest.h:465
Aws::EC2::Model::DescribeVolumesRequest::SetFilters
void SetFilters(const Aws::Vector< Filter > &value)
Definition: DescribeVolumesRequest.h:153
Aws::EC2::Model::DescribeVolumesRequest::WithVolumeIds
DescribeVolumesRequest & WithVolumeIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeVolumesRequest.h:369
Aws
Definition: AccessManagementClient.h:15
Aws::EC2::Model::DescribeVolumesRequest::SetFilters
void SetFilters(Aws::Vector< Filter > &&value)
Definition: DescribeVolumesRequest.h:191
Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds
DescribeVolumesRequest & AddVolumeIds(Aws::String &&value)
Definition: DescribeVolumesRequest.h:384
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::EC2::EC2Request
Definition: EC2Request.h:17
Aws::EC2::Model::DescribeVolumesRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::EC2::Model::DescribeVolumesRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: DescribeVolumesRequest.h:516
Aws::EC2::Model::DescribeVolumesRequest::GetVolumeIds
const Aws::Vector< Aws::String > & GetVolumeIds() const
Definition: DescribeVolumesRequest.h:349
EC2_EXPORTS.h
Aws::EC2::Model::DescribeVolumesRequest::AddVolumeIds
DescribeVolumesRequest & AddVolumeIds(const char *value)
Definition: DescribeVolumesRequest.h:389