Class MetricClientImpl

java.lang.Object

com.eqixiac.equinix.core.client.ClientBase

com.eqixiac.equinix.core.client.ResourceClientBase<Metric, MetricJson>

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

All Implemented Interfaces:

Pageable<Metric>, PageablePost<Metric>, MetricClient<Metric>

public class MetricClientImpl
extends ResourceClientBase<Metric, MetricJson>
implements MetricClient<Metric>

Internal client for the Fabric Metrics search API (POST /fabric/v4/metrics/search). Standard POST-search paging comes from ResourceClientBase; since MetricJson implements Metric directly, wrap(MetricJson) is the identity.

Author:

ianjones

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

Method Summary

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

MetricClientImpl

public MetricClientImpl(FabricConfigImpl configClient)

Method Details

wrap

protected Metric wrap(MetricJson 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<Metric, MetricJson>

Parameters:

json - the deserialized JSON model

Returns:

the public model wrapper

search

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

Description copied from interface: MetricClient

Searches metrics matching the supplied filter and sort criteria.

Specified by:

search in interface MetricClient<Metric>

getMetricsByName

public List<Metric> getMetricsByName(String name,
 String value)

Description copied from interface: MetricClient

Retrieves metrics by wildcard metric name (GET /fabric/v4/metrics). Only the wildcard metro metric types are supported by this endpoint (for example equinix.fabric.metro.*.latency). This endpoint does not support time-range filtering.

Specified by:

getMetricsByName in interface MetricClient<Metric>

Parameters:

name - the wildcard metric name (required)

value - which value to retrieve (for example last; required)

Returns:

the matching metrics