pub struct CreatePlaceIndexFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreatePlaceIndex.
This operation is no longer current and may be deprecated in the future. We recommend you upgrade to the Places API V2 unless you require Grab data.
-
CreatePlaceIndexis part of a previous Amazon Location Service Places API (version 1) which has been superseded by a more intuitive, powerful, and complete API (version 2). -
The Places API version 2 has a simplified interface that can be used without creating or managing place index resources.
-
If you are using an Amazon Web Services SDK or the Amazon Web Services CLI, note that the Places API version 2 is found under
geo-placesorgeo_places, not underlocation. -
Since Grab is not yet fully supported in Places API version 2, we recommend you continue using API version 1 when using Grab.
-
Start your version 2 API journey with the Places V2 API Reference or the Developer Guide.
Creates a place index resource in your Amazon Web Services account. Use a place index resource to geocode addresses and other text queries by using the SearchPlaceIndexForText operation, and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation, and enable autosuggestions by using the SearchPlaceIndexForSuggestions operation.
If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the Amazon Web Services service terms for more details.
Implementations§
Source§impl CreatePlaceIndexFluentBuilder
impl CreatePlaceIndexFluentBuilder
Sourcepub fn as_input(&self) -> &CreatePlaceIndexInputBuilder
pub fn as_input(&self) -> &CreatePlaceIndexInputBuilder
Access the CreatePlaceIndex as a reference.
Sourcepub async fn send(
self,
) -> Result<CreatePlaceIndexOutput, SdkError<CreatePlaceIndexError, HttpResponse>>
pub async fn send( self, ) -> Result<CreatePlaceIndexOutput, SdkError<CreatePlaceIndexError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreatePlaceIndexOutput, CreatePlaceIndexError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreatePlaceIndexOutput, CreatePlaceIndexError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The name of the place index resource.
Requirements:
-
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
-
Must be a unique place index resource name.
-
No spaces allowed. For example,
ExamplePlaceIndex.
Sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The name of the place index resource.
Requirements:
-
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
-
Must be a unique place index resource name.
-
No spaces allowed. For example,
ExamplePlaceIndex.
Sourcepub fn get_index_name(&self) -> &Option<String>
pub fn get_index_name(&self) -> &Option<String>
The name of the place index resource.
Requirements:
-
Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).
-
Must be a unique place index resource name.
-
No spaces allowed. For example,
ExamplePlaceIndex.
Sourcepub fn data_source(self, input: impl Into<String>) -> Self
pub fn data_source(self, input: impl Into<String>) -> Self
Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
-
Esri– For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage. -
Grab– Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered. -
Here– For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.If you specify HERE Technologies (
Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services service terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service developer guide.
Sourcepub fn set_data_source(self, input: Option<String>) -> Self
pub fn set_data_source(self, input: Option<String>) -> Self
Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
-
Esri– For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage. -
Grab– Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered. -
Here– For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.If you specify HERE Technologies (
Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services service terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service developer guide.
Sourcepub fn get_data_source(&self) -> &Option<String>
pub fn get_data_source(&self) -> &Option<String>
Specifies the geospatial data provider for the new place index.
This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
Valid values include:
-
Esri– For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage. -
Grab– Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered. -
Here– For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.If you specify HERE Technologies (
Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services service terms for Amazon Location Service.
For additional information , see Data providers on the Amazon Location Service developer guide.
Sourcepub fn pricing_plan(self, input: PricingPlan) -> Self
👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.
pub fn pricing_plan(self, input: PricingPlan) -> Self
No longer used. If included, the only allowed value is RequestBasedUsage.
Sourcepub fn set_pricing_plan(self, input: Option<PricingPlan>) -> Self
👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.
pub fn set_pricing_plan(self, input: Option<PricingPlan>) -> Self
No longer used. If included, the only allowed value is RequestBasedUsage.
Sourcepub fn get_pricing_plan(&self) -> &Option<PricingPlan>
👎Deprecated since 2022-02-01: Deprecated. If included, the only allowed value is RequestBasedUsage.
pub fn get_pricing_plan(&self) -> &Option<PricingPlan>
No longer used. If included, the only allowed value is RequestBasedUsage.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The optional description for the place index resource.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The optional description for the place index resource.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The optional description for the place index resource.
Sourcepub fn data_source_configuration(self, input: DataSourceConfiguration) -> Self
pub fn data_source_configuration(self, input: DataSourceConfiguration) -> Self
Specifies the data storage option requesting Places.
Sourcepub fn set_data_source_configuration(
self,
input: Option<DataSourceConfiguration>,
) -> Self
pub fn set_data_source_configuration( self, input: Option<DataSourceConfiguration>, ) -> Self
Specifies the data storage option requesting Places.
Sourcepub fn get_data_source_configuration(&self) -> &Option<DataSourceConfiguration>
pub fn get_data_source_configuration(&self) -> &Option<DataSourceConfiguration>
Specifies the data storage option requesting Places.
Adds a key-value pair to Tags.
To override the contents of this collection use set_tags.
Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
-
Maximum 50 tags per resource.
-
Each tag key must be unique and must have exactly one associated value.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
-
Cannot use "aws:" as a prefix for a key.
Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
-
Maximum 50 tags per resource.
-
Each tag key must be unique and must have exactly one associated value.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
-
Cannot use "aws:" as a prefix for a key.
Applies one or more tags to the place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
Format: "key" : "value"
Restrictions:
-
Maximum 50 tags per resource.
-
Each tag key must be unique and must have exactly one associated value.
-
Maximum key length: 128 Unicode characters in UTF-8.
-
Maximum value length: 256 Unicode characters in UTF-8.
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @
-
Cannot use "aws:" as a prefix for a key.
Trait Implementations§
Source§impl Clone for CreatePlaceIndexFluentBuilder
impl Clone for CreatePlaceIndexFluentBuilder
Source§fn clone(&self) -> CreatePlaceIndexFluentBuilder
fn clone(&self) -> CreatePlaceIndexFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreatePlaceIndexFluentBuilder
impl !RefUnwindSafe for CreatePlaceIndexFluentBuilder
impl Send for CreatePlaceIndexFluentBuilder
impl Sync for CreatePlaceIndexFluentBuilder
impl Unpin for CreatePlaceIndexFluentBuilder
impl !UnwindSafe for CreatePlaceIndexFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);