Interface LegacyEnvironmentals

All Known Implementing Classes:

LegacyEnvironmentalsImpl

public interface LegacyEnvironmentals

Client interface for accessing legacy IBX SmartView environmental data. Provides methods to retrieve current and trending environmental measurements such as temperature and humidity at various hierarchy levels within an IBX.

Method Summary

Modifier and Type	Method	Description
EnvironmentData	getCurrent(String accountNo, String ibx, String levelType, String levelValue)	Retrieves the current environmental data for a specific hierarchy level and value.
TrendingEnvironmentData	getTrending(String accountNo, String ibx, String dataPoint, String levelType, String levelValue, String interval, String fromDate, String toDate)	Retrieves trending environmental data over a specified time range and interval.
List<EnvironmentDataForArray>	listCurrent(String accountNo, String ibx, String levelType)	Lists current environmental data for all entries at the specified hierarchy level.

Method Details

getCurrent

EnvironmentData getCurrent(String accountNo,
 String ibx,
 String levelType,
 String levelValue)

Retrieves the current environmental data for a specific hierarchy level and value.

Parameters:

accountNo - the Equinix account number (required; the service answers HTTP 400 without it)

ibx - the IBX code identifying the data center

levelType - the hierarchy level type (e.g., cage, cabinet)

levelValue - the specific value for the hierarchy level

Returns:

the current environmental data

Throws:

IllegalArgumentException - if a parameter the spec marks required is null or blank

listCurrent

List<EnvironmentDataForArray> listCurrent(String accountNo,
 String ibx,
 String levelType)

Lists current environmental data for all entries at the specified hierarchy level.

Parameters:

accountNo - the Equinix account number (required; the service answers HTTP 400 without it)

ibx - the IBX code identifying the data center

levelType - the hierarchy level type (e.g., cage, cabinet)

Returns:

a list of current environmental data entries

Throws:

IllegalArgumentException - if a parameter the spec marks required is null or blank

getTrending

TrendingEnvironmentData getTrending(String accountNo,
 String ibx,
 String dataPoint,
 String levelType,
 String levelValue,
 String interval,
 String fromDate,
 String toDate)

Retrieves trending environmental data over a specified time range and interval.

Parameters:

accountNo - the Equinix account number (required; the service answers HTTP 400 without it)

ibx - the IBX code identifying the data center

dataPoint - the environmental data point to trend (e.g., temperature, humidity)

levelType - the hierarchy level type (e.g., cage, cabinet)

levelValue - the specific value for the hierarchy level

interval - the aggregation interval for trend data

fromDate - the start date of the trend range

toDate - the end date of the trend range

Returns:

the trending environmental data

Throws:

IllegalArgumentException - if a parameter the spec marks required is null or blank