Interface CloudRouterClient<T>

All Superinterfaces:

Pageable<T>, PageablePost<T>

All Known Implementing Classes:

CloudRouterClientImpl

public interface CloudRouterClient<T>
extends PageablePost<T>

Method Summary

Modifier and Type	Method	Description
CloudRouterJson	create(CloudRouterCreatorJson cloudRouterCreatorJson)
CloudRouterJson	delete(String uuid)
CloudRouterJson	dryRunCreate(CloudRouterCreatorJson cloudRouterCreatorJson)	Dry-run variant of create(CloudRouterCreatorJson): POSTs the same body to /fabric/v4/routers with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed".
CloudRouterAction	getAction(String routerId, String uuid)
List<CloudRouterAction>	getActions(String routerId)
CloudRouterJson	getByUuid(String uuid)
CloudRouterJson	refresh(String uuid)
Page<CloudRouterJson>	search(FilterPropertyList filter, SortPropertyList sort)
PaginatedFilteredList<CloudRouterAction>	searchActions(String routerId, FilterPropertyList filter, SortPropertyList sort)
PaginatedFilteredList<RouteAggregationAttachment>	searchRouteAggregationAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)
PaginatedFilteredList<RouteFilterAttachment>	searchRouteFilterAttachments(String routerId, FilterPropertyList filter, SortPropertyList sort)
CloudRouterJson	update(String uuid, List<PatchOperation> operations)
RoutingProtocolValidation	validateRoutingProtocol(String routerId, FilterPropertyList filter)

Methods inherited from interface Pageable

nextPage

Modifier and Type	Method	Description
PaginatedList<T>	nextPage(PaginatedRequest<T> equinixRequest)

Methods inherited from interface PageablePost

nextPage

Modifier and Type	Method	Description
PaginatedFilteredList<T>	nextPage(PaginatedPostRequest<T> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).

Method Details

search

Page<CloudRouterJson> search(FilterPropertyList filter,
 SortPropertyList sort)

getByUuid

CloudRouterJson getByUuid(String uuid)

create

CloudRouterJson create(CloudRouterCreatorJson cloudRouterCreatorJson)

dryRunCreate

CloudRouterJson dryRunCreate(CloudRouterCreatorJson cloudRouterCreatorJson)

Dry-run variant of create(CloudRouterCreatorJson): POSTs the same body to /fabric/v4/routers with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed". Nothing is provisioned; the API responds 200 with the validated request echoed back (no uuid/href/state).

update

CloudRouterJson update(String uuid,
 List<PatchOperation> operations)

delete

CloudRouterJson delete(String uuid)

refresh

CloudRouterJson refresh(String uuid)

validateRoutingProtocol

RoutingProtocolValidation validateRoutingProtocol(String routerId,
 FilterPropertyList filter)

getActions

List<CloudRouterAction> getActions(String routerId)

getAction

CloudRouterAction getAction(String routerId,
 String uuid)

searchActions

PaginatedFilteredList<CloudRouterAction> searchActions(String routerId,
 FilterPropertyList filter,
 SortPropertyList sort)

searchRouteFilterAttachments

PaginatedFilteredList<RouteFilterAttachment> searchRouteFilterAttachments(String routerId,
 FilterPropertyList filter,
 SortPropertyList sort)

searchRouteAggregationAttachments

PaginatedFilteredList<RouteAggregationAttachment> searchRouteAggregationAttachments(String routerId,
 FilterPropertyList filter,
 SortPropertyList sort)