Package api.equinix.javasdk
Class Fabric
java.lang.Object
api.equinix.javasdk.EquinixClient
api.equinix.javasdk.Fabric
- All Implemented Interfaces:
Service,Closeable,AutoCloseable
The primary entry point for accessing the Equinix Fabric APIs.
Equinix Fabric provides interconnection services that enable direct, private connectivity between infrastructure and applications. This class offers typed access to all Fabric resources including connections, ports, service tokens, cloud routers, routing protocols, route filters, streams, precision time services, networks, 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");
Fabric fabric = new Fabric(credentials);
// List all connections
PaginatedFilteredList<Connection> connections = fabric.connections().search();
// Create a connection with dry-run validation
Connection validated = fabric.connections()
.define(ConnectionType.EVPL_VC)
.withName("My-Connection")
.withBandwidth(100)
.dryRun()
.create();
// Check Fabric API health
HealthStatus health = fabric.health();
Resource Chaining
// Port -> Connection -> Statistics pipeline
Port port = fabric.ports().list().get(0);
ConnectionStatistic stats = fabric.connections().getStatistics(
connectionUuid, startTime, endTime);
// Cloud Router -> Routing Protocol -> Route Filter chain
PaginatedFilteredList<CloudRouter> routers = fabric.cloudRouters().search();
PaginatedList<RoutingProtocol> protocols = fabric.routingProtocols().list(connectionId);
PaginatedFilteredList<RouteFilter> filters = fabric.routeFilters().search();
- Version:
- $Id: $Id
- Author:
- ianjones
- See Also:
-
Field Summary
Fields inherited from class api.equinix.javasdk.EquinixClient
equinixClient -
Constructor Summary
ConstructorsConstructorDescriptionFabric(EquinixCredentials equinixCredentials) Creates a new Fabric client using the provided credentials.Fabric(EquinixCredentials equinixCredentials, boolean isSandBoxed) Creates a new Fabric client with optional sandbox mode. -
Method Summary
Modifier and TypeMethodDescriptionReturns the client for accessing Fabric cloud events.Returns the client for managing Fabric Cloud Routers and their associated packages.Returns the client for managing Fabric connections and connection statistics.Returns the client for managing Fabric gateways (also known as Fabric Cloud Routers).health()Retrieves the current health status of the Equinix Fabric API.Returns the client for managing Fabric marketplace subscriptions.metros()Returns the client for managing Equinix metro locations.networks()Returns the client for managing Fabric networks.ports()Returns the client for managing Fabric ports and port statistics.Returns the client for managing Equinix Precision Time services.prices()Returns the client for querying Fabric pricing information.Returns the client for managing individual rules within Fabric route aggregations.Returns the client for managing Fabric route aggregations.Returns the client for managing individual rules within Fabric route filters.Returns the client for managing Fabric route filters.Returns the client for managing routing protocols on Fabric connections.Returns the client for managing Fabric service profiles.Returns the client for managing Fabric service tokens.streams()Returns the client for managing Fabric event streams.Returns the client for managing Fabric stream subscriptions.Methods inherited from class api.equinix.javasdk.EquinixClient
authenticate, close, core
-
Constructor Details
-
Fabric
Creates a new Fabric client using the provided credentials. Authentication occurs automatically on the first API call.- Parameters:
equinixCredentials- the OAuth2 credentials for authenticating with Equinix APIs
-
Fabric
Creates a new Fabric client with optional sandbox mode.- Parameters:
equinixCredentials- the OAuth2 credentials for authenticating with Equinix APIsisSandBoxed-trueto use the sandbox environment for testing;falsefor production
-
-
Method Details
-
metros
-
serviceTokens
Returns the client for managing Fabric service tokens. Service tokens enable secure, delegated provisioning of connections between parties. Supports dry-run validation via the fluent builder.- Returns:
- the
ServiceTokensclient for creating, listing, and managing service tokens
-
ports
-
connections
Returns the client for managing Fabric connections and connection statistics. Connections are the core resource in Fabric, representing virtual circuits between two access points (ports, service profiles, cloud providers, or network endpoints). Supports dry-run validation and fluent builder creation.- Returns:
- the
Connectionsclient for creating, searching, and managing connections
-
prices
-
serviceProfiles
Returns the client for managing Fabric service profiles. Service profiles define how third-party providers (such as cloud providers) expose their services for Fabric connections.- Returns:
- the
ServiceProfilesclient for searching and managing service profiles
-
fabricGateways
Returns the client for managing Fabric gateways (also known as Fabric Cloud Routers). Gateways provide Layer 3 routing capabilities for Fabric connections, with associated gateway packages defining performance tiers.- Returns:
- the
FabricGatewaysclient for creating and managing gateways
-
cloudRouters
Returns the client for managing Fabric Cloud Routers and their associated packages. Cloud Routers enable dynamic routing between Fabric connections using BGP.- Returns:
- the
CloudRoutersclient for creating, searching, and managing cloud routers
-
routingProtocols
Returns the client for managing routing protocols on Fabric connections. Routing protocols (such as BGP) define how routes are exchanged between connected endpoints through Cloud Routers.- Returns:
- the
RoutingProtocolsclient for configuring routing protocols on connections
-
routeFilters
Returns the client for managing Fabric route filters. Route filters control which routes are advertised or accepted through routing protocols, enabling fine-grained traffic engineering.- Returns:
- the
RouteFiltersclient for creating, searching, and managing route filters
-
routeFilterRules
Returns the client for managing individual rules within Fabric route filters. Each rule specifies a prefix and action (permit/deny) that determines how matching routes are handled.- Returns:
- the
RouteFilterRulesclient for CRUD operations on route filter rules
-
routeAggregations
Returns the client for managing Fabric route aggregations. Route aggregations summarize multiple specific routes into a single aggregated route, reducing the routing table size and simplifying network management.- Returns:
- the
RouteAggregationsclient for creating, searching, and managing route aggregations
-
routeAggregationRules
Returns the client for managing individual rules within Fabric route aggregations. Each rule specifies which prefixes are included in the aggregated route.- Returns:
- the
RouteAggregationRulesclient for CRUD operations on route aggregation rules
-
networks
-
streams
-
streamSubscriptions
Returns the client for managing Fabric stream subscriptions. Stream subscriptions define how events from a stream are delivered to consumers, supporting various delivery mechanisms.- Returns:
- the
StreamSubscriptionsclient for creating and managing stream subscriptions
-
precisionTimes
Returns the client for managing Equinix Precision Time services. Precision Time provides accurate time synchronization (NTP/PTP) for network infrastructure connected through Fabric.- Returns:
- the
PrecisionTimesclient for creating and managing precision time services
-
cloudEvents
Returns the client for accessing Fabric cloud events. Cloud events provide audit and operational event data for Fabric resources.- Returns:
- the
CloudEventsclient for listing and searching cloud events
-
marketplaceSubscriptions
Returns the client for managing Fabric marketplace subscriptions. Marketplace subscriptions represent active subscriptions to services offered through the Equinix Fabric marketplace.- Returns:
- the
MarketplaceSubscriptionsclient for managing marketplace subscriptions
-
health
Retrieves the current health status of the Equinix Fabric API. This is a direct call (not a lazy-initialized client) that returns the current API availability and status information.- Returns:
- the current
HealthStatusof the Fabric API
-