Class AlarmDimensionStatesEntry


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20180401")
    public final class AlarmDimensionStatesEntry
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A timestamped alarm state entry for a metric stream.
    Note: Objects should always be created or deserialized using the AlarmDimensionStatesEntry.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AlarmDimensionStatesEntry.Builder, which maintain a set of all explicitly set fields called AlarmDimensionStatesEntry.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).
    • Method Detail

      • getAlarmSummary

        public String getAlarmSummary()
        Customizable alarm summary (alarmSummary alarm message parameter).

        Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to listAlarmsStatus getAlarmHistory and retrieveDimensionStates.

        Returns:
        the value
      • getDimensions

        public Map<String,​String> getDimensions()
        Indicator of the metric stream associated with the alarm state entry.

        Includes one or more dimension key-value pairs.

        Returns:
        the value
      • getStatus

        public AlarmDimensionStatesEntry.Status getStatus()
        Transition state (status value) associated with the alarm state entry.

        Example: FIRING

        Returns:
        the value
      • getRuleName

        public String getRuleName()
        Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides.

        Default value is BASE. For information about alarm overrides, see alarmOverride.

        Returns:
        the value
      • getTimestamp

        public Date getTimestamp()
        Transition time associated with the alarm state entry.

        Format defined by RFC3339.

        Example: 2022-02-01T01:02:29.600Z

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel