AWS SDK for C++  1.9.175
AWS SDK for C++
DescribeEnvironmentsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace ElasticBeanstalk
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 "DescribeEnvironments"; }
36 
37  Aws::String SerializePayload() const override;
38 
39  protected:
40  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
41 
42  public:
43 
48  inline const Aws::String& GetApplicationName() const{ return m_applicationName; }
49 
54  inline bool ApplicationNameHasBeenSet() const { return m_applicationNameHasBeenSet; }
55 
60  inline void SetApplicationName(const Aws::String& value) { m_applicationNameHasBeenSet = true; m_applicationName = value; }
61 
66  inline void SetApplicationName(Aws::String&& value) { m_applicationNameHasBeenSet = true; m_applicationName = std::move(value); }
67 
72  inline void SetApplicationName(const char* value) { m_applicationNameHasBeenSet = true; m_applicationName.assign(value); }
73 
78  inline DescribeEnvironmentsRequest& WithApplicationName(const Aws::String& value) { SetApplicationName(value); return *this;}
79 
84  inline DescribeEnvironmentsRequest& WithApplicationName(Aws::String&& value) { SetApplicationName(std::move(value)); return *this;}
85 
90  inline DescribeEnvironmentsRequest& WithApplicationName(const char* value) { SetApplicationName(value); return *this;}
91 
92 
97  inline const Aws::String& GetVersionLabel() const{ return m_versionLabel; }
98 
103  inline bool VersionLabelHasBeenSet() const { return m_versionLabelHasBeenSet; }
104 
109  inline void SetVersionLabel(const Aws::String& value) { m_versionLabelHasBeenSet = true; m_versionLabel = value; }
110 
115  inline void SetVersionLabel(Aws::String&& value) { m_versionLabelHasBeenSet = true; m_versionLabel = std::move(value); }
116 
121  inline void SetVersionLabel(const char* value) { m_versionLabelHasBeenSet = true; m_versionLabel.assign(value); }
122 
127  inline DescribeEnvironmentsRequest& WithVersionLabel(const Aws::String& value) { SetVersionLabel(value); return *this;}
128 
133  inline DescribeEnvironmentsRequest& WithVersionLabel(Aws::String&& value) { SetVersionLabel(std::move(value)); return *this;}
134 
139  inline DescribeEnvironmentsRequest& WithVersionLabel(const char* value) { SetVersionLabel(value); return *this;}
140 
141 
146  inline const Aws::Vector<Aws::String>& GetEnvironmentIds() const{ return m_environmentIds; }
147 
152  inline bool EnvironmentIdsHasBeenSet() const { return m_environmentIdsHasBeenSet; }
153 
158  inline void SetEnvironmentIds(const Aws::Vector<Aws::String>& value) { m_environmentIdsHasBeenSet = true; m_environmentIds = value; }
159 
164  inline void SetEnvironmentIds(Aws::Vector<Aws::String>&& value) { m_environmentIdsHasBeenSet = true; m_environmentIds = std::move(value); }
165 
170  inline DescribeEnvironmentsRequest& WithEnvironmentIds(const Aws::Vector<Aws::String>& value) { SetEnvironmentIds(value); return *this;}
171 
176  inline DescribeEnvironmentsRequest& WithEnvironmentIds(Aws::Vector<Aws::String>&& value) { SetEnvironmentIds(std::move(value)); return *this;}
177 
182  inline DescribeEnvironmentsRequest& AddEnvironmentIds(const Aws::String& value) { m_environmentIdsHasBeenSet = true; m_environmentIds.push_back(value); return *this; }
183 
188  inline DescribeEnvironmentsRequest& AddEnvironmentIds(Aws::String&& value) { m_environmentIdsHasBeenSet = true; m_environmentIds.push_back(std::move(value)); return *this; }
189 
194  inline DescribeEnvironmentsRequest& AddEnvironmentIds(const char* value) { m_environmentIdsHasBeenSet = true; m_environmentIds.push_back(value); return *this; }
195 
196 
201  inline const Aws::Vector<Aws::String>& GetEnvironmentNames() const{ return m_environmentNames; }
202 
207  inline bool EnvironmentNamesHasBeenSet() const { return m_environmentNamesHasBeenSet; }
208 
213  inline void SetEnvironmentNames(const Aws::Vector<Aws::String>& value) { m_environmentNamesHasBeenSet = true; m_environmentNames = value; }
214 
219  inline void SetEnvironmentNames(Aws::Vector<Aws::String>&& value) { m_environmentNamesHasBeenSet = true; m_environmentNames = std::move(value); }
220 
225  inline DescribeEnvironmentsRequest& WithEnvironmentNames(const Aws::Vector<Aws::String>& value) { SetEnvironmentNames(value); return *this;}
226 
231  inline DescribeEnvironmentsRequest& WithEnvironmentNames(Aws::Vector<Aws::String>&& value) { SetEnvironmentNames(std::move(value)); return *this;}
232 
237  inline DescribeEnvironmentsRequest& AddEnvironmentNames(const Aws::String& value) { m_environmentNamesHasBeenSet = true; m_environmentNames.push_back(value); return *this; }
238 
243  inline DescribeEnvironmentsRequest& AddEnvironmentNames(Aws::String&& value) { m_environmentNamesHasBeenSet = true; m_environmentNames.push_back(std::move(value)); return *this; }
244 
249  inline DescribeEnvironmentsRequest& AddEnvironmentNames(const char* value) { m_environmentNamesHasBeenSet = true; m_environmentNames.push_back(value); return *this; }
250 
251 
257  inline bool GetIncludeDeleted() const{ return m_includeDeleted; }
258 
264  inline bool IncludeDeletedHasBeenSet() const { return m_includeDeletedHasBeenSet; }
265 
271  inline void SetIncludeDeleted(bool value) { m_includeDeletedHasBeenSet = true; m_includeDeleted = value; }
272 
278  inline DescribeEnvironmentsRequest& WithIncludeDeleted(bool value) { SetIncludeDeleted(value); return *this;}
279 
280 
285  inline const Aws::Utils::DateTime& GetIncludedDeletedBackTo() const{ return m_includedDeletedBackTo; }
286 
291  inline bool IncludedDeletedBackToHasBeenSet() const { return m_includedDeletedBackToHasBeenSet; }
292 
297  inline void SetIncludedDeletedBackTo(const Aws::Utils::DateTime& value) { m_includedDeletedBackToHasBeenSet = true; m_includedDeletedBackTo = value; }
298 
303  inline void SetIncludedDeletedBackTo(Aws::Utils::DateTime&& value) { m_includedDeletedBackToHasBeenSet = true; m_includedDeletedBackTo = std::move(value); }
304 
309  inline DescribeEnvironmentsRequest& WithIncludedDeletedBackTo(const Aws::Utils::DateTime& value) { SetIncludedDeletedBackTo(value); return *this;}
310 
315  inline DescribeEnvironmentsRequest& WithIncludedDeletedBackTo(Aws::Utils::DateTime&& value) { SetIncludedDeletedBackTo(std::move(value)); return *this;}
316 
317 
323  inline int GetMaxRecords() const{ return m_maxRecords; }
324 
330  inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; }
331 
337  inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; }
338 
344  inline DescribeEnvironmentsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;}
345 
346 
353  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
354 
361  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
362 
369  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
370 
377  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
378 
385  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
386 
393  inline DescribeEnvironmentsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
394 
401  inline DescribeEnvironmentsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
402 
409  inline DescribeEnvironmentsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
410 
411  private:
412 
413  Aws::String m_applicationName;
414  bool m_applicationNameHasBeenSet;
415 
416  Aws::String m_versionLabel;
417  bool m_versionLabelHasBeenSet;
418 
419  Aws::Vector<Aws::String> m_environmentIds;
420  bool m_environmentIdsHasBeenSet;
421 
422  Aws::Vector<Aws::String> m_environmentNames;
423  bool m_environmentNamesHasBeenSet;
424 
425  bool m_includeDeleted;
426  bool m_includeDeletedHasBeenSet;
427 
428  Aws::Utils::DateTime m_includedDeletedBackTo;
429  bool m_includedDeletedBackToHasBeenSet;
430 
431  int m_maxRecords;
432  bool m_maxRecordsHasBeenSet;
433 
434  Aws::String m_nextToken;
435  bool m_nextTokenHasBeenSet;
436  };
437 
438 } // namespace Model
439 } // namespace ElasticBeanstalk
440 } // namespace Aws
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel
DescribeEnvironmentsRequest & WithVersionLabel(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:127
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:369
Aws::Utils::DateTime
Definition: DateTime.h:55
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentNames
DescribeEnvironmentsRequest & WithEnvironmentNames(Aws::Vector< Aws::String > &&value)
Definition: DescribeEnvironmentsRequest.h:231
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::EnvironmentIdsHasBeenSet
bool EnvironmentIdsHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:152
Aws::Http::URI
Definition: URI.h:32
AWS_ELASTICBEANSTALK_API
#define AWS_ELASTICBEANSTALK_API
Definition: ElasticBeanstalk_EXPORTS.h:28
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel
void SetVersionLabel(const char *value)
Definition: DescribeEnvironmentsRequest.h:121
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludedDeletedBackTo
void SetIncludedDeletedBackTo(const Aws::Utils::DateTime &value)
Definition: DescribeEnvironmentsRequest.h:297
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludedDeletedBackTo
DescribeEnvironmentsRequest & WithIncludedDeletedBackTo(const Aws::Utils::DateTime &value)
Definition: DescribeEnvironmentsRequest.h:309
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel
void SetVersionLabel(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:109
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentIds
void SetEnvironmentIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeEnvironmentsRequest.h:164
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetEnvironmentNames
const Aws::Vector< Aws::String > & GetEnvironmentNames() const
Definition: DescribeEnvironmentsRequest.h:201
DateTime.h
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName
void SetApplicationName(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:66
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentIds
DescribeEnvironmentsRequest & WithEnvironmentIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeEnvironmentsRequest.h:176
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::DescribeEnvironmentsRequest
DescribeEnvironmentsRequest()
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken
DescribeEnvironmentsRequest & WithNextToken(const char *value)
Definition: DescribeEnvironmentsRequest.h:409
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName
void SetApplicationName(const char *value)
Definition: DescribeEnvironmentsRequest.h:72
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithMaxRecords
DescribeEnvironmentsRequest & WithMaxRecords(int value)
Definition: DescribeEnvironmentsRequest.h:344
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentNames
void SetEnvironmentNames(const Aws::Vector< Aws::String > &value)
Definition: DescribeEnvironmentsRequest.h:213
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetApplicationName
const Aws::String & GetApplicationName() const
Definition: DescribeEnvironmentsRequest.h:48
ElasticBeanstalkRequest.h
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:377
AWSVector.h
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName
DescribeEnvironmentsRequest & WithApplicationName(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:78
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::ApplicationNameHasBeenSet
bool ApplicationNameHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:54
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentNames
void SetEnvironmentNames(Aws::Vector< Aws::String > &&value)
Definition: DescribeEnvironmentsRequest.h:219
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName
void SetApplicationName(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:60
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::EnvironmentNamesHasBeenSet
bool EnvironmentNamesHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:207
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::IncludeDeletedHasBeenSet
bool IncludeDeletedHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:264
AWSString.h
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludeDeleted
DescribeEnvironmentsRequest & WithIncludeDeleted(bool value)
Definition: DescribeEnvironmentsRequest.h:278
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentIds
void SetEnvironmentIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeEnvironmentsRequest.h:158
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::IncludedDeletedBackToHasBeenSet
bool IncludedDeletedBackToHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:291
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames
DescribeEnvironmentsRequest & AddEnvironmentNames(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:237
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetEnvironmentIds
const Aws::Vector< Aws::String > & GetEnvironmentIds() const
Definition: DescribeEnvironmentsRequest.h:146
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel
void SetVersionLabel(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:115
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetIncludedDeletedBackTo
const Aws::Utils::DateTime & GetIncludedDeletedBackTo() const
Definition: DescribeEnvironmentsRequest.h:285
ElasticBeanstalk_EXPORTS.h
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludeDeleted
void SetIncludeDeleted(bool value)
Definition: DescribeEnvironmentsRequest.h:271
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetVersionLabel
const Aws::String & GetVersionLabel() const
Definition: DescribeEnvironmentsRequest.h:97
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:361
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::VersionLabelHasBeenSet
bool VersionLabelHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:103
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken
DescribeEnvironmentsRequest & WithNextToken(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:393
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames
DescribeEnvironmentsRequest & AddEnvironmentNames(const char *value)
Definition: DescribeEnvironmentsRequest.h:249
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken
DescribeEnvironmentsRequest & WithNextToken(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:401
Aws
Definition: AccessManagementClient.h:15
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentIds
DescribeEnvironmentsRequest & WithEnvironmentIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeEnvironmentsRequest.h:170
Aws::ElasticBeanstalk::ElasticBeanstalkRequest
Definition: ElasticBeanstalkRequest.h:17
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: DescribeEnvironmentsRequest.h:353
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetMaxRecords
int GetMaxRecords() const
Definition: DescribeEnvironmentsRequest.h:323
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludedDeletedBackTo
DescribeEnvironmentsRequest & WithIncludedDeletedBackTo(Aws::Utils::DateTime &&value)
Definition: DescribeEnvironmentsRequest.h:315
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds
DescribeEnvironmentsRequest & AddEnvironmentIds(const char *value)
Definition: DescribeEnvironmentsRequest.h:194
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetMaxRecords
void SetMaxRecords(int value)
Definition: DescribeEnvironmentsRequest.h:337
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeEnvironmentsRequest.h:35
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName
DescribeEnvironmentsRequest & WithApplicationName(const char *value)
Definition: DescribeEnvironmentsRequest.h:90
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel
DescribeEnvironmentsRequest & WithVersionLabel(const char *value)
Definition: DescribeEnvironmentsRequest.h:139
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentNames
DescribeEnvironmentsRequest & WithEnvironmentNames(const Aws::Vector< Aws::String > &value)
Definition: DescribeEnvironmentsRequest.h:225
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: DescribeEnvironmentsRequest.h:385
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds
DescribeEnvironmentsRequest & AddEnvironmentIds(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:188
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName
DescribeEnvironmentsRequest & WithApplicationName(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:84
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds
DescribeEnvironmentsRequest & AddEnvironmentIds(const Aws::String &value)
Definition: DescribeEnvironmentsRequest.h:182
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel
DescribeEnvironmentsRequest & WithVersionLabel(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:133
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludedDeletedBackTo
void SetIncludedDeletedBackTo(Aws::Utils::DateTime &&value)
Definition: DescribeEnvironmentsRequest.h:303
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetIncludeDeleted
bool GetIncludeDeleted() const
Definition: DescribeEnvironmentsRequest.h:257
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::MaxRecordsHasBeenSet
bool MaxRecordsHasBeenSet() const
Definition: DescribeEnvironmentsRequest.h:330
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest
Definition: DescribeEnvironmentsRequest.h:27
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames
DescribeEnvironmentsRequest & AddEnvironmentNames(Aws::String &&value)
Definition: DescribeEnvironmentsRequest.h:243