Class AlertCondition

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

The condition that determines when the alert fires.

On UpdateAlert a supplied condition is replaced whole, not merged: an omitted warningThreshold or criticalThreshold removes that tier, and an omitted thresholdField clears it. A condition must keep at least one tier. thresholdMode and comparator are optional at the Smithy level (so a single-tier condition is expressible) but are required whenever a threshold is present; enforced by the service-side validator.

See Also:

  • Method Details

    • thresholdMode

      public final ThresholdMode thresholdMode()

      How the threshold is applied to query results.

      If the service returns an enum value that is not available in the current SDK version, thresholdMode will return ThresholdMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdModeAsString().

      Returns:
      How the threshold is applied to query results.
      See Also:

    • thresholdModeAsString

      public final String thresholdModeAsString()

      How the threshold is applied to query results.

      If the service returns an enum value that is not available in the current SDK version, thresholdMode will return ThresholdMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thresholdModeAsString().

      Returns:
      How the threshold is applied to query results.
      See Also:

    • thresholdField

      public final String thresholdField()

      The field the threshold is evaluated against.

      Returns:
      The field the threshold is evaluated against.

    • comparator

      public final Comparator comparator()

      The comparison operator applied to the threshold.

      If the service returns an enum value that is not available in the current SDK version, comparator will return Comparator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparatorAsString().

      Returns:
      The comparison operator applied to the threshold.
      See Also:

    • comparatorAsString

      public final String comparatorAsString()

      The comparison operator applied to the threshold.

      If the service returns an enum value that is not available in the current SDK version, comparator will return Comparator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparatorAsString().

      Returns:
      The comparison operator applied to the threshold.
      See Also:

    • warningThreshold

      public final Double warningThreshold()

      The value at which the alert enters the WARNING state.

      Returns:
      The value at which the alert enters the WARNING state.

    • criticalThreshold

      public final Double criticalThreshold()

      The value at which the alert enters the CRITICAL state.

      Returns:
      The value at which the alert enters the CRITICAL state.

    • toBuilder

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

    • builder

      public static AlertCondition.Builder builder()

    • serializableBuilderClass

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