AWS SDK for C++

AWS SDK for C++ Version 1.11.867

Loading...
Searching...
No Matches
GeocodeRequest.h
1
6#pragma once
7#include <aws/core/utils/memory/stl/AWSString.h>
8#include <aws/core/utils/memory/stl/AWSVector.h>
9#include <aws/geo-places/GeoPlacesRequest.h>
10#include <aws/geo-places/GeoPlaces_EXPORTS.h>
11#include <aws/geo-places/model/AddressTranslationComponent.h>
12#include <aws/geo-places/model/GeocodeAdditionalFeature.h>
13#include <aws/geo-places/model/GeocodeAddressNamesMode.h>
14#include <aws/geo-places/model/GeocodeFilter.h>
15#include <aws/geo-places/model/GeocodeIntendedUse.h>
16#include <aws/geo-places/model/GeocodeQueryComponents.h>
17#include <aws/geo-places/model/PostalCodeMode.h>
18
19#include <utility>
20
21namespace Aws {
22namespace Http {
23class URI;
24} // namespace Http
25namespace GeoPlaces {
26namespace Model {
27
31 public:
32 AWS_GEOPLACES_API GeocodeRequest() = default;
33
34 // Service request name is the Operation name which will send this request out,
35 // each operation should has unique request name, so that we can get operation's name from this request.
36 // Note: this is not true for response, multiple operations may have the same response name,
37 // so we can not get operation's name from response.
38 inline virtual const char* GetServiceRequestName() const override { return "Geocode"; }
39
40 AWS_GEOPLACES_API Aws::String SerializePayload() const override;
41
42 AWS_GEOPLACES_API void AddQueryStringParameters(Aws::Http::URI& uri) const override;
43
45
49 inline const Aws::String& GetQueryText() const { return m_queryText; }
50 inline bool QueryTextHasBeenSet() const { return m_queryTextHasBeenSet; }
51 template <typename QueryTextT = Aws::String>
52 void SetQueryText(QueryTextT&& value) {
53 m_queryTextHasBeenSet = true;
54 m_queryText = std::forward<QueryTextT>(value);
55 }
56 template <typename QueryTextT = Aws::String>
57 GeocodeRequest& WithQueryText(QueryTextT&& value) {
58 SetQueryText(std::forward<QueryTextT>(value));
59 return *this;
60 }
62
64
65 inline const GeocodeQueryComponents& GetQueryComponents() const { return m_queryComponents; }
66 inline bool QueryComponentsHasBeenSet() const { return m_queryComponentsHasBeenSet; }
67 template <typename QueryComponentsT = GeocodeQueryComponents>
68 void SetQueryComponents(QueryComponentsT&& value) {
69 m_queryComponentsHasBeenSet = true;
70 m_queryComponents = std::forward<QueryComponentsT>(value);
71 }
72 template <typename QueryComponentsT = GeocodeQueryComponents>
73 GeocodeRequest& WithQueryComponents(QueryComponentsT&& value) {
74 SetQueryComponents(std::forward<QueryComponentsT>(value));
75 return *this;
76 }
78
80
84 inline int GetMaxResults() const { return m_maxResults; }
85 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
86 inline void SetMaxResults(int value) {
87 m_maxResultsHasBeenSet = true;
88 m_maxResults = value;
89 }
90 inline GeocodeRequest& WithMaxResults(int value) {
91 SetMaxResults(value);
92 return *this;
93 }
95
97
102 inline const Aws::Vector<double>& GetBiasPosition() const { return m_biasPosition; }
103 inline bool BiasPositionHasBeenSet() const { return m_biasPositionHasBeenSet; }
104 template <typename BiasPositionT = Aws::Vector<double>>
105 void SetBiasPosition(BiasPositionT&& value) {
106 m_biasPositionHasBeenSet = true;
107 m_biasPosition = std::forward<BiasPositionT>(value);
108 }
109 template <typename BiasPositionT = Aws::Vector<double>>
110 GeocodeRequest& WithBiasPosition(BiasPositionT&& value) {
111 SetBiasPosition(std::forward<BiasPositionT>(value));
112 return *this;
113 }
114 inline GeocodeRequest& AddBiasPosition(double value) {
115 m_biasPositionHasBeenSet = true;
116 m_biasPosition.push_back(value);
117 return *this;
118 }
120
122
126 inline const GeocodeFilter& GetFilter() const { return m_filter; }
127 inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; }
128 template <typename FilterT = GeocodeFilter>
129 void SetFilter(FilterT&& value) {
130 m_filterHasBeenSet = true;
131 m_filter = std::forward<FilterT>(value);
132 }
133 template <typename FilterT = GeocodeFilter>
134 GeocodeRequest& WithFilter(FilterT&& value) {
135 SetFilter(std::forward<FilterT>(value));
136 return *this;
137 }
139
141
145 inline const Aws::Vector<GeocodeAdditionalFeature>& GetAdditionalFeatures() const { return m_additionalFeatures; }
146 inline bool AdditionalFeaturesHasBeenSet() const { return m_additionalFeaturesHasBeenSet; }
147 template <typename AdditionalFeaturesT = Aws::Vector<GeocodeAdditionalFeature>>
148 void SetAdditionalFeatures(AdditionalFeaturesT&& value) {
149 m_additionalFeaturesHasBeenSet = true;
150 m_additionalFeatures = std::forward<AdditionalFeaturesT>(value);
151 }
152 template <typename AdditionalFeaturesT = Aws::Vector<GeocodeAdditionalFeature>>
153 GeocodeRequest& WithAdditionalFeatures(AdditionalFeaturesT&& value) {
154 SetAdditionalFeatures(std::forward<AdditionalFeaturesT>(value));
155 return *this;
156 }
158 m_additionalFeaturesHasBeenSet = true;
159 m_additionalFeatures.push_back(value);
160 return *this;
161 }
163
165
172 inline const Aws::String& GetLanguage() const { return m_language; }
173 inline bool LanguageHasBeenSet() const { return m_languageHasBeenSet; }
174 template <typename LanguageT = Aws::String>
175 void SetLanguage(LanguageT&& value) {
176 m_languageHasBeenSet = true;
177 m_language = std::forward<LanguageT>(value);
178 }
179 template <typename LanguageT = Aws::String>
180 GeocodeRequest& WithLanguage(LanguageT&& value) {
181 SetLanguage(std::forward<LanguageT>(value));
182 return *this;
183 }
185
187
192 inline const Aws::String& GetPoliticalView() const { return m_politicalView; }
193 inline bool PoliticalViewHasBeenSet() const { return m_politicalViewHasBeenSet; }
194 template <typename PoliticalViewT = Aws::String>
195 void SetPoliticalView(PoliticalViewT&& value) {
196 m_politicalViewHasBeenSet = true;
197 m_politicalView = std::forward<PoliticalViewT>(value);
198 }
199 template <typename PoliticalViewT = Aws::String>
200 GeocodeRequest& WithPoliticalView(PoliticalViewT&& value) {
201 SetPoliticalView(std::forward<PoliticalViewT>(value));
202 return *this;
203 }
205
207
219 inline GeocodeIntendedUse GetIntendedUse() const { return m_intendedUse; }
220 inline bool IntendedUseHasBeenSet() const { return m_intendedUseHasBeenSet; }
222 m_intendedUseHasBeenSet = true;
223 m_intendedUse = value;
224 }
226 SetIntendedUse(value);
227 return *this;
228 }
230
232
236 inline const Aws::String& GetKey() const { return m_key; }
237 inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; }
238 template <typename KeyT = Aws::String>
239 void SetKey(KeyT&& value) {
240 m_keyHasBeenSet = true;
241 m_key = std::forward<KeyT>(value);
242 }
243 template <typename KeyT = Aws::String>
244 GeocodeRequest& WithKey(KeyT&& value) {
245 SetKey(std::forward<KeyT>(value));
246 return *this;
247 }
249
251
261 inline PostalCodeMode GetPostalCodeMode() const { return m_postalCodeMode; }
262 inline bool PostalCodeModeHasBeenSet() const { return m_postalCodeModeHasBeenSet; }
264 m_postalCodeModeHasBeenSet = true;
265 m_postalCodeMode = value;
266 }
268 SetPostalCodeMode(value);
269 return *this;
270 }
272
274
280 inline const Aws::Vector<AddressTranslationComponent>& GetAddressTranslations() const { return m_addressTranslations; }
281 inline bool AddressTranslationsHasBeenSet() const { return m_addressTranslationsHasBeenSet; }
282 template <typename AddressTranslationsT = Aws::Vector<AddressTranslationComponent>>
283 void SetAddressTranslations(AddressTranslationsT&& value) {
284 m_addressTranslationsHasBeenSet = true;
285 m_addressTranslations = std::forward<AddressTranslationsT>(value);
286 }
287 template <typename AddressTranslationsT = Aws::Vector<AddressTranslationComponent>>
288 GeocodeRequest& WithAddressTranslations(AddressTranslationsT&& value) {
289 SetAddressTranslations(std::forward<AddressTranslationsT>(value));
290 return *this;
291 }
293 m_addressTranslationsHasBeenSet = true;
294 m_addressTranslations.push_back(value);
295 return *this;
296 }
298
300
308 inline GeocodeAddressNamesMode GetAddressNamesMode() const { return m_addressNamesMode; }
309 inline bool AddressNamesModeHasBeenSet() const { return m_addressNamesModeHasBeenSet; }
311 m_addressNamesModeHasBeenSet = true;
312 m_addressNamesMode = value;
313 }
315 SetAddressNamesMode(value);
316 return *this;
317 }
319 private:
320 Aws::String m_queryText;
321
322 GeocodeQueryComponents m_queryComponents;
323
324 int m_maxResults{0};
325
326 Aws::Vector<double> m_biasPosition;
327
328 GeocodeFilter m_filter;
329
330 Aws::Vector<GeocodeAdditionalFeature> m_additionalFeatures;
331
332 Aws::String m_language;
333
334 Aws::String m_politicalView;
335
337
338 Aws::String m_key;
339
340 PostalCodeMode m_postalCodeMode{PostalCodeMode::NOT_SET};
341
342 Aws::Vector<AddressTranslationComponent> m_addressTranslations;
343
345 bool m_queryTextHasBeenSet = false;
346 bool m_queryComponentsHasBeenSet = false;
347 bool m_maxResultsHasBeenSet = false;
348 bool m_biasPositionHasBeenSet = false;
349 bool m_filterHasBeenSet = false;
350 bool m_additionalFeaturesHasBeenSet = false;
351 bool m_languageHasBeenSet = false;
352 bool m_politicalViewHasBeenSet = false;
353 bool m_intendedUseHasBeenSet = false;
354 bool m_keyHasBeenSet = false;
355 bool m_postalCodeModeHasBeenSet = false;
356 bool m_addressTranslationsHasBeenSet = false;
357 bool m_addressNamesModeHasBeenSet = false;
358};
359
360} // namespace Model
361} // namespace GeoPlaces
362} // namespace Aws
const Aws::String & GetPoliticalView() const
const Aws::String & GetKey() const
const Aws::Vector< GeocodeAdditionalFeature > & GetAdditionalFeatures() const
AWS_GEOPLACES_API GeocodeRequest()=default
const GeocodeQueryComponents & GetQueryComponents() const
GeocodeRequest & WithAddressTranslations(AddressTranslationsT &&value)
virtual const char * GetServiceRequestName() const override
const Aws::String & GetQueryText() const
GeocodeRequest & AddAddressTranslations(AddressTranslationComponent value)
GeocodeRequest & WithIntendedUse(GeocodeIntendedUse value)
GeocodeRequest & AddAdditionalFeatures(GeocodeAdditionalFeature value)
const Aws::Vector< double > & GetBiasPosition() const
void SetQueryComponents(QueryComponentsT &&value)
AWS_GEOPLACES_API void AddQueryStringParameters(Aws::Http::URI &uri) const override
GeocodeIntendedUse GetIntendedUse() const
void SetPostalCodeMode(PostalCodeMode value)
GeocodeRequest & WithQueryText(QueryTextT &&value)
GeocodeRequest & WithLanguage(LanguageT &&value)
void SetQueryText(QueryTextT &&value)
const GeocodeFilter & GetFilter() const
GeocodeRequest & WithAdditionalFeatures(AdditionalFeaturesT &&value)
void SetAddressTranslations(AddressTranslationsT &&value)
GeocodeRequest & WithBiasPosition(BiasPositionT &&value)
void SetAdditionalFeatures(AdditionalFeaturesT &&value)
GeocodeRequest & WithPostalCodeMode(PostalCodeMode value)
void SetPoliticalView(PoliticalViewT &&value)
AWS_GEOPLACES_API Aws::String SerializePayload() const override
GeocodeRequest & WithMaxResults(int value)
void SetAddressNamesMode(GeocodeAddressNamesMode value)
GeocodeRequest & WithAddressNamesMode(GeocodeAddressNamesMode value)
void SetBiasPosition(BiasPositionT &&value)
GeocodeRequest & WithPoliticalView(PoliticalViewT &&value)
GeocodeRequest & WithKey(KeyT &&value)
const Aws::Vector< AddressTranslationComponent > & GetAddressTranslations() const
const Aws::String & GetLanguage() const
GeocodeRequest & WithQueryComponents(QueryComponentsT &&value)
GeocodeRequest & WithFilter(FilterT &&value)
GeocodeAddressNamesMode GetAddressNamesMode() const
void SetIntendedUse(GeocodeIntendedUse value)
GeocodeRequest & AddBiasPosition(double value)
PostalCodeMode GetPostalCodeMode() const
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector