Interface CloudRouters

All Known Implementing Classes:
CloudRoutersImpl
public interface CloudRouters
Client interface for managing Equinix Fabric Cloud Routers. Provides operations for searching, retrieving, creating cloud routers and querying available router packages.

  • Method Details

    • search

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

    • search

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

    • search

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

    • search

      PaginatedFilteredList<CloudRouter> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for cloud routers 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 cloud routers

    • getByUuid

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

    • define

      CloudRouterOperator.CloudRouterBuilder define()
      Begins the fluent builder for creating a new cloud router. Call methods on the returned builder to configure the router, then call create().
      Returns:
      a builder for configuring the new cloud router

    • routerPackages

      PaginatedList<CloudRouterPackage> routerPackages()
      Lists all available cloud router packages.
      Returns:
      a paginated list of cloud router packages

    • routerPackageByCode

      CloudRouterPackage routerPackageByCode(CloudRouterPackageCode packageCode)
      Retrieves a specific cloud router package by its package code.
      Parameters:
      packageCode - the code identifying the router package
      Returns:
      the cloud router package matching the given code

    • searchRoutes

      PaginatedFilteredList<RouteTableEntry> searchRoutes(String routerId)
      Searches the route table of a Fabric Cloud Router using default filter and sort criteria.
      Parameters:
      routerId - the unique identifier of the cloud router
      Returns:
      a paginated, filtered list of route table entries

    • searchRoutes

      PaginatedFilteredList<RouteTableEntry> searchRoutes(String routerId, FilterPropertyList filter, SortPropertyList sort)
      Searches the route table of a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of route table entries

    • validateRoutingProtocol

      RoutingProtocolValidation validateRoutingProtocol(String routerId, FilterPropertyList filter)
      Validates all subnets associated with the connections on a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the validation filter (for example a direct interface IP and connection uuid)
      Returns:
      the validation result

    • commands

      List<CloudRouterCommand> commands(String routerId)
      Lists all diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router. 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.
      Parameters:
      routerId - the unique identifier of the cloud router
      Returns:
      the cloud router commands

    • getCommand

      CloudRouterCommand getCommand(String routerId, String commandId)
      Retrieves a single Fabric Cloud Router diagnostic command by its unique identifier.
      Parameters:
      routerId - the unique identifier of the cloud router
      commandId - the unique identifier of the command
      Returns:
      the cloud router command matching the given UUID

    • defineCommand

      CloudRouterCommandOperator.CloudRouterCommandBuilder defineCommand(String routerId)
      Begins the fluent builder for issuing a new Fabric Cloud Router diagnostic command.
      Parameters:
      routerId - the unique identifier of the cloud router
      Returns:
      a builder for configuring the new command

    • deleteCommand

      Boolean deleteCommand(String routerId, String commandId)
      Deletes a Fabric Cloud Router diagnostic command by its unique identifier.
      Parameters:
      routerId - the unique identifier of the cloud router
      commandId - the unique identifier of the command
      Returns:
      true if the command was deleted

    • getActions

      List<CloudRouterAction> getActions(String routerId)
      Lists all route-table / BGP-session actions issued against a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      Returns:
      the list of cloud router actions

    • getAction

      CloudRouterAction getAction(String routerId, String uuid)
      Retrieves a single Fabric Cloud Router action by its unique identifier.
      Parameters:
      routerId - the unique identifier of the cloud router
      uuid - the unique identifier of the action
      Returns:
      the cloud router action matching the given UUID

    • searchActions

      PaginatedFilteredList<CloudRouterAction> searchActions(String routerId, FilterPropertyList filter, SortPropertyList sort)
      Searches the route-table / BGP-session actions issued against a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of cloud router actions

    • searchCommands

      PaginatedFilteredList<CloudRouterCommand> searchCommands(String routerId, FilterPropertyList filter, SortPropertyList sort)
      Searches the diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of cloud router commands

    • searchRouteFilterAttachments

      PaginatedFilteredList<RouteFilterAttachment> searchRouteFilterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)
      Searches the Route Filter attachments for a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of route filter attachments

    • searchRouteAggregationAttachments

      PaginatedFilteredList<RouteAggregationAttachment> searchRouteAggregationAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)
      Searches the Route Aggregation attachments for a Fabric Cloud Router.
      Parameters:
      routerId - the unique identifier of the cloud router
      filter - the filter criteria to apply (may be null)
      sort - the sort criteria to apply (may be null)
      Returns:
      a paginated, filtered list of route aggregation attachments