Class EvaluationWindow

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

The evaluation window that an alarm uses to select the range of metric data that it evaluates each time it runs. This is a union type. Set exactly one of its members, SlidingWindow or WallClockWindow. If you don't set EvaluationWindow, the alarm uses a SlidingWindow by default.

For more information, see Alarm evaluation windows in the CloudWatch User Guide.

See Also:

  • Method Details

    • wallClockWindow

      public final WallClockWindow wallClockWindow()

      A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

      Returns:
      A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

    • slidingWindow

      public final SlidingWindow slidingWindow()

      A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

      Returns:
      A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

    • toBuilder

      public EvaluationWindow.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<EvaluationWindow.Builder,EvaluationWindow>
      Returns:
      a builder for type T

    • builder

      public static EvaluationWindow.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EvaluationWindow.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)

    • fromWallClockWindow

      public static EvaluationWindow fromWallClockWindow(WallClockWindow wallClockWindow)
      Create an instance of this class with wallClockWindow() initialized to the given value.

      A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

      Parameters:
      wallClockWindow - A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

    • fromWallClockWindow

      public static EvaluationWindow fromWallClockWindow(Consumer<WallClockWindow.Builder> wallClockWindow)
      Create an instance of this class with wallClockWindow() initialized to the given value.

      A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

      Parameters:
      wallClockWindow - A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm's period, such as the top of the hour, midnight, or the start of the calendar week.

    • fromSlidingWindow

      public static EvaluationWindow fromSlidingWindow(SlidingWindow slidingWindow)
      Create an instance of this class with slidingWindow() initialized to the given value.

      A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

      Parameters:
      slidingWindow - A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

    • fromSlidingWindow

      public static EvaluationWindow fromSlidingWindow(Consumer<SlidingWindow.Builder> slidingWindow)
      Create an instance of this class with slidingWindow() initialized to the given value.

      A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

      Parameters:
      slidingWindow - A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window.

    • type

      public EvaluationWindow.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be EvaluationWindow.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be EvaluationWindow.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.