aws-sdk-location 0.26.0

AWS SDK for Amazon Location Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_device_position_history::_get_device_position_history_output::GetDevicePositionHistoryOutputBuilder;

pub use crate::operation::get_device_position_history::_get_device_position_history_input::GetDevicePositionHistoryInputBuilder;

/// Fluent builder constructing a request to `GetDevicePositionHistory`.
///
/// <p>Retrieves the device position history from a tracker resource within a specified range of time.</p> <note>
/// <p>Device positions are deleted after 30 days.</p>
/// </note>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct GetDevicePositionHistoryFluentBuilder {
                handle: std::sync::Arc<crate::client::Handle>,
                inner: crate::operation::get_device_position_history::builders::GetDevicePositionHistoryInputBuilder
            }
impl GetDevicePositionHistoryFluentBuilder {
    /// Creates a new `GetDevicePositionHistory`.
    pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: Default::default(),
        }
    }

    /// Consume this builder, creating a customizable operation that can be modified before being
    /// sent. The operation's inner [http::Request] can be modified as well.
    pub async fn customize(
        self,
    ) -> std::result::Result<
        crate::client::customize::CustomizableOperation<
            crate::operation::get_device_position_history::GetDevicePositionHistory,
            aws_http::retry::AwsResponseRetryClassifier,
        >,
        aws_smithy_http::result::SdkError<
            crate::operation::get_device_position_history::GetDevicePositionHistoryError,
        >,
    > {
        let handle = self.handle.clone();
        let operation = self
            .inner
            .build()
            .map_err(aws_smithy_http::result::SdkError::construction_failure)?
            .make_operation(&handle.conf)
            .await
            .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
        Ok(crate::client::customize::CustomizableOperation { handle, operation })
    }

    /// 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::get_device_position_history::GetDevicePositionHistoryOutput,
        aws_smithy_http::result::SdkError<
            crate::operation::get_device_position_history::GetDevicePositionHistoryError,
        >,
    > {
        let op = self
            .inner
            .build()
            .map_err(aws_smithy_http::result::SdkError::construction_failure)?
            .make_operation(&self.handle.conf)
            .await
            .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
        self.handle.client.call(op).await
    }
    /// Create a paginator for this request
    ///
    /// Paginators are used by calling [`send().await`](crate::operation::get_device_position_history::paginator::GetDevicePositionHistoryPaginator::send) which returns a `Stream`.
    pub fn into_paginator(
        self,
    ) -> crate::operation::get_device_position_history::paginator::GetDevicePositionHistoryPaginator
    {
        crate::operation::get_device_position_history::paginator::GetDevicePositionHistoryPaginator::new(self.handle, self.inner)
    }
    /// <p>The tracker resource receiving the request for the device position history.</p>
    pub fn tracker_name(mut self, input: impl Into<std::string::String>) -> Self {
        self.inner = self.inner.tracker_name(input.into());
        self
    }
    /// <p>The tracker resource receiving the request for the device position history.</p>
    pub fn set_tracker_name(mut self, input: std::option::Option<std::string::String>) -> Self {
        self.inner = self.inner.set_tracker_name(input);
        self
    }
    /// <p>The device whose position history you want to retrieve.</p>
    pub fn device_id(mut self, input: impl Into<std::string::String>) -> Self {
        self.inner = self.inner.device_id(input.into());
        self
    }
    /// <p>The device whose position history you want to retrieve.</p>
    pub fn set_device_id(mut self, input: std::option::Option<std::string::String>) -> Self {
        self.inner = self.inner.set_device_id(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 next_token(mut self, input: impl 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>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours prior to the time that the request is made.</p>
    /// <p>Requirement:</p>
    /// <ul>
    /// <li> <p>The time specified for <code>StartTimeInclusive</code> must be before <code>EndTimeExclusive</code>.</p> </li>
    /// </ul>
    pub fn start_time_inclusive(mut self, input: aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_time_inclusive(input);
        self
    }
    /// <p>Specify the start time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be 24 hours prior to the time that the request is made.</p>
    /// <p>Requirement:</p>
    /// <ul>
    /// <li> <p>The time specified for <code>StartTimeInclusive</code> must be before <code>EndTimeExclusive</code>.</p> </li>
    /// </ul>
    pub fn set_start_time_inclusive(
        mut self,
        input: std::option::Option<aws_smithy_types::DateTime>,
    ) -> Self {
        self.inner = self.inner.set_start_time_inclusive(input);
        self
    }
    /// <p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time that the request is made.</p>
    /// <p>Requirement:</p>
    /// <ul>
    /// <li> <p>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</p> </li>
    /// </ul>
    pub fn end_time_exclusive(mut self, input: aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_time_exclusive(input);
        self
    }
    /// <p>Specify the end time for the position history in <a href="https://www.iso.org/iso-8601-date-and-time-format.html"> ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code>. By default, the value will be the time that the request is made.</p>
    /// <p>Requirement:</p>
    /// <ul>
    /// <li> <p>The time specified for <code>EndTimeExclusive</code> must be after the time for <code>StartTimeInclusive</code>.</p> </li>
    /// </ul>
    pub fn set_end_time_exclusive(
        mut self,
        input: std::option::Option<aws_smithy_types::DateTime>,
    ) -> Self {
        self.inner = self.inner.set_end_time_exclusive(input);
        self
    }
    /// <p>An optional limit for the number of device positions returned in a single call.</p>
    /// <p>Default value: <code>100</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 device positions returned in a single call.</p>
    /// <p>Default value: <code>100</code> </p>
    pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
}