Class AlarmSummary

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

Contains a summary of an alarm.

See Also:

  • Method Details

    • alarmModelName

      public final String alarmModelName()

      The name of the alarm model.

      Returns:
      The name of the alarm model.

    • alarmModelVersion

      public final String alarmModelVersion()

      The version of the alarm model.

      Returns:
      The version of the alarm model.

    • keyValue

      public final String keyValue()

      The value of the key used as a filter to select only the alarms associated with the key.

      Returns:
      The value of the key used as a filter to select only the alarms associated with the key.

    • stateName

      public final AlarmStateName stateName()

      The name of the alarm state. The state name can be one of the following values:

      • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

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

      Returns:
      The name of the alarm state. The state name can be one of the following values:

      • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

      See Also:

    • stateNameAsString

      public final String stateNameAsString()

      The name of the alarm state. The state name can be one of the following values:

      • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

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

      Returns:
      The name of the alarm state. The state name can be one of the following values:

      • DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

      See Also:

    • creationTime

      public final Instant creationTime()

      The time the alarm was created, in the Unix epoch format.

      Returns:
      The time the alarm was created, in the Unix epoch format.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The time the alarm was last updated, in the Unix epoch format.

      Returns:
      The time the alarm was last updated, in the Unix epoch format.

    • toBuilder

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

    • builder

      public static AlarmSummary.Builder builder()

    • serializableBuilderClass

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