Interface RouteFilterRules

All Known Implementing Classes:
RouteFilterRulesImpl
public interface RouteFilterRules
Client interface for managing rules within an Equinix Fabric route filter. Each rule defines a prefix match and action (permit/deny) that controls route acceptance.

  • Method Details

    • list

      PaginatedList<RouteFilterRule> list(String routeFilterId)
      Lists all rules belonging to the specified route filter.
      Parameters:
      routeFilterId - the unique identifier of the parent route filter
      Returns:
      a paginated list of route filter rules

    • getByUuid

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

    • define

      RouteFilterRuleOperator.RouteFilterRuleBuilder define(String routeFilterId)
      Begins the fluent builder for creating a new route filter rule. Call methods on the returned builder to configure the rule, then call create().
      Parameters:
      routeFilterId - the unique identifier of the parent route filter
      Returns:
      a builder for configuring the new route filter rule

    • replace

      RouteFilterRule replace(String routeFilterId, String uuid, RouteFilterRuleCreatorJson routeFilterRuleCreatorJson)
      Replaces an existing route filter rule's configuration in full.
      Parameters:
      routeFilterId - the unique identifier of the parent route filter
      uuid - the unique identifier of the route filter rule to replace
      routeFilterRuleCreatorJson - the new rule configuration
      Returns:
      the replaced route filter rule

    • createBulk

      List<RouteFilterRule> createBulk(String routeFilterId, List<RouteFilterRuleCreatorJson> routeFilterRuleCreatorJsonList)
      Creates multiple route filter rules under a route filter in a single request.
      Parameters:
      routeFilterId - the unique identifier of the parent route filter
      routeFilterRuleCreatorJsonList - the rule configurations to create
      Returns:
      the list of created route filter rules

    • search

      PaginatedFilteredList<RouteFilterRule> search(String routeFilterId, FilterPropertyList filter, SortPropertyList sort)
      Searches the rules belonging to a route filter using the given filter and sort criteria.
      Parameters:
      routeFilterId - the unique identifier of the parent route filter
      filter - the filter criteria to apply
      sort - the sort criteria to apply
      Returns:
      a paginated, filtered list of matching route filter rules

    • getChanges

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

    • getChange

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