Class TumblingWindow

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.TumblingWindow
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TumblingWindow.Builder,TumblingWindow>
@Generated("software.amazon.awssdk:codegen") public final class TumblingWindow extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TumblingWindow.Builder,TumblingWindow>

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.

See Also:

  • Method Details

    • interval

      public final String 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), 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.

      Returns:
      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

      public final String offset()

      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.

      Returns:
      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.

    • toBuilder

      public TumblingWindow.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TumblingWindow.Builder,TumblingWindow>
      Returns:
      a builder for type T

    • builder

      public static TumblingWindow.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TumblingWindow.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.