Interface Environmentals
- All Known Implementing Classes:
EnvironmentalsImpl
public interface Environmentals
Client interface for accessing IBX SmartView environmental sensor data. Provides methods
to list and retrieve temperature, humidity, and other environmental sensor readings
within an Equinix IBX data center.
-
Method Summary
Modifier and TypeMethodDescriptiongetSensorReading(String ibx, String sensorId) Retrieves a specific environmental sensor reading by sensor identifier.Lists all environmental sensor readings for the specified IBX.Lists environmental sensor readings for the specified IBX, narrowed by sensor data type and zone and paged by offset/limit.
-
Method Details
-
list
Lists all environmental sensor readings for the specified IBX.- Parameters:
ibx- the IBX code identifying the data center- Returns:
- a paginated list of sensor readings
-
list
PaginatedList<SensorReading> list(String ibx, String type, String zone, Integer offset, Integer limit) Lists environmental sensor readings for the specified IBX, narrowed by sensor data type and zone and paged by offset/limit.- Parameters:
ibx- the IBX code identifying the data centertype- the sensor data type to filter by (e.g.HUMIDITY), ornullfor allzone- the zone name to filter by, ornullfor alloffset- the zero-based results offset, ornullfor the default (0)limit- the maximum number of records to retrieve, ornullfor the default (20)- Returns:
- a paginated list of sensor readings
-
getSensorReading
Retrieves a specific environmental sensor reading by sensor identifier.- Parameters:
ibx- the IBX code identifying the data centersensorId- the unique identifier of the sensor- Returns:
- the sensor reading for the specified sensor
-