Class CageClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Cage,CageJson>

com.eqixiac.equinix.internetaccess.client.internal.implementation.CageClientImpl

All Implemented Interfaces:

Pageable<Cage>, PageablePost<Cage>, CageClient

public class CageClientImpl
extends ResourceClientBase<Cage,CageJson>
implements CageClient

Internal client implementation for the Equinix Internet Access (EIA) v1 product-availability lookup GET /internetAccess/v1/cages. The Cage response is read-only, so the deserialized CageJson (which implements Cage directly) is returned without a wrapper.

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
CageClientImpl(InternetAccessConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
Page<CageJson>	list(String ibx, String accountNumber)
protected Cage	wrap(CageJson 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 CageJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected CageJson	deleteOne(String serviceEndpoint, String uuid)
protected CageJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected CageJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected CageJson	dryRunCreate(String serviceEndpoint, Object body)
protected CageJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected CageJson	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 CageJson	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 CageJson	getOne(String serviceEndpoint, String uuid)
protected CageJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected CageJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<CageJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<CageJson>	listPage(String serviceEndpoint)
protected Page<CageJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<CageJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Cage>	nextPage(PaginatedPostRequest<Cage> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Cage>	nextPage(PaginatedRequest<Cage> equinixRequest)
protected CageJson	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 CageJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected CageJson	postOne(String serviceEndpoint, Object creatorBody)
protected CageJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected CageJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<CageJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<CageJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<CageJson>	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<CageJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected CageJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected CageJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected CageJson	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

CageClientImpl

public CageClientImpl(InternetAccessConfigImpl configClient)

Method Details

wrap

protected Cage wrap(CageJson 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<Cage,CageJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

list

public Page<CageJson> list(String ibx,
 String accountNumber)

Specified by:

list in interface CageClient