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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::forecast_geofence_events::_forecast_geofence_events_output::ForecastGeofenceEventsOutputBuilder;
pub use crate::operation::forecast_geofence_events::_forecast_geofence_events_input::ForecastGeofenceEventsInputBuilder;
impl crate::operation::forecast_geofence_events::builders::ForecastGeofenceEventsInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::forecast_geofence_events::ForecastGeofenceEventsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::forecast_geofence_events::ForecastGeofenceEventsError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.forecast_geofence_events();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `ForecastGeofenceEvents`.
///
/// <p>This action forecasts future geofence events that are likely to occur within a specified time horizon if a device continues moving at its current speed. Each forecasted event is associated with a geofence from a provided geofence collection. A forecast event can have one of the following states:</p>
/// <p><code>ENTER</code>: The device position is outside the referenced geofence, but the device may cross into the geofence during the forecasting time horizon if it maintains its current speed.</p>
/// <p><code>EXIT</code>: The device position is inside the referenced geofence, but the device may leave the geofence during the forecasted time horizon if the device maintains it's current speed.</p>
/// <p><code>IDLE</code>:The device is inside the geofence, and it will remain inside the geofence through the end of the time horizon if the device maintains it's current speed.</p><note>
/// <p>Heading direction is not considered in the current version. The API takes a conservative approach and includes events that can occur for any heading.</p>
/// </note>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct ForecastGeofenceEventsFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::forecast_geofence_events::builders::ForecastGeofenceEventsInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::forecast_geofence_events::ForecastGeofenceEventsOutput,
crate::operation::forecast_geofence_events::ForecastGeofenceEventsError,
> for ForecastGeofenceEventsFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::forecast_geofence_events::ForecastGeofenceEventsOutput,
crate::operation::forecast_geofence_events::ForecastGeofenceEventsError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl ForecastGeofenceEventsFluentBuilder {
/// Creates a new `ForecastGeofenceEventsFluentBuilder`.
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 ForecastGeofenceEvents as a reference.
pub fn as_input(&self) -> &crate::operation::forecast_geofence_events::builders::ForecastGeofenceEventsInputBuilder {
&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::forecast_geofence_events::ForecastGeofenceEventsOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::forecast_geofence_events::ForecastGeofenceEventsError,
::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::forecast_geofence_events::ForecastGeofenceEvents::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::forecast_geofence_events::ForecastGeofenceEvents::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::forecast_geofence_events::ForecastGeofenceEventsOutput,
crate::operation::forecast_geofence_events::ForecastGeofenceEventsError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
self.set_config_override(::std::option::Option::Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// Create a paginator for this request
///
/// Paginators are used by calling [`send().await`](crate::operation::forecast_geofence_events::paginator::ForecastGeofenceEventsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
pub fn into_paginator(self) -> crate::operation::forecast_geofence_events::paginator::ForecastGeofenceEventsPaginator {
crate::operation::forecast_geofence_events::paginator::ForecastGeofenceEventsPaginator::new(self.handle, self.inner)
}
/// <p>The name of the geofence collection.</p>
pub fn collection_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.collection_name(input.into());
self
}
/// <p>The name of the geofence collection.</p>
pub fn set_collection_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_collection_name(input);
self
}
/// <p>The name of the geofence collection.</p>
pub fn get_collection_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_collection_name()
}
/// <p>Represents the device's state, including its current position and speed. When speed is omitted, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn device_state(mut self, input: crate::types::ForecastGeofenceEventsDeviceState) -> Self {
self.inner = self.inner.device_state(input);
self
}
/// <p>Represents the device's state, including its current position and speed. When speed is omitted, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn set_device_state(mut self, input: ::std::option::Option<crate::types::ForecastGeofenceEventsDeviceState>) -> Self {
self.inner = self.inner.set_device_state(input);
self
}
/// <p>Represents the device's state, including its current position and speed. When speed is omitted, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn get_device_state(&self) -> &::std::option::Option<crate::types::ForecastGeofenceEventsDeviceState> {
self.inner.get_device_state()
}
/// <p>The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn time_horizon_minutes(mut self, input: f64) -> Self {
self.inner = self.inner.time_horizon_minutes(input);
self
}
/// <p>The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn set_time_horizon_minutes(mut self, input: ::std::option::Option<f64>) -> Self {
self.inner = self.inner.set_time_horizon_minutes(input);
self
}
/// <p>The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a <i>containment check</i>. The <i>containment check</i> operation returns <code>IDLE</code> events for geofences where the device is currently inside of, but no other events.</p>
pub fn get_time_horizon_minutes(&self) -> &::std::option::Option<f64> {
self.inner.get_time_horizon_minutes()
}
/// <p>The distance unit used for the <code>NearestDistance</code> property returned in a forecasted event. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>Kilometers</code></p>
pub fn distance_unit(mut self, input: crate::types::DistanceUnit) -> Self {
self.inner = self.inner.distance_unit(input);
self
}
/// <p>The distance unit used for the <code>NearestDistance</code> property returned in a forecasted event. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>Kilometers</code></p>
pub fn set_distance_unit(mut self, input: ::std::option::Option<crate::types::DistanceUnit>) -> Self {
self.inner = self.inner.set_distance_unit(input);
self
}
/// <p>The distance unit used for the <code>NearestDistance</code> property returned in a forecasted event. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>Kilometers</code></p>
pub fn get_distance_unit(&self) -> &::std::option::Option<crate::types::DistanceUnit> {
self.inner.get_distance_unit()
}
/// <p>The speed unit for the device captured by the device state. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>KilometersPerHour</code>.</p>
pub fn speed_unit(mut self, input: crate::types::SpeedUnit) -> Self {
self.inner = self.inner.speed_unit(input);
self
}
/// <p>The speed unit for the device captured by the device state. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>KilometersPerHour</code>.</p>
pub fn set_speed_unit(mut self, input: ::std::option::Option<crate::types::SpeedUnit>) -> Self {
self.inner = self.inner.set_speed_unit(input);
self
}
/// <p>The speed unit for the device captured by the device state. The measurement system must match for <code>DistanceUnit</code> and <code>SpeedUnit</code>; if <code>Kilometers</code> is specified for <code>DistanceUnit</code>, then <code>SpeedUnit</code> must be <code>KilometersPerHour</code>.</p>
/// <p>Default Value: <code>KilometersPerHour</code>.</p>
pub fn get_speed_unit(&self) -> &::std::option::Option<crate::types::SpeedUnit> {
self.inner.get_speed_unit()
}
/// <p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p>
/// <p>Default value: <code>null</code></p>
pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.next_token(input.into());
self
}
/// <p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p>
/// <p>Default value: <code>null</code></p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_next_token(input);
self
}
/// <p>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.</p>
/// <p>Default value: <code>null</code></p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_next_token()
}
/// <p>An optional limit for the number of resources returned in a single call.</p>
/// <p>Default value: <code>20</code></p>
pub fn max_results(mut self, input: i32) -> Self {
self.inner = self.inner.max_results(input);
self
}
/// <p>An optional limit for the number of resources returned in a single call.</p>
/// <p>Default value: <code>20</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 limit for the number of resources returned in a single call.</p>
/// <p>Default value: <code>20</code></p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
self.inner.get_max_results()
}
}