Struct aws_sdk_iotsitewise::types::TumblingWindow

#[non_exhaustive]
pub struct TumblingWindow {
    pub interval: String,
    pub offset: Option<String>,
}

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.

You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, h represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset.

The interval and offset parameters support the ISO 8601 format. For example, PT5S represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.

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.

interval: String

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

offset: Option<String>

The offset for the tumbling window. The offset parameter accepts the following:

• The offset time.

  For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

• The ISO 8601 format.

  For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

• The 24-hour clock.

  For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

• The offset time zone.

  For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.

  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

Implementations

impl TumblingWindow

pub fn interval(&self) -> &str

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval.

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

The offset for the tumbling window. The offset parameter accepts the following:

• The offset time.

  For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

• The ISO 8601 format.

  For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.

  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.

• The 24-hour clock.

  For example, if you specify 00:03:00 for offset, 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

• The offset time zone.

  For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.

  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

impl TumblingWindow

pub fn builder() -> TumblingWindowBuilder

Creates a new builder-style object to manufacture TumblingWindow.

Trait Implementations

impl Clone for TumblingWindow

fn clone(&self) -> TumblingWindow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TumblingWindow

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

Formats the value using the given formatter.

impl PartialEq for TumblingWindow

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for TumblingWindow