Skip to content

MetricQueryBuilder🔗

Constructor🔗

new MetricQueryBuilder()

Methods🔗

build🔗

Builds the object.

public MetricQuery build()

aggregation🔗

The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.

public MetricQueryBuilder aggregation(String aggregation)

alias🔗

Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.

public MetricQueryBuilder alias(String alias)

allowedTimeGrainsMs🔗

Time grains that are supported by the metric.

public MetricQueryBuilder allowedTimeGrainsMs(List<Long> allowedTimeGrainsMs)

customNamespace🔗

Used as the value for the metricNamespace property when it's different from the resource namespace.

public MetricQueryBuilder customNamespace(String customNamespace)

dimension🔗

@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration

public MetricQueryBuilder dimension(String dimension)

dimensionFilter🔗

@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration

public MetricQueryBuilder dimensionFilter(String dimensionFilter)

dimensionFilters🔗

Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.

public MetricQueryBuilder dimensionFilters(List<com.grafana.foundation.cog.Builder<MetricDimension>> dimensionFilters)

metricDefinition🔗

@deprecated Use metricNamespace instead

public MetricQueryBuilder metricDefinition(String metricDefinition)

metricName🔗

The metric to query data for within the specified metricNamespace. e.g. UsedCapacity

public MetricQueryBuilder metricName(String metricName)

metricNamespace🔗

metricNamespace is used as the resource type (or resource namespace).

It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts

Kept the name of the variable as metricNamespace to avoid backward incompatibility issues.

public MetricQueryBuilder metricNamespace(String metricNamespace)

region🔗

The Azure region containing the resource(s).

public MetricQueryBuilder region(String region)

resourceGroup🔗

@deprecated Use resources instead

public MetricQueryBuilder resourceGroup(String resourceGroup)

resourceName🔗

@deprecated Use resources instead

public MetricQueryBuilder resourceName(String resourceName)

resourceUri🔗

@deprecated Use resourceGroup, resourceName and metricNamespace instead

public MetricQueryBuilder resourceUri(String resourceUri)

resources🔗

Array of resource URIs to be queried.

public MetricQueryBuilder resources(List<com.grafana.foundation.cog.Builder<MonitorResource>> resources)

timeGrain🔗

The granularity of data points to be queried. Defaults to auto.

public MetricQueryBuilder timeGrain(String timeGrain)

timeGrainUnit🔗

@deprecated

public MetricQueryBuilder timeGrainUnit(String timeGrainUnit)

top🔗

Maximum number of records to return. Defaults to 10.

public MetricQueryBuilder top(String top)

See also🔗