Interface Ports

All Known Implementing Classes:
PortsImpl
public interface Ports
Client interface for managing Equinix Fabric ports. Provides operations for listing, retrieving, and monitoring port bandwidth statistics.
Author:
ianjones

  • Method Details

    • list

      List<Port> list()
      Lists all ports accessible to the current account (GET /fabric/v4/ports). Spec 4.34.0 declares no offset on this GET and the live service returns every item in one response (for GET /ports: limit 999, offset and limit ignored, observed 2026-11-11), so this is a plain list, not a multi-page one.
      Returns:
      the ports

    • search

      PaginatedFilteredList<Port> search()
      Searches for ports using default filter and sort criteria.
      Returns:
      a paginated, filtered list of matching ports

    • search

      PaginatedFilteredList<Port> search(FilterPropertyList filter)
      Searches for ports matching the specified filter criteria.
      Parameters:
      filter - the filter criteria to apply
      Returns:
      a paginated, filtered list of matching ports

    • search

      PaginatedFilteredList<Port> search(SortPropertyList sort)
      Searches for ports with the specified sort order.
      Parameters:
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching ports

    • search

      PaginatedFilteredList<Port> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for ports matching the specified filter and sort criteria.
      Parameters:
      filter - the filter criteria to apply
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching ports

    • getByUuid

      Port getByUuid(String uuid)
      Retrieves a single port by its unique identifier.
      Parameters:
      uuid - the unique identifier of the port
      Returns:
      the port matching the given UUID

    • getVlans

      List<PortVlan> getVlans(String portUuid)
      Lists the VLANs (link protocols) configured on a port.
      Parameters:
      portUuid - the unique identifier of the port
      Returns:
      the list of VLANs configured on the port

    • define

      PortOperator.PortBuilder define()
      Begins the fluent builder for creating a new port (POST /fabric/v4/ports). Configure the returned builder, then call create().
      Returns:
      a builder for configuring the new port

    • delete

      Port delete(String uuid)
      Deletes a port by its unique identifier (DELETE /fabric/v4/ports/{uuid}).
      Parameters:
      uuid - the unique identifier of the port to delete
      Returns:
      the deleted port as returned by the server

    • delete

      Port delete(String uuid, boolean dryRun)
      Deletes a port by its unique identifier, optionally as a validate-only dry run (DELETE /fabric/v4/ports/{uuid}?dryRun=true; spec: "option to verify that API calls will succeed"; boolean, default false).

      With dryRun = true nothing is deleted: the API responds 200 (rather than the real delete's 202 Accepted) with the existing port entity - uuid, name and all - that WOULD be deleted. With dryRun = false this behaves exactly like delete(String).

      Parameters:
      uuid - the unique identifier of the port to delete
      dryRun - true to only verify that the delete would succeed, without deleting
      Returns:
      the deleted port - or, on a dry run, the port that would be deleted

    • update

      PortOperator.PortUpdater update(String uuid)
      Begins a fluent update of an existing port (PATCH /fabric/v4/ports/{uuid}). Configure the returned updater, then call save().
      Parameters:
      uuid - the unique identifier of the port to update
      Returns:
      an updater for applying changes to the port

    • addToLag

      PhysicalPortsResponseJson addToLag(String portId, List<PhysicalPort> physicalPorts)
      Adds physical ports to a virtual port's Link Aggregation Group (POST /fabric/v4/ports/{portId}/physicalPorts/bulk).
      Parameters:
      portId - the virtual port uuid
      physicalPorts - the physical ports to add to the LAG
      Returns:
      the full set of physical ports backing the virtual port after the addition