Skip to main content

aws_sdk_location/operation/create_geofence_collection/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_geofence_collection::_create_geofence_collection_input::CreateGeofenceCollectionInputBuilder;
3
4pub use crate::operation::create_geofence_collection::_create_geofence_collection_output::CreateGeofenceCollectionOutputBuilder;
5
6impl crate::operation::create_geofence_collection::builders::CreateGeofenceCollectionInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_geofence_collection::CreateGeofenceCollectionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_geofence_collection::CreateGeofenceCollectionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_geofence_collection();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateGeofenceCollection`.
24///
25/// <p>Creates a geofence collection, which manages and stores geofences.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateGeofenceCollectionFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_geofence_collection::builders::CreateGeofenceCollectionInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_geofence_collection::CreateGeofenceCollectionOutput,
35        crate::operation::create_geofence_collection::CreateGeofenceCollectionError,
36    > for CreateGeofenceCollectionFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_geofence_collection::CreateGeofenceCollectionOutput,
44            crate::operation::create_geofence_collection::CreateGeofenceCollectionError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateGeofenceCollectionFluentBuilder {
51    /// Creates a new `CreateGeofenceCollectionFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateGeofenceCollection as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_geofence_collection::builders::CreateGeofenceCollectionInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_geofence_collection::CreateGeofenceCollectionOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_geofence_collection::CreateGeofenceCollectionError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_geofence_collection::CreateGeofenceCollection::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_geofence_collection::CreateGeofenceCollection::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_geofence_collection::CreateGeofenceCollectionOutput,
97        crate::operation::create_geofence_collection::CreateGeofenceCollectionError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>A custom name for the geofence collection.</p>
112    /// <p>Requirements:</p>
113    /// <ul>
114    /// <li>
115    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
116    /// <li>
117    /// <p>Must be a unique geofence collection name.</p></li>
118    /// <li>
119    /// <p>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</p></li>
120    /// </ul>
121    pub fn collection_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.collection_name(input.into());
123        self
124    }
125    /// <p>A custom name for the geofence collection.</p>
126    /// <p>Requirements:</p>
127    /// <ul>
128    /// <li>
129    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
130    /// <li>
131    /// <p>Must be a unique geofence collection name.</p></li>
132    /// <li>
133    /// <p>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</p></li>
134    /// </ul>
135    pub fn set_collection_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
136        self.inner = self.inner.set_collection_name(input);
137        self
138    }
139    /// <p>A custom name for the geofence collection.</p>
140    /// <p>Requirements:</p>
141    /// <ul>
142    /// <li>
143    /// <p>Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).</p></li>
144    /// <li>
145    /// <p>Must be a unique geofence collection name.</p></li>
146    /// <li>
147    /// <p>No spaces allowed. For example, <code>ExampleGeofenceCollection</code>.</p></li>
148    /// </ul>
149    pub fn get_collection_name(&self) -> &::std::option::Option<::std::string::String> {
150        self.inner.get_collection_name()
151    }
152    /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
153    #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
154    pub fn pricing_plan(mut self, input: crate::types::PricingPlan) -> Self {
155        self.inner = self.inner.pricing_plan(input);
156        self
157    }
158    /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
159    #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
160    pub fn set_pricing_plan(mut self, input: ::std::option::Option<crate::types::PricingPlan>) -> Self {
161        self.inner = self.inner.set_pricing_plan(input);
162        self
163    }
164    /// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
165    #[deprecated(note = "Deprecated. If included, the only allowed value is RequestBasedUsage.", since = "2022-02-01")]
166    pub fn get_pricing_plan(&self) -> &::std::option::Option<crate::types::PricingPlan> {
167        self.inner.get_pricing_plan()
168    }
169    /// <p>This parameter is no longer used.</p>
170    #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
171    pub fn pricing_plan_data_source(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
172        self.inner = self.inner.pricing_plan_data_source(input.into());
173        self
174    }
175    /// <p>This parameter is no longer used.</p>
176    #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
177    pub fn set_pricing_plan_data_source(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
178        self.inner = self.inner.set_pricing_plan_data_source(input);
179        self
180    }
181    /// <p>This parameter is no longer used.</p>
182    #[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
183    pub fn get_pricing_plan_data_source(&self) -> &::std::option::Option<::std::string::String> {
184        self.inner.get_pricing_plan_data_source()
185    }
186    /// <p>An optional description for the geofence collection.</p>
187    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
188        self.inner = self.inner.description(input.into());
189        self
190    }
191    /// <p>An optional description for the geofence collection.</p>
192    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
193        self.inner = self.inner.set_description(input);
194        self
195    }
196    /// <p>An optional description for the geofence collection.</p>
197    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
198        self.inner.get_description()
199    }
200    ///
201    /// Adds a key-value pair to `Tags`.
202    ///
203    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
204    ///
205    /// <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
206    /// <p>Format: <code>"key" : "value"</code></p>
207    /// <p>Restrictions:</p>
208    /// <ul>
209    /// <li>
210    /// <p>Maximum 50 tags per resource</p></li>
211    /// <li>
212    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
213    /// <li>
214    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
215    /// <li>
216    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
217    /// <li>
218    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
219    /// <li>
220    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
221    /// </ul>
222    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
223        self.inner = self.inner.tags(k.into(), v.into());
224        self
225    }
226    /// <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
227    /// <p>Format: <code>"key" : "value"</code></p>
228    /// <p>Restrictions:</p>
229    /// <ul>
230    /// <li>
231    /// <p>Maximum 50 tags per resource</p></li>
232    /// <li>
233    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
234    /// <li>
235    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
236    /// <li>
237    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
238    /// <li>
239    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
240    /// <li>
241    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
242    /// </ul>
243    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
244        self.inner = self.inner.set_tags(input);
245        self
246    }
247    /// <p>Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.</p>
248    /// <p>Format: <code>"key" : "value"</code></p>
249    /// <p>Restrictions:</p>
250    /// <ul>
251    /// <li>
252    /// <p>Maximum 50 tags per resource</p></li>
253    /// <li>
254    /// <p>Each resource tag must be unique with a maximum of one value.</p></li>
255    /// <li>
256    /// <p>Maximum key length: 128 Unicode characters in UTF-8</p></li>
257    /// <li>
258    /// <p>Maximum value length: 256 Unicode characters in UTF-8</p></li>
259    /// <li>
260    /// <p>Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.</p></li>
261    /// <li>
262    /// <p>Cannot use "aws:" as a prefix for a key.</p></li>
263    /// </ul>
264    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
265        self.inner.get_tags()
266    }
267    /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
268    pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
269        self.inner = self.inner.kms_key_id(input.into());
270        self
271    }
272    /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
273    pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
274        self.inner = self.inner.set_kms_key_id(input);
275        self
276    }
277    /// <p>A key identifier for an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html">Amazon Web Services KMS customer managed key</a>. Enter a key ID, key ARN, alias name, or alias ARN.</p>
278    pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
279        self.inner.get_kms_key_id()
280    }
281}