Interface MetricClient<T>

All Superinterfaces:

Pageable<T>, PageablePost<T>

All Known Implementing Classes:

MetricClientImpl

public interface MetricClient<T>
extends PageablePost<T>

MetricClient interface. Internal client for the Fabric Metrics search API (POST /fabric/v4/metrics/search).

Author:

ianjones

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.

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

Searches metrics matching the supplied filter and sort criteria.

getMetricsByName

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

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.

Parameters:

name - the wildcard metric name (required)

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

Returns:

the matching metrics