public static class AlarmHistoryEntry.Builder extends Object
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
AlarmHistoryEntry.Builder |
alarmSummary(String alarmSummary)
Customizable alarm summary (
alarmSummary alarm message
parameter). |
AlarmHistoryEntry |
build() |
AlarmHistoryEntry.Builder |
copy(AlarmHistoryEntry model) |
AlarmHistoryEntry.Builder |
summary(String summary)
Description for this alarm history entry.
|
AlarmHistoryEntry.Builder |
timestamp(Date timestamp)
Timestamp for this alarm history entry.
|
AlarmHistoryEntry.Builder |
timestampTriggered(Date timestampTriggered)
Timestamp for the transition of the alarm state.
|
public AlarmHistoryEntry.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
.
alarmSummary
- the value to setpublic AlarmHistoryEntry.Builder summary(String summary)
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
summary
- the value to setpublic AlarmHistoryEntry.Builder timestamp(Date timestamp)
Timestamp for this alarm history entry. Format defined by RFC3339.
Example: 2023-02-01T01:02:29.600Z
timestamp
- the value to setpublic AlarmHistoryEntry.Builder timestampTriggered(Date timestampTriggered)
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
timestampTriggered
- the value to setpublic AlarmHistoryEntry build()
public AlarmHistoryEntry.Builder copy(AlarmHistoryEntry model)
Copyright © 2016–2024. All rights reserved.