Interface RoutingProtocols

All Known Implementing Classes:
RoutingProtocolsImpl
public interface RoutingProtocols
Client interface for managing routing protocols on Equinix Fabric connections. Routing protocols (BGP, Direct) control how routes are exchanged over a connection.

  • Method Details

    • list

      PaginatedList<RoutingProtocol> list(String connectionId)
      Lists all routing protocols configured on the specified connection.
      Parameters:
      connectionId - the unique identifier of the connection
      Returns:
      a paginated list of routing protocols for the connection

    • getByUuid

      RoutingProtocol getByUuid(String connectionId, String uuid)
      Retrieves a single routing protocol by its unique identifier on the specified connection.
      Parameters:
      connectionId - the unique identifier of the connection
      uuid - the unique identifier of the routing protocol
      Returns:
      the routing protocol matching the given UUID

    • define

      RoutingProtocolOperator.RoutingProtocolBuilder define()
      Begins the fluent builder for creating a new routing protocol. Call methods on the returned builder to configure the protocol, then call create().
      Returns:
      a builder for configuring the new routing protocol

    • replace

      RoutingProtocol replace(String connectionId, String uuid, RoutingProtocolOperator.RoutingProtocolBuilder builder)
      Replaces (full update via PUT) an existing routing protocol with the configuration described by the supplied builder. Unlike a PATCH, the supplied configuration replaces the routing protocol in its entirety.
      Parameters:
      connectionId - the unique identifier of the connection
      uuid - the unique identifier of the routing protocol to replace
      builder - a configured routing protocol builder (as returned by define())
      Returns:
      the replaced routing protocol

    • createBulk

      List<RoutingProtocol> createBulk(String connectionId, List<RoutingProtocolOperator.RoutingProtocolBuilder> builders)
      Creates multiple routing protocols on a connection in a single bulk request.
      Parameters:
      connectionId - the unique identifier of the connection
      builders - the configured routing protocol builders (each as returned by define())
      Returns:
      the list of created routing protocols

    • getBgpActions

      List<BGPAction> getBgpActions(String connectionId, String routingProtocolId)
      Lists the BGP clear/reset actions issued against a routing protocol on a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routingProtocolId - the unique identifier of the routing protocol
      Returns:
      the list of BGP actions

    • createBgpAction

      BGPAction createBgpAction(String connectionId, String routingProtocolId, BGPActionType type)
      Issues a BGP clear/reset action against a routing protocol on a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routingProtocolId - the unique identifier of the routing protocol
      type - the BGP action type (clear/reset, IPv4/IPv6, inbound)
      Returns:
      the created BGP action

    • getBgpAction

      BGPAction getBgpAction(String connectionId, String routingProtocolId, String actionId)
      Retrieves a single BGP clear/reset action by its identifier.
      Parameters:
      connectionId - the unique identifier of the connection
      routingProtocolId - the unique identifier of the routing protocol
      actionId - the unique identifier of the BGP action
      Returns:
      the BGP action

    • getChanges

      List<Change> getChanges(String connectionId, String routingProtocolId)
      Lists the changes recorded against a routing protocol on a connection.
      Parameters:
      connectionId - the unique identifier of the connection
      routingProtocolId - the unique identifier of the routing protocol
      Returns:
      the list of routing protocol changes

    • getChange

      Change getChange(String connectionId, String routingProtocolId, String changeId)
      Retrieves a single routing protocol change by its identifier.
      Parameters:
      connectionId - the unique identifier of the connection
      routingProtocolId - the unique identifier of the routing protocol
      changeId - the unique identifier of the change
      Returns:
      the routing protocol change