Interface Hierarchy

All Known Implementing Classes:
HierarchyImpl
public interface Hierarchy
Client interface for retrieving IBX SmartView hierarchy structures. Provides methods to obtain the location and power hierarchy trees for an IBX, which define the organizational structure of cages, cabinets, sensors and power circuits.

Both endpoints return a top-level array of recursive nodes, each describing one level of the hierarchy and its children.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<HierarchyNode>
    getLocationHierarchy(String accountNo, String ibx)
    Retrieves the location hierarchy for an account/IBX, returned as a tree of recursive nodes spanning ibx, zone, cage, cabinet and sensor levels.
    List<PowerHierarchyNode>
    getPowerHierarchy(String accountNo, String ibx)
    Retrieves the power hierarchy for an account/IBX, returned as a tree of recursive nodes spanning ibx, cage, cabinet and circuit levels.

  • Method Details

    • getLocationHierarchy

      List<HierarchyNode> getLocationHierarchy(String accountNo, String ibx)
      Retrieves the location hierarchy for an account/IBX, returned as a tree of recursive nodes spanning ibx, zone, cage, cabinet and sensor levels.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center (optional; may be null for all entitled IBXs)
      Returns:
      the top-level location hierarchy nodes
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getPowerHierarchy

      List<PowerHierarchyNode> getPowerHierarchy(String accountNo, String ibx)
      Retrieves the power hierarchy for an account/IBX, returned as a tree of recursive nodes spanning ibx, cage, cabinet and circuit levels.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center (optional; may be null for all entitled IBXs)
      Returns:
      the top-level power hierarchy nodes
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank