MetricsClient Interface

public interface MetricsClient

An instance of this class provides access to all the operations defined in MetricsClient.

Method Summary

Modifier and Type Method and Description
abstract ResponseInner list(String resourceUri)

**Lists the metric values for a resource**.

abstract Mono<ResponseInner> listAsync(String resourceUri)

**Lists the metric values for a resource**.

abstract Response<ResponseInner> listWithResponse(String resourceUri, String timespan, Duration interval, String metricnames, String aggregation, Integer top, String orderBy, String filter, ResultType resultType, String metricnamespace, Context context)

**Lists the metric values for a resource**.

abstract Mono<Response<ResponseInner>> listWithResponseAsync(String resourceUri, String timespan, Duration interval, String metricnames, String aggregation, Integer top, String orderBy, String filter, ResultType resultType, String metricnamespace)

**Lists the metric values for a resource**.

Method Details

list

public abstract ResponseInner list(String resourceUri)

**Lists the metric values for a resource**.

Parameters:

resourceUri - The identifier of the resource.

Returns:

the response to a metrics query.

listAsync

public abstract Mono listAsync(String resourceUri)

**Lists the metric values for a resource**.

Parameters:

resourceUri - The identifier of the resource.

Returns:

the response to a metrics query on successful completion of Mono.

listWithResponse

public abstract Response listWithResponse(String resourceUri, String timespan, Duration interval, String metricnames, String aggregation, Integer top, String orderBy, String filter, ResultType resultType, String metricnamespace, Context context)

**Lists the metric values for a resource**.

Parameters:

resourceUri - The identifier of the resource.
timespan - The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.
interval - The interval (i.e. timegrain) of the query.
metricnames - The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'.
aggregation - The list of aggregation types (comma separated) to retrieve.
top - The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10.
orderBy - The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc.
filter - The $filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 $filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' - Invalid variant: $filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2' This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: $filter=A eq 'a1' and B eq 'b1' and C eq 'c1' - Return all time series where A = a1 $filter=A eq 'a1' and B eq '' and C eq ''. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is dim (test) 1 Instead of using $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** When dimension name is dim (test) 3 and dimension value is dim3 (test) val Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' ".
resultType - Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.
metricnamespace - Metric namespace to query metric definitions for.
context - The context to associate with this operation.

Returns:

the response to a metrics query along with Response<T>.

listWithResponseAsync

public abstract Mono> listWithResponseAsync(String resourceUri, String timespan, Duration interval, String metricnames, String aggregation, Integer top, String orderBy, String filter, ResultType resultType, String metricnamespace)

**Lists the metric values for a resource**.

Parameters:

resourceUri - The identifier of the resource.
timespan - The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.
interval - The interval (i.e. timegrain) of the query.
metricnames - The names of the metrics (comma separated) to retrieve. Special case: If a metricname itself has a comma in it then use %2 to indicate it. Eg: 'Metric,Name1' should be 'Metric%2Name1'.
aggregation - The list of aggregation types (comma separated) to retrieve.
top - The maximum number of records to retrieve. Valid only if $filter is specified. Defaults to 10.
orderBy - The aggregation to use for sorting results and the direction of the sort. Only one order can be specified. Examples: sum asc.
filter - The $filter is used to reduce the set of metric data returned. Example: Metric contains metadata A, B and C. - Return all time series of C where A = a1 and B = b1 or b2 $filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' - Invalid variant: $filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2' This is invalid because the logical or operator cannot separate two different metadata names. - Return all time series where A = a1, B = b1 and C = c1: $filter=A eq 'a1' and B eq 'b1' and C eq 'c1' - Return all time series where A = a1 $filter=A eq 'a1' and B eq '' and C eq ''. Special case: When dimension name or dimension value uses round brackets. Eg: When dimension name is dim (test) 1 Instead of using $filter= "dim (test) 1 eq '' " use **$filter= "dim %2528test%2529 1 eq '' "** When dimension name is dim (test) 3 and dimension value is dim3 (test) val Instead of using $filter= "dim (test) 3 eq 'dim3 (test) val' " use $filter= "dim %2528test%2529 3 eq 'dim3 %2528test%2529 val' ".
resultType - Reduces the set of data collected. The syntax allowed depends on the operation. See the operation's description for details.
metricnamespace - Metric namespace to query metric definitions for.

Returns:

the response to a metrics query along with Response<T> on successful completion of Mono.

Applies to