aws_sdk_location/operation/batch_update_device_position/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::batch_update_device_position::_batch_update_device_position_output::BatchUpdateDevicePositionOutputBuilder;
3
4pub use crate::operation::batch_update_device_position::_batch_update_device_position_input::BatchUpdateDevicePositionInputBuilder;
5
6impl crate::operation::batch_update_device_position::builders::BatchUpdateDevicePositionInputBuilder {
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::batch_update_device_position::BatchUpdateDevicePositionOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::batch_update_device_position::BatchUpdateDevicePositionError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.batch_update_device_position();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `BatchUpdateDevicePosition`.
24///
25/// <p>Uploads position update data for one or more devices to a tracker resource (up to 10 devices per batch). Amazon Location uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 days.</p><note>
26/// <p>Position updates are handled based on the <code>PositionFiltering</code> property of the tracker. When <code>PositionFiltering</code> is set to <code>TimeBased</code>, updates are evaluated against linked geofence collections, and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than every 30 seconds, only one update per 30 seconds is stored for each unique device ID.</p>
27/// <p>When <code>PositionFiltering</code> is set to <code>DistanceBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than 30 m (98.4 ft).</p>
28/// <p>When <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, location data is stored and evaluated against linked geofence collections only if the device has moved more than the measured accuracy. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is neither stored or evaluated if the device has moved less than 15 m. If <code>PositionFiltering</code> is set to <code>AccuracyBased</code> filtering, Amazon Location uses the default value <code>{ "Horizontal": 0}</code> when accuracy is not provided on a <code>DevicePositionUpdate</code>.</p>
29/// </note>
30#[derive(::std::clone::Clone, ::std::fmt::Debug)]
31pub struct BatchUpdateDevicePositionFluentBuilder {
32    handle: ::std::sync::Arc<crate::client::Handle>,
33    inner: crate::operation::batch_update_device_position::builders::BatchUpdateDevicePositionInputBuilder,
34    config_override: ::std::option::Option<crate::config::Builder>,
35}
36impl
37    crate::client::customize::internal::CustomizableSend<
38        crate::operation::batch_update_device_position::BatchUpdateDevicePositionOutput,
39        crate::operation::batch_update_device_position::BatchUpdateDevicePositionError,
40    > for BatchUpdateDevicePositionFluentBuilder
41{
42    fn send(
43        self,
44        config_override: crate::config::Builder,
45    ) -> crate::client::customize::internal::BoxFuture<
46        crate::client::customize::internal::SendResult<
47            crate::operation::batch_update_device_position::BatchUpdateDevicePositionOutput,
48            crate::operation::batch_update_device_position::BatchUpdateDevicePositionError,
49        >,
50    > {
51        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
52    }
53}
54impl BatchUpdateDevicePositionFluentBuilder {
55    /// Creates a new `BatchUpdateDevicePositionFluentBuilder`.
56    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
57        Self {
58            handle,
59            inner: ::std::default::Default::default(),
60            config_override: ::std::option::Option::None,
61        }
62    }
63    /// Access the BatchUpdateDevicePosition as a reference.
64    pub fn as_input(&self) -> &crate::operation::batch_update_device_position::builders::BatchUpdateDevicePositionInputBuilder {
65        &self.inner
66    }
67    /// Sends the request and returns the response.
68    ///
69    /// If an error occurs, an `SdkError` will be returned with additional details that
70    /// can be matched against.
71    ///
72    /// By default, any retryable failures will be retried twice. Retry behavior
73    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
74    /// set when configuring the client.
75    pub async fn send(
76        self,
77    ) -> ::std::result::Result<
78        crate::operation::batch_update_device_position::BatchUpdateDevicePositionOutput,
79        ::aws_smithy_runtime_api::client::result::SdkError<
80            crate::operation::batch_update_device_position::BatchUpdateDevicePositionError,
81            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
82        >,
83    > {
84        let input = self
85            .inner
86            .build()
87            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
88        let runtime_plugins = crate::operation::batch_update_device_position::BatchUpdateDevicePosition::operation_runtime_plugins(
89            self.handle.runtime_plugins.clone(),
90            &self.handle.conf,
91            self.config_override,
92        );
93        crate::operation::batch_update_device_position::BatchUpdateDevicePosition::orchestrate(&runtime_plugins, input).await
94    }
95
96    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
97    pub fn customize(
98        self,
99    ) -> crate::client::customize::CustomizableOperation<
100        crate::operation::batch_update_device_position::BatchUpdateDevicePositionOutput,
101        crate::operation::batch_update_device_position::BatchUpdateDevicePositionError,
102        Self,
103    > {
104        crate::client::customize::CustomizableOperation::new(self)
105    }
106    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
107        self.set_config_override(::std::option::Option::Some(config_override.into()));
108        self
109    }
110
111    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
112        self.config_override = config_override;
113        self
114    }
115    /// <p>The name of the tracker resource to update.</p>
116    pub fn tracker_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.inner = self.inner.tracker_name(input.into());
118        self
119    }
120    /// <p>The name of the tracker resource to update.</p>
121    pub fn set_tracker_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.inner = self.inner.set_tracker_name(input);
123        self
124    }
125    /// <p>The name of the tracker resource to update.</p>
126    pub fn get_tracker_name(&self) -> &::std::option::Option<::std::string::String> {
127        self.inner.get_tracker_name()
128    }
129    ///
130    /// Appends an item to `Updates`.
131    ///
132    /// To override the contents of this collection use [`set_updates`](Self::set_updates).
133    ///
134    /// <p>Contains the position update details for each device, up to 10 devices.</p>
135    pub fn updates(mut self, input: crate::types::DevicePositionUpdate) -> Self {
136        self.inner = self.inner.updates(input);
137        self
138    }
139    /// <p>Contains the position update details for each device, up to 10 devices.</p>
140    pub fn set_updates(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DevicePositionUpdate>>) -> Self {
141        self.inner = self.inner.set_updates(input);
142        self
143    }
144    /// <p>Contains the position update details for each device, up to 10 devices.</p>
145    pub fn get_updates(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DevicePositionUpdate>> {
146        self.inner.get_updates()
147    }
148}
aws_sdk_location/operation/batch_update_device_position/builders.rs

aws_sdk_location/operation/batch_update_device_position/
builders.rs
