Class CloudRoutersImpl
java.lang.Object
com.eqixiac.equinix.fabric.client.implementation.CloudRoutersImpl
- All Implemented Interfaces:
CloudRouters
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionLists all diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router.define()Begins the fluent builder for creating a new cloud router.defineCommand(String routerId) Begins the fluent builder for issuing a new Fabric Cloud Router diagnostic command.deleteCommand(String routerId, String commandId) Deletes a Fabric Cloud Router diagnostic command by its unique identifier.Retrieves a single Fabric Cloud Router action by its unique identifier.getActions(String routerId) Lists all route-table / BGP-session actions issued against a Fabric Cloud Router.Retrieves a single cloud router by its unique identifier.getCommand(String routerId, String commandId) Retrieves a single Fabric Cloud Router diagnostic command by its unique identifier.routerPackageByCode(CloudRouterPackageCode packageCode) Retrieves a specific cloud router package by its package code.Lists all available cloud router packages.search()Searches for cloud routers using default filter and sort criteria.search(FilterPropertyList filter) Searches for cloud routers matching the specified filter criteria.search(FilterPropertyList filter, SortPropertyList sort) Searches for cloud routers matching the specified filter and sort criteria.search(SortPropertyList sort) Searches for cloud routers with the specified sort order.searchActions(String routerId, FilterPropertyList filter, SortPropertyList sort) Searches the route-table / BGP-session actions issued against a Fabric Cloud Router.searchCommands(String routerId, FilterPropertyList filter, SortPropertyList sort) Searches the diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router.searchRouteAggregationAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort) Searches the Route Aggregation attachments for a Fabric Cloud Router.searchRouteFilterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort) Searches the Route Filter attachments for a Fabric Cloud Router.searchRoutes(String routerId) Searches the route table of a Fabric Cloud Router using default filter and sort criteria.searchRoutes(String routerId, FilterPropertyList filter, SortPropertyList sort) Searches the route table of a Fabric Cloud Router.validateRoutingProtocol(String routerId, FilterPropertyList filter) Validates all subnets associated with the connections on a Fabric Cloud Router.
-
Constructor Details
-
CloudRoutersImpl
public CloudRoutersImpl()
-
-
Method Details
-
search
Description copied from interface:CloudRoutersSearches for cloud routers using default filter and sort criteria.- Specified by:
searchin interfaceCloudRouters- Returns:
- a paginated, filtered list of matching cloud routers
-
search
Description copied from interface:CloudRoutersSearches for cloud routers matching the specified filter criteria.- Specified by:
searchin interfaceCloudRouters- Parameters:
filter- the filter criteria to apply- Returns:
- a paginated, filtered list of matching cloud routers
-
search
Description copied from interface:CloudRoutersSearches for cloud routers with the specified sort order.- Specified by:
searchin interfaceCloudRouters- Parameters:
sort- the sort criteria to apply- Returns:
- a paginated, filtered list of matching cloud routers
-
search
Description copied from interface:CloudRoutersSearches for cloud routers matching the specified filter and sort criteria.- Specified by:
searchin interfaceCloudRouters- Parameters:
filter- the filter criteria to applysort- the sort criteria to apply- Returns:
- a paginated, filtered list of matching cloud routers
-
getByUuid
Description copied from interface:CloudRoutersRetrieves a single cloud router by its unique identifier.- Specified by:
getByUuidin interfaceCloudRouters- Parameters:
uuid- the unique identifier of the cloud router- Returns:
- the cloud router matching the given UUID
-
define
Description copied from interface:CloudRoutersBegins the fluent builder for creating a new cloud router. Call methods on the returned builder to configure the router, then callcreate().- Specified by:
definein interfaceCloudRouters- Returns:
- a builder for configuring the new cloud router
-
routerPackages
Description copied from interface:CloudRoutersLists all available cloud router packages.- Specified by:
routerPackagesin interfaceCloudRouters- Returns:
- a paginated list of cloud router packages
-
routerPackageByCode
Description copied from interface:CloudRoutersRetrieves a specific cloud router package by its package code.- Specified by:
routerPackageByCodein interfaceCloudRouters- Parameters:
packageCode- the code identifying the router package- Returns:
- the cloud router package matching the given code
-
searchRoutes
Description copied from interface:CloudRoutersSearches the route table of a Fabric Cloud Router using default filter and sort criteria.- Specified by:
searchRoutesin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud router- Returns:
- a paginated, filtered list of route table entries
-
searchRoutes
public PaginatedFilteredList<RouteTableEntry> searchRoutes(String routerId, FilterPropertyList filter, SortPropertyList sort) Description copied from interface:CloudRoutersSearches the route table of a Fabric Cloud Router.- Specified by:
searchRoutesin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the filter criteria to apply (may benull)sort- the sort criteria to apply (may benull)- Returns:
- a paginated, filtered list of route table entries
-
validateRoutingProtocol
public RoutingProtocolValidation validateRoutingProtocol(String routerId, FilterPropertyList filter) Description copied from interface:CloudRoutersValidates all subnets associated with the connections on a Fabric Cloud Router.- Specified by:
validateRoutingProtocolin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the validation filter (for example a direct interface IP and connection uuid)- Returns:
- the validation result
-
commands
Description copied from interface:CloudRoutersLists all diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router. Spec 4.34.0 declares nooffseton this GET and the live service returns every item in one response (forGET /ports:limit 999,offsetandlimitignored, observed 2026-11-11), so this is a plain list, not a multi-page one.- Specified by:
commandsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud router- Returns:
- the cloud router commands
-
getCommand
Description copied from interface:CloudRoutersRetrieves a single Fabric Cloud Router diagnostic command by its unique identifier.- Specified by:
getCommandin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routercommandId- the unique identifier of the command- Returns:
- the cloud router command matching the given UUID
-
defineCommand
Description copied from interface:CloudRoutersBegins the fluent builder for issuing a new Fabric Cloud Router diagnostic command.- Specified by:
defineCommandin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud router- Returns:
- a builder for configuring the new command
-
deleteCommand
Description copied from interface:CloudRoutersDeletes a Fabric Cloud Router diagnostic command by its unique identifier.- Specified by:
deleteCommandin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routercommandId- the unique identifier of the command- Returns:
trueif the command was deleted
-
getActions
Description copied from interface:CloudRoutersLists all route-table / BGP-session actions issued against a Fabric Cloud Router.- Specified by:
getActionsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud router- Returns:
- the list of cloud router actions
-
getAction
Description copied from interface:CloudRoutersRetrieves a single Fabric Cloud Router action by its unique identifier.- Specified by:
getActionin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routeruuid- the unique identifier of the action- Returns:
- the cloud router action matching the given UUID
-
searchActions
public PaginatedFilteredList<CloudRouterAction> searchActions(String routerId, FilterPropertyList filter, SortPropertyList sort) Description copied from interface:CloudRoutersSearches the route-table / BGP-session actions issued against a Fabric Cloud Router.- Specified by:
searchActionsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the filter criteria to apply (may benull)sort- the sort criteria to apply (may benull)- Returns:
- a paginated, filtered list of cloud router actions
-
searchCommands
public PaginatedFilteredList<CloudRouterCommand> searchCommands(String routerId, FilterPropertyList filter, SortPropertyList sort) Description copied from interface:CloudRoutersSearches the diagnostic commands (ping / traceroute) issued against a Fabric Cloud Router.- Specified by:
searchCommandsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the filter criteria to apply (may benull)sort- the sort criteria to apply (may benull)- Returns:
- a paginated, filtered list of cloud router commands
-
searchRouteFilterAttachments
public PaginatedFilteredList<RouteFilterAttachment> searchRouteFilterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort) Description copied from interface:CloudRoutersSearches the Route Filter attachments for a Fabric Cloud Router.- Specified by:
searchRouteFilterAttachmentsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the filter criteria to apply (may benull)sort- the sort criteria to apply (may benull)- Returns:
- a paginated, filtered list of route filter attachments
-
searchRouteAggregationAttachments
public PaginatedFilteredList<RouteAggregationAttachment> searchRouteAggregationAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort) Description copied from interface:CloudRoutersSearches the Route Aggregation attachments for a Fabric Cloud Router.- Specified by:
searchRouteAggregationAttachmentsin interfaceCloudRouters- Parameters:
routerId- the unique identifier of the cloud routerfilter- the filter criteria to apply (may benull)sort- the sort criteria to apply (may benull)- Returns:
- a paginated, filtered list of route aggregation attachments
-