Class CustomerPortal

java.lang.Object
com.eqixiac.equinix.EquinixClient
com.eqixiac.equinix.CustomerPortal
All Implemented Interfaces:
Closeable, AutoCloseable
public class CustomerPortal extends EquinixClient
The primary entry point for accessing Equinix Customer Portal APIs.

The Customer Portal provides comprehensive operations management for Equinix colocation facilities. This class offers typed access to all portal resources including cross-connects, trouble tickets, work visits, smart hands requests, shipments, invoices, orders, assets, reports, and more.

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");
CustomerPortal portal = new CustomerPortal(credentials);

// List cross-connects
PaginatedList<CrossConnect> crossConnects = portal.crossConnects().list();

// List trouble tickets
PaginatedList<TroubleTicket> tickets = portal.troubleTickets().list();

// Access invoice summaries
PaginatedList<InvoiceSummary> invoices = portal.invoices().summaries();
Author:
ianjones
See Also:

  • Constructor Details

    • CustomerPortal

      public CustomerPortal(EquinixCredentials equinixCredentials)
      Creates a new Customer Portal client using the provided credentials. Authentication occurs automatically on the first API call.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

    • CustomerPortal

      public CustomerPortal(EquinixCredentials equinixCredentials, boolean isSandBoxed)
      Creates a new Customer Portal client with optional sandbox mode.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs
      isSandBoxed - true to use the sandbox environment; false for production

    • CustomerPortal

      public CustomerPortal(EquinixCredentialsProvider credentialsProvider)
      Creates a new Customer Portal 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

    • CustomerPortal

      public CustomerPortal(EquinixCredentialsProvider credentialsProvider, boolean isSandBoxed)
      Creates a new Customer Portal 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; false for production

    • CustomerPortal

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

    • CustomerPortal

      public CustomerPortal(EquinixCredentialsProvider credentialsProvider, EquinixConfig config)
      Creates a new CustomerPortal 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

    • invoices

      public Invoices invoices()
      Returns the client for accessing invoice summaries and details. Provides billing information including line items, charges, and payment history.
      Returns:
      the Invoices client for invoice operations

    • crossConnects

      public CrossConnects crossConnects()
      Returns the client for managing cross-connect orders within Equinix IBX data centers. Cross-connects are physical cable connections between customer cages/cabinets and other network participants within the same facility.
      Returns:
      the CrossConnects client for cross-connect operations

    • orders

      public Orders orders()
      Returns the client for managing orders for Equinix services and products. Orders represent requests for new services, upgrades, or changes to existing infrastructure.
      Returns:
      the Orders client for order operations

    • troubleTickets

      public TroubleTickets troubleTickets()
      Returns the client for managing trouble tickets for reporting and tracking issues. Trouble tickets allow customers to report problems with their colocation infrastructure and track resolution progress.
      Returns:
      the TroubleTickets client for trouble ticket operations

    • workVisits

      public WorkVisits workVisits()
      Returns the client for scheduling and managing work visits to Equinix IBX data centers. Work visits coordinate on-site access for customer personnel to perform maintenance or installation tasks within their colocation space.
      Returns:
      the WorkVisits client for work visit operations

    • smartHandsRequests

      public SmartHandsRequests smartHandsRequests()
      Returns the client for requesting Smart Hands services. Smart Hands provides remote technical support at Equinix facilities, allowing trained technicians to perform tasks on behalf of the customer.
      Returns:
      the SmartHandsRequests client for Smart Hands operations

    • shipments

      public Shipments shipments()
      Returns the client for managing equipment shipments to and from Equinix data centers. Shipments track inbound and outbound deliveries of hardware and equipment to customer colocation spaces.
      Returns:
      the Shipments client for shipment operations

    • notifications

      public Notifications notifications()
      Returns the client for managing notification preferences and delivery. Notifications keep customers informed about events affecting their colocation infrastructure, including maintenance windows and operational alerts.
      Returns:
      the Notifications client for notification operations

    • assets

      public Assets assets()
      Returns the client for managing infrastructure assets within Equinix facilities. Assets represent physical equipment such as cages, cabinets, power circuits, and other deployed infrastructure.
      Returns:
      the Assets client for asset operations

    • quotes

      public Quotes quotes()
      Returns the client for requesting and managing service quotes. Quotes provide pricing estimates for new Equinix services, expansions, or changes to existing infrastructure before committing to an order.
      Returns:
      the Quotes client for quote operations

    • supportPlans

      public SupportPlans supportPlans()
      Returns the client for accessing support plan information and entitlements. Support plans define the level of service and response times available to the customer for technical and operational support.
      Returns:
      the SupportPlans client for support plan operations

    • orderHistory

      public OrderHistory orderHistory()
      Returns the client for querying historical order records. Order history provides a read-only view of past orders, including completed, cancelled, and in-progress service requests.
      Returns:
      the OrderHistory client for order history operations

    • lookups

      public Lookups lookups()
      Returns the client for performing reference data lookups such as IBX locations and metro codes. Lookups provide the enumerated values and reference data needed when creating or filtering other portal resources.
      Returns:
      the Lookups client for reference data lookup operations

    • attachments

      public Attachments attachments()
      Returns the client for managing file attachments on portal resources like tickets and cases. Attachments allow customers to upload supporting documentation such as diagrams, photos, and configuration files.
      Returns:
      the Attachments client for attachment operations

    • reports

      public Reports reports()
      Returns the client for generating and accessing operational reports. Reports provide aggregated views of facility usage, power consumption, capacity, and other operational metrics.
      Returns:
      the Reports client for report operations

    • secureCabinets

      public SecureCabinets secureCabinets()
      Returns the client for managing secure cabinet access and configurations. Secure cabinets provide enhanced physical security controls for sensitive equipment within Equinix colocation facilities.
      Returns:
      the SecureCabinets client for secure cabinet operations

    • supportCases

      public SupportCases supportCases()
      Returns the client for creating and managing support cases (the v2 Support tickets API). Support cases track non-incident requests and inquiries raised against the customer's Equinix services.
      Returns:
      the SupportCases client for support case operations

    • unifiedNotifications

      public UnifiedNotifications unifiedNotifications()
      Returns the client for searching unified notifications (the /notifications/v2 events API). Unified notifications aggregate IBX and network events into a single searchable feed.
      Returns:
      the UnifiedNotifications client for unified notification operations

    • digitalLoas

      public DigitalLoas digitalLoas()
      Returns the client for managing Digital Letters of Authorization (DiLOAs). DiLOAs authorize third parties to provision cross-connects to the customer's assets.
      Returns:
      the DigitalLoas client for digital LOA operations

    • troubleTicketOrders

      public TroubleTicketOrders troubleTicketOrders()
      Returns the client for placing trouble-ticket orders (the v1 trouble-ticket order API). Provides the supported types, permitted locations and order placement for reporting infrastructure issues as orders.
      Returns:
      the TroubleTicketOrders client for trouble-ticket order operations

    • billingAccounts

      public BillingAccounts billingAccounts()
      Returns the client for accessing finance billing-account summaries and downloading invoice documents (the v1 finance API).
      Returns:
      the BillingAccounts client for billing-account operations

    • billingAccountsSearch

      public BillingAccountsSearch billingAccountsSearch()
      Returns the client for searching billing accounts and looking them up by number or id (the billing v2 billing-accounts API).
      Returns:
      the BillingAccountsSearch client for billing-account search operations