Interface RouteAggregationRules

All Known Implementing Classes:
RouteAggregationRulesImpl
public interface RouteAggregationRules
Client interface for managing rules within an Equinix Fabric route aggregation. Each rule defines a prefix that participates in the parent route aggregation.

  • Method Details

    • list

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

    • getByUuid

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

    • define

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

    • replace

      RouteAggregationRule replace(String routeAggregationId, String uuid, RouteAggregationRuleCreatorJson routeAggregationRuleCreatorJson)
      Replaces an existing route aggregation rule's configuration in full.
      Parameters:
      routeAggregationId - the unique identifier of the parent route aggregation
      uuid - the unique identifier of the route aggregation rule to replace
      routeAggregationRuleCreatorJson - the new rule configuration
      Returns:
      the replaced route aggregation rule

    • createBulk

      List<RouteAggregationRule> createBulk(String routeAggregationId, List<RouteAggregationRuleCreatorJson> routeAggregationRuleCreatorJsonList)
      Creates multiple route aggregation rules under a route aggregation in a single request.
      Parameters:
      routeAggregationId - the unique identifier of the parent route aggregation
      routeAggregationRuleCreatorJsonList - the rule configurations to create
      Returns:
      the list of created route aggregation rules

    • search

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

    • getChanges

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

    • getChange

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