Package com.azure.monitor.query.models

Class MetricDefinition

java.lang.Object
com.azure.monitor.query.models.MetricDefinition
public final class MetricDefinition extends Object
Metric definition class specifies the metadata for a metric.

  • Constructor Details

    • MetricDefinition

      public MetricDefinition()

  • Method Details

    • isDimensionRequired

      public Boolean isDimensionRequired()
      Returns a flag to indicate whether the dimension is required.
      Returns:
      Flag to indicate whether the dimension is required.

    • 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.

    • getNamespace

      public String getNamespace()
      Returns the namespace the metric belongs to.
      Returns:
      the namespace the metric belongs to.

    • getName

      public String getName()
      Returns the name of the metric,
      Returns:
      the name of the metric,

    • getDescription

      public String getDescription()
      Returns the detailed description of this metric.
      Returns:
      detailed description of this metric.

    • getCategory

      public String getCategory()
      Returns the custom category name for this metric.
      Returns:
      custom category name for this metric.

    • getMetricClass

      public MetricClass getMetricClass()
      Returns the class of the metric.
      Returns:
      the class of the metric.

    • getUnit

      public MetricUnit getUnit()
      Returns the unit of the metric.
      Returns:
      the unit of the metric.

    • 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.

    • getSupportedAggregationTypes

      public List<AggregationType> getSupportedAggregationTypes()
      Returns the collection of what aggregation types are supported.
      Returns:
      the collection of what aggregation types are supported.

    • getMetricAvailabilities

      public List<MetricAvailability> 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.

    • getId

      public String getId()
      The resource identifier of the metric definition.
      Returns:
      the resource identifier of the metric definition.

    • getDimensions

      public List<String> getDimensions()
      Returns the names of all the dimensions available for this metric.
      Returns:
      the names of all the dimensions available for this metric.