com.oracle.bmc.monitoring.model

Class AlarmHistoryEntry

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.monitoring.model.AlarmHistoryEntry

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180401")
public final class AlarmHistoryEntry
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.
Note: Objects should always be created or deserialized using the AlarmHistoryEntry.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 AlarmHistoryEntry.Builder, which maintain a set of all explicitly set fields called AlarmHistoryEntry.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlarmHistoryEntry.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AlarmHistoryEntry(String alarmSummary, String summary, Date timestamp, Date timestampTriggered) Deprecated.

Method Summary

Modifier and Type	Method and Description
static AlarmHistoryEntry.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getAlarmSummary() Customizable alarm summary (alarmSummary alarm message parameter).
String	getSummary() Description for this alarm history entry.
Date	getTimestamp() Timestamp for this alarm history entry.
Date	getTimestampTriggered() Timestamp for the transition of the alarm state.
int	hashCode()
AlarmHistoryEntry.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlarmHistoryEntry

@Deprecated
 @ConstructorProperties(value={"alarmSummary","summary","timestamp","timestampTriggered"})
public AlarmHistoryEntry(String alarmSummary,
                                                                                                                                String summary,
                                                                                                                                Date timestamp,
                                                                                                                                Date timestampTriggered)

Deprecated.

Method Detail

builder

public static AlarmHistoryEntry.Builder builder()

Create a new builder.

toBuilder

public AlarmHistoryEntry.Builder toBuilder()

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

getSummary

public String getSummary()

Description for this alarm history entry.

Example 1 - alarm state history entry: The alarm state is FIRING

Example 2 - alarm state transition history entry: State transitioned from OK to Firing

Returns:

the value

getTimestamp

public Date getTimestamp()

Timestamp for this alarm history entry. Format defined by RFC3339.

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

Returns:

the value

getTimestampTriggered

public Date getTimestampTriggered()

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.

Example: 2023-02-01T0:59:00.789Z

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