aws-sdk-iottwinmaker 1.101.0

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::get_property_value_history::_get_property_value_history_input::GetPropertyValueHistoryInputBuilder;

pub use crate::operation::get_property_value_history::_get_property_value_history_output::GetPropertyValueHistoryOutputBuilder;

impl crate::operation::get_property_value_history::builders::GetPropertyValueHistoryInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::get_property_value_history::GetPropertyValueHistoryOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_property_value_history::GetPropertyValueHistoryError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.get_property_value_history();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `GetPropertyValueHistory`.
///
/// <p>Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.</p>
/// <p>You must specify a value for <code>workspaceId</code>. For entity-specific queries, specify values for <code>componentName</code> and <code>entityId</code>. For cross-entity quries, specify a value for <code>componentTypeId</code>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct GetPropertyValueHistoryFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::get_property_value_history::builders::GetPropertyValueHistoryInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::get_property_value_history::GetPropertyValueHistoryOutput,
        crate::operation::get_property_value_history::GetPropertyValueHistoryError,
    > for GetPropertyValueHistoryFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::get_property_value_history::GetPropertyValueHistoryOutput,
            crate::operation::get_property_value_history::GetPropertyValueHistoryError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl GetPropertyValueHistoryFluentBuilder {
    /// Creates a new `GetPropertyValueHistoryFluentBuilder`.
    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 GetPropertyValueHistory as a reference.
    pub fn as_input(&self) -> &crate::operation::get_property_value_history::builders::GetPropertyValueHistoryInputBuilder {
        &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::get_property_value_history::GetPropertyValueHistoryOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::get_property_value_history::GetPropertyValueHistoryError,
            ::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::get_property_value_history::GetPropertyValueHistory::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::get_property_value_history::GetPropertyValueHistory::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::get_property_value_history::GetPropertyValueHistoryOutput,
        crate::operation::get_property_value_history::GetPropertyValueHistoryError,
        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::get_property_value_history::paginator::GetPropertyValueHistoryPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
    pub fn into_paginator(self) -> crate::operation::get_property_value_history::paginator::GetPropertyValueHistoryPaginator {
        crate::operation::get_property_value_history::paginator::GetPropertyValueHistoryPaginator::new(self.handle, self.inner)
    }
    /// <p>The ID of the workspace.</p>
    pub fn workspace_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.workspace_id(input.into());
        self
    }
    /// <p>The ID of the workspace.</p>
    pub fn set_workspace_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_workspace_id(input);
        self
    }
    /// <p>The ID of the workspace.</p>
    pub fn get_workspace_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_workspace_id()
    }
    /// <p>The ID of the entity.</p>
    pub fn entity_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.entity_id(input.into());
        self
    }
    /// <p>The ID of the entity.</p>
    pub fn set_entity_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_entity_id(input);
        self
    }
    /// <p>The ID of the entity.</p>
    pub fn get_entity_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_entity_id()
    }
    /// <p>The name of the component.</p>
    pub fn component_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.component_name(input.into());
        self
    }
    /// <p>The name of the component.</p>
    pub fn set_component_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_component_name(input);
        self
    }
    /// <p>The name of the component.</p>
    pub fn get_component_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_component_name()
    }
    /// <p>This string specifies the path to the composite component, starting from the top-level component.</p>
    pub fn component_path(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.component_path(input.into());
        self
    }
    /// <p>This string specifies the path to the composite component, starting from the top-level component.</p>
    pub fn set_component_path(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_component_path(input);
        self
    }
    /// <p>This string specifies the path to the composite component, starting from the top-level component.</p>
    pub fn get_component_path(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_component_path()
    }
    /// <p>The ID of the component type.</p>
    pub fn component_type_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.component_type_id(input.into());
        self
    }
    /// <p>The ID of the component type.</p>
    pub fn set_component_type_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_component_type_id(input);
        self
    }
    /// <p>The ID of the component type.</p>
    pub fn get_component_type_id(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_component_type_id()
    }
    ///
    /// Appends an item to `selectedProperties`.
    ///
    /// To override the contents of this collection use [`set_selected_properties`](Self::set_selected_properties).
    ///
    /// <p>A list of properties whose value histories the request retrieves.</p>
    pub fn selected_properties(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.selected_properties(input.into());
        self
    }
    /// <p>A list of properties whose value histories the request retrieves.</p>
    pub fn set_selected_properties(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_selected_properties(input);
        self
    }
    /// <p>A list of properties whose value histories the request retrieves.</p>
    pub fn get_selected_properties(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_selected_properties()
    }
    ///
    /// Appends an item to `propertyFilters`.
    ///
    /// To override the contents of this collection use [`set_property_filters`](Self::set_property_filters).
    ///
    /// <p>A list of objects that filter the property value history request.</p>
    pub fn property_filters(mut self, input: crate::types::PropertyFilter) -> Self {
        self.inner = self.inner.property_filters(input);
        self
    }
    /// <p>A list of objects that filter the property value history request.</p>
    pub fn set_property_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PropertyFilter>>) -> Self {
        self.inner = self.inner.set_property_filters(input);
        self
    }
    /// <p>A list of objects that filter the property value history request.</p>
    pub fn get_property_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PropertyFilter>> {
        self.inner.get_property_filters()
    }
    /// <p>The date and time of the earliest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use startTime instead.")]
    pub fn start_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.start_date_time(input);
        self
    }
    /// <p>The date and time of the earliest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use startTime instead.")]
    pub fn set_start_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_start_date_time(input);
        self
    }
    /// <p>The date and time of the earliest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use startTime instead.")]
    pub fn get_start_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_start_date_time()
    }
    /// <p>The date and time of the latest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use endTime instead.")]
    pub fn end_date_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.inner = self.inner.end_date_time(input);
        self
    }
    /// <p>The date and time of the latest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use endTime instead.")]
    pub fn set_end_date_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.inner = self.inner.set_end_date_time(input);
        self
    }
    /// <p>The date and time of the latest property value to return.</p>
    #[deprecated(note = "This field is deprecated and will throw an error in the future. Use endTime instead.")]
    pub fn get_end_date_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        self.inner.get_end_date_time()
    }
    /// <p>An object that specifies the interpolation type and the interval over which to interpolate data.</p>
    pub fn interpolation(mut self, input: crate::types::InterpolationParameters) -> Self {
        self.inner = self.inner.interpolation(input);
        self
    }
    /// <p>An object that specifies the interpolation type and the interval over which to interpolate data.</p>
    pub fn set_interpolation(mut self, input: ::std::option::Option<crate::types::InterpolationParameters>) -> Self {
        self.inner = self.inner.set_interpolation(input);
        self
    }
    /// <p>An object that specifies the interpolation type and the interval over which to interpolate data.</p>
    pub fn get_interpolation(&self) -> &::std::option::Option<crate::types::InterpolationParameters> {
        self.inner.get_interpolation()
    }
    /// <p>The string that specifies the next page of results.</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 string that specifies the next page of results.</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 string that specifies the next page of results.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_next_token()
    }
    /// <p>The maximum number of results to return at one time. The default is 25.</p>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.inner = self.inner.max_results(input);
        self
    }
    /// <p>The maximum number of results to return at one time. The default is 25.</p>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.inner = self.inner.set_max_results(input);
        self
    }
    /// <p>The maximum number of results to return at one time. The default is 25.</p>
    /// <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        self.inner.get_max_results()
    }
    /// <p>The time direction to use in the result order.</p>
    pub fn order_by_time(mut self, input: crate::types::OrderByTime) -> Self {
        self.inner = self.inner.order_by_time(input);
        self
    }
    /// <p>The time direction to use in the result order.</p>
    pub fn set_order_by_time(mut self, input: ::std::option::Option<crate::types::OrderByTime>) -> Self {
        self.inner = self.inner.set_order_by_time(input);
        self
    }
    /// <p>The time direction to use in the result order.</p>
    pub fn get_order_by_time(&self) -> &::std::option::Option<crate::types::OrderByTime> {
        self.inner.get_order_by_time()
    }
    /// <p>The ISO8601 DateTime of the earliest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn start_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.start_time(input.into());
        self
    }
    /// <p>The ISO8601 DateTime of the earliest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn set_start_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_start_time(input);
        self
    }
    /// <p>The ISO8601 DateTime of the earliest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn get_start_time(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_start_time()
    }
    /// <p>The ISO8601 DateTime of the latest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn end_time(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.end_time(input.into());
        self
    }
    /// <p>The ISO8601 DateTime of the latest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn set_end_time(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_end_time(input);
        self
    }
    /// <p>The ISO8601 DateTime of the latest property value to return.</p>
    /// <p>For more information about the ISO8601 DateTime format, see the data type <a href="https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html">PropertyValue</a>.</p>
    pub fn get_end_time(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_end_time()
    }
}