Interface ConnectionClient<T>

All Superinterfaces:

Pageable<T>, PageablePost<T>

All Known Implementing Classes:

ConnectionClientImpl

public interface ConnectionClient<T>
extends PageablePost<T>

Author:

ianjones

Method Summary

Modifier and Type	Method	Description
RouteAggregationAttachment	attachRouteAggregation(String connectionId, String routeAggregationId)
RouteFilterAttachment	attachRouteFilter(String connectionId, String routeFilterId, Direction direction)
ConnectionJson	create(ConnectionCreatorJson connectionCreatorJson)
Boolean	detachRouteAggregation(String connectionId, String routeAggregationId)
Boolean	detachRouteFilter(String connectionId, String routeFilterId)
ConnectionJson	dryRunCreate(ConnectionCreatorJson connectionCreatorJson)
ConnectionJson	dryRunUpdate(String uuid, List<PatchOperation> operations)	Dry-run variant of update(String, List): sends the same JSON Patch to PATCH /fabric/v4/connections/{uuid} with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed".
ConnectionJson	getByUuid(String uuid)
RouteAggregationAttachment	getRouteAggregation(String connectionId, String routeAggregationId)
List<RouteAggregationAttachment>	getRouteAggregations(String connectionId)
RouteFilterAttachment	getRouteFilter(String connectionId, String routeFilterId)
List<RouteFilterAttachment>	getRouteFilters(String connectionId)
ConnectionActionJson	performOperation(String uuid, ConnectionOperationType connectionOperationType, String description, Object bodyObject)
Page<ConnectionJson>	search(FilterPropertyList filter, SortPropertyList sort)
ConnectionJson	update(String uuid, List<PatchOperation> operations)
List<ValidateConnectionResult>	validate(FilterPropertyList filter)	Validates connections against the supplied filter (auth key or VLAN availability).

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<ConnectionJson> search(FilterPropertyList filter,
 SortPropertyList sort)

validate

List<ValidateConnectionResult> validate(FilterPropertyList filter)

Validates connections against the supplied filter (auth key or VLAN availability).

Returns:

a List of ValidateConnectionResult objects.

getByUuid

ConnectionJson getByUuid(String uuid)

create

ConnectionJson create(ConnectionCreatorJson connectionCreatorJson)

dryRunCreate

ConnectionJson dryRunCreate(ConnectionCreatorJson connectionCreatorJson)

performOperation

ConnectionActionJson performOperation(String uuid,
 ConnectionOperationType connectionOperationType,
 String description,
 Object bodyObject)

update

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

dryRunUpdate

ConnectionJson dryRunUpdate(String uuid,
 List<PatchOperation> operations)

Dry-run variant of update(String, List): sends the same JSON Patch to PATCH /fabric/v4/connections/{uuid} with dryRun=true - per the Fabric v4 spec, an "option to verify that API calls will succeed". Nothing is persisted; the API responds 200 (the real update responds 202) with a simulation of the post-update connection.

getRouteAggregations

List<RouteAggregationAttachment> getRouteAggregations(String connectionId)

getRouteAggregation

RouteAggregationAttachment getRouteAggregation(String connectionId,
 String routeAggregationId)

attachRouteAggregation

RouteAggregationAttachment attachRouteAggregation(String connectionId,
 String routeAggregationId)

detachRouteAggregation

Boolean detachRouteAggregation(String connectionId,
 String routeAggregationId)

getRouteFilters

List<RouteFilterAttachment> getRouteFilters(String connectionId)

getRouteFilter

RouteFilterAttachment getRouteFilter(String connectionId,
 String routeFilterId)

attachRouteFilter

RouteFilterAttachment attachRouteFilter(String connectionId,
 String routeFilterId,
 Direction direction)

detachRouteFilter

Boolean detachRouteFilter(String connectionId,
 String routeFilterId)