Class AlarmHistoryItem

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

Represents the history of a specific alarm.

See Also:

  • Method Details

    • alarmName

      public final String alarmName()

      The descriptive name for the alarm.

      Returns:
      The descriptive name for the alarm.

    • alarmType

      public final AlarmType alarmType()

      The type of alarm, either metric alarm or composite alarm.

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

      Returns:
      The type of alarm, either metric alarm or composite alarm.
      See Also:

    • alarmTypeAsString

      public final String alarmTypeAsString()

      The type of alarm, either metric alarm or composite alarm.

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

      Returns:
      The type of alarm, either metric alarm or composite alarm.
      See Also:

    • timestamp

      public final Instant timestamp()

      The time stamp for the alarm history item.

      Returns:
      The time stamp for the alarm history item.

    • historyItemType

      public final HistoryItemType historyItemType()

      The type of alarm history item.

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

      Returns:
      The type of alarm history item.
      See Also:

    • historyItemTypeAsString

      public final String historyItemTypeAsString()

      The type of alarm history item.

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

      Returns:
      The type of alarm history item.
      See Also:

    • historySummary

      public final String historySummary()

      A summary of the alarm history, in text format.

      Returns:
      A summary of the alarm history, in text format.

    • historyData

      public final String historyData()

      Data about the alarm, in JSON format.

      Returns:
      Data about the alarm, in JSON format.

    • toBuilder

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

    • builder

      public static AlarmHistoryItem.Builder builder()

    • serializableBuilderClass

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