Interface Connections

All Known Implementing Classes:
ConnectionsImpl
public interface Connections
Client interface for managing Equinix Fabric connections. Provides operations for searching, retrieving, creating, and monitoring connections between Fabric endpoints.
Author:
ianjones

  • Method Details

    • search

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

    • search

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

    • search

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

    • search

      PaginatedFilteredList<Connection> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for connections 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 connections

    • validate

      List<ValidateConnectionResult> validate(FilterPropertyList filter)
      Validates one or more prospective connections against the supplied filter criteria, for example a cloud provider authorization key or VLAN availability, without creating the connection. Mirrors the SDK's existing Fabric search filter shape.
      Parameters:
      filter - the validation filter criteria (auth key or VLAN)
      Returns:
      the list of connection specifications matching the validation request

    • getByUuid

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

    • define

      ConnectionOperator.ConnectionBuilder define(ConnectionType connectionType)
      Begins the fluent builder for creating a new connection. Call methods on the returned builder to configure the connection, then call create().
      Parameters:
      connectionType - the type of connection to create
      Returns:
      a builder for configuring the new connection

    • searchAdvertisedRoutes

      PaginatedFilteredList<RouteTableEntry> searchAdvertisedRoutes(String uuid)
      Searches the routes a connection's Cloud Router is advertising to the customer, with default filter and sort criteria.
      Parameters:
      uuid - the unique identifier of the connection
      Returns:
      a paginated, filtered list of advertised route table entries

    • searchAdvertisedRoutes

      PaginatedFilteredList<RouteTableEntry> searchAdvertisedRoutes(String uuid, FilterPropertyList filter, SortPropertyList sort)
      Searches the routes a connection's Cloud Router is advertising to the customer.
      Parameters:
      uuid - the unique identifier of the connection
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of advertised route table entries

    • searchReceivedRoutes

      PaginatedFilteredList<RouteTableEntry> searchReceivedRoutes(String uuid)
      Searches the routes a connection's Cloud Router has received from the customer, with default filter and sort criteria.
      Parameters:
      uuid - the unique identifier of the connection
      Returns:
      a paginated, filtered list of received route table entries

    • searchReceivedRoutes

      PaginatedFilteredList<RouteTableEntry> searchReceivedRoutes(String uuid, FilterPropertyList filter, SortPropertyList sort)
      Searches the routes a connection's Cloud Router has received from the customer.
      Parameters:
      uuid - the unique identifier of the connection
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of received route table entries

    • getRouteAggregations

      List<RouteAggregationAttachment> getRouteAggregations(String connectionId)
      Lists all Route Aggregations attached to a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      Returns:
      the list of route aggregation attachments

    • getRouteAggregation

      RouteAggregationAttachment getRouteAggregation(String connectionId, String routeAggregationId)
      Retrieves a single Route Aggregation attached to a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routeAggregationId - the unique identifier of the route aggregation
      Returns:
      the route aggregation attachment

    • attachRouteAggregation

      RouteAggregationAttachment attachRouteAggregation(String connectionId, String routeAggregationId)
      Attaches a Route Aggregation to a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routeAggregationId - the unique identifier of the route aggregation to attach
      Returns:
      the resulting route aggregation attachment

    • detachRouteAggregation

      Boolean detachRouteAggregation(String connectionId, String routeAggregationId)
      Detaches a Route Aggregation from a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routeAggregationId - the unique identifier of the route aggregation to detach
      Returns:
      true if the detach request was accepted

    • getRouteFilters

      List<RouteFilterAttachment> getRouteFilters(String connectionId)
      Lists all Route Filters attached to a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      Returns:
      the list of route filter attachments

    • getRouteFilter

      RouteFilterAttachment getRouteFilter(String connectionId, String routeFilterId)
      Retrieves a single Route Filter attached to a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routeFilterId - the unique identifier of the route filter
      Returns:
      the route filter attachment

    • attachRouteFilter

      RouteFilterAttachment attachRouteFilter(String connectionId, String routeFilterId, Direction direction)
      Attaches a Route Filter to a connection in the given direction.
      Parameters:
      connectionId - the unique identifier of the connection
      routeFilterId - the unique identifier of the route filter to attach
      direction - the direction to apply the route filter (INBOUND or OUTBOUND)
      Returns:
      the resulting route filter attachment

    • detachRouteFilter

      Boolean detachRouteFilter(String connectionId, String routeFilterId)
      Detaches a Route Filter from a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routeFilterId - the unique identifier of the route filter to detach
      Returns:
      true if the detach request was accepted