com.oracle.bmc.monitoring.model

Class AlarmStatusSummary

java.lang.Object

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

com.oracle.bmc.monitoring.model.AlarmStatusSummary

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

A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

For information about endpoints and signing API requests, see [About the API](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdks.htm).
Note: Objects should always be created or deserialized using the AlarmStatusSummary.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 AlarmStatusSummary.Builder, which maintain a set of all explicitly set fields called AlarmStatusSummary.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	AlarmStatusSummary.Builder
static class	AlarmStatusSummary.Severity The perceived type of response required when the alarm is in the “FIRING” state.
static class	AlarmStatusSummary.Status The status of this alarm.

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
AlarmStatusSummary(String id, String displayName, AlarmStatusSummary.Severity severity, String ruleName, Date timestampTriggered, String alarmSummary, AlarmStatusSummary.Status status, Suppression suppression) Deprecated.

Method Summary

Modifier and Type	Method and Description
static AlarmStatusSummary.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getAlarmSummary() Customizable alarm summary (alarmSummary alarm message parameter).
String	getDisplayName() The configured name of the alarm.
String	getId() The OCID of the alarm.
String	getRuleName() Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides.
AlarmStatusSummary.Severity	getSeverity() The perceived type of response required when the alarm is in the “FIRING” state.
AlarmStatusSummary.Status	getStatus() The status of this alarm.
Suppression	getSuppression() The configuration details for suppressing an alarm.
Date	getTimestampTriggered() Timestamp for the transition of the alarm state.
int	hashCode()
AlarmStatusSummary.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

AlarmStatusSummary

@Deprecated
 @ConstructorProperties(value={"id","displayName","severity","ruleName","timestampTriggered","alarmSummary","status","suppression"})
public AlarmStatusSummary(String id,
                                                                                                                                                                           String displayName,
                                                                                                                                                                           AlarmStatusSummary.Severity severity,
                                                                                                                                                                           String ruleName,
                                                                                                                                                                           Date timestampTriggered,
                                                                                                                                                                           String alarmSummary,
                                                                                                                                                                           AlarmStatusSummary.Status status,
                                                                                                                                                                           Suppression suppression)

Deprecated.

Method Detail

builder

public static AlarmStatusSummary.Builder builder()

Create a new builder.

toBuilder

public AlarmStatusSummary.Builder toBuilder()

getId

public String getId()

The OCID of the alarm.

Returns:

the value

getDisplayName

public String getDisplayName()

The configured name of the alarm.

Example: High CPU Utilization

Returns:

the value

getSeverity

public AlarmStatusSummary.Severity getSeverity()

The perceived type of response required when the alarm is in the “FIRING” state.

Example: CRITICAL

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

getTimestampTriggered

public Date getTimestampTriggered()

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

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

Returns:

the value

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

getStatus

public AlarmStatusSummary.Status getStatus()

The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use retrieveDimensionStates.

Example: FIRING

Returns:

the value

getSuppression

public Suppression getSuppression()

The configuration details for suppressing an alarm.

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