Class NetworkEdge

java.lang.Object
com.eqixiac.equinix.EquinixClient
com.eqixiac.equinix.NetworkEdge
All Implemented Interfaces:
Closeable, AutoCloseable
public class NetworkEdge extends EquinixClient
The primary entry point for accessing the Equinix Network Edge APIs.

Network Edge provides virtual network devices deployed at Equinix data centers, enabling customers to run network functions (routers, firewalls, SD-WAN) without physical hardware. This class offers typed access to all Network Edge resources including virtual devices, ACL templates, VPN connections, BGP peerings, device links, public keys, and backups.

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");
NetworkEdge networkEdge = new NetworkEdge(credentials);

// List all virtual devices
PaginatedList<Device> devices = networkEdge.devices().list();

// Create a virtual device with the fluent builder
Device device = networkEdge.devices()
    .define("my-router")
    .withAccountNumber(accountNumber)
    .inMetro(MetroCode.SV)
    .withDeviceType("CSR1000V")
    .create();

// Manage ACL templates
PaginatedList<ACLTemplate> templates = networkEdge.aclTemplates().list();
Author:
ianjones
See Also:

  • Constructor Details

    • NetworkEdge

      public NetworkEdge(EquinixCredentials equinixCredentials)
      Creates a new Network Edge client using the provided credentials. Authentication occurs automatically on the first API call.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

    • NetworkEdge

      public NetworkEdge(EquinixCredentials equinixCredentials, boolean isSandBoxed)
      Creates a new Network Edge client with optional sandbox mode.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs
      isSandBoxed - true to use the sandbox environment for testing; false for production

    • NetworkEdge

      public NetworkEdge(EquinixCredentialsProvider credentialsProvider)
      Creates a new Network Edge client whose credentials are resolved through the given provider. Authentication occurs automatically on the first API call.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs

    • NetworkEdge

      public NetworkEdge(EquinixCredentialsProvider credentialsProvider, boolean isSandBoxed)
      Creates a new Network Edge client over a custom credentials provider, with optional sandbox mode.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs
      isSandBoxed - true to use the sandbox environment for testing; false for production

    • NetworkEdge

      public NetworkEdge(EquinixCredentials equinixCredentials, EquinixConfig config)
      Creates a new NetworkEdge client with explicit EquinixConfig options.
      Parameters:
      equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs
      config - the construction-time options

    • NetworkEdge

      public NetworkEdge(EquinixCredentialsProvider credentialsProvider, EquinixConfig config)
      Creates a new NetworkEdge client over a custom credentials provider with explicit EquinixConfig options.
      Parameters:
      credentialsProvider - supplies the OAuth2 credentials for authenticating with Equinix APIs
      config - the construction-time options

  • Method Details

    • setup

      public Setup setup()
      Returns the client for Network Edge setup and provisioning operations. Provides access to account settings, metro availability, license agreements, pricing, and generic file uploads for virtual network devices.
      Returns:
      the Setup client for managing setup-related resources

    • devices

      public Devices devices()
      Returns the client for managing virtual network devices and device types. Devices are virtual appliances (routers, firewalls, SD-WAN) running at Equinix data centers. Supports creation via fluent builders, lifecycle management, and querying available device types.
      Returns:
      the Devices client for CRUD operations on virtual devices

    • publicKeys

      public PublicKeys publicKeys()
      Returns the client for managing SSH public keys. Public keys are uploaded and associated with virtual devices for secure SSH access without password-based authentication.
      Returns:
      the PublicKeys client for managing SSH public keys

    • deviceLinks

      public DeviceLinks deviceLinks()
      Returns the client for managing device links between virtual network devices. Device links create logical connections between devices, enabling multi-device topologies and high-availability configurations.
      Returns:
      the DeviceLinks client for creating and managing device links

    • aclTemplates

      public ACLTemplates aclTemplates()
      Returns the client for managing Access Control List (ACL) templates. ACL templates define network access rules that can be applied to virtual devices to control inbound and outbound traffic.
      Returns:
      the ACLTemplates client for CRUD operations on ACL templates

    • vpns

      public VPNs vpns()
      Returns the client for managing VPN connections on virtual devices. VPNs establish secure, encrypted tunnels between virtual devices and remote network endpoints.
      Returns:
      the VPNs client for creating and managing VPN connections

    • bgpPeerings

      public BGPPeerings bgpPeerings()
      Returns the client for managing BGP peering sessions on virtual devices. BGP peerings enable dynamic route exchange between virtual devices and neighboring routers for network reachability.
      Returns:
      the BGPPeerings client for configuring BGP peering sessions

    • backups

      public Backups backups()
      Returns the client for managing device configuration backups. Backups capture the running configuration of virtual devices, enabling point-in-time recovery and configuration rollback.
      Returns:
      the Backups client for managing device backups