software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.TumblingWindowProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.TumblingWindowProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(value=Stable)
public static interface CfnAssetModel.TumblingWindowProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 TumblingWindowProperty tumblingWindowProperty = TumblingWindowProperty.builder()
         .interval("interval")
         // the properties below are optional
         .offset("offset")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAssetModel.TumblingWindowProperty.Builder A builder for CfnAssetModel.TumblingWindowProperty
static class	CfnAssetModel.TumblingWindowProperty.Jsii$Proxy An implementation for CfnAssetModel.TumblingWindowProperty

Method Summary

Modifier and Type	Method and Description
static CfnAssetModel.TumblingWindowProperty.Builder	builder()
String	getInterval() The time interval for the tumbling window.
default String	getOffset() The offset for the tumbling window.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInterval

@Stability(value=Stable)
 @NotNull
String getInterval()

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

AWS 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 AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

getOffset

@Stability(value=Stable)
 @Nullable
default String getOffset()

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 , AWS 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 , AWS 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 , AWS 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.

builder

@Stability(value=Stable)
static CfnAssetModel.TumblingWindowProperty.Builder builder()

Returns:

a CfnAssetModel.TumblingWindowProperty.Builder of CfnAssetModel.TumblingWindowProperty