Class CloudRouterClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<CloudRouter, CloudRouterJson>

com.eqixiac.equinix.fabric.client.internal.implementation.CloudRouterClientImpl

All Implemented Interfaces:

Pageable<CloudRouter>, PageablePost<CloudRouter>, CloudRouterClient<CloudRouter>

public class CloudRouterClientImpl
extends ResourceClientBase<CloudRouter, CloudRouterJson>
implements CloudRouterClient<CloudRouter>

Nested Class Summary

Nested classes/interfaces inherited from class ClientBase

ClientBase.EquinixRequestBuilder

Modifier and Type	Class	Description
protected class	ClientBase.EquinixRequestBuilder	Fluent builder for constructing EquinixRequest instances.

Constructor Summary

Constructors

Constructor	Description
CloudRouterClientImpl(FabricConfigImpl configClient)

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 the spec's dryRun=true query parameter ("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)
protected CloudRouter	wrap(CloudRouterJson json)	Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Methods inherited from class ResourceClientBase

createOne, deleteOne, deleteOne, deleteOneByUuid, dryRunCreate, dryRunCreate, dryRunPatch, dryRunUpdate, getOne, getOne, getOneByUuid, listPage, listPage, listPage, listPagePath, nextPage, nextPage, patchOne, patchOne, postOne, postOne, postOne, searchPage, searchPage, searchPageQueryPaginated, searchPageQueryPaginated, updateOne, updateOne, updateOneByUuid

Modifier and Type	Method	Description
protected CloudRouterJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected CloudRouterJson	deleteOne(String serviceEndpoint, String uuid)
protected CloudRouterJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected CloudRouterJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected CloudRouterJson	dryRunCreate(String serviceEndpoint, Object body)
protected CloudRouterJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected CloudRouterJson	dryRunPatch(String serviceEndpoint, String uuid, List<PatchOperation> operations)	Dry-run variant of ResourceClientBase.patchOne(String, String, List): sends the identical RFC 6902 JSON Patch request (same application/json-patch+json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected CloudRouterJson	dryRunUpdate(String serviceEndpoint, String uuid, Object body)	Dry-run variant of ResourceClientBase.updateOne(String, String, Object): sends the identical update request (same default application/json content type) plus the dryRun=true query parameter - per the spec, an "option to verify that API calls will succeed".
protected CloudRouterJson	getOne(String serviceEndpoint, String uuid)
protected CloudRouterJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected CloudRouterJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<CloudRouterJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<CloudRouterJson>	listPage(String serviceEndpoint)
protected Page<CloudRouterJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<CloudRouterJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<CloudRouter>	nextPage(PaginatedPostRequest<CloudRouter> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<CloudRouter>	nextPage(PaginatedRequest<CloudRouter> equinixRequest)
protected CloudRouterJson	patchOne(String serviceEndpoint, String uuid, List<PatchOperation> operations)	PATCH a resource by uuid with an RFC 6902 JSON Patch operations array, sent with content-type application/json-patch+json.
protected CloudRouterJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected CloudRouterJson	postOne(String serviceEndpoint, Object creatorBody)
protected CloudRouterJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected CloudRouterJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<CloudRouterJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<CloudRouterJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<CloudRouterJson>	searchPageQueryPaginated(String serviceEndpoint, Object filterBody)	POST search whose pagination travels as offset/limit query parameters (per the endpoint's spec) rather than inside the body - e.g. assets v1 and the EIA services/prices searches.
protected Page<CloudRouterJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected CloudRouterJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected CloudRouterJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected CloudRouterJson	updateOneByUuid(String uuid, Object body)	update(uuid, body) via the derived Update<Singular> endpoint name.

Methods inherited from class ClientBase

booleanOp, buildRequest, buildRequest, buildRequestWithPathParams, buildRequestWithQueryParams, bytesOp, createReturningLocationUuid, getAs, getAs, getConfigClient, invoke, listAs, mapOp, newRequest, postAs, postForType, postForType, postForType, postListAs, stringOp, voidOp

Modifier and Type	Method	Description
protected boolean	booleanOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequest(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithPathParams(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Class<?> jsonClass)
protected <T> EquinixRequest<T>	buildRequestWithQueryParams(String serviceEndpoint, RequestType requestType, Map<String, List<String>> queryParams, Class<?> jsonClass)
protected byte[]	bytesOp(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams)
protected String	createReturningLocationUuid(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	POST a body, then return the created resource's uuid parsed from the response Location header (for endpoints that return 201 Location: .../{uuid} rather than a body).
protected <R> R	getAs(String serviceEndpoint, Class<R> responseType)
protected <R> R	getAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> responseType)
protected Config	getConfigClient()
protected <T> EquinixResponse<T>	invoke(EquinixRequest<T> equinixRequest)
protected <R> List<R>	listAs(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Class<R> elementType)
protected Map<String,String>	mapOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected ClientBase.EquinixRequestBuilder	newRequest(String serviceEndpoint)	Creates a fluent request builder for the given service endpoint.
protected <R> R	postAs(String serviceEndpoint, Object body, Class<R> responseType)
protected <R> R	postForType(String serviceEndpoint, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> R	postForType(String serviceEndpoint, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body, com.fasterxml.jackson.core.type.TypeReference<?> typeReference)
protected <R> List<R>	postListAs(String serviceEndpoint, Object body, Class<R> elementType)
protected String	stringOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)
protected void	voidOp(String serviceEndpoint, RequestType requestType, Map<String,String> pathParams, Map<String, List<String>> queryParams, Object body)	Execute a request for its side effect only - the response body is validated (throws on API error) and discarded.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CloudRouterClientImpl

public CloudRouterClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected CloudRouter wrap(CloudRouterJson json)

Description copied from class: ResourceClientBase

Wraps a JSON model into its public model type, binding this client so the returned object can refresh/delete/page itself.

Specified by:

wrap in class ResourceClientBase<CloudRouter, CloudRouterJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

search

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

Specified by:

search in interface CloudRouterClient<CloudRouter>

getByUuid

public CloudRouterJson getByUuid(String uuid)

Specified by:

getByUuid in interface CloudRouterClient<CloudRouter>

create

public CloudRouterJson create(CloudRouterCreatorJson cloudRouterCreatorJson)

Specified by:

create in interface CloudRouterClient<CloudRouter>

dryRunCreate

public CloudRouterJson dryRunCreate(CloudRouterCreatorJson cloudRouterCreatorJson)

Dry-run variant of create(CloudRouterCreatorJson): POSTs the same body to /fabric/v4/routers with the spec's dryRun=true query parameter ("option to verify that API calls will succeed"). Nothing is provisioned; the spec's dry-run example (CloudRouterResponseExampleDryRun) is the validated request echoed back with no uuid/href/state.

Specified by:

dryRunCreate in interface CloudRouterClient<CloudRouter>

Parameters:

cloudRouterCreatorJson - the create request body to validate

Returns:

the validated request echoed back by the API

update

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

Specified by:

update in interface CloudRouterClient<CloudRouter>

delete

public CloudRouterJson delete(String uuid)

Specified by:

delete in interface CloudRouterClient<CloudRouter>

refresh

public CloudRouterJson refresh(String uuid)

Specified by:

refresh in interface CloudRouterClient<CloudRouter>

validateRoutingProtocol

public RoutingProtocolValidation validateRoutingProtocol(String routerId,
 FilterPropertyList filter)

Specified by:

validateRoutingProtocol in interface CloudRouterClient<CloudRouter>

getActions

public List<CloudRouterAction> getActions(String routerId)

Specified by:

getActions in interface CloudRouterClient<CloudRouter>

getAction

public CloudRouterAction getAction(String routerId,
 String uuid)

Specified by:

getAction in interface CloudRouterClient<CloudRouter>

searchActions

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

Specified by:

searchActions in interface CloudRouterClient<CloudRouter>

searchRouteFilterAttachments

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

Specified by:

searchRouteFilterAttachments in interface CloudRouterClient<CloudRouter>

searchRouteAggregationAttachments

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

Specified by:

searchRouteAggregationAttachments in interface CloudRouterClient<CloudRouter>