Interface RouteFilters

All Known Implementing Classes:
RouteFiltersImpl
public interface RouteFilters
Client interface for managing Equinix Fabric route filters. Route filters control which routes are accepted or rejected on a connection's routing protocol.

  • Method Details

    • search

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

    • search

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

    • search

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

    • search

      PaginatedFilteredList<RouteFilter> search(FilterPropertyList filter, SortPropertyList sort)
      Searches for route filters 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 route filters

    • getByUuid

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

    • define

      RouteFilterOperator.RouteFilterBuilder define()
      Begins the fluent builder for creating a new route filter. Call methods on the returned builder to configure the filter, then call create().
      Returns:
      a builder for configuring the new route filter

    • getChanges

      List<Change> getChanges(String uuid)
      Retrieves the change history for a route filter.
      Parameters:
      uuid - the unique identifier of the route filter
      Returns:
      the list of changes applied to the route filter

    • getChange

      Change getChange(String uuid, String changeId)
      Retrieves a single change applied to a route filter by its change identifier.
      Parameters:
      uuid - the unique identifier of the route filter
      changeId - the unique identifier of the change
      Returns:
      the matching change

    • getConnections

      List<Connection> getConnections(String uuid)
      Retrieves the connections currently using a route filter.
      Parameters:
      uuid - the unique identifier of the route filter
      Returns:
      the list of connections attached to the route filter