API reference
Javadoc location and package map.
Location#
The Javadoc is published at /apidocs/. It is generated from the sources with mvn javadoc:javadoc and republished with each release.
A request for a Javadoc path without the /apidocs/ prefix, such as /com/eqixiac/equinix/Fabric.html, is forwarded to /apidocs/com/eqixiac/equinix/Fabric.html.
The published Javadoc describes the latest release, 3.0.0, and this site describes the 4.0 development tree. The Javadoc of a type labelled New in 4.0 here has to be built from source.
Package map#
| Package | Content | Guide |
|---|---|---|
com.eqixiac.equinix | Equinix, the domain entry points, EquinixConfig, Design | Sessions |
core.auth | Credentials, credential providers, bearer tokens | Authentication |
core.http, core.http.response | Retry policy, circuit breaker, paginated lists | Retries, Pagination |
core.exception | Exception hierarchy | Error model |
core.model.multicloud | Activation key codec, provider vocabulary (Beta) | Cloud-to-cloud |
fabric.client, fabric.model, fabric.enums | Fabric v4 | Fabric |
fabric.model.implementation.cloud | Cloud provider adapters | Connections |
fabric.beta | Beta families | Beta families |
networkedge, customerportal, internetaccess, ibxsmartview, iam, sts, projects | The other domains | Other API domains |
design.spec, design.spi, design.solve | Design document, plug-in interfaces, solver | DesignSpec |
design.optimizer, design.optimizer.wizard | Metro Optimizer, Deployment Wizard | Metro Optimizer, Deployment Wizard |
design.peering, design.geo | Peering Intelligence, latency | Peering Intelligence |
design.value | Rate cards, savings, TCO | Cost and value |
design.export | Terraform and diagram export | Deployment Wizard |
mcp.server, mcp.server.broker | MCP server and broker | MCP server |
All packages are under com.eqixiac.equinix.
Reading order#
EquinixandEquinixConfig- The client interface of the resource in question, for example
fabric.client.Connections - The operator class that holds its builders, for example
fabric.model.json.creators.ConnectionOperator - The model interface, for example
fabric.model.Connection
The builders carry the most detailed Javadoc, including the wire property each method sets.