Interface TumblingWindow.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TumblingWindow.Builder,
,TumblingWindow> SdkBuilder<TumblingWindow.Builder,
,TumblingWindow> SdkPojo
- Enclosing class:
TumblingWindow
-
Method Summary
Modifier and TypeMethodDescriptionThe time interval for the tumbling window.The offset for the tumbling window.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
interval
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), the1d
interval at the end of each day at midnight (UTC), the1h
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.
- Parameters:
interval
- 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), the1d
interval at the end of each day at midnight (UTC), the1h
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
offset
The offset for the tumbling window. The
offset
parameter accepts the following:-
The offset time.
For example, if you specify
18h
foroffset
and1d
forinterval
, 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
foroffset
and1d
forinterval
, 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
foroffset
,5m
forinterval
, 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
foroffset
and1d
forinterval
, 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.
-
- Parameters:
offset
- The offset for the tumbling window. Theoffset
parameter accepts the following:-
The offset time.
For example, if you specify
18h
foroffset
and1d
forinterval
, 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
foroffset
and1d
forinterval
, 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
foroffset
,5m
forinterval
, 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
foroffset
and1d
forinterval
, 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.
-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-