Class AlarmHistoryEntry.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • alarmSummary

        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.

        Parameters:
        alarmSummary - the value to set
        Returns:
        this builder
      • summary

        public 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

        Parameters:
        summary - the value to set
        Returns:
        this builder
      • timestamp

        public AlarmHistoryEntry.Builder timestamp​(Date timestamp)
        Timestamp for this alarm history entry.

        Format defined by RFC3339.

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

        Parameters:
        timestamp - the value to set
        Returns:
        this builder
      • timestampTriggered

        public 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

        Parameters:
        timestampTriggered - the value to set
        Returns:
        this builder