Class SmartViewAssetsImpl

java.lang.Object

com.eqixiac.equinix.ibxsmartview.client.implementation.SmartViewAssetsImpl

All Implemented Interfaces:

SmartViewAssets

public class SmartViewAssetsImpl
extends Object
implements SmartViewAssets

Constructor Summary

Constructors

Constructor	Description
SmartViewAssetsImpl()

Method Summary

Modifier and Type	Method	Description
HierarchyNodeForAssetAPI	getAffectedAssets(String accountNo, String ibx, String assetId, String classification)	Retrieves the hierarchy of customer assets affected by a given asset.
AssetDetail	getAssetDetails(String accountNo, String ibx, String classification, String assetId)	Retrieves detailed information (including tag points) for a single monitored asset.
TagPointData	getCurrentTagPoint(String accountNo, String ibx, String tagId)	Retrieves the most recent tag-point data for a given tag identifier.
AssetDetailsResponse	getMultipleAssetDetails(AssetDetailsRequest requestBody)	Retrieves details for multiple assets using a typed request body.
TagPointData	getMultipleCurrentTagPoints(CurrentTagPointRequest requestBody)	Retrieves current tag-point data for multiple tag identifiers using a typed request body.
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.
Assets	search(String accountNo, String ibx, String searchString)	Searches for monitored assets matching a wildcard search string within an account/IBX.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SmartViewAssetsImpl

public SmartViewAssetsImpl()

Method Details

list

public AssetsList list(String accountNo,
 String ibx,
 String classification,
 List<String> cages)

Description copied from interface: SmartViewAssets

Lists monitored assets for the specified account/IBX as a category/template/asset hierarchy.

Specified by:

list in interface SmartViewAssets

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

getAssetDetails

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

Description copied from interface: SmartViewAssets

Retrieves detailed information (including tag points) for a single monitored asset.

Specified by:

getAssetDetails in interface SmartViewAssets

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

getMultipleAssetDetails

public AssetDetailsResponse getMultipleAssetDetails(AssetDetailsRequest requestBody)

Description copied from interface: SmartViewAssets

Retrieves details for multiple assets using a typed request body.

Specified by:

getMultipleAssetDetails in interface SmartViewAssets

Parameters:

requestBody - the typed request body specifying the account, IBX, classification and asset ids

Returns:

the multi-asset details response

search

public Assets search(String accountNo,
 String ibx,
 String searchString)

Description copied from interface: SmartViewAssets

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

Specified by:

search in interface SmartViewAssets

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

getAffectedAssets

public HierarchyNodeForAssetAPI getAffectedAssets(String accountNo,
 String ibx,
 String assetId,
 String classification)

Description copied from interface: SmartViewAssets

Retrieves the hierarchy of customer assets affected by a given asset.

Specified by:

getAffectedAssets in interface SmartViewAssets

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

getCurrentTagPoint

public TagPointData getCurrentTagPoint(String accountNo,
 String ibx,
 String tagId)

Description copied from interface: SmartViewAssets

Retrieves the most recent tag-point data for a given tag identifier.

Specified by:

getCurrentTagPoint in interface SmartViewAssets

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

getMultipleCurrentTagPoints

public TagPointData getMultipleCurrentTagPoints(CurrentTagPointRequest requestBody)

Description copied from interface: SmartViewAssets

Retrieves current tag-point data for multiple tag identifiers using a typed request body.

Specified by:

getMultipleCurrentTagPoints in interface SmartViewAssets

Parameters:

requestBody - the typed request body specifying the account, tag ids and IBX

Returns:

the current tag-point data