Struct aws_sdk_iottwinmaker::client::fluent_builders::GetPropertyValueHistory

pub struct GetPropertyValueHistory { /* private fields */ }

Fluent builder constructing a request to GetPropertyValueHistory.

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

Implementations

impl GetPropertyValueHistory

pub async fn send(
    self
) -> Result<GetPropertyValueHistoryOutput, SdkError<GetPropertyValueHistoryError>>

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, which can be set when configuring the client.

pub fn into_paginator(self) -> GetPropertyValueHistoryPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn workspace_id(self, input: impl Into<String>) -> Self

The ID of the workspace.

pub fn set_workspace_id(self, input: Option<String>) -> Self

The ID of the workspace.

pub fn entity_id(self, input: impl Into<String>) -> Self

The ID of the entity.

pub fn set_entity_id(self, input: Option<String>) -> Self

The ID of the entity.

pub fn component_name(self, input: impl Into<String>) -> Self

The name of the component.

pub fn set_component_name(self, input: Option<String>) -> Self

The name of the component.

pub fn component_type_id(self, input: impl Into<String>) -> Self

The ID of the component type.

pub fn set_component_type_id(self, input: Option<String>) -> Self

The ID of the component type.

pub fn selected_properties(self, input: impl Into<String>) -> Self

Appends an item to selectedProperties.

To override the contents of this collection use set_selected_properties.

A list of properties whose value histories the request retrieves.

pub fn set_selected_properties(self, input: Option<Vec<String>>) -> Self

A list of properties whose value histories the request retrieves.

pub fn property_filters(self, input: PropertyFilter) -> Self

Appends an item to propertyFilters.

To override the contents of this collection use set_property_filters.

A list of objects that filter the property value history request.

pub fn set_property_filters(self, input: Option<Vec<PropertyFilter>>) -> Self

A list of objects that filter the property value history request.

pub fn start_date_time(self, input: DateTime) -> Self

The date and time of the earliest property value to return.

pub fn set_start_date_time(self, input: Option<DateTime>) -> Self

The date and time of the earliest property value to return.

pub fn end_date_time(self, input: DateTime) -> Self

The date and time of the latest property value to return.

pub fn set_end_date_time(self, input: Option<DateTime>) -> Self

The date and time of the latest property value to return.

pub fn interpolation(self, input: InterpolationParameters) -> Self

An object that specifies the interpolation type and the interval over which to interpolate data.

pub fn set_interpolation(self, input: Option<InterpolationParameters>) -> Self

An object that specifies the interpolation type and the interval over which to interpolate data.

pub fn next_token(self, input: impl Into<String>) -> Self

The string that specifies the next page of results.

pub fn set_next_token(self, input: Option<String>) -> Self

The string that specifies the next page of results.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return.

pub fn order_by_time(self, input: OrderByTime) -> Self

The time direction to use in the result order.

pub fn set_order_by_time(self, input: Option<OrderByTime>) -> Self

The time direction to use in the result order.

pub fn start_time(self, input: impl Into<String>) -> Self

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

pub fn set_start_time(self, input: Option<String>) -> Self

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

pub fn end_time(self, input: impl Into<String>) -> Self

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

pub fn set_end_time(self, input: Option<String>) -> Self

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

Trait Implementations

impl Clone for GetPropertyValueHistory

fn clone(&self) -> GetPropertyValueHistory

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetPropertyValueHistory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.