Class AlarmHistoryEntry

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.

Inheritance

object

AlarmHistoryEntry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Models

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class AlarmHistoryEntry

Properties

AlarmSummary

Declaration

[Required(ErrorMessage = "AlarmSummary is required.")]
[JsonProperty(PropertyName = "alarmSummary")]
public string AlarmSummary { get; set; }

Property Value

Type

Description

string

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 {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.

Remarks

Required

Summary

Declaration

[Required(ErrorMessage = "Summary is required.")]
[JsonProperty(PropertyName = "summary")]
public string Summary { get; set; }

Property Value

Type	Description
string	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

Remarks

Required

Timestamp

Declaration

[Required(ErrorMessage = "Timestamp is required.")]
[JsonProperty(PropertyName = "timestamp")]
public DateTime? Timestamp { get; set; }

Property Value

Type	Description
DateTime?	Timestamp for this alarm history entry. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

Remarks

Required

TimestampTriggered

Declaration

[JsonProperty(PropertyName = "timestampTriggered")]
public DateTime? TimestampTriggered { get; set; }

Property Value

Type	Description
DateTime?	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