Interface PowerAlertConfiguration

All Known Implementing Classes:
PowerAlertConfigurationJson
public interface PowerAlertConfiguration
Read-only model representing a power alert configuration returned by the IBX SmartView power-events API. A power alert configuration defines the condition (event type and threshold) that triggers an alert, the recipients to notify, and the assets being monitored, scoped by level type (CAGE, CABINET, or CIRCUIT).

  • Method Details

    • getAlertConfigurationUid

      String getAlertConfigurationUid()
      Returns the unique identifier of the alert configuration.
      Returns:
      the alert configuration UID

    • getIbx

      String getIbx()
      Returns the IBX code associated with the alert configuration.
      Returns:
      the IBX code

    • getState

      AlertConfigurationState getState()
      Returns the current state of the alert configuration (e.g. ACTIVE, PAUSED, DELETED).
      Returns:
      the configuration state

    • getSection

      String getSection()
      Returns the section type of the alert configuration (e.g. POWER).
      Returns:
      the section type

    • getSource

      String getSource()
      Returns the source system that created the configuration.
      Returns:
      the source

    • getCondition

      PowerAlertCondition getCondition()
      Returns the condition that triggers the alert.
      Returns:
      the alert condition

    • getRecipients

      List<PowerAlertRecipient> getRecipients()
      Returns the list of configured notification recipients.
      Returns:
      the recipients

    • getCreator

      PowerAlertCreator getCreator()
      Returns information about the user who created the configuration.
      Returns:
      the creator information

    • getCreatedOn

      String getCreatedOn()
      Returns the timestamp at which the configuration was created.
      Returns:
      the creation timestamp

    • getUpdatedOn

      String getUpdatedOn()
      Returns the timestamp at which the configuration was last updated.
      Returns:
      the last-updated timestamp

    • getAssets

      Map<String, List<PowerAlertConfigurationAsset>> getAssets()
      Returns the assets being monitored, keyed by level type (CAGE, CABINET, CIRCUIT).
      Returns:
      the monitored assets keyed by level type