Package api.equinix.javasdk.ibxsmartview.client

Interface SmartViewAssets

All Known Implementing Classes:

SmartViewAssetsImpl

public interface SmartViewAssets

Client interface for managing IBX SmartView monitored assets. Provides methods to list, search, and retrieve details for infrastructure assets such as cooling units and power distribution equipment, as well as their associated tag point data.

Method Summary

Modifier and Type	Method	Description
TagPointData	getAffectedAssets(String accountNo, String ibx)	Retrieves tag point data for assets affected by active alerts in the specified IBX.
AssetDetail	getAssetDetails(String accountNo, String ibx, String classification, String assetId)	Retrieves detailed information for a specific monitored asset.
TagPointData	getCurrentTagPoint(String accountNo, String ibx)	Retrieves the current tag point data for a specified IBX.
List<AssetDetail>	getMultipleAssetDetails(Object requestBody)	Retrieves details for multiple assets using a structured request body.
List<TagPointData>	getMultipleCurrentTagPoints(Object requestBody)	Retrieves current tag point data for multiple assets using a structured request body.
PaginatedList<SmartViewAsset>	list(String accountNo, String ibx, String classification, List<String> cages)	Lists monitored assets for the specified IBX, optionally filtered by classification and cages.
PaginatedList<SmartViewAsset>	search(String accountNo, String ibx, String searchString)	Searches for monitored assets matching a search string within an IBX.

Method Details

list

PaginatedList<SmartViewAsset> list(String accountNo,
 String ibx,
 String classification,
 List<String> cages)

Lists monitored assets for the specified IBX, optionally filtered by classification and cages.

Parameters:

accountNo - the Equinix account number

ibx - the IBX code identifying the data center

classification - the asset classification to filter by

cages - the list of cage identifiers to filter by

Returns:

a paginated list of SmartView assets

getAssetDetails

AssetDetail getAssetDetails(String accountNo,
 String ibx,
 String classification,
 String assetId)

Retrieves detailed information for a specific monitored asset.

Parameters:

accountNo - the Equinix account number

ibx - the IBX code identifying the data center

classification - the asset classification

assetId - the unique identifier of the asset

Returns:

the asset detail

getMultipleAssetDetails

List<AssetDetail> getMultipleAssetDetails(Object requestBody)

Retrieves details for multiple assets using a structured request body.

Parameters:

requestBody - the request body specifying the assets to query

Returns:

a list of asset details

search

PaginatedList<SmartViewAsset> search(String accountNo,
 String ibx,
 String searchString)

Searches for monitored assets matching a search string within an IBX.

Parameters:

accountNo - the Equinix account number

ibx - the IBX code identifying the data center

searchString - the search term to match against asset names or attributes

Returns:

a paginated list of matching SmartView assets

getAffectedAssets

TagPointData getAffectedAssets(String accountNo,
 String ibx)

Retrieves tag point data for assets affected by active alerts in the specified IBX.

Parameters:

accountNo - the Equinix account number

ibx - the IBX code identifying the data center

Returns:

the tag point data for affected assets

getCurrentTagPoint

TagPointData getCurrentTagPoint(String accountNo,
 String ibx)

Retrieves the current tag point data for a specified IBX.

Parameters:

accountNo - the Equinix account number

ibx - the IBX code identifying the data center

Returns:

the current tag point data

getMultipleCurrentTagPoints

List<TagPointData> getMultipleCurrentTagPoints(Object requestBody)

Retrieves current tag point data for multiple assets using a structured request body.

Parameters:

requestBody - the request body specifying the assets to query

Returns:

a list of tag point data entries