Interface AlarmHistoryItem.Builder

    • Method Detail

      • alarmName

        AlarmHistoryItem.Builder alarmName​(String alarmName)

        The descriptive name for the alarm.

        Parameters:
        alarmName - The descriptive name for the alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • alarmContributorId

        AlarmHistoryItem.Builder alarmContributorId​(String alarmContributorId)

        The unique identifier of the alarm contributor associated with this history item, if applicable.

        Parameters:
        alarmContributorId - The unique identifier of the alarm contributor associated with this history item, if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • alarmType

        AlarmHistoryItem.Builder alarmType​(String alarmType)

        The type of alarm, either metric alarm or composite alarm.

        Parameters:
        alarmType - The type of alarm, either metric alarm or composite alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AlarmType, AlarmType
      • alarmType

        AlarmHistoryItem.Builder alarmType​(AlarmType alarmType)

        The type of alarm, either metric alarm or composite alarm.

        Parameters:
        alarmType - The type of alarm, either metric alarm or composite alarm.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AlarmType, AlarmType
      • timestamp

        AlarmHistoryItem.Builder timestamp​(Instant timestamp)

        The time stamp for the alarm history item.

        Parameters:
        timestamp - The time stamp for the alarm history item.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • historyItemType

        AlarmHistoryItem.Builder historyItemType​(String historyItemType)

        The type of alarm history item.

        Parameters:
        historyItemType - The type of alarm history item.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        HistoryItemType, HistoryItemType
      • historySummary

        AlarmHistoryItem.Builder historySummary​(String historySummary)

        A summary of the alarm history, in text format.

        Parameters:
        historySummary - A summary of the alarm history, in text format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • historyData

        AlarmHistoryItem.Builder historyData​(String historyData)

        Data about the alarm, in JSON format.

        Parameters:
        historyData - Data about the alarm, in JSON format.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • alarmContributorAttributes

        AlarmHistoryItem.Builder alarmContributorAttributes​(Map<String,​String> alarmContributorAttributes)

        A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.

        Parameters:
        alarmContributorAttributes - A map of attributes that describe the alarm contributor associated with this history item, providing context about the contributor's characteristics at the time of the event.
        Returns:
        Returns a reference to this object so that method calls can be chained together.