Class IBXSmartView

java.lang.Object
com.eqixiac.equinix.EquinixClient
com.eqixiac.equinix.IBXSmartView
All Implemented Interfaces:
Closeable, AutoCloseable
public class IBXSmartView extends EquinixClient
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");

// Search recent power events for one or more IBX data centers
PaginatedList<PowerEvent> events = smartView.powerEvents().search(List.of("SV5"), null, null, 0, 100);

// Create a streaming subscription for real-time alerts
StreamingSubscription sub = smartView.streamingSubscriptions()
    .define()
    .withChannel(Channel.builder()
        .channelType(ChannelType.WEBHOOK)
        .webhookChannelConfiguration(WebhookChannelConfiguration.builder()
            .url("https://example.com/webhook").build())
        .build())
    .withMessageType(MessageType.builder()
        .environmental(List.of(EnvironmentalMessageType.builder()
            .accountNumber("123456").ibx(List.of("SV5")).build()))
        .build())
    .create();
Author:
ianjones
See Also:

  • 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

    • IBXSmartView

      public IBXSmartView(EquinixCredentialsProvider credentialsProvider)
      Creates a new IBX SmartView client whose credentials are resolved through the given provider. Authentication occurs automatically on the first API call.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs

    • IBXSmartView

      public IBXSmartView(EquinixCredentialsProvider credentialsProvider, boolean isSandBoxed)
      Creates a new IBX SmartView client over a custom credentials provider, with optional sandbox mode.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs
      isSandBoxed - true to use the sandbox environment for testing; false for production

    • IBXSmartView

      public IBXSmartView(EquinixCredentials equinixCredentials, EquinixConfig config)
      Creates a new IBXSmartView client with explicit EquinixConfig options.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs
      config - the construction-time options

    • IBXSmartView

      public IBXSmartView(EquinixCredentialsProvider credentialsProvider, EquinixConfig config)
      Creates a new IBXSmartView client over a custom credentials provider with explicit EquinixConfig options.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs
      config - the construction-time options

  • 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

    • powerEvents

      public PowerEvents powerEvents()
      Returns the client for accessing IBX SmartView power events and power alert configurations. Provides power-event search plus create, search, pause, resume, and delete operations for power alert configurations.
      Returns:
      the PowerEvents client for querying power events and managing power alert configurations

    • 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