Struct TimeSeriesSummary 

#[non_exhaustive]
pub struct TimeSeriesSummary {
    pub asset_id: Option<String>,
    pub property_id: Option<String>,
    pub alias: Option<String>,
    pub time_series_id: String,
    pub data_type: PropertyDataType,
    pub data_type_spec: Option<String>,
    pub time_series_creation_date: DateTime,
    pub time_series_last_update_date: DateTime,
    pub time_series_arn: String,
}

Contains a summary of a time series (data stream).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

asset_id: Option<String>

The ID of the asset in which the asset property was created.

property_id: Option<String>

The ID of the asset property, in UUID format.

alias: Option<String>

The alias that identifies the time series.

time_series_id: String

The ID of the time series.

data_type: PropertyDataType

The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

data_type_spec: Option<String>

The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

time_series_creation_date: DateTime

The date that the time series was created, in Unix epoch time.

time_series_last_update_date: DateTime

The date that the time series was last updated, in Unix epoch time.

time_series_arn: String

The ARN of the time series, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

Implementations

impl TimeSeriesSummary

pub fn asset_id(&self) -> Option<&str>

The ID of the asset in which the asset property was created.

pub fn property_id(&self) -> Option<&str>

The ID of the asset property, in UUID format.

pub fn alias(&self) -> Option<&str>

The alias that identifies the time series.

pub fn time_series_id(&self) -> &str

The ID of the time series.

pub fn data_type(&self) -> &PropertyDataType

The data type of the time series.

If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this time series.

pub fn data_type_spec(&self) -> Option<&str>

The data type of the structure for this time series. This parameter is required for time series that have the STRUCT data type.

The options for this parameter depend on the type of the composite model in which you created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm composite models.

pub fn time_series_creation_date(&self) -> &DateTime

The date that the time series was created, in Unix epoch time.

pub fn time_series_last_update_date(&self) -> &DateTime

The date that the time series was last updated, in Unix epoch time.

pub fn time_series_arn(&self) -> &str

The ARN of the time series, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}

impl TimeSeriesSummary

pub fn builder() -> TimeSeriesSummaryBuilder

Creates a new builder-style object to manufacture TimeSeriesSummary.

Trait Implementations

impl Clone for TimeSeriesSummary

fn clone(&self) -> TimeSeriesSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimeSeriesSummary

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

Formats the value using the given formatter.

impl PartialEq for TimeSeriesSummary

fn eq(&self, other: &TimeSeriesSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TimeSeriesSummary