Class NetworkClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Network, NetworkJson>

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

All Implemented Interfaces:

Pageable<Network>, PageablePost<Network>, NetworkClient<Network>

public class NetworkClientImpl
extends ResourceClientBase<Network, NetworkJson>
implements NetworkClient<Network>

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
NetworkClientImpl(FabricConfigImpl configClient)

Method Summary

Modifier and Type	Method	Description
NetworkJson	create(NetworkCreatorJson networkCreatorJson)
NetworkJson	delete(String uuid)
NetworkJson	dryRunCreate(NetworkCreatorJson networkCreatorJson)	Dry-run variant of create(NetworkCreatorJson): POSTs the same body to /fabric/v4/networks with the spec's dryRun=true query parameter ("option to verify that API calls will succeed").
NetworkJson	getByUuid(String uuid)
Change	getChange(String uuid, String changeId)
List<Change>	getChanges(String uuid)
Page<ConnectionJson>	getConnections(String networkId)
NetworkJson	refresh(String uuid)
Page<NetworkJson>	search(FilterPropertyList filter, SortPropertyList sort)
NetworkJson	update(String uuid, List<PatchOperation> operations)
protected Network	wrap(NetworkJson 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 NetworkJson	createOne(Object creatorBody)	create(body) via the derived Create<Singular> endpoint name.
protected NetworkJson	deleteOne(String serviceEndpoint, String uuid)
protected NetworkJson	deleteOne(String serviceEndpoint, Map<String,String> pathParams)
protected NetworkJson	deleteOneByUuid(String uuid)	delete(uuid) via the derived Delete<Singular> endpoint name.
protected NetworkJson	dryRunCreate(String serviceEndpoint, Object body)
protected NetworkJson	dryRunCreate(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected NetworkJson	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 NetworkJson	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 NetworkJson	getOne(String serviceEndpoint, String uuid)
protected NetworkJson	getOne(String serviceEndpoint, Map<String,String> pathParams)
protected NetworkJson	getOneByUuid(String uuid)	get(uuid) via the derived Get<Singular> endpoint name.
protected Page<NetworkJson>	listPage()	list() via the derived List<Plural> endpoint name.
protected Page<NetworkJson>	listPage(String serviceEndpoint)
protected Page<NetworkJson>	listPage(String serviceEndpoint, Map<String, List<String>> queryParams)
protected Page<NetworkJson>	listPagePath(String serviceEndpoint, Map<String,String> pathParams)
PaginatedFilteredList<Network>	nextPage(PaginatedPostRequest<Network> equinixRequest)	Fetches the next page for the given POST-search request (its body's pagination has already been advanced by the paging pipeline).
PaginatedList<Network>	nextPage(PaginatedRequest<Network> equinixRequest)
protected NetworkJson	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 NetworkJson	patchOne(String serviceEndpoint, Map<String,String> pathParams, List<PatchOperation> operations)
protected NetworkJson	postOne(String serviceEndpoint, Object creatorBody)
protected NetworkJson	postOne(String serviceEndpoint, Object body, com.fasterxml.jackson.databind.ser.FilterProvider filters)
protected NetworkJson	postOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected Page<NetworkJson>	searchPage(Object filterSortBody)	search(body) via the derived Search<Plural> endpoint name.
protected Page<NetworkJson>	searchPage(String serviceEndpoint, Object filterSortBody)
protected Page<NetworkJson>	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<NetworkJson>	searchPageQueryPaginated(String serviceEndpoint, Map<String, List<String>> queryParams, Object filterBody)	Variant of ResourceClientBase.searchPageQueryPaginated(String, Object) carrying additional query parameters (e.g.
protected NetworkJson	updateOne(String serviceEndpoint, String uuid, Object body)
protected NetworkJson	updateOne(String serviceEndpoint, Map<String,String> pathParams, Object body)
protected NetworkJson	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

NetworkClientImpl

public NetworkClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected Network wrap(NetworkJson 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<Network, NetworkJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

search

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

Specified by:

search in interface NetworkClient<Network>

getConnections

public Page<ConnectionJson> getConnections(String networkId)

Specified by:

getConnections in interface NetworkClient<Network>

getChanges

public List<Change> getChanges(String uuid)

Specified by:

getChanges in interface NetworkClient<Network>

getChange

public Change getChange(String uuid,
 String changeId)

Specified by:

getChange in interface NetworkClient<Network>

getByUuid

public NetworkJson getByUuid(String uuid)

Specified by:

getByUuid in interface NetworkClient<Network>

create

public NetworkJson create(NetworkCreatorJson networkCreatorJson)

Specified by:

create in interface NetworkClient<Network>

dryRunCreate

public NetworkJson dryRunCreate(NetworkCreatorJson networkCreatorJson)

Dry-run variant of create(NetworkCreatorJson): POSTs the same body to /fabric/v4/networks 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 (CreateNetworkDryRunResponse) is the validated request echoed back with no uuid/href/state.

Specified by:

dryRunCreate in interface NetworkClient<Network>

Parameters:

networkCreatorJson - the create request body to validate

Returns:

the validated request echoed back by the API

update

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

Specified by:

update in interface NetworkClient<Network>

delete

public NetworkJson delete(String uuid)

Specified by:

delete in interface NetworkClient<Network>

refresh

public NetworkJson refresh(String uuid)

Specified by:

refresh in interface NetworkClient<Network>