Share via

MetricsQueryResourcesOptions Class

Package:
com.azure.monitor.query.models
Maven Artifact:
com.azure:azure-monitor-query:1.5.8
  • java.lang.Object
    • com.azure.monitor.query.models.MetricsQueryResourcesOptions

public final class MetricsQueryResourcesOptions

The model class to configure the metrics batch query options.

Constructor Summary

Constructor Description
MetricsQueryResourcesOptions()

Creates an instance of MetricsQueryResourcesOptions.

Method Summary

Modifier and Type Method and Description
List<AggregationType> getAggregations()

Returns the list of aggregations that should be applied to the metrics data.
String getFilter()

Returns the filter to be applied to the query.
Duration getGranularity()

Returns the interval (window size) for which the metric data was returned in.
String getOrderBy()

Returns the order in which the query results should be ordered.
String getRollupBy()

Gets the dimension name(s) to rollup results by.
QueryTimeInterval getTimeInterval()

Returns the time span for which the metrics data is queried.
Integer getTop()

Returns the number of top metrics values to query.
MetricsQueryResourcesOptions setAggregations(List<AggregationType> aggregations)

Sets the list of aggregations that should be applied to the metrics data.
MetricsQueryResourcesOptions setFilter(String filter)

Sets the filter to be applied to the query.
MetricsQueryResourcesOptions setGranularity(Duration granularity)

Sets the interval (window size) for which the metric data was returned in.
MetricsQueryResourcesOptions setOrderBy(String orderBy)

Sets the order in which the query results should be ordered.
MetricsQueryResourcesOptions setRollupBy(String rollupBy)

Sets the dimension name(s) to rollup results by.
MetricsQueryResourcesOptions setTimeInterval(QueryTimeInterval timeInterval)

Sets the time span for which the metrics data is queried.
MetricsQueryResourcesOptions setTop(Integer top)

Sets the number of top metrics values to query.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricsQueryResourcesOptions

public MetricsQueryResourcesOptions()

Creates an instance of MetricsQueryResourcesOptions.

Method Details

getAggregations

public List<AggregationType> getAggregations()

Returns the list of aggregations that should be applied to the metrics data.

Returns:

the list of aggregations that should be applied to the metrics data.

getFilter

public String getFilter()

Returns the filter to be applied to the query. The filter users OData format.

Returns:

the filter to be applied to the query. The filter users OData format.

getGranularity

public Duration getGranularity()

Returns the interval (window size) for which the metric data was returned in.

Returns:

The interval (window size) for which the metric data was returned in.

getOrderBy

public String getOrderBy()

Returns the order in which the query results should be ordered.

Returns:

the order in which the query results should be ordered.

getRollupBy

public String getRollupBy()

Gets the dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

Returns:

the dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

getTimeInterval

public QueryTimeInterval getTimeInterval()

Returns the time span for which the metrics data is queried.

Returns:

the time span for which the metrics data is queried.

getTop

public Integer getTop()

Returns the number of top metrics values to query.

Returns:

the number of top metrics values to query.

setAggregations

public MetricsQueryResourcesOptions setAggregations(List<AggregationType> aggregations)

Sets the list of aggregations that should be applied to the metrics data.

Parameters:

aggregations - the list of aggregations that should be applied to the metrics data.

Returns:

The updated options instance

setFilter

public MetricsQueryResourcesOptions setFilter(String filter)

Sets the filter to be applied to the query. The filter users OData format.

Parameters:

filter - the filter to be applied to the query. The filter users OData format.

Returns:

The updated options instance

setGranularity

public MetricsQueryResourcesOptions setGranularity(Duration granularity)

Sets the interval (window size) for which the metric data was returned in.

Parameters:

granularity - The interval (window size) for which the metric data was returned in.

Returns:

The updated options instance

setOrderBy

public MetricsQueryResourcesOptions setOrderBy(String orderBy)

Sets the order in which the query results should be ordered.

Parameters:

orderBy - the order in which the query results should be ordered.

Returns:

The updated options instance

setRollupBy

public MetricsQueryResourcesOptions setRollupBy(String rollupBy)

Sets the dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

Parameters:

rollupBy - the dimension name(s) to rollup results by. For example if you only want to see metric values with a filter like 'City eq Seattle or City eq Tacoma' but don't want to see separate values for each city, you can specify 'RollUpBy=City' to see the results for Seattle and Tacoma rolled up into one timeseries.

Returns:

The updated options instance

setTimeInterval

public MetricsQueryResourcesOptions setTimeInterval(QueryTimeInterval timeInterval)

Sets the time span for which the metrics data is queried.

Parameters:

timeInterval - the time span for which the metrics data is queried.

Returns:

The updated options instance

setTop

public MetricsQueryResourcesOptions setTop(Integer top)

Sets the number of top metrics values to query.

Parameters:

top - the number of top metrics values to query.

Returns:

The updated options instance

Applies to