// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq, std::fmt::Debug)]
pub struct UpdateTrackerInput {
/// <p>The name of the tracker resource to update.</p>
#[doc(hidden)]
pub tracker_name: std::option::Option<std::string::String>,
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
#[doc(hidden)]
pub pricing_plan: std::option::Option<crate::types::PricingPlan>,
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
#[doc(hidden)]
pub pricing_plan_data_source: std::option::Option<std::string::String>,
/// <p>Updates the description for the tracker resource.</p>
#[doc(hidden)]
pub description: std::option::Option<std::string::String>,
/// <p>Updates the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li> <p> <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. </p> </li>
/// <li> <p> <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. </p> </li>
/// <li> <p> <code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations. </p> </li>
/// </ul>
#[doc(hidden)]
pub position_filtering: std::option::Option<crate::types::PositionFiltering>,
}
impl UpdateTrackerInput {
/// <p>The name of the tracker resource to update.</p>
pub fn tracker_name(&self) -> std::option::Option<&str> {
self.tracker_name.as_deref()
}
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
pub fn pricing_plan(&self) -> std::option::Option<&crate::types::PricingPlan> {
self.pricing_plan.as_ref()
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn pricing_plan_data_source(&self) -> std::option::Option<&str> {
self.pricing_plan_data_source.as_deref()
}
/// <p>Updates the description for the tracker resource.</p>
pub fn description(&self) -> std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Updates the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li> <p> <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. </p> </li>
/// <li> <p> <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. </p> </li>
/// <li> <p> <code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations. </p> </li>
/// </ul>
pub fn position_filtering(&self) -> std::option::Option<&crate::types::PositionFiltering> {
self.position_filtering.as_ref()
}
}
impl UpdateTrackerInput {
/// Creates a new builder-style object to manufacture [`UpdateTrackerInput`](crate::operation::update_tracker::UpdateTrackerInput).
pub fn builder() -> crate::operation::update_tracker::builders::UpdateTrackerInputBuilder {
crate::operation::update_tracker::builders::UpdateTrackerInputBuilder::default()
}
}
/// A builder for [`UpdateTrackerInput`](crate::operation::update_tracker::UpdateTrackerInput).
#[non_exhaustive]
#[derive(std::clone::Clone, std::cmp::PartialEq, std::default::Default, std::fmt::Debug)]
pub struct UpdateTrackerInputBuilder {
pub(crate) tracker_name: std::option::Option<std::string::String>,
pub(crate) pricing_plan: std::option::Option<crate::types::PricingPlan>,
pub(crate) pricing_plan_data_source: std::option::Option<std::string::String>,
pub(crate) description: std::option::Option<std::string::String>,
pub(crate) position_filtering: std::option::Option<crate::types::PositionFiltering>,
}
impl UpdateTrackerInputBuilder {
/// <p>The name of the tracker resource to update.</p>
pub fn tracker_name(mut self, input: impl Into<std::string::String>) -> Self {
self.tracker_name = Some(input.into());
self
}
/// <p>The name of the tracker resource to update.</p>
pub fn set_tracker_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.tracker_name = input;
self
}
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
pub fn pricing_plan(mut self, input: crate::types::PricingPlan) -> Self {
self.pricing_plan = Some(input);
self
}
/// <p>No longer used. If included, the only allowed value is <code>RequestBasedUsage</code>.</p>
#[deprecated(
note = "Deprecated. If included, the only allowed value is RequestBasedUsage.",
since = "2022-02-01"
)]
pub fn set_pricing_plan(
mut self,
input: std::option::Option<crate::types::PricingPlan>,
) -> Self {
self.pricing_plan = input;
self
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn pricing_plan_data_source(mut self, input: impl Into<std::string::String>) -> Self {
self.pricing_plan_data_source = Some(input.into());
self
}
/// <p>This parameter is no longer used.</p>
#[deprecated(note = "Deprecated. No longer allowed.", since = "2022-02-01")]
pub fn set_pricing_plan_data_source(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.pricing_plan_data_source = input;
self
}
/// <p>Updates the description for the tracker resource.</p>
pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
self.description = Some(input.into());
self
}
/// <p>Updates the description for the tracker resource.</p>
pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Updates the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li> <p> <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. </p> </li>
/// <li> <p> <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. </p> </li>
/// <li> <p> <code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations. </p> </li>
/// </ul>
pub fn position_filtering(mut self, input: crate::types::PositionFiltering) -> Self {
self.position_filtering = Some(input);
self
}
/// <p>Updates the position filtering for the tracker resource.</p>
/// <p>Valid values:</p>
/// <ul>
/// <li> <p> <code>TimeBased</code> - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID. </p> </li>
/// <li> <p> <code>DistanceBased</code> - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map. </p> </li>
/// <li> <p> <code>AccuracyBased</code> - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations. </p> </li>
/// </ul>
pub fn set_position_filtering(
mut self,
input: std::option::Option<crate::types::PositionFiltering>,
) -> Self {
self.position_filtering = input;
self
}
/// Consumes the builder and constructs a [`UpdateTrackerInput`](crate::operation::update_tracker::UpdateTrackerInput).
pub fn build(
self,
) -> Result<
crate::operation::update_tracker::UpdateTrackerInput,
aws_smithy_http::operation::error::BuildError,
> {
Ok(crate::operation::update_tracker::UpdateTrackerInput {
tracker_name: self.tracker_name,
pricing_plan: self.pricing_plan,
pricing_plan_data_source: self.pricing_plan_data_source,
description: self.description,
position_filtering: self.position_filtering,
})
}
}