1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::search_place_index_for_text::_search_place_index_for_text_output::SearchPlaceIndexForTextOutputBuilder;
pub use crate::operation::search_place_index_for_text::_search_place_index_for_text_input::SearchPlaceIndexForTextInputBuilder;
impl SearchPlaceIndexForTextInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.search_place_index_for_text();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `SearchPlaceIndexForText`.
///
/// <p>Geocodes free-form text, such as an address, name, city, or region to allow you to search for Places or points of interest.</p>
/// <p>Optional parameters let you narrow your search results by bounding box or country, or bias your search toward a specific position on the globe.</p><note>
/// <p>You can search for places near a given position using <code>BiasPosition</code>, or filter results within a bounding box using <code>FilterBBox</code>. Providing both parameters simultaneously returns an error.</p>
/// </note>
/// <p>Search results are returned in order of highest to lowest relevance.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct SearchPlaceIndexForTextFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::search_place_index_for_text::builders::SearchPlaceIndexForTextInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextOutput,
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextError,
> for SearchPlaceIndexForTextFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextOutput,
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl SearchPlaceIndexForTextFluentBuilder {
/// Creates a new `SearchPlaceIndexForText`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the SearchPlaceIndexForText as a reference.
pub fn as_input(&self) -> &crate::operation::search_place_index_for_text::builders::SearchPlaceIndexForTextInputBuilder {
&self.inner
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> ::std::result::Result<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::search_place_index_for_text::SearchPlaceIndexForText::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::search_place_index_for_text::SearchPlaceIndexForText::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextOutput,
crate::operation::search_place_index_for_text::SearchPlaceIndexForTextError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>The name of the place index resource you want to use for the search.</p>
pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.index_name(input.into());
self
}
/// <p>The name of the place index resource you want to use for the search.</p>
pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_index_name(input);
self
}
/// <p>The name of the place index resource you want to use for the search.</p>
pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_index_name()
}
/// <p>The address, name, city, or region to be used in the search in free-form text format. For example, <code>123 Any Street</code>.</p>
pub fn text(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.text(input.into());
self
}
/// <p>The address, name, city, or region to be used in the search in free-form text format. For example, <code>123 Any Street</code>.</p>
pub fn set_text(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_text(input);
self
}
/// <p>The address, name, city, or region to be used in the search in free-form text format. For example, <code>123 Any Street</code>.</p>
pub fn get_text(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_text()
}
/// Appends an item to `BiasPosition`.
///
/// To override the contents of this collection use [`set_bias_position`](Self::set_bias_position).
///
/// <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
/// <p>If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
/// <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p><note>
/// <p><code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn bias_position(mut self, input: f64) -> Self {
self.inner = self.inner.bias_position(input);
self
}
/// <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
/// <p>If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
/// <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p><note>
/// <p><code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn set_bias_position(mut self, input: ::std::option::Option<::std::vec::Vec<f64>>) -> Self {
self.inner = self.inner.set_bias_position(input);
self
}
/// <p>An optional parameter that indicates a preference for places that are closer to a specified position.</p>
/// <p>If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the second number represents the Y coordinate, or latitude.</p>
/// <p>For example, <code>[-123.1174, 49.2847]</code> represents the position with longitude <code>-123.1174</code> and latitude <code>49.2847</code>.</p><note>
/// <p><code>BiasPosition</code> and <code>FilterBBox</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn get_bias_position(&self) -> &::std::option::Option<::std::vec::Vec<f64>> {
self.inner.get_bias_position()
}
/// Appends an item to `FilterBBox`.
///
/// To override the contents of this collection use [`set_filter_b_box`](Self::set_filter_b_box).
///
/// <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
/// <p>If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p>
/// <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p><note>
/// <p><code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn filter_b_box(mut self, input: f64) -> Self {
self.inner = self.inner.filter_b_box(input);
self
}
/// <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
/// <p>If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p>
/// <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p><note>
/// <p><code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn set_filter_b_box(mut self, input: ::std::option::Option<::std::vec::Vec<f64>>) -> Self {
self.inner = self.inner.set_filter_b_box(input);
self
}
/// <p>An optional parameter that limits the search results by returning only places that are within the provided bounding box.</p>
/// <p>If provided, this parameter must contain a total of four consecutive numbers in two pairs. The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively) of the northeast corner of the bounding box.</p>
/// <p>For example, <code>[-12.7935, -37.4835, -12.0684, -36.9542]</code> represents a bounding box where the southwest corner has longitude <code>-12.7935</code> and latitude <code>-37.4835</code>, and the northeast corner has longitude <code>-12.0684</code> and latitude <code>-36.9542</code>.</p><note>
/// <p><code>FilterBBox</code> and <code>BiasPosition</code> are mutually exclusive. Specifying both options results in an error.</p>
/// </note>
pub fn get_filter_b_box(&self) -> &::std::option::Option<::std::vec::Vec<f64>> {
self.inner.get_filter_b_box()
}
/// Appends an item to `FilterCountries`.
///
/// To override the contents of this collection use [`set_filter_countries`](Self::set_filter_countries).
///
/// <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
/// <ul>
/// <li>
/// <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country codes. For example, Australia uses three upper-case characters: <code>AUS</code>.</p></li>
/// </ul>
pub fn filter_countries(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.filter_countries(input.into());
self
}
/// <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
/// <ul>
/// <li>
/// <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country codes. For example, Australia uses three upper-case characters: <code>AUS</code>.</p></li>
/// </ul>
pub fn set_filter_countries(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_filter_countries(input);
self
}
/// <p>An optional parameter that limits the search results by returning only places that are in a specified list of countries.</p>
/// <ul>
/// <li>
/// <p>Valid values include <a href="https://www.iso.org/iso-3166-country-codes.html">ISO 3166</a> 3-digit country codes. For example, Australia uses three upper-case characters: <code>AUS</code>.</p></li>
/// </ul>
pub fn get_filter_countries(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_filter_countries()
}
/// <p>An optional parameter. The maximum number of results returned per request.</p>
/// <p>The default: <code>50</code></p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>An optional parameter. The maximum number of results returned per request.</p>
/// <p>The default: <code>50</code></p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.inner = self.inner.set_max_results(input);
self
}
/// <p>An optional parameter. The maximum number of results returned per request.</p>
/// <p>The default: <code>50</code></p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
/// <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> for English.</p>
/// <p>This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p>
/// <p>For an example, we'll use the Greek language. You search for <code>Athens, Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The result found will most likely be returned as <code>Athens</code>.</p>
/// <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα</code>.</p>
/// <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>
pub fn language(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.language(input.into());
self
}
/// <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> for English.</p>
/// <p>This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p>
/// <p>For an example, we'll use the Greek language. You search for <code>Athens, Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The result found will most likely be returned as <code>Athens</code>.</p>
/// <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα</code>.</p>
/// <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>
pub fn set_language(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_language(input);
self
}
/// <p>The preferred language used to return results. The value must be a valid <a href="https://tools.ietf.org/search/bcp47">BCP 47</a> language tag, for example, <code>en</code> for English.</p>
/// <p>This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.</p>
/// <p>For an example, we'll use the Greek language. You search for <code>Athens, Greece</code>, with the <code>language</code> parameter set to <code>en</code>. The result found will most likely be returned as <code>Athens</code>.</p>
/// <p>If you set the <code>language</code> parameter to <code>el</code>, for Greek, then the result found will more likely be returned as <code>Αθήνα</code>.</p>
/// <p>If the data provider does not have a value for Greek, the result will be in a language that the provider does support.</p>
pub fn get_language(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_language()
}
/// Appends an item to `FilterCategories`.
///
/// To override the contents of this collection use [`set_filter_categories`](Self::set_filter_categories).
///
/// <p>A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match <i>any</i> of the categories listed.</p>
/// <p>For more information about using categories, including a list of Amazon Location categories, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service Developer Guide</i>.</p>
pub fn filter_categories(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.filter_categories(input.into());
self
}
/// <p>A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match <i>any</i> of the categories listed.</p>
/// <p>For more information about using categories, including a list of Amazon Location categories, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service Developer Guide</i>.</p>
pub fn set_filter_categories(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_filter_categories(input);
self
}
/// <p>A list of one or more Amazon Location categories to filter the returned places. If you include more than one category, the results will include results that match <i>any</i> of the categories listed.</p>
/// <p>For more information about using categories, including a list of Amazon Location categories, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/category-filtering.html">Categories and filtering</a>, in the <i>Amazon Location Service Developer Guide</i>.</p>
pub fn get_filter_categories(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_filter_categories()
}
/// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.key(input.into());
self
}
/// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_key(input);
self
}
/// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_key()
}
}