com.oracle.bmc.monitoring.model

Class AlarmStatusSummary.Builder

java.lang.Object

com.oracle.bmc.monitoring.model.AlarmStatusSummary.Builder

Enclosing class:

AlarmStatusSummary

public static class AlarmStatusSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AlarmStatusSummary.Builder	alarmSummary(String alarmSummary) Customizable alarm summary (alarmSummary alarm message parameter).
AlarmStatusSummary	build()
AlarmStatusSummary.Builder	copy(AlarmStatusSummary model)
AlarmStatusSummary.Builder	displayName(String displayName) The configured name of the alarm.
AlarmStatusSummary.Builder	id(String id) The OCID of the alarm.
AlarmStatusSummary.Builder	ruleName(String ruleName) Identifier of the alarm’s base values for alarm evaluation, for use when the alarm contains overrides.
AlarmStatusSummary.Builder	severity(AlarmStatusSummary.Severity severity) The perceived type of response required when the alarm is in the “FIRING” state.
AlarmStatusSummary.Builder	status(AlarmStatusSummary.Status status) The status of this alarm.
AlarmStatusSummary.Builder	suppression(Suppression suppression) The configuration details for suppressing an alarm.
AlarmStatusSummary.Builder	timestampTriggered(Date timestampTriggered) Timestamp for the transition of the alarm state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public AlarmStatusSummary.Builder id(String id)

The OCID of the alarm.

Parameters:

id - the value to set

Returns:

this builder

displayName

public AlarmStatusSummary.Builder displayName(String displayName)

The configured name of the alarm.

Example: High CPU Utilization

Parameters:

displayName - the value to set

Returns:

this builder

severity

public AlarmStatusSummary.Builder severity(AlarmStatusSummary.Severity severity)

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

Example: CRITICAL

Parameters:

severity - the value to set

Returns:

this builder

ruleName

public AlarmStatusSummary.Builder ruleName(String ruleName)

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.

Parameters:

ruleName - the value to set

Returns:

this builder

timestampTriggered

public AlarmStatusSummary.Builder timestampTriggered(Date timestampTriggered)

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

Parameters:

timestampTriggered - the value to set

Returns:

this builder

alarmSummary

public AlarmStatusSummary.Builder alarmSummary(String alarmSummary)

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.

Parameters:

alarmSummary - the value to set

Returns:

this builder

status

public AlarmStatusSummary.Builder status(AlarmStatusSummary.Status status)

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

Parameters:

status - the value to set

Returns:

this builder

suppression

public AlarmStatusSummary.Builder suppression(Suppression suppression)

The configuration details for suppressing an alarm.

Parameters:

suppression - the value to set

Returns:

this builder

build

public AlarmStatusSummary build()

copy

public AlarmStatusSummary.Builder copy(AlarmStatusSummary model)