Equinix SDK for Java 4.0.0 API
Packages
Package
Description
Root package for the Equinix Java SDK.
Asynchronous execution support for the Equinix Java SDK, built on Java 21 virtual threads.
Authentication and credential management for the Equinix Java SDK.
Core client infrastructure for the Equinix Java SDK.
Shared enumerations used across multiple domains within the Equinix Java SDK.
Exception hierarchy for Equinix API errors.
HTTP communication layer for the Equinix Java SDK.
HTTP request model for the Equinix Java SDK.
HTTP response handling for the Equinix Java SDK.
Core model interfaces and base types for the Equinix Java SDK.
Value types for the vocabulary of the Connection Coordinator specification, an open
(Apache-2.0) provider-to-provider API for coordinating private connections between two cloud or
network providers.
Customer Portal client interfaces for the Equinix Java SDK.
Customer Portal enumerations for the Equinix Java SDK.
Customer Portal model interfaces for the Equinix Java SDK.
Value-add design engines built on top of the Equinix API clients: placement optimization,
deployment planning, pricing/TCO analysis, peering intelligence, latency physics, and
infrastructure-as-code export.
The built-in hard limits of the Metro Optimizer: one small, pure
Constraint per field of
DesignConstraints, plus the workload rules, the
single-currency budget and the every-metro-used rule.Pricing of candidate designs:
RateCardCostModel is the
CostModel the Metro Optimizer uses, pricing each metro's
needs from a RateCard with every line's source and a range from
PriceBands.Estate analysis: looks at what a customer already runs on Equinix and produces a priced,
evidence-backed improvement report.
The default estate-analysis rules.
Exporters that render design-engine output into portable, version-controllable text formats.
Latency physics:
SpeedOfLightLatency computes
speed-of-light-in-fibre latency floors (one-way or round-trip) and haversine great-circle
distances between IBXes, metros, or raw coordinates - fully offline once the endpoints'
coordinates are known.The built-in objectives of the Metro Optimizer: latency, cost, provider coverage, resilience and
compliance.
The Metro Optimizer: which set of Equinix metros best serves a
DesignSpec, as a multi-objective search.The facts of a Metro Optimizer run:
CatalogDesignContext
(an in-memory DesignContext with a builder),
FabricCatalogLoader (builds one from live Fabric
data, read-only) and ProviderCatalog (which metros
each cloud is reachable from).Enumerations that parameterize the Metro Optimization Engine:
OptimizationStrategy (scoring weight
presets), WorkloadType (workload archetypes
with built-in profiles), LatencySensitivity
(default per-workload placement ceilings),
SiteRole (site importance multipliers),
RedundancyTier (metro-count floors and
region-diversity selection), ComplianceZone
(region-based data-sovereignty zones with deployment-level AND semantics),
ScoreCategory (the five scoring
dimensions), and RiskSeverity (risk-finding
levels).Immutable value types for the Metro Optimization Engine - the request side (sites, provider
requirements, workload specs, constraints, scoring weights) and the result side (ranked
recommendations, scores, topology, latency matrix, risk assessment, cost estimates).
The Deployment Wizard: turns a metro
OptimizationResult into an executable
DeploymentPlan - Cloud Routers,
provider connections, inter-metro backbone links, and routing protocols, with bandwidth-aware
profile selection and honestly-reconciled pricing.Configuration enums for the Deployment Wizard:
BackboneTopology (how the recommended
metros are meshed with inter-metro backbone links),
BandwidthStrategy (how provider
connections are sized from workload requirements), and
ConnectionPurpose (what role a planned
connection plays in the plan).Value types for the Deployment Wizard - the plan itself and everything it is made of, plus the
execution-side inputs and outcomes.
Peering Intelligence: interconnection analysis combining PeeringDB IX/facility data with the
live Equinix Fabric catalog.
Lightweight PeeringDB REST client and its wire models - a credential and transport entirely
separate from the Equinix OAuth client.
Classification enums for Peering Intelligence:
ConnectivityType (how an ASN is reachable at
a metro - IX, Fabric, both, facility-only, none),
PeeringPolicy and
NetworkType (parsed from PeeringDB's
policy_general / info_type fields),
DiversityRating (distance-banded geographic
diversity, with UNKNOWN reserved for unavailable distances), and
FailureScope (blast-radius failure domains).Result value types for Peering Intelligence, all Lombok
@Value (get-prefixed
accessors) unless a hand-written accessor is documented.Workload placement on a chosen set of metros:
WorkloadPlacer
decides where each workload runs (honouring pinnedMetro, per-workload maxLatencyMs and
cloud reachability) and which cloud connections that implies, as a
PlacementPlan.The deployment-plan lifecycle: plan as data, drift detection, idempotent and resumable reconcile,
and safe rollback.
The Design Decision Record: the one document an architect hands to a review board for a
DesignSpec.Failure analysis of a design.
Portfolio search: the reference
ExhaustiveSolver, the
Pareto dominance rules it uses, and the named
WeightProfiles that turn a spec's objectives into weights.The shared design document every design engine reads:
DesignSpec.Extension points of the design engines.
Sustainability plug-ins for the design engines.
The value-realization layer of the design API: design-time cost modelling that puts a
money figure on an interconnect decision.
Rate cards: pluggable sources of unit prices for the design-time cost, savings, and
TCO models.
Live cloud-provider pricing adapters:
RateCard implementations that source
current data-egress list prices from the providers' public pricing APIs -
AwsPriceListRateCard (AWS
Price List bulk offers),
AzureRetailPricesRateCard
(Azure Retail Prices),
GcpBillingCatalogRateCard
(GCP Cloud Billing Catalog; the only one needing an API key), and
OracleCloudPriceListRateCard
(OCI Price List).Cloud-egress savings estimation: how much routing a monthly data volume over an
Equinix private interconnect saves versus egressing it to the public internet, net of
the Equinix interconnect cost.
Design-time total-cost-of-ownership comparison across the
DeploymentArchetypes - public cloud over
the internet, on-premises, Equinix-interconnected, and (for a cloud-to-cloud comparison) the
providers' native multicloud link.Fabric v4 API families the spec (version 4.34.0, read 2026-11-11) labels Beta:
ASNs, Internet Exchange services, Application Connect (domains, links, processors, services,
subscriptions), Optical Metro Connects, cross connects, digital LOAs, single-tag lookup and logos.
Public Fabric Beta client interfaces: the
FabricBeta hub and one client per family.Implementations of the Fabric Beta clients.
Internal transport helpers shared by the Fabric Beta clients; not part of the public API.
Fabric Beta enums generated from the Fabric v4 4.34.0 spec; each has an
UNKNOWN read fallback.Fabric Beta request and response models generated from the Fabric v4 4.34.0 spec.
Fabric domain client interfaces for the Equinix Java SDK.
Fabric-specific enumerations for the Equinix Java SDK.
Fabric domain model interfaces for the Equinix Java SDK.
Cloud provider SDK interoperability layer for Equinix Fabric connections.
IAM client interfaces for the Equinix Java SDK.
Typed enumerations for the Equinix IAM (access v1) API.
IBX SmartView client interfaces for the Equinix Java SDK.
IBX SmartView enumerations for the Equinix Java SDK.
IBX SmartView model interfaces for the Equinix Java SDK.
Internet Access client interfaces for the Equinix Java SDK.
The embedded Equinix Intelligence MCP Server - a community Model Context Protocol
server, not affiliated with or endorsed by Equinix, and separate from Equinix's official Fabric
MCP server.
The Safe Mutation Broker - the embedded MCP server's only route to a mutation, enforced by
the server rather than by prompt discipline: agents propose, dry-run diffs decide,
humans confirm.
Client for the Equinix Messaging Gateway (EMG), Equinix's push channel for notifications:
IBX (data center) and network maintenance and incidents (flagged
SERVICE_IMPACTING or
NON_SERVICE_IMPACTING), Fabric port/virtual-connection up/down, billing start, order status
and Managed Services tickets.Optional transport layer for the Equinix Messaging Gateway:
EmgListener drives an EmgReceiver (peek-lock receive, explicit settlement) and
feeds the transport-agnostic EmgMessageParser.Azure Service Bus binding for the Equinix Messaging Gateway transport.
Network Edge client interfaces for the Equinix Java SDK.
Network Edge enumerations for the Equinix Java SDK.
Network Edge model interfaces for the Equinix Java SDK.
Projects client interfaces for the Equinix Java SDK.
STS client interfaces for the Equinix Java SDK.
Typed enumerations for the Equinix Security Token Service (STS v1) API.