Package api.equinix.javasdk

Class IBXSmartView

java.lang.Object

api.equinix.javasdk.EquinixClient

api.equinix.javasdk.IBXSmartView

All Implemented Interfaces:

Service, Closeable, AutoCloseable

public final class IBXSmartView
extends EquinixClient
implements Service

The primary entry point for accessing Equinix IBX SmartView APIs.

IBX SmartView provides real-time environmental monitoring, power usage data, system alerts, and streaming subscriptions for Equinix IBX data centers. This class offers typed access to current and legacy sensor data, power readings, location hierarchy information, and asset management.

All resource accessors use lazy initialization — internal clients are created on first access and reused for subsequent calls.

Quick Start

 BasicEquinixCredentials credentials = new BasicEquinixCredentials("clientId", "clientSecret");
 IBXSmartView smartView = new IBXSmartView(credentials);

 // Get environmental readings for a data center
 PaginatedList<SensorReading> readings = smartView.environmentals().list("DC2");

 // Get power readings
 PaginatedList<PowerReading> power = smartView.power().list("DC2");

 // Create a streaming subscription for real-time alerts
 StreamingSubscription sub = smartView.streamingSubscriptions()
     .define()
     .withName("My-Alerts")
     .withChannelType(ChannelType.WEBHOOK)
     .withWebhookUrl("https://example.com/webhook")
     .create();
 

Author:

ianjones

See Also:

• BasicEquinixCredentials
• Environmentals
• StreamingSubscriptions

Field Summary

Fields inherited from class api.equinix.javasdk.EquinixClient

equinixClient

Constructor Summary

Constructors

Constructor	Description
IBXSmartView(EquinixCredentials equinixCredentials)	Creates a new IBX SmartView client using the provided credentials.
IBXSmartView(EquinixCredentials equinixCredentials, boolean isSandBoxed)	Creates a new IBX SmartView client with optional sandbox mode.

Method Summary

Modifier and Type	Method	Description
Environmentals	environmentals()	Returns the client for accessing current environmental sensor data from IBX data centers.
Hierarchy	hierarchy()	Returns the client for querying IBX location hierarchy data.
LegacyEnvironmentals	legacyEnvironmentals()	Returns the client for accessing legacy (v1) environmental data APIs.
LegacyPower	legacyPower()	Returns the client for accessing legacy (v1) power data APIs.
Power	power()	Returns the client for accessing current power usage data from IBX data centers.
SmartViewAssets	smartViewAssets()	Returns the client for managing SmartView asset information within IBX facilities.
StreamingSubscriptions	streamingSubscriptions()	Returns the client for managing real-time streaming subscriptions.
SystemAlerts	systemAlerts()	Returns the client for accessing system alerts from IBX facilities.

Methods inherited from class api.equinix.javasdk.EquinixClient

authenticate, close, core

Methods inherited from class java.lang.Object

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

Constructor Details

IBXSmartView

public IBXSmartView(EquinixCredentials equinixCredentials)

Creates a new IBX SmartView client using the provided credentials. Authentication occurs automatically on the first API call.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

IBXSmartView

public IBXSmartView(EquinixCredentials equinixCredentials,
 boolean isSandBoxed)

Creates a new IBX SmartView client with optional sandbox mode.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Method Details

environmentals

public Environmentals environmentals()

Returns the client for accessing current environmental sensor data from IBX data centers. Provides temperature, humidity, and other environmental readings.

Returns:

the Environmentals client for querying environmental sensor data

power

public Power power()

Returns the client for accessing current power usage data from IBX data centers. Provides real-time power consumption and capacity metrics.

Returns:

the Power client for querying power usage data

streamingSubscriptions

public StreamingSubscriptions streamingSubscriptions()

Returns the client for managing real-time streaming subscriptions. Supports AWS IoT, Azure Event Hub, Webhook, and REST delivery channels for environmental, power, and alert data.

Returns:

the StreamingSubscriptions client for creating and managing streaming subscriptions

systemAlerts

public SystemAlerts systemAlerts()

Returns the client for accessing system alerts from IBX facilities. Provides active and historical alerts for environmental and power anomalies.

Returns:

the SystemAlerts client for querying system alerts

hierarchy

public Hierarchy hierarchy()

Returns the client for querying IBX location hierarchy data. Provides the organizational structure of accounts, IBX locations, floors, cages, and cabinets.

Returns:

the Hierarchy client for querying location hierarchy

smartViewAssets

public SmartViewAssets smartViewAssets()

Returns the client for managing SmartView asset information within IBX facilities.

Returns:

the SmartViewAssets client for managing SmartView assets

legacyEnvironmentals

public LegacyEnvironmentals legacyEnvironmentals()

Returns the client for accessing legacy (v1) environmental data APIs. Provides historical trending data for temperature and humidity with configurable time intervals.

Returns:

the LegacyEnvironmentals client for querying legacy environmental data

legacyPower

public LegacyPower legacyPower()

Returns the client for accessing legacy (v1) power data APIs. Provides historical trending data for power consumption with configurable time intervals.

Returns:

the LegacyPower client for querying legacy power data