Interface PowerEvents

All Known Implementing Classes:
PowerEventsImpl
public interface PowerEvents
Client interface for the IBX SmartView power-events API (/dcim/v3/powerEvents). Provides methods to search power events raised against monitored power assets and to manage power alert configurations, including create, search, update, pause, resume, and delete operations.

  • Method Details

    • search

      PaginatedList<PowerEvent> search(List<String> ibx, List<String> status, String edgeCollectedOn, int offset, int limit)
      Searches power events matching the specified filters.
      Parameters:
      ibx - the list of IBX codes to filter by, or null for all
      status - the list of statuses to filter by (e.g. ACTIVE, INACTIVE), or null for all
      edgeCollectedOn - an ISO-8601 date to retrieve events collected after a specific date, or null for all
      offset - the zero-based record offset for pagination
      limit - the maximum number of records to retrieve per request
      Returns:
      a paginated list of matching power events

    • defineAlertConfiguration

      PowerAlertConfigurationOperator.PowerAlertConfigurationBuilder defineAlertConfiguration()
      Returns a builder for defining and creating a new power alert configuration.
      Returns:
      a power alert configuration builder

    • searchAlertConfigurations

      PaginatedList<PowerAlertConfiguration> searchAlertConfigurations(List<String> ibx, List<String> state, int offset, int limit)
      Searches power alert configurations matching the specified filters.
      Parameters:
      ibx - the list of IBX codes to filter by, or null for all
      state - the list of states to filter by (e.g. ACTIVE, PAUSED, DELETED), or null for all
      offset - the zero-based record offset for pagination
      limit - the maximum number of records to retrieve per request
      Returns:
      a paginated list of matching power alert configurations

    • updateAlertConfiguration

      PowerAlertConfigurationOperator.PowerAlertConfigurationUpdateBuilder updateAlertConfiguration(String alertConfigurationUid)
      Returns a builder for updating an existing power alert configuration. The alertConfigurationUid identifies the configuration to update.
      Parameters:
      alertConfigurationUid - the unique identifier of the power alert configuration to update
      Returns:
      a power alert configuration update builder

    • pauseAlertConfiguration

      void pauseAlertConfiguration(String alertConfigurationUid)
      Pauses an active power alert configuration so that it stops triggering new alerts until resumed.
      Parameters:
      alertConfigurationUid - the unique identifier of the power alert configuration to pause

    • resumeAlertConfiguration

      void resumeAlertConfiguration(String alertConfigurationUid)
      Resumes a previously paused power alert configuration, returning it to the ACTIVE state.
      Parameters:
      alertConfigurationUid - the unique identifier of the power alert configuration to resume

    • deleteAlertConfiguration

      void deleteAlertConfiguration(String alertConfigurationUid)
      Permanently deletes a power alert configuration. Deleted configurations cannot be recovered.
      Parameters:
      alertConfigurationUid - the unique identifier of the power alert configuration to delete