Interface SmartViewAssets

All Known Implementing Classes:
SmartViewAssetsImpl
public interface SmartViewAssets
Client interface for the IBX SmartView Assets API. Provides methods to list assets as a category/template/asset hierarchy, search assets, retrieve asset details and their tag points, and read current tag-point values.

  • Method Details

    • list

      AssetsList list(String accountNo, String ibx, String classification, List<String> cages)
      Lists monitored assets for the specified account/IBX as a category/template/asset hierarchy.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center
      classification - the asset classification to filter by (Electrical or Mechanical)
      cages - the list of cage unique space ids to filter by, or null for all
      Returns:
      the assets list hierarchy
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getAssetDetails

      AssetDetail getAssetDetails(String accountNo, String ibx, String classification, String assetId)
      Retrieves detailed information (including tag points) for a single monitored asset.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center
      classification - the asset classification (Electrical or Mechanical)
      assetId - the unique identifier of the asset
      Returns:
      the asset detail envelope
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getMultipleAssetDetails

      AssetDetailsResponse getMultipleAssetDetails(AssetDetailsRequest requestBody)
      Retrieves details for multiple assets using a typed request body.
      Parameters:
      requestBody - the typed request body specifying the account, IBX, classification and asset ids
      Returns:
      the multi-asset details response

    • search

      Assets search(String accountNo, String ibx, String searchString)
      Searches for monitored assets matching a wildcard search string within an account/IBX.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center
      searchString - the search term to match against asset identifiers
      Returns:
      the asset search results
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getAffectedAssets

      HierarchyNodeForAssetAPI getAffectedAssets(String accountNo, String ibx, String assetId, String classification)
      Retrieves the hierarchy of customer assets affected by a given asset.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center
      assetId - the unique identifier of the asset
      classification - the asset classification (Electrical or Mechanical)
      Returns:
      the affected-assets hierarchy
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getCurrentTagPoint

      TagPointData getCurrentTagPoint(String accountNo, String ibx, String tagId)
      Retrieves the most recent tag-point data for a given tag identifier.
      Parameters:
      accountNo - the Equinix account number (required; the service answers HTTP 400 without it)
      ibx - the IBX code identifying the data center
      tagId - the unique identifier of the tag point
      Returns:
      the current tag-point data
      Throws:
      IllegalArgumentException - if a parameter the spec marks required is null or blank

    • getMultipleCurrentTagPoints

      TagPointData getMultipleCurrentTagPoints(CurrentTagPointRequest requestBody)
      Retrieves current tag-point data for multiple tag identifiers using a typed request body.
      Parameters:
      requestBody - the typed request body specifying the account, tag ids and IBX
      Returns:
      the current tag-point data