Package com.azure.monitor.query.models

Class MetricsQueryOptions

java.lang.Object
com.azure.monitor.query.models.MetricsQueryOptions
public final class MetricsQueryOptions extends Object
The model class to configure the metrics query options.

  • Constructor Details

    • MetricsQueryOptions

      public MetricsQueryOptions()

  • Method Details

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

    • setTimeInterval

      public MetricsQueryOptions 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

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

    • setGranularity

      public MetricsQueryOptions 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

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

    • setAggregations

      public MetricsQueryOptions 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

    • setAggregations

      public MetricsQueryOptions setAggregations(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

    • getTop

      public Integer getTop()
      Returns the number of top metrics values to query.
      Returns:
      the number of top metrics values to query.

    • setTop

      public MetricsQueryOptions 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

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

    • setOrderBy

      public MetricsQueryOptions 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

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

    • setFilter

      public MetricsQueryOptions 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

    • getMetricNamespace

      public String getMetricNamespace()
      Returns the namespace of the metrics been queried
      Returns:
      the namespace of the metrics been queried

    • setMetricNamespace

      public MetricsQueryOptions setMetricNamespace(String metricNamespace)
      Sets the namespace of the metrics been queried
      Parameters:
      metricNamespace - the namespace of the metrics been queried
      Returns:
      The updated options instance