Package api.equinix.javasdk.fabric.client

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 Summary

Modifier and Type	Method	Description
CloudRouterOperator.CloudRouterBuilder	define()	Begins the fluent builder for creating a new cloud router.
CloudRouter	getByUuid(String uuid)	Retrieves a single cloud router by its unique identifier.
CloudRouterPackage	routerPackageByCode(CloudRouterPackageCode packageCode)	Retrieves a specific cloud router package by its package code.
PaginatedList<CloudRouterPackage>	routerPackages()	Lists all available cloud router packages.
PaginatedFilteredList<CloudRouter>	search()	Searches for cloud routers using default filter and sort criteria.
PaginatedFilteredList<CloudRouter>	search(FilterPropertyList filter)	Searches for cloud routers matching the specified filter criteria.
PaginatedFilteredList<CloudRouter>	search(FilterPropertyList filter, SortPropertyList sort)	Searches for cloud routers matching the specified filter and sort criteria.
PaginatedFilteredList<CloudRouter>	search(SortPropertyList sort)	Searches for cloud routers with the specified sort order.

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