Class ConnectionOperator.ConnectionBuilder

java.lang.Object

com.eqixiac.equinix.fabric.model.json.creators.ConnectionOperator.ConnectionBuilder

Enclosing class:

ConnectionOperator

public class ConnectionOperator.ConnectionBuilder
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConnectionBuilder(ConnectionType type)

Method Summary

Modifier and Type	Method	Description
ConnectionOperator.ConnectionBuilder	additionalInfo(String key, String value)
ConnectionOperator.ConnectionBuilder	additionalInfo(List<ConnectionSideAdditionalInfo> additionalInfo)
ConnectionOperator.ConnectionBuilder	aSideAccessPoint(CloudRouter cloudRouter, LinkProtocol linkProtocol, InterfaceType interfaceType, Integer interfaceId)
ConnectionOperator.ConnectionBuilder	aSideAccessPoint(Port port, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	aSideAccessPoint(ServiceProfile serviceProfile, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	aSideAccessPoint(String virtualDeviceUuid, LinkProtocol linkProtocol, InterfaceType interfaceType, Integer interfaceId)
ConnectionOperator.ConnectionBuilder	aSideAccessPointCloudRouter(CloudRouter cloudRouter)
ConnectionOperator.ConnectionBuilder	aSideAccessPointCloudRouter(String cloudRouterUuid)	Configures the A-side access point to target a Fabric Cloud Router (by uuid).
ConnectionOperator.ConnectionBuilder	aSideAccessPointInterconnect(String interconnectUuid)	A-side Fabric Interconnect access point (type IC, interconnect.uuid).
ConnectionOperator.ConnectionBuilder	aSideAccessPointNetwork(String networkUuid)
ConnectionOperator.ConnectionBuilder	aSideAccessPointPort(String portUuid, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	aSideAccessPointService(String serviceUuid, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	aSideAccessPointServiceProfile(String serviceProfileUuid, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	aSideServiceToken(ServiceToken serviceToken)
ConnectionOperator.ConnectionBuilder	aSideServiceToken(String serviceTokenUuid)
ConnectionOperator.ConnectionBuilder	bandwidth(Integer bandwidth)
Connection	create()
ConnectionOperator.ConnectionBuilder	dryRun()
ConnectionOperator.ConnectionBuilder	geoScope(GeoScopeType geoScope)
ConnectionOperator.ConnectionBuilder	marketplaceSubscription(String subscriptionUuid)
ConnectionOperator.ConnectionBuilder	name(String name)
ConnectionOperator.ConnectionBuilder	notification(NotificationType type, String emailAddress)
ConnectionOperator.ConnectionBuilder	notification(String emailAddress)
ConnectionOperator.ConnectionBuilder	notification(List<Notification> notifications)
ConnectionOperator.ConnectionBuilder	project(String projectId)
ConnectionOperator.ConnectionBuilder	purchaseOrderNumber(String purchaseOrderNumber)
ConnectionOperator.ConnectionBuilder	redundancy(Redundancy redundancy)
ConnectionOperator.ConnectionBuilder	redundancy(String group, RedundancyPriority priority)
ConnectionOperator.ConnectionBuilder	zSideAccessPoint(CloudRouter cloudRouter, LinkProtocol linkProtocol, InterfaceType interfaceType, Integer interfaceId)
ConnectionOperator.ConnectionBuilder	zSideAccessPoint(SimpleAccessPoint accessPoint)	Sets the Z-side access point to a pre-built SimpleAccessPoint.
ConnectionOperator.ConnectionBuilder	zSideAccessPoint(Port port, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	zSideAccessPoint(ServiceProfile serviceProfile, LinkProtocol linkProtocol, String metroCode)	Service-provider z-side from a service profile read model, with location.metroCode.
ConnectionOperator.ConnectionBuilder	zSideAccessPoint(String virtualDeviceUuid, LinkProtocol linkProtocol, InterfaceType interfaceType, Integer interfaceId)
ConnectionOperator.ConnectionBuilder	zSideAccessPointCloudRouter(CloudRouter cloudRouter)
ConnectionOperator.ConnectionBuilder	zSideAccessPointCloudRouter(String cloudRouterUuid)	Configures the Z-side access point to target a Fabric Cloud Router (by uuid).
ConnectionOperator.ConnectionBuilder	zSideAccessPointNetwork(String networkUuid)	Configures the Z-side access point to target a Fabric Network (by uuid).
ConnectionOperator.ConnectionBuilder	zSideAccessPointPort(String portUuid, LinkProtocol linkProtocol)
ConnectionOperator.ConnectionBuilder	zSideAccessPointServiceProfile(String serviceProfileUuid, LinkProtocol linkProtocol, String metroCode)	Service-provider z-side with location.metroCode, the shape every service-provider connection example in the Fabric v4 spec uses.
ConnectionOperator.ConnectionBuilder	zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter)	Configures the Z-side access point from a cloud provider adapter, using the adapter's preferred link protocol (if any) and its metro.
ConnectionOperator.ConnectionBuilder	zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter, LinkProtocol linkProtocol)	Configures the Z-side access point from a cloud provider adapter: service profile, authentication key, seller region (when the provider uses one), peering type and the adapter's metro.
ConnectionOperator.ConnectionBuilder	zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter, LinkProtocol linkProtocol, String metroCode)	As zSideCloudProvider(CloudProviderConnectionAdapter, LinkProtocol) with an explicit z-side location.metroCode, which overrides the adapter's.
ConnectionOperator.ConnectionBuilder	zSideServiceToken(ServiceToken serviceToken)
ConnectionOperator.ConnectionBuilder	zSideServiceToken(String serviceTokenUuid)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConnectionBuilder

protected ConnectionBuilder(ConnectionType type)

Method Details

name

public ConnectionOperator.ConnectionBuilder name(String name)

purchaseOrderNumber

public ConnectionOperator.ConnectionBuilder purchaseOrderNumber(String purchaseOrderNumber)

bandwidth

public ConnectionOperator.ConnectionBuilder bandwidth(Integer bandwidth)

redundancy

public ConnectionOperator.ConnectionBuilder redundancy(Redundancy redundancy)

redundancy

public ConnectionOperator.ConnectionBuilder redundancy(String group,
 RedundancyPriority priority)

aSideServiceToken

public ConnectionOperator.ConnectionBuilder aSideServiceToken(ServiceToken serviceToken)

aSideServiceToken

public ConnectionOperator.ConnectionBuilder aSideServiceToken(String serviceTokenUuid)

aSideAccessPoint

public ConnectionOperator.ConnectionBuilder aSideAccessPoint(Port port,
 LinkProtocol linkProtocol)

aSideAccessPointPort

public ConnectionOperator.ConnectionBuilder aSideAccessPointPort(String portUuid,
 LinkProtocol linkProtocol)

aSideAccessPointService

public ConnectionOperator.ConnectionBuilder aSideAccessPointService(String serviceUuid,
 LinkProtocol linkProtocol)

aSideAccessPoint

public ConnectionOperator.ConnectionBuilder aSideAccessPoint(ServiceProfile serviceProfile,
 LinkProtocol linkProtocol)

aSideAccessPointServiceProfile

public ConnectionOperator.ConnectionBuilder aSideAccessPointServiceProfile(String serviceProfileUuid,
 LinkProtocol linkProtocol)

aSideAccessPoint

public ConnectionOperator.ConnectionBuilder aSideAccessPoint(String virtualDeviceUuid,
 LinkProtocol linkProtocol,
 InterfaceType interfaceType,
 Integer interfaceId)

aSideAccessPoint

public ConnectionOperator.ConnectionBuilder aSideAccessPoint(CloudRouter cloudRouter,
 LinkProtocol linkProtocol,
 InterfaceType interfaceType,
 Integer interfaceId)

aSideAccessPointCloudRouter

public ConnectionOperator.ConnectionBuilder aSideAccessPointCloudRouter(String cloudRouterUuid)

Configures the A-side access point to target a Fabric Cloud Router (by uuid).

Parameters:

cloudRouterUuid - the Cloud Router uuid

Returns:

this builder for chaining

aSideAccessPointCloudRouter

public ConnectionOperator.ConnectionBuilder aSideAccessPointCloudRouter(CloudRouter cloudRouter)

aSideAccessPointInterconnect

public ConnectionOperator.ConnectionBuilder aSideAccessPointInterconnect(String interconnectUuid)

A-side Fabric Interconnect access point (type IC, interconnect.uuid). The spec publishes no create example for it; send with dryRun() first.

Parameters:

interconnectUuid - the interconnect uuid

Returns:

this builder

aSideAccessPointNetwork

public ConnectionOperator.ConnectionBuilder aSideAccessPointNetwork(String networkUuid)

zSideServiceToken

public ConnectionOperator.ConnectionBuilder zSideServiceToken(String serviceTokenUuid)

zSideServiceToken

public ConnectionOperator.ConnectionBuilder zSideServiceToken(ServiceToken serviceToken)

zSideAccessPoint

public ConnectionOperator.ConnectionBuilder zSideAccessPoint(Port port,
 LinkProtocol linkProtocol)

zSideAccessPointPort

public ConnectionOperator.ConnectionBuilder zSideAccessPointPort(String portUuid,
 LinkProtocol linkProtocol)

zSideAccessPoint

public ConnectionOperator.ConnectionBuilder zSideAccessPoint(ServiceProfile serviceProfile,
 LinkProtocol linkProtocol,
 String metroCode)

Service-provider z-side from a service profile read model, with location.metroCode.

Parameters:

serviceProfile - the provider's service profile

linkProtocol - the z-side link protocol, or null

metroCode - the metro the provider is reached in, e.g. "SV"; required

Returns:

this builder

zSideAccessPointServiceProfile

public ConnectionOperator.ConnectionBuilder zSideAccessPointServiceProfile(String serviceProfileUuid,
 LinkProtocol linkProtocol,
 String metroCode)

Service-provider z-side with location.metroCode, the shape every service-provider connection example in the Fabric v4 spec uses. The metro is required: without it Fabric answers HTTP 400 EQ-3142501 "Invalid seller metroCode location" (live-confirmed 2026-11-11), so the overload without a metro was removed.

Parameters:

serviceProfileUuid - the provider's service profile

linkProtocol - the z-side link protocol, or null

metroCode - the metro the provider is reached in, e.g. "SV"; required

Returns:

this builder

zSideAccessPoint

public ConnectionOperator.ConnectionBuilder zSideAccessPoint(String virtualDeviceUuid,
 LinkProtocol linkProtocol,
 InterfaceType interfaceType,
 Integer interfaceId)

zSideAccessPoint

public ConnectionOperator.ConnectionBuilder zSideAccessPoint(CloudRouter cloudRouter,
 LinkProtocol linkProtocol,
 InterfaceType interfaceType,
 Integer interfaceId)

zSideAccessPointCloudRouter

public ConnectionOperator.ConnectionBuilder zSideAccessPointCloudRouter(String cloudRouterUuid)

Configures the Z-side access point to target a Fabric Cloud Router (by uuid).

Parameters:

cloudRouterUuid - the Cloud Router uuid

Returns:

this builder for chaining

zSideAccessPointCloudRouter

public ConnectionOperator.ConnectionBuilder zSideAccessPointCloudRouter(CloudRouter cloudRouter)

zSideAccessPointNetwork

public ConnectionOperator.ConnectionBuilder zSideAccessPointNetwork(String networkUuid)

Configures the Z-side access point to target a Fabric Network (by uuid).

Parameters:

networkUuid - the network uuid

Returns:

this builder for chaining

zSideAccessPoint

public ConnectionOperator.ConnectionBuilder zSideAccessPoint(SimpleAccessPoint accessPoint)

Sets the Z-side access point to a pre-built SimpleAccessPoint. Use it for access point properties that have no dedicated zSide... method, such as activationKey and environment.

The access point is sent as built. This method adds no defaults and performs no validation; a later zSide... call replaces it.

Beta: activationKey and environment are defined on the Fabric v4 catalog's AccessPoint schema (fetched 2026-09-21) without a connection-create example. The combination below is a request the schema permits, not one the catalog demonstrates. Send it with dryRun() first.

SimpleAccessPoint zSide = SimpleAccessPoint.define(AccessPointType.SP)
    .serviceProfile(icProfileUuid)
    .environment(environmentUuid)
    .activationKey(activationKey)
    .create();

Connection simulated = fabric.connections()
    .define(ConnectionType.IP_VC)
    .name("cloud-router-to-provider")
    .bandwidth(1000)
    .aSideAccessPointCloudRouter(cloudRouterUuid)
    .zSideAccessPoint(zSide)
    .notification("ops@example.com")
    .dryRun()
    .create();

Parameters:

accessPoint - the Z-side access point; must not be null

Returns:

this builder for chaining

Throws:

NullPointerException - if accessPoint is null

zSideCloudProvider

public ConnectionOperator.ConnectionBuilder zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter,
 LinkProtocol linkProtocol)

Configures the Z-side access point from a cloud provider adapter: service profile, authentication key, seller region (when the provider uses one), peering type and the adapter's metro.

AwsDirectConnectAdapter<?> adapter = AwsDirectConnectAdapter.of(
    "123456789012", "us-east-1", "equinix-aws-profile-uuid", "DC");

Connection conn = fabric.connections()
    .define(ConnectionType.EVPL_VC)
    .name("AWS-Connection")
    .bandwidth(100)
    .aSideAccessPointPort(portUuid, LinkProtocol.dot1q().vlanTag(1000).create())
    .zSideCloudProvider(adapter, null)
    .notification("ops@example.com")
    .create();

Parameters:

adapter - the cloud provider adapter; its getMetroCode() must not be null

linkProtocol - the z-side link protocol, or null (the spec's cloud examples send none)

Returns:

this builder for chaining

Throws:

IllegalArgumentException - when the adapter carries no metro; use zSideCloudProvider(CloudProviderConnectionAdapter, LinkProtocol, String)

See Also:

• CloudProviderConnectionAdapter

zSideCloudProvider

public ConnectionOperator.ConnectionBuilder zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter,
 LinkProtocol linkProtocol,
 String metroCode)

As zSideCloudProvider(CloudProviderConnectionAdapter, LinkProtocol) with an explicit z-side location.metroCode, which overrides the adapter's.

Parameters:

adapter - the cloud provider adapter

linkProtocol - the link protocol, or null

metroCode - the provider metro, e.g. "SV"; required

Returns:

this builder for chaining

zSideCloudProvider

public ConnectionOperator.ConnectionBuilder zSideCloudProvider(CloudProviderConnectionAdapter<?> adapter)

Configures the Z-side access point from a cloud provider adapter, using the adapter's preferred link protocol (if any) and its metro.

Parameters:

adapter - the cloud provider adapter; its getMetroCode() must not be null

Returns:

this builder for chaining

See Also:

• zSideCloudProvider(CloudProviderConnectionAdapter, LinkProtocol)

geoScope

public ConnectionOperator.ConnectionBuilder geoScope(GeoScopeType geoScope)

project

public ConnectionOperator.ConnectionBuilder project(String projectId)

additionalInfo

public ConnectionOperator.ConnectionBuilder additionalInfo(List<ConnectionSideAdditionalInfo> additionalInfo)

additionalInfo

public ConnectionOperator.ConnectionBuilder additionalInfo(String key,
 String value)

marketplaceSubscription

public ConnectionOperator.ConnectionBuilder marketplaceSubscription(String subscriptionUuid)

dryRun

public ConnectionOperator.ConnectionBuilder dryRun()

notification

public ConnectionOperator.ConnectionBuilder notification(NotificationType type,
 String emailAddress)

notification

public ConnectionOperator.ConnectionBuilder notification(String emailAddress)

notification

public ConnectionOperator.ConnectionBuilder notification(List<Notification> notifications)

create

public Connection create()