AWS SDK for C++  1.9.126
AWS SDK for C++
DescribeImagesRequest.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 "DescribeImages"; }
33 
34  Aws::String SerializePayload() const override;
35 
36  protected:
37  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
38 
39  public:
40 
46  inline const Aws::Vector<Aws::String>& GetExecutableUsers() const{ return m_executableUsers; }
47 
53  inline bool ExecutableUsersHasBeenSet() const { return m_executableUsersHasBeenSet; }
54 
60  inline void SetExecutableUsers(const Aws::Vector<Aws::String>& value) { m_executableUsersHasBeenSet = true; m_executableUsers = value; }
61 
67  inline void SetExecutableUsers(Aws::Vector<Aws::String>&& value) { m_executableUsersHasBeenSet = true; m_executableUsers = std::move(value); }
68 
74  inline DescribeImagesRequest& WithExecutableUsers(const Aws::Vector<Aws::String>& value) { SetExecutableUsers(value); return *this;}
75 
81  inline DescribeImagesRequest& WithExecutableUsers(Aws::Vector<Aws::String>&& value) { SetExecutableUsers(std::move(value)); return *this;}
82 
88  inline DescribeImagesRequest& AddExecutableUsers(const Aws::String& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; }
89 
95  inline DescribeImagesRequest& AddExecutableUsers(Aws::String&& value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(std::move(value)); return *this; }
96 
102  inline DescribeImagesRequest& AddExecutableUsers(const char* value) { m_executableUsersHasBeenSet = true; m_executableUsers.push_back(value); return *this; }
103 
104 
168  inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
169 
233  inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
234 
298  inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
299 
363  inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
364 
428  inline DescribeImagesRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
429 
493  inline DescribeImagesRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
494 
558  inline DescribeImagesRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
559 
623  inline DescribeImagesRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
624 
625 
629  inline const Aws::Vector<Aws::String>& GetImageIds() const{ return m_imageIds; }
630 
634  inline bool ImageIdsHasBeenSet() const { return m_imageIdsHasBeenSet; }
635 
639  inline void SetImageIds(const Aws::Vector<Aws::String>& value) { m_imageIdsHasBeenSet = true; m_imageIds = value; }
640 
644  inline void SetImageIds(Aws::Vector<Aws::String>&& value) { m_imageIdsHasBeenSet = true; m_imageIds = std::move(value); }
645 
649  inline DescribeImagesRequest& WithImageIds(const Aws::Vector<Aws::String>& value) { SetImageIds(value); return *this;}
650 
654  inline DescribeImagesRequest& WithImageIds(Aws::Vector<Aws::String>&& value) { SetImageIds(std::move(value)); return *this;}
655 
659  inline DescribeImagesRequest& AddImageIds(const Aws::String& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; }
660 
664  inline DescribeImagesRequest& AddImageIds(Aws::String&& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(std::move(value)); return *this; }
665 
669  inline DescribeImagesRequest& AddImageIds(const char* value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; }
670 
671 
679  inline const Aws::Vector<Aws::String>& GetOwners() const{ return m_owners; }
680 
688  inline bool OwnersHasBeenSet() const { return m_ownersHasBeenSet; }
689 
697  inline void SetOwners(const Aws::Vector<Aws::String>& value) { m_ownersHasBeenSet = true; m_owners = value; }
698 
706  inline void SetOwners(Aws::Vector<Aws::String>&& value) { m_ownersHasBeenSet = true; m_owners = std::move(value); }
707 
715  inline DescribeImagesRequest& WithOwners(const Aws::Vector<Aws::String>& value) { SetOwners(value); return *this;}
716 
724  inline DescribeImagesRequest& WithOwners(Aws::Vector<Aws::String>&& value) { SetOwners(std::move(value)); return *this;}
725 
733  inline DescribeImagesRequest& AddOwners(const Aws::String& value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; }
734 
742  inline DescribeImagesRequest& AddOwners(Aws::String&& value) { m_ownersHasBeenSet = true; m_owners.push_back(std::move(value)); return *this; }
743 
751  inline DescribeImagesRequest& AddOwners(const char* value) { m_ownersHasBeenSet = true; m_owners.push_back(value); return *this; }
752 
753 
762  inline bool GetIncludeDeprecated() const{ return m_includeDeprecated; }
763 
772  inline bool IncludeDeprecatedHasBeenSet() const { return m_includeDeprecatedHasBeenSet; }
773 
782  inline void SetIncludeDeprecated(bool value) { m_includeDeprecatedHasBeenSet = true; m_includeDeprecated = value; }
783 
792  inline DescribeImagesRequest& WithIncludeDeprecated(bool value) { SetIncludeDeprecated(value); return *this;}
793 
794 
801  inline bool GetDryRun() const{ return m_dryRun; }
802 
809  inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
810 
817  inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
818 
825  inline DescribeImagesRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
826 
827  private:
828 
829  Aws::Vector<Aws::String> m_executableUsers;
830  bool m_executableUsersHasBeenSet;
831 
832  Aws::Vector<Filter> m_filters;
833  bool m_filtersHasBeenSet;
834 
835  Aws::Vector<Aws::String> m_imageIds;
836  bool m_imageIdsHasBeenSet;
837 
838  Aws::Vector<Aws::String> m_owners;
839  bool m_ownersHasBeenSet;
840 
841  bool m_includeDeprecated;
842  bool m_includeDeprecatedHasBeenSet;
843 
844  bool m_dryRun;
845  bool m_dryRunHasBeenSet;
846  };
847 
848 } // namespace Model
849 } // namespace EC2
850 } // namespace Aws
Aws::EC2::Model::DescribeImagesRequest::AddOwners
DescribeImagesRequest & AddOwners(const char *value)
Definition: DescribeImagesRequest.h:751
Aws::EC2::Model::DescribeImagesRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Http::URI
Definition: URI.h:32
Aws::EC2::Model::DescribeImagesRequest::GetExecutableUsers
const Aws::Vector< Aws::String > & GetExecutableUsers() const
Definition: DescribeImagesRequest.h:46
Aws::EC2::Model::DescribeImagesRequest::AddOwners
DescribeImagesRequest & AddOwners(Aws::String &&value)
Definition: DescribeImagesRequest.h:742
Aws::EC2::Model::DescribeImagesRequest::WithDryRun
DescribeImagesRequest & WithDryRun(bool value)
Definition: DescribeImagesRequest.h:825
Aws::EC2::Model::DescribeImagesRequest::OwnersHasBeenSet
bool OwnersHasBeenSet() const
Definition: DescribeImagesRequest.h:688
Aws::EC2::Model::DescribeImagesRequest::WithExecutableUsers
DescribeImagesRequest & WithExecutableUsers(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:81
Aws::EC2::Model::DescribeImagesRequest::AddImageIds
DescribeImagesRequest & AddImageIds(const Aws::String &value)
Definition: DescribeImagesRequest.h:659
Aws::EC2::Model::DescribeImagesRequest::GetFilters
const Aws::Vector< Filter > & GetFilters() const
Definition: DescribeImagesRequest.h:168
Aws::EC2::Model::DescribeImagesRequest::WithFilters
DescribeImagesRequest & WithFilters(Aws::Vector< Filter > &&value)
Definition: DescribeImagesRequest.h:493
AWS_EC2_API
#define AWS_EC2_API
Definition: EC2_EXPORTS.h:28
Aws::EC2::Model::DescribeImagesRequest::SetOwners
void SetOwners(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:706
Aws::EC2::Model::DescribeImagesRequest::FiltersHasBeenSet
bool FiltersHasBeenSet() const
Definition: DescribeImagesRequest.h:233
Aws::EC2::Model::Filter
Definition: Filter.h:36
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::EC2::Model::DescribeImagesRequest::AddFilters
DescribeImagesRequest & AddFilters(Filter &&value)
Definition: DescribeImagesRequest.h:623
Aws::EC2::Model::DescribeImagesRequest::DescribeImagesRequest
DescribeImagesRequest()
Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers
DescribeImagesRequest & AddExecutableUsers(Aws::String &&value)
Definition: DescribeImagesRequest.h:95
Aws::EC2::Model::DescribeImagesRequest::AddImageIds
DescribeImagesRequest & AddImageIds(const char *value)
Definition: DescribeImagesRequest.h:669
Aws::EC2::Model::DescribeImagesRequest::WithImageIds
DescribeImagesRequest & WithImageIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:649
AWSVector.h
Filter.h
Aws::EC2::Model::DescribeImagesRequest::WithOwners
DescribeImagesRequest & WithOwners(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:724
Aws::EC2::Model::DescribeImagesRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeImagesRequest.h:32
Aws::EC2::Model::DescribeImagesRequest::WithIncludeDeprecated
DescribeImagesRequest & WithIncludeDeprecated(bool value)
Definition: DescribeImagesRequest.h:792
Aws::EC2::Model::DescribeImagesRequest::SetFilters
void SetFilters(Aws::Vector< Filter > &&value)
Definition: DescribeImagesRequest.h:363
Aws::EC2::Model::DescribeImagesRequest::SetExecutableUsers
void SetExecutableUsers(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:67
Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers
DescribeImagesRequest & AddExecutableUsers(const Aws::String &value)
Definition: DescribeImagesRequest.h:88
EC2Request.h
Aws::EC2::Model::DescribeImagesRequest::IncludeDeprecatedHasBeenSet
bool IncludeDeprecatedHasBeenSet() const
Definition: DescribeImagesRequest.h:772
Aws::EC2::Model::DescribeImagesRequest::ExecutableUsersHasBeenSet
bool ExecutableUsersHasBeenSet() const
Definition: DescribeImagesRequest.h:53
Aws::EC2::Model::DescribeImagesRequest::WithOwners
DescribeImagesRequest & WithOwners(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:715
AWSString.h
Aws::EC2::Model::DescribeImagesRequest::SetOwners
void SetOwners(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:697
Aws::EC2::Model::DescribeImagesRequest::SetImageIds
void SetImageIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:644
Aws::EC2::Model::DescribeImagesRequest::GetIncludeDeprecated
bool GetIncludeDeprecated() const
Definition: DescribeImagesRequest.h:762
Aws::EC2::Model::DescribeImagesRequest::SetImageIds
void SetImageIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:639
Aws::EC2::Model::DescribeImagesRequest::SetExecutableUsers
void SetExecutableUsers(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:60
Aws::EC2::Model::DescribeImagesRequest::SetFilters
void SetFilters(const Aws::Vector< Filter > &value)
Definition: DescribeImagesRequest.h:298
Aws::EC2::Model::DescribeImagesRequest::GetOwners
const Aws::Vector< Aws::String > & GetOwners() const
Definition: DescribeImagesRequest.h:679
Aws::EC2::Model::DescribeImagesRequest::SetIncludeDeprecated
void SetIncludeDeprecated(bool value)
Definition: DescribeImagesRequest.h:782
Aws::EC2::Model::DescribeImagesRequest::AddImageIds
DescribeImagesRequest & AddImageIds(Aws::String &&value)
Definition: DescribeImagesRequest.h:664
Aws::EC2::Model::DescribeImagesRequest::WithImageIds
DescribeImagesRequest & WithImageIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeImagesRequest.h:654
Aws::EC2::Model::DescribeImagesRequest::ImageIdsHasBeenSet
bool ImageIdsHasBeenSet() const
Definition: DescribeImagesRequest.h:634
Aws
Definition: AccessManagementClient.h:15
Aws::EC2::Model::DescribeImagesRequest::AddFilters
DescribeImagesRequest & AddFilters(const Filter &value)
Definition: DescribeImagesRequest.h:558
Aws::EC2::Model::DescribeImagesRequest::GetImageIds
const Aws::Vector< Aws::String > & GetImageIds() const
Definition: DescribeImagesRequest.h:629
Aws::EC2::Model::DescribeImagesRequest::AddExecutableUsers
DescribeImagesRequest & AddExecutableUsers(const char *value)
Definition: DescribeImagesRequest.h:102
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::EC2::Model::DescribeImagesRequest
Definition: DescribeImagesRequest.h:24
Aws::EC2::Model::DescribeImagesRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::EC2::EC2Request
Definition: EC2Request.h:17
Aws::EC2::Model::DescribeImagesRequest::SetDryRun
void SetDryRun(bool value)
Definition: DescribeImagesRequest.h:817
Aws::EC2::Model::DescribeImagesRequest::DryRunHasBeenSet
bool DryRunHasBeenSet() const
Definition: DescribeImagesRequest.h:809
Aws::EC2::Model::DescribeImagesRequest::WithFilters
DescribeImagesRequest & WithFilters(const Aws::Vector< Filter > &value)
Definition: DescribeImagesRequest.h:428
EC2_EXPORTS.h
Aws::EC2::Model::DescribeImagesRequest::GetDryRun
bool GetDryRun() const
Definition: DescribeImagesRequest.h:801
Aws::EC2::Model::DescribeImagesRequest::AddOwners
DescribeImagesRequest & AddOwners(const Aws::String &value)
Definition: DescribeImagesRequest.h:733
Aws::EC2::Model::DescribeImagesRequest::WithExecutableUsers
DescribeImagesRequest & WithExecutableUsers(const Aws::Vector< Aws::String > &value)
Definition: DescribeImagesRequest.h:74