MetricDefinition Class

  • Reference
Package:
com.azure.monitor.query.models
Maven Artifact:
com.azure:azure-monitor-query:1.3.0-beta.3
  • java.lang.Object
    • com.azure.monitor.query.models.MetricDefinition

public final class MetricDefinition

Metric definition class specifies the metadata for a metric.

Constructor Summary

Constructor Description
MetricDefinition()

Method Summary

Modifier and Type Method and Description
String getCategory()

Returns the custom category name for this metric.
String getDescription()

Returns the detailed description of this metric.
List<String> getDimensions()

Returns the names of all the dimensions available for this metric.
String getId()

The resource identifier of the metric definition.
List<MetricAvailability> getMetricAvailabilities()

Returns the collection of what aggregation intervals are available to be queried.
MetricClass getMetricClass()

Returns the class of the metric.
String getName()

Returns the name of the metric,
String getNamespace()

Returns the namespace the metric belongs to.
AggregationType getPrimaryAggregationType()

Returns the primary aggregation type value defining how to use the values for display.
String getResourceId()

Returns the resource identifier of the resource that emitted the metric.
List<AggregationType> getSupportedAggregationTypes()

Returns the collection of what aggregation types are supported.
MetricUnit getUnit()

Returns the unit of the metric.
Boolean isDimensionRequired()

Returns a flag to indicate whether the dimension is required.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricDefinition

public MetricDefinition()

Method Details

getCategory

public String getCategory()

Returns the custom category name for this metric.

Returns:

custom category name for this metric.

getDescription

public String getDescription()

Returns the detailed description of this metric.

Returns:

detailed description of this metric.

getDimensions

public List getDimensions()

Returns the names of all the dimensions available for this metric.

Returns:

the names of all the dimensions available for this metric.

getId

public String getId()

The resource identifier of the metric definition.

Returns:

the resource identifier of the metric definition.

getMetricAvailabilities

public List getMetricAvailabilities()

Returns the collection of what aggregation intervals are available to be queried.

Returns:

the collection of what aggregation intervals are available to be queried.

getMetricClass

public MetricClass getMetricClass()

Returns the class of the metric.

Returns:

the class of the metric.

getName

public String getName()

Returns the name of the metric,

Returns:

the name of the metric,

getNamespace

public String getNamespace()

Returns the namespace the metric belongs to.

Returns:

the namespace the metric belongs to.

getPrimaryAggregationType

public AggregationType getPrimaryAggregationType()

Returns the primary aggregation type value defining how to use the values for display.

Returns:

the primary aggregation type value defining how to use the values for display.

getResourceId

public String getResourceId()

Returns the resource identifier of the resource that emitted the metric.

Returns:

the resource identifier of the resource that emitted the metric.

getSupportedAggregationTypes

public List getSupportedAggregationTypes()

Returns the collection of what aggregation types are supported.

Returns:

the collection of what aggregation types are supported.

getUnit

public MetricUnit getUnit()

Returns the unit of the metric.

Returns:

the unit of the metric.

isDimensionRequired

public Boolean isDimensionRequired()

Returns a flag to indicate whether the dimension is required.

Returns:

Flag to indicate whether the dimension is required.

Applies to