AWS SDK for C++

AWS SDK for C++ Version 1.11.768

Loading...
Searching...
No Matches
RestApi.h
1
6#pragma once
7#include <aws/apigateway/APIGateway_EXPORTS.h>
8#include <aws/apigateway/model/ApiKeySourceType.h>
9#include <aws/apigateway/model/ApiStatus.h>
10#include <aws/apigateway/model/EndpointAccessMode.h>
11#include <aws/apigateway/model/EndpointConfiguration.h>
12#include <aws/apigateway/model/SecurityPolicy.h>
13#include <aws/core/utils/DateTime.h>
14#include <aws/core/utils/memory/stl/AWSMap.h>
15#include <aws/core/utils/memory/stl/AWSString.h>
16#include <aws/core/utils/memory/stl/AWSVector.h>
17
18#include <utility>
19
20namespace Aws {
21namespace Utils {
22namespace Json {
23class JsonValue;
24class JsonView;
25} // namespace Json
26} // namespace Utils
27namespace APIGateway {
28namespace Model {
29
35class RestApi {
36 public:
37 AWS_APIGATEWAY_API RestApi() = default;
38 AWS_APIGATEWAY_API RestApi(Aws::Utils::Json::JsonView jsonValue);
39 AWS_APIGATEWAY_API RestApi& operator=(Aws::Utils::Json::JsonView jsonValue);
40 AWS_APIGATEWAY_API Aws::Utils::Json::JsonValue Jsonize() const;
41
43
47 inline const Aws::String& GetId() const { return m_id; }
48 inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
49 template <typename IdT = Aws::String>
50 void SetId(IdT&& value) {
51 m_idHasBeenSet = true;
52 m_id = std::forward<IdT>(value);
53 }
54 template <typename IdT = Aws::String>
55 RestApi& WithId(IdT&& value) {
56 SetId(std::forward<IdT>(value));
57 return *this;
58 }
60
62
65 inline const Aws::String& GetName() const { return m_name; }
66 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
67 template <typename NameT = Aws::String>
68 void SetName(NameT&& value) {
69 m_nameHasBeenSet = true;
70 m_name = std::forward<NameT>(value);
71 }
72 template <typename NameT = Aws::String>
73 RestApi& WithName(NameT&& value) {
74 SetName(std::forward<NameT>(value));
75 return *this;
76 }
78
80
83 inline const Aws::String& GetDescription() const { return m_description; }
84 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
85 template <typename DescriptionT = Aws::String>
86 void SetDescription(DescriptionT&& value) {
87 m_descriptionHasBeenSet = true;
88 m_description = std::forward<DescriptionT>(value);
89 }
90 template <typename DescriptionT = Aws::String>
91 RestApi& WithDescription(DescriptionT&& value) {
92 SetDescription(std::forward<DescriptionT>(value));
93 return *this;
94 }
96
98
101 inline const Aws::Utils::DateTime& GetCreatedDate() const { return m_createdDate; }
102 inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; }
103 template <typename CreatedDateT = Aws::Utils::DateTime>
104 void SetCreatedDate(CreatedDateT&& value) {
105 m_createdDateHasBeenSet = true;
106 m_createdDate = std::forward<CreatedDateT>(value);
107 }
108 template <typename CreatedDateT = Aws::Utils::DateTime>
109 RestApi& WithCreatedDate(CreatedDateT&& value) {
110 SetCreatedDate(std::forward<CreatedDateT>(value));
111 return *this;
112 }
114
116
119 inline const Aws::String& GetVersion() const { return m_version; }
120 inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; }
121 template <typename VersionT = Aws::String>
122 void SetVersion(VersionT&& value) {
123 m_versionHasBeenSet = true;
124 m_version = std::forward<VersionT>(value);
125 }
126 template <typename VersionT = Aws::String>
127 RestApi& WithVersion(VersionT&& value) {
128 SetVersion(std::forward<VersionT>(value));
129 return *this;
130 }
132
134
138 inline const Aws::Vector<Aws::String>& GetWarnings() const { return m_warnings; }
139 inline bool WarningsHasBeenSet() const { return m_warningsHasBeenSet; }
140 template <typename WarningsT = Aws::Vector<Aws::String>>
141 void SetWarnings(WarningsT&& value) {
142 m_warningsHasBeenSet = true;
143 m_warnings = std::forward<WarningsT>(value);
144 }
145 template <typename WarningsT = Aws::Vector<Aws::String>>
146 RestApi& WithWarnings(WarningsT&& value) {
147 SetWarnings(std::forward<WarningsT>(value));
148 return *this;
149 }
150 template <typename WarningsT = Aws::String>
151 RestApi& AddWarnings(WarningsT&& value) {
152 m_warningsHasBeenSet = true;
153 m_warnings.emplace_back(std::forward<WarningsT>(value));
154 return *this;
155 }
157
159
163 inline const Aws::Vector<Aws::String>& GetBinaryMediaTypes() const { return m_binaryMediaTypes; }
164 inline bool BinaryMediaTypesHasBeenSet() const { return m_binaryMediaTypesHasBeenSet; }
165 template <typename BinaryMediaTypesT = Aws::Vector<Aws::String>>
166 void SetBinaryMediaTypes(BinaryMediaTypesT&& value) {
167 m_binaryMediaTypesHasBeenSet = true;
168 m_binaryMediaTypes = std::forward<BinaryMediaTypesT>(value);
169 }
170 template <typename BinaryMediaTypesT = Aws::Vector<Aws::String>>
171 RestApi& WithBinaryMediaTypes(BinaryMediaTypesT&& value) {
172 SetBinaryMediaTypes(std::forward<BinaryMediaTypesT>(value));
173 return *this;
174 }
175 template <typename BinaryMediaTypesT = Aws::String>
176 RestApi& AddBinaryMediaTypes(BinaryMediaTypesT&& value) {
177 m_binaryMediaTypesHasBeenSet = true;
178 m_binaryMediaTypes.emplace_back(std::forward<BinaryMediaTypesT>(value));
179 return *this;
180 }
182
184
191 inline int GetMinimumCompressionSize() const { return m_minimumCompressionSize; }
192 inline bool MinimumCompressionSizeHasBeenSet() const { return m_minimumCompressionSizeHasBeenSet; }
193 inline void SetMinimumCompressionSize(int value) {
194 m_minimumCompressionSizeHasBeenSet = true;
195 m_minimumCompressionSize = value;
196 }
199 return *this;
200 }
202
204
210 inline ApiKeySourceType GetApiKeySource() const { return m_apiKeySource; }
211 inline bool ApiKeySourceHasBeenSet() const { return m_apiKeySourceHasBeenSet; }
213 m_apiKeySourceHasBeenSet = true;
214 m_apiKeySource = value;
215 }
217 SetApiKeySource(value);
218 return *this;
219 }
221
223
227 inline const EndpointConfiguration& GetEndpointConfiguration() const { return m_endpointConfiguration; }
228 inline bool EndpointConfigurationHasBeenSet() const { return m_endpointConfigurationHasBeenSet; }
229 template <typename EndpointConfigurationT = EndpointConfiguration>
230 void SetEndpointConfiguration(EndpointConfigurationT&& value) {
231 m_endpointConfigurationHasBeenSet = true;
232 m_endpointConfiguration = std::forward<EndpointConfigurationT>(value);
233 }
234 template <typename EndpointConfigurationT = EndpointConfiguration>
235 RestApi& WithEndpointConfiguration(EndpointConfigurationT&& value) {
236 SetEndpointConfiguration(std::forward<EndpointConfigurationT>(value));
237 return *this;
238 }
240
242
246 inline const Aws::String& GetPolicy() const { return m_policy; }
247 inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; }
248 template <typename PolicyT = Aws::String>
249 void SetPolicy(PolicyT&& value) {
250 m_policyHasBeenSet = true;
251 m_policy = std::forward<PolicyT>(value);
252 }
253 template <typename PolicyT = Aws::String>
254 RestApi& WithPolicy(PolicyT&& value) {
255 SetPolicy(std::forward<PolicyT>(value));
256 return *this;
257 }
259
261
265 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
266 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
267 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
268 void SetTags(TagsT&& value) {
269 m_tagsHasBeenSet = true;
270 m_tags = std::forward<TagsT>(value);
271 }
272 template <typename TagsT = Aws::Map<Aws::String, Aws::String>>
273 RestApi& WithTags(TagsT&& value) {
274 SetTags(std::forward<TagsT>(value));
275 return *this;
276 }
277 template <typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
278 RestApi& AddTags(TagsKeyT&& key, TagsValueT&& value) {
279 m_tagsHasBeenSet = true;
280 m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value));
281 return *this;
282 }
284
286
293 inline bool GetDisableExecuteApiEndpoint() const { return m_disableExecuteApiEndpoint; }
294 inline bool DisableExecuteApiEndpointHasBeenSet() const { return m_disableExecuteApiEndpointHasBeenSet; }
295 inline void SetDisableExecuteApiEndpoint(bool value) {
296 m_disableExecuteApiEndpointHasBeenSet = true;
297 m_disableExecuteApiEndpoint = value;
298 }
301 return *this;
302 }
304
306
309 inline const Aws::String& GetRootResourceId() const { return m_rootResourceId; }
310 inline bool RootResourceIdHasBeenSet() const { return m_rootResourceIdHasBeenSet; }
311 template <typename RootResourceIdT = Aws::String>
312 void SetRootResourceId(RootResourceIdT&& value) {
313 m_rootResourceIdHasBeenSet = true;
314 m_rootResourceId = std::forward<RootResourceIdT>(value);
315 }
316 template <typename RootResourceIdT = Aws::String>
317 RestApi& WithRootResourceId(RootResourceIdT&& value) {
318 SetRootResourceId(std::forward<RootResourceIdT>(value));
319 return *this;
320 }
322
324
328 inline SecurityPolicy GetSecurityPolicy() const { return m_securityPolicy; }
329 inline bool SecurityPolicyHasBeenSet() const { return m_securityPolicyHasBeenSet; }
331 m_securityPolicyHasBeenSet = true;
332 m_securityPolicy = value;
333 }
335 SetSecurityPolicy(value);
336 return *this;
337 }
339
341
344 inline EndpointAccessMode GetEndpointAccessMode() const { return m_endpointAccessMode; }
345 inline bool EndpointAccessModeHasBeenSet() const { return m_endpointAccessModeHasBeenSet; }
347 m_endpointAccessModeHasBeenSet = true;
348 m_endpointAccessMode = value;
349 }
352 return *this;
353 }
355
357
360 inline ApiStatus GetApiStatus() const { return m_apiStatus; }
361 inline bool ApiStatusHasBeenSet() const { return m_apiStatusHasBeenSet; }
362 inline void SetApiStatus(ApiStatus value) {
363 m_apiStatusHasBeenSet = true;
364 m_apiStatus = value;
365 }
367 SetApiStatus(value);
368 return *this;
369 }
371
373
377 inline const Aws::String& GetApiStatusMessage() const { return m_apiStatusMessage; }
378 inline bool ApiStatusMessageHasBeenSet() const { return m_apiStatusMessageHasBeenSet; }
379 template <typename ApiStatusMessageT = Aws::String>
380 void SetApiStatusMessage(ApiStatusMessageT&& value) {
381 m_apiStatusMessageHasBeenSet = true;
382 m_apiStatusMessage = std::forward<ApiStatusMessageT>(value);
383 }
384 template <typename ApiStatusMessageT = Aws::String>
385 RestApi& WithApiStatusMessage(ApiStatusMessageT&& value) {
386 SetApiStatusMessage(std::forward<ApiStatusMessageT>(value));
387 return *this;
388 }
390
392
393 inline const Aws::String& GetRequestId() const { return m_requestId; }
394 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
395 template <typename RequestIdT = Aws::String>
396 void SetRequestId(RequestIdT&& value) {
397 m_requestIdHasBeenSet = true;
398 m_requestId = std::forward<RequestIdT>(value);
399 }
400 template <typename RequestIdT = Aws::String>
401 RestApi& WithRequestId(RequestIdT&& value) {
402 SetRequestId(std::forward<RequestIdT>(value));
403 return *this;
404 }
406 private:
407 Aws::String m_id;
408
409 Aws::String m_name;
410
411 Aws::String m_description;
412
413 Aws::Utils::DateTime m_createdDate{};
414
415 Aws::String m_version;
416
417 Aws::Vector<Aws::String> m_warnings;
418
419 Aws::Vector<Aws::String> m_binaryMediaTypes;
420
421 int m_minimumCompressionSize{0};
422
424
425 EndpointConfiguration m_endpointConfiguration;
426
427 Aws::String m_policy;
428
430
431 bool m_disableExecuteApiEndpoint{false};
432
433 Aws::String m_rootResourceId;
434
435 SecurityPolicy m_securityPolicy{SecurityPolicy::NOT_SET};
436
438
439 ApiStatus m_apiStatus{ApiStatus::NOT_SET};
440
441 Aws::String m_apiStatusMessage;
442
443 Aws::String m_requestId;
444 bool m_idHasBeenSet = false;
445 bool m_nameHasBeenSet = false;
446 bool m_descriptionHasBeenSet = false;
447 bool m_createdDateHasBeenSet = false;
448 bool m_versionHasBeenSet = false;
449 bool m_warningsHasBeenSet = false;
450 bool m_binaryMediaTypesHasBeenSet = false;
451 bool m_minimumCompressionSizeHasBeenSet = false;
452 bool m_apiKeySourceHasBeenSet = false;
453 bool m_endpointConfigurationHasBeenSet = false;
454 bool m_policyHasBeenSet = false;
455 bool m_tagsHasBeenSet = false;
456 bool m_disableExecuteApiEndpointHasBeenSet = false;
457 bool m_rootResourceIdHasBeenSet = false;
458 bool m_securityPolicyHasBeenSet = false;
459 bool m_endpointAccessModeHasBeenSet = false;
460 bool m_apiStatusHasBeenSet = false;
461 bool m_apiStatusMessageHasBeenSet = false;
462 bool m_requestIdHasBeenSet = false;
463};
464
465} // namespace Model
466} // namespace APIGateway
467} // namespace Aws
SecurityPolicy GetSecurityPolicy() const
Definition RestApi.h:328
bool DisableExecuteApiEndpointHasBeenSet() const
Definition RestApi.h:294
RestApi & AddTags(TagsKeyT &&key, TagsValueT &&value)
Definition RestApi.h:278
void SetDisableExecuteApiEndpoint(bool value)
Definition RestApi.h:295
AWS_APIGATEWAY_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::String & GetDescription() const
Definition RestApi.h:83
int GetMinimumCompressionSize() const
Definition RestApi.h:191
const Aws::String & GetId() const
Definition RestApi.h:47
const Aws::String & GetVersion() const
Definition RestApi.h:119
void SetApiStatus(ApiStatus value)
Definition RestApi.h:362
bool MinimumCompressionSizeHasBeenSet() const
Definition RestApi.h:192
void SetVersion(VersionT &&value)
Definition RestApi.h:122
void SetApiKeySource(ApiKeySourceType value)
Definition RestApi.h:212
RestApi & AddWarnings(WarningsT &&value)
Definition RestApi.h:151
const Aws::String & GetRequestId() const
Definition RestApi.h:393
void SetCreatedDate(CreatedDateT &&value)
Definition RestApi.h:104
void SetRootResourceId(RootResourceIdT &&value)
Definition RestApi.h:312
bool RootResourceIdHasBeenSet() const
Definition RestApi.h:310
bool GetDisableExecuteApiEndpoint() const
Definition RestApi.h:293
AWS_APIGATEWAY_API RestApi(Aws::Utils::Json::JsonView jsonValue)
bool EndpointAccessModeHasBeenSet() const
Definition RestApi.h:345
RestApi & WithId(IdT &&value)
Definition RestApi.h:55
const Aws::Vector< Aws::String > & GetWarnings() const
Definition RestApi.h:138
void SetId(IdT &&value)
Definition RestApi.h:50
ApiStatus GetApiStatus() const
Definition RestApi.h:360
bool CreatedDateHasBeenSet() const
Definition RestApi.h:102
AWS_APIGATEWAY_API RestApi & operator=(Aws::Utils::Json::JsonView jsonValue)
RestApi & WithApiKeySource(ApiKeySourceType value)
Definition RestApi.h:216
void SetEndpointAccessMode(EndpointAccessMode value)
Definition RestApi.h:346
bool BinaryMediaTypesHasBeenSet() const
Definition RestApi.h:164
AWS_APIGATEWAY_API RestApi()=default
void SetEndpointConfiguration(EndpointConfigurationT &&value)
Definition RestApi.h:230
RestApi & AddBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:176
const Aws::String & GetPolicy() const
Definition RestApi.h:246
RestApi & WithRootResourceId(RootResourceIdT &&value)
Definition RestApi.h:317
void SetWarnings(WarningsT &&value)
Definition RestApi.h:141
bool SecurityPolicyHasBeenSet() const
Definition RestApi.h:329
void SetBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:166
void SetPolicy(PolicyT &&value)
Definition RestApi.h:249
EndpointAccessMode GetEndpointAccessMode() const
Definition RestApi.h:344
RestApi & WithCreatedDate(CreatedDateT &&value)
Definition RestApi.h:109
const Aws::String & GetName() const
Definition RestApi.h:65
RestApi & WithWarnings(WarningsT &&value)
Definition RestApi.h:146
bool ApiKeySourceHasBeenSet() const
Definition RestApi.h:211
RestApi & WithApiStatus(ApiStatus value)
Definition RestApi.h:366
RestApi & WithApiStatusMessage(ApiStatusMessageT &&value)
Definition RestApi.h:385
ApiKeySourceType GetApiKeySource() const
Definition RestApi.h:210
bool EndpointConfigurationHasBeenSet() const
Definition RestApi.h:228
const Aws::Utils::DateTime & GetCreatedDate() const
Definition RestApi.h:101
void SetRequestId(RequestIdT &&value)
Definition RestApi.h:396
RestApi & WithSecurityPolicy(SecurityPolicy value)
Definition RestApi.h:334
void SetApiStatusMessage(ApiStatusMessageT &&value)
Definition RestApi.h:380
RestApi & WithBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:171
const Aws::String & GetApiStatusMessage() const
Definition RestApi.h:377
RestApi & WithVersion(VersionT &&value)
Definition RestApi.h:127
RestApi & WithRequestId(RequestIdT &&value)
Definition RestApi.h:401
void SetDescription(DescriptionT &&value)
Definition RestApi.h:86
void SetTags(TagsT &&value)
Definition RestApi.h:268
const Aws::String & GetRootResourceId() const
Definition RestApi.h:309
void SetName(NameT &&value)
Definition RestApi.h:68
RestApi & WithDescription(DescriptionT &&value)
Definition RestApi.h:91
RestApi & WithEndpointAccessMode(EndpointAccessMode value)
Definition RestApi.h:350
const Aws::Vector< Aws::String > & GetBinaryMediaTypes() const
Definition RestApi.h:163
const Aws::Map< Aws::String, Aws::String > & GetTags() const
Definition RestApi.h:265
RestApi & WithPolicy(PolicyT &&value)
Definition RestApi.h:254
RestApi & WithName(NameT &&value)
Definition RestApi.h:73
RestApi & WithEndpointConfiguration(EndpointConfigurationT &&value)
Definition RestApi.h:235
void SetMinimumCompressionSize(int value)
Definition RestApi.h:193
RestApi & WithMinimumCompressionSize(int value)
Definition RestApi.h:197
RestApi & WithTags(TagsT &&value)
Definition RestApi.h:273
const EndpointConfiguration & GetEndpointConfiguration() const
Definition RestApi.h:227
RestApi & WithDisableExecuteApiEndpoint(bool value)
Definition RestApi.h:299
bool ApiStatusMessageHasBeenSet() const
Definition RestApi.h:378
bool DescriptionHasBeenSet() const
Definition RestApi.h:84
void SetSecurityPolicy(SecurityPolicy value)
Definition RestApi.h:330
std::map< K, V, std::less< K >, Aws::Allocator< std::pair< const K, V > > > Map
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue