Class SimpleAccessPoint.AccessPointBuilder

java.lang.Object

com.eqixiac.equinix.fabric.model.implementation.SimpleAccessPoint.AccessPointBuilder

Enclosing class:

SimpleAccessPoint

public static class SimpleAccessPoint.AccessPointBuilder
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccessPointBuilder(AccessPointType type)
protected	AccessPointBuilder(AccessPoint accessPoint)

Method Summary

Modifier and Type	Method	Description
SimpleAccessPoint.AccessPointBuilder	activationKey(String activationKey)	Sets AccessPoint.activationKey ("Access point activation key" in the Fabric v4 catalog).
SimpleAccessPoint.AccessPointBuilder	address(AccessPointAddress address)	Sets address.
SimpleAccessPoint.AccessPointBuilder	authenticationKey(String authenticationKey)
SimpleAccessPoint.AccessPointBuilder	bandwidthCommit(Integer bandwidthCommitMbps)	Sets bandwidthCommit in Mbps.
SimpleAccessPoint.AccessPointBuilder	cloudRouter(CloudRouter cloudRouter)
SimpleAccessPoint.AccessPointBuilder	cloudRouter(String cloudRouterUuid)	Targets a Fabric Cloud Router (by uuid) as this access point.
SimpleAccessPoint	create()
SimpleAccessPoint.AccessPointBuilder	deviceInterface(InterfaceType interfaceType, Integer interfaceId)
SimpleAccessPoint.AccessPointBuilder	environment(ProviderEnvironment environment)	Sets AccessPoint.environment from a provider environment read model, by uuid.
SimpleAccessPoint.AccessPointBuilder	environment(String environmentUuid)	Sets AccessPoint.environment to a uuid-only reference ({"uuid": "<environmentUuid>"}) to a provider environment of an IC_PROFILE service profile.
SimpleAccessPoint.AccessPointBuilder	fromCloudProvider(CloudProviderConnectionAdapter<?> adapter)	Configures this access point using a CloudProviderConnectionAdapter.
SimpleAccessPoint.AccessPointBuilder	interconnect(String interconnectUuid)	Sets interconnect.uuid for an AccessPointType.IC access point (Fabric Interconnect).
SimpleAccessPoint.AccessPointBuilder	linkProtocol(LinkProtocolType linkProtocolType, Integer vlanTag, Integer vlanCTag, Integer vlanSTag)
SimpleAccessPoint.AccessPointBuilder	linkProtocol(LinkProtocol linkProtocol)
SimpleAccessPoint.AccessPointBuilder	metro(MetroCode metroCode)	Sets location.metroCode from a MetroCode.
SimpleAccessPoint.AccessPointBuilder	metro(String metroCode)	Sets location.metroCode: the metro in which this access point is reached.
SimpleAccessPoint.AccessPointBuilder	network(Network network)
SimpleAccessPoint.AccessPointBuilder	network(String networkUuid)	Targets a Fabric Network (by uuid) as this access point.
SimpleAccessPoint.AccessPointBuilder	peeringType(PeeringType peeringType)
SimpleAccessPoint.AccessPointBuilder	port(Port port)
SimpleAccessPoint.AccessPointBuilder	port(String portUuid)
SimpleAccessPoint.AccessPointBuilder	productOffering(ProductOffering productOffering)	Sets productOffering (spec: z-side only).
SimpleAccessPoint.AccessPointBuilder	providerIdentifier(String providerIdentifier)	Sets providerIdentifier (spec 4.34.0 AccessPoint).
SimpleAccessPoint.AccessPointBuilder	role(AccessPointRole role)
SimpleAccessPoint.AccessPointBuilder	sellerRegion(String sellerRegion)
SimpleAccessPoint.AccessPointBuilder	serviceProfile(ServiceProfile serviceProfile)
SimpleAccessPoint.AccessPointBuilder	serviceProfile(String serviceProfileUuid)
SimpleAccessPoint.AccessPointBuilder	virtualDevice(String virtualDeviceUuid)
SimpleAccessPoint.AccessPointBuilder	virtualNetwork(String virtualNetworkUuid)

Methods inherited from class Object

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

Constructor Details

AccessPointBuilder

protected AccessPointBuilder(AccessPointType type)

AccessPointBuilder

protected AccessPointBuilder(AccessPoint accessPoint)

Method Details

port

public SimpleAccessPoint.AccessPointBuilder port(String portUuid)

port

public SimpleAccessPoint.AccessPointBuilder port(Port port)

serviceProfile

public SimpleAccessPoint.AccessPointBuilder serviceProfile(String serviceProfileUuid)

serviceProfile

public SimpleAccessPoint.AccessPointBuilder serviceProfile(ServiceProfile serviceProfile)

virtualDevice

public SimpleAccessPoint.AccessPointBuilder virtualDevice(String virtualDeviceUuid)

linkProtocol

public SimpleAccessPoint.AccessPointBuilder linkProtocol(LinkProtocol linkProtocol)

linkProtocol

public SimpleAccessPoint.AccessPointBuilder linkProtocol(LinkProtocolType linkProtocolType,
 Integer vlanTag,
 Integer vlanCTag,
 Integer vlanSTag)

deviceInterface

public SimpleAccessPoint.AccessPointBuilder deviceInterface(InterfaceType interfaceType,
 Integer interfaceId)

sellerRegion

public SimpleAccessPoint.AccessPointBuilder sellerRegion(String sellerRegion)

authenticationKey

public SimpleAccessPoint.AccessPointBuilder authenticationKey(String authenticationKey)

activationKey

public SimpleAccessPoint.AccessPointBuilder activationKey(String activationKey)

Sets AccessPoint.activationKey ("Access point activation key" in the Fabric v4 catalog). The value is sent unmodified as its own JSON property. It does not read or write authenticationKey; a request can carry either, both or neither.

Beta: the property is defined on the catalog's AccessPoint schema (fetched 2026-09-21). The catalog puts no Beta marker on the property itself. It is labelled Beta here because the surfaces that produce and check activation keys (ProviderEnvironment, ActivationKeyDetails, the environment actions operation) all carry the catalog's Beta marker. The catalog publishes no connection-create example that sets it, so which access point types accept it, and which other properties must accompany it, is unverified. Probe with ConnectionBuilder.dryRun() before a live create. A key can be checked first with ServiceProfiles.validateActivationKey(...).

Parameters:

activationKey - the provider-encoded activation key, or null to omit the property

Returns:

this builder for chaining

environment

public SimpleAccessPoint.AccessPointBuilder environment(String environmentUuid)

Sets AccessPoint.environment to a uuid-only reference ({"uuid": "<environmentUuid>"}) to a provider environment of an IC_PROFILE service profile. Environment uuids come from ServiceProfiles.getEnvironments(serviceProfileUuid) or ServiceProfile.getEnvironments().

Beta: ProviderEnvironment carries the catalog's Beta marker (catalog fetched 2026-09-21). The catalog publishes no connection-create example that sets this property; the reference-by-uuid form is unverified against the service. Probe with ConnectionBuilder.dryRun() before a live create.

Parameters:

environmentUuid - the provider environment uuid, or null to omit the property

Returns:

this builder for chaining

environment

public SimpleAccessPoint.AccessPointBuilder environment(ProviderEnvironment environment)

Sets AccessPoint.environment from a provider environment read model, by uuid.

Beta: see environment(String).

Parameters:

environment - the provider environment; must not be null

Returns:

this builder for chaining

peeringType

public SimpleAccessPoint.AccessPointBuilder peeringType(PeeringType peeringType)

cloudRouter

public SimpleAccessPoint.AccessPointBuilder cloudRouter(String cloudRouterUuid)

Targets a Fabric Cloud Router (by uuid) as this access point. Used to build Fabric Cloud Router connections.

Parameters:

cloudRouterUuid - the Cloud Router uuid

Returns:

this builder for chaining

cloudRouter

public SimpleAccessPoint.AccessPointBuilder cloudRouter(CloudRouter cloudRouter)

network

public SimpleAccessPoint.AccessPointBuilder network(String networkUuid)

Targets a Fabric Network (by uuid) as this access point. Used to build network-type (E-LAN / E-Tree) connections.

Parameters:

networkUuid - the network uuid

Returns:

this builder for chaining

network

public SimpleAccessPoint.AccessPointBuilder network(Network network)

virtualNetwork

public SimpleAccessPoint.AccessPointBuilder virtualNetwork(String virtualNetworkUuid)

role

public SimpleAccessPoint.AccessPointBuilder role(AccessPointRole role)

metro

public SimpleAccessPoint.AccessPointBuilder metro(String metroCode)

Sets location.metroCode: the metro in which this access point is reached. The Fabric v4 spec's service-provider connection examples send it on the z-side.

Parameters:

metroCode - the metro code, e.g. "SV"; null clears it

Returns:

this builder for chaining

metro

public SimpleAccessPoint.AccessPointBuilder metro(MetroCode metroCode)

Sets location.metroCode from a MetroCode.

Parameters:

metroCode - the metro; null clears it

Returns:

this builder for chaining

fromCloudProvider

public SimpleAccessPoint.AccessPointBuilder fromCloudProvider(CloudProviderConnectionAdapter<?> adapter)

Configures this access point using a CloudProviderConnectionAdapter.

Extracts the service profile UUID, authentication key, seller region, and optional peering type from the adapter and applies them to this access point builder. If the adapter's getActivationKey() returns a non-null value it is copied to activationKey as a separate property (Beta, see activationKey(String)); a null return leaves any activation key already set on this builder unchanged. The four built-in adapters return null.

Parameters:

adapter - the cloud provider adapter to extract connection parameters from

Returns:

this builder for chaining

providerIdentifier

public SimpleAccessPoint.AccessPointBuilder providerIdentifier(String providerIdentifier)

Sets providerIdentifier (spec 4.34.0 AccessPoint).

Parameters:

providerIdentifier - the provider identifier

Returns:

this builder for chaining

productOffering

public SimpleAccessPoint.AccessPointBuilder productOffering(ProductOffering productOffering)

Sets productOffering (spec: z-side only).

Parameters:

productOffering - the offering

Returns:

this builder for chaining

bandwidthCommit

public SimpleAccessPoint.AccessPointBuilder bandwidthCommit(Integer bandwidthCommitMbps)

Sets bandwidthCommit in Mbps.

Parameters:

bandwidthCommitMbps - the committed bandwidth, 0 to 100000

Returns:

this builder for chaining

address

public SimpleAccessPoint.AccessPointBuilder address(AccessPointAddress address)

Sets address.

Parameters:

address - the address

Returns:

this builder for chaining

interconnect

public SimpleAccessPoint.AccessPointBuilder interconnect(String interconnectUuid)

Sets interconnect.uuid for an AccessPointType.IC access point (Fabric Interconnect). Live IC a-sides read back as {"type":"IC","interconnect":{...}, "router":{"uuid":...}} (observed 2026-11-11); the spec publishes no create example with an IC access point, so which properties a create needs is unverified. Build the request with ConnectionBuilder.dryRun() first and check the validation result before a live create.

Parameters:

interconnectUuid - the interconnect uuid

Returns:

this builder for chaining

create

public SimpleAccessPoint create()