AWS SDK for C++

AWS SDK for C++ Version 1.11.607

Loading...
Searching...
No Matches
RestApi.h
1
6#pragma once
7#include <aws/apigateway/APIGateway_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/apigateway/model/ApiKeySourceType.h>
12#include <aws/apigateway/model/EndpointConfiguration.h>
13#include <aws/core/utils/memory/stl/AWSMap.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Utils
19{
20namespace Json
21{
22 class JsonValue;
23 class JsonView;
24} // namespace Json
25} // namespace Utils
26namespace APIGateway
27{
28namespace Model
29{
30
36 class RestApi
37 {
38 public:
39 AWS_APIGATEWAY_API RestApi() = default;
40 AWS_APIGATEWAY_API RestApi(Aws::Utils::Json::JsonView jsonValue);
41 AWS_APIGATEWAY_API RestApi& operator=(Aws::Utils::Json::JsonView jsonValue);
42 AWS_APIGATEWAY_API Aws::Utils::Json::JsonValue Jsonize() const;
43
44
46
50 inline const Aws::String& GetId() const { return m_id; }
51 inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
52 template<typename IdT = Aws::String>
53 void SetId(IdT&& value) { m_idHasBeenSet = true; m_id = std::forward<IdT>(value); }
54 template<typename IdT = Aws::String>
55 RestApi& WithId(IdT&& value) { SetId(std::forward<IdT>(value)); return *this;}
57
59
62 inline const Aws::String& GetName() const { return m_name; }
63 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
64 template<typename NameT = Aws::String>
65 void SetName(NameT&& value) { m_nameHasBeenSet = true; m_name = std::forward<NameT>(value); }
66 template<typename NameT = Aws::String>
67 RestApi& WithName(NameT&& value) { SetName(std::forward<NameT>(value)); return *this;}
69
71
74 inline const Aws::String& GetDescription() const { return m_description; }
75 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
76 template<typename DescriptionT = Aws::String>
77 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
78 template<typename DescriptionT = Aws::String>
79 RestApi& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
81
83
86 inline const Aws::Utils::DateTime& GetCreatedDate() const { return m_createdDate; }
87 inline bool CreatedDateHasBeenSet() const { return m_createdDateHasBeenSet; }
88 template<typename CreatedDateT = Aws::Utils::DateTime>
89 void SetCreatedDate(CreatedDateT&& value) { m_createdDateHasBeenSet = true; m_createdDate = std::forward<CreatedDateT>(value); }
90 template<typename CreatedDateT = Aws::Utils::DateTime>
91 RestApi& WithCreatedDate(CreatedDateT&& value) { SetCreatedDate(std::forward<CreatedDateT>(value)); return *this;}
93
95
98 inline const Aws::String& GetVersion() const { return m_version; }
99 inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; }
100 template<typename VersionT = Aws::String>
101 void SetVersion(VersionT&& value) { m_versionHasBeenSet = true; m_version = std::forward<VersionT>(value); }
102 template<typename VersionT = Aws::String>
103 RestApi& WithVersion(VersionT&& value) { SetVersion(std::forward<VersionT>(value)); return *this;}
105
107
111 inline const Aws::Vector<Aws::String>& GetWarnings() const { return m_warnings; }
112 inline bool WarningsHasBeenSet() const { return m_warningsHasBeenSet; }
113 template<typename WarningsT = Aws::Vector<Aws::String>>
114 void SetWarnings(WarningsT&& value) { m_warningsHasBeenSet = true; m_warnings = std::forward<WarningsT>(value); }
115 template<typename WarningsT = Aws::Vector<Aws::String>>
116 RestApi& WithWarnings(WarningsT&& value) { SetWarnings(std::forward<WarningsT>(value)); return *this;}
117 template<typename WarningsT = Aws::String>
118 RestApi& AddWarnings(WarningsT&& value) { m_warningsHasBeenSet = true; m_warnings.emplace_back(std::forward<WarningsT>(value)); return *this; }
120
122
126 inline const Aws::Vector<Aws::String>& GetBinaryMediaTypes() const { return m_binaryMediaTypes; }
127 inline bool BinaryMediaTypesHasBeenSet() const { return m_binaryMediaTypesHasBeenSet; }
128 template<typename BinaryMediaTypesT = Aws::Vector<Aws::String>>
129 void SetBinaryMediaTypes(BinaryMediaTypesT&& value) { m_binaryMediaTypesHasBeenSet = true; m_binaryMediaTypes = std::forward<BinaryMediaTypesT>(value); }
130 template<typename BinaryMediaTypesT = Aws::Vector<Aws::String>>
131 RestApi& WithBinaryMediaTypes(BinaryMediaTypesT&& value) { SetBinaryMediaTypes(std::forward<BinaryMediaTypesT>(value)); return *this;}
132 template<typename BinaryMediaTypesT = Aws::String>
133 RestApi& AddBinaryMediaTypes(BinaryMediaTypesT&& value) { m_binaryMediaTypesHasBeenSet = true; m_binaryMediaTypes.emplace_back(std::forward<BinaryMediaTypesT>(value)); return *this; }
135
137
144 inline int GetMinimumCompressionSize() const { return m_minimumCompressionSize; }
145 inline bool MinimumCompressionSizeHasBeenSet() const { return m_minimumCompressionSizeHasBeenSet; }
146 inline void SetMinimumCompressionSize(int value) { m_minimumCompressionSizeHasBeenSet = true; m_minimumCompressionSize = value; }
147 inline RestApi& WithMinimumCompressionSize(int value) { SetMinimumCompressionSize(value); return *this;}
149
151
157 inline ApiKeySourceType GetApiKeySource() const { return m_apiKeySource; }
158 inline bool ApiKeySourceHasBeenSet() const { return m_apiKeySourceHasBeenSet; }
159 inline void SetApiKeySource(ApiKeySourceType value) { m_apiKeySourceHasBeenSet = true; m_apiKeySource = value; }
160 inline RestApi& WithApiKeySource(ApiKeySourceType value) { SetApiKeySource(value); return *this;}
162
164
168 inline const EndpointConfiguration& GetEndpointConfiguration() const { return m_endpointConfiguration; }
169 inline bool EndpointConfigurationHasBeenSet() const { return m_endpointConfigurationHasBeenSet; }
170 template<typename EndpointConfigurationT = EndpointConfiguration>
171 void SetEndpointConfiguration(EndpointConfigurationT&& value) { m_endpointConfigurationHasBeenSet = true; m_endpointConfiguration = std::forward<EndpointConfigurationT>(value); }
172 template<typename EndpointConfigurationT = EndpointConfiguration>
173 RestApi& WithEndpointConfiguration(EndpointConfigurationT&& value) { SetEndpointConfiguration(std::forward<EndpointConfigurationT>(value)); return *this;}
175
177
181 inline const Aws::String& GetPolicy() const { return m_policy; }
182 inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; }
183 template<typename PolicyT = Aws::String>
184 void SetPolicy(PolicyT&& value) { m_policyHasBeenSet = true; m_policy = std::forward<PolicyT>(value); }
185 template<typename PolicyT = Aws::String>
186 RestApi& WithPolicy(PolicyT&& value) { SetPolicy(std::forward<PolicyT>(value)); return *this;}
188
190
194 inline const Aws::Map<Aws::String, Aws::String>& GetTags() const { return m_tags; }
195 inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
196 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
197 void SetTags(TagsT&& value) { m_tagsHasBeenSet = true; m_tags = std::forward<TagsT>(value); }
198 template<typename TagsT = Aws::Map<Aws::String, Aws::String>>
199 RestApi& WithTags(TagsT&& value) { SetTags(std::forward<TagsT>(value)); return *this;}
200 template<typename TagsKeyT = Aws::String, typename TagsValueT = Aws::String>
201 RestApi& AddTags(TagsKeyT&& key, TagsValueT&& value) {
202 m_tagsHasBeenSet = true; m_tags.emplace(std::forward<TagsKeyT>(key), std::forward<TagsValueT>(value)); return *this;
203 }
205
207
214 inline bool GetDisableExecuteApiEndpoint() const { return m_disableExecuteApiEndpoint; }
215 inline bool DisableExecuteApiEndpointHasBeenSet() const { return m_disableExecuteApiEndpointHasBeenSet; }
216 inline void SetDisableExecuteApiEndpoint(bool value) { m_disableExecuteApiEndpointHasBeenSet = true; m_disableExecuteApiEndpoint = value; }
217 inline RestApi& WithDisableExecuteApiEndpoint(bool value) { SetDisableExecuteApiEndpoint(value); return *this;}
219
221
224 inline const Aws::String& GetRootResourceId() const { return m_rootResourceId; }
225 inline bool RootResourceIdHasBeenSet() const { return m_rootResourceIdHasBeenSet; }
226 template<typename RootResourceIdT = Aws::String>
227 void SetRootResourceId(RootResourceIdT&& value) { m_rootResourceIdHasBeenSet = true; m_rootResourceId = std::forward<RootResourceIdT>(value); }
228 template<typename RootResourceIdT = Aws::String>
229 RestApi& WithRootResourceId(RootResourceIdT&& value) { SetRootResourceId(std::forward<RootResourceIdT>(value)); return *this;}
231
233
234 inline const Aws::String& GetRequestId() const { return m_requestId; }
235 inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; }
236 template<typename RequestIdT = Aws::String>
237 void SetRequestId(RequestIdT&& value) { m_requestIdHasBeenSet = true; m_requestId = std::forward<RequestIdT>(value); }
238 template<typename RequestIdT = Aws::String>
239 RestApi& WithRequestId(RequestIdT&& value) { SetRequestId(std::forward<RequestIdT>(value)); return *this;}
241 private:
242
243 Aws::String m_id;
244 bool m_idHasBeenSet = false;
245
246 Aws::String m_name;
247 bool m_nameHasBeenSet = false;
248
249 Aws::String m_description;
250 bool m_descriptionHasBeenSet = false;
251
252 Aws::Utils::DateTime m_createdDate{};
253 bool m_createdDateHasBeenSet = false;
254
255 Aws::String m_version;
256 bool m_versionHasBeenSet = false;
257
258 Aws::Vector<Aws::String> m_warnings;
259 bool m_warningsHasBeenSet = false;
260
261 Aws::Vector<Aws::String> m_binaryMediaTypes;
262 bool m_binaryMediaTypesHasBeenSet = false;
263
264 int m_minimumCompressionSize{0};
265 bool m_minimumCompressionSizeHasBeenSet = false;
266
268 bool m_apiKeySourceHasBeenSet = false;
269
270 EndpointConfiguration m_endpointConfiguration;
271 bool m_endpointConfigurationHasBeenSet = false;
272
273 Aws::String m_policy;
274 bool m_policyHasBeenSet = false;
275
277 bool m_tagsHasBeenSet = false;
278
279 bool m_disableExecuteApiEndpoint{false};
280 bool m_disableExecuteApiEndpointHasBeenSet = false;
281
282 Aws::String m_rootResourceId;
283 bool m_rootResourceIdHasBeenSet = false;
284
285 Aws::String m_requestId;
286 bool m_requestIdHasBeenSet = false;
287 };
288
289} // namespace Model
290} // namespace APIGateway
291} // namespace Aws
bool DisableExecuteApiEndpointHasBeenSet() const
Definition RestApi.h:215
RestApi & AddTags(TagsKeyT &&key, TagsValueT &&value)
Definition RestApi.h:201
void SetDisableExecuteApiEndpoint(bool value)
Definition RestApi.h:216
AWS_APIGATEWAY_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::String & GetDescription() const
Definition RestApi.h:74
int GetMinimumCompressionSize() const
Definition RestApi.h:144
const Aws::String & GetId() const
Definition RestApi.h:50
const Aws::String & GetVersion() const
Definition RestApi.h:98
bool MinimumCompressionSizeHasBeenSet() const
Definition RestApi.h:145
void SetVersion(VersionT &&value)
Definition RestApi.h:101
void SetApiKeySource(ApiKeySourceType value)
Definition RestApi.h:159
RestApi & AddWarnings(WarningsT &&value)
Definition RestApi.h:118
const Aws::String & GetRequestId() const
Definition RestApi.h:234
void SetCreatedDate(CreatedDateT &&value)
Definition RestApi.h:89
void SetRootResourceId(RootResourceIdT &&value)
Definition RestApi.h:227
bool RootResourceIdHasBeenSet() const
Definition RestApi.h:225
bool GetDisableExecuteApiEndpoint() const
Definition RestApi.h:214
AWS_APIGATEWAY_API RestApi(Aws::Utils::Json::JsonView jsonValue)
RestApi & WithId(IdT &&value)
Definition RestApi.h:55
const Aws::Vector< Aws::String > & GetWarnings() const
Definition RestApi.h:111
void SetId(IdT &&value)
Definition RestApi.h:53
bool CreatedDateHasBeenSet() const
Definition RestApi.h:87
AWS_APIGATEWAY_API RestApi & operator=(Aws::Utils::Json::JsonView jsonValue)
RestApi & WithApiKeySource(ApiKeySourceType value)
Definition RestApi.h:160
bool BinaryMediaTypesHasBeenSet() const
Definition RestApi.h:127
AWS_APIGATEWAY_API RestApi()=default
void SetEndpointConfiguration(EndpointConfigurationT &&value)
Definition RestApi.h:171
RestApi & AddBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:133
const Aws::String & GetPolicy() const
Definition RestApi.h:181
RestApi & WithRootResourceId(RootResourceIdT &&value)
Definition RestApi.h:229
void SetWarnings(WarningsT &&value)
Definition RestApi.h:114
void SetBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:129
void SetPolicy(PolicyT &&value)
Definition RestApi.h:184
RestApi & WithCreatedDate(CreatedDateT &&value)
Definition RestApi.h:91
const Aws::String & GetName() const
Definition RestApi.h:62
RestApi & WithWarnings(WarningsT &&value)
Definition RestApi.h:116
bool ApiKeySourceHasBeenSet() const
Definition RestApi.h:158
ApiKeySourceType GetApiKeySource() const
Definition RestApi.h:157
bool EndpointConfigurationHasBeenSet() const
Definition RestApi.h:169
const Aws::Utils::DateTime & GetCreatedDate() const
Definition RestApi.h:86
void SetRequestId(RequestIdT &&value)
Definition RestApi.h:237
RestApi & WithBinaryMediaTypes(BinaryMediaTypesT &&value)
Definition RestApi.h:131
RestApi & WithVersion(VersionT &&value)
Definition RestApi.h:103
RestApi & WithRequestId(RequestIdT &&value)
Definition RestApi.h:239
void SetDescription(DescriptionT &&value)
Definition RestApi.h:77
void SetTags(TagsT &&value)
Definition RestApi.h:197
const Aws::String & GetRootResourceId() const
Definition RestApi.h:224
void SetName(NameT &&value)
Definition RestApi.h:65
RestApi & WithDescription(DescriptionT &&value)
Definition RestApi.h:79
const Aws::Vector< Aws::String > & GetBinaryMediaTypes() const
Definition RestApi.h:126
const Aws::Map< Aws::String, Aws::String > & GetTags() const
Definition RestApi.h:194
RestApi & WithPolicy(PolicyT &&value)
Definition RestApi.h:186
RestApi & WithName(NameT &&value)
Definition RestApi.h:67
RestApi & WithEndpointConfiguration(EndpointConfigurationT &&value)
Definition RestApi.h:173
void SetMinimumCompressionSize(int value)
Definition RestApi.h:146
RestApi & WithMinimumCompressionSize(int value)
Definition RestApi.h:147
RestApi & WithTags(TagsT &&value)
Definition RestApi.h:199
const EndpointConfiguration & GetEndpointConfiguration() const
Definition RestApi.h:168
RestApi & WithDisableExecuteApiEndpoint(bool value)
Definition RestApi.h:217
bool DescriptionHasBeenSet() const
Definition RestApi.h:75
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