Package com.azure.ai.metricsadvisor.models

Class ListMetricSeriesDefinitionOptions

java.lang.Object
com.azure.ai.metricsadvisor.models.ListMetricSeriesDefinitionOptions
public final class ListMetricSeriesDefinitionOptions extends Object
Additional parameters for the API to list metric series definition information for a metric.

  • Constructor Details

    • ListMetricSeriesDefinitionOptions

      public ListMetricSeriesDefinitionOptions()

  • Method Details

    • getDimensionCombinationsToFilter

      public Map<String,List<String>> getDimensionCombinationsToFilter()
      Gets the dimension key and values.

      This enables additional filtering of the metric series for the provided dimension combinations. For example, let's say we've the dimensions 'category' and 'city', so the api can query metric series for the dimension combination 'category', and 'city'.

      Returns:
      The dimension key and values.

    • getMaxPageSize

      public Integer getMaxPageSize()
      Gets limit indicating the number of items that will be included in a service returned page.
      Returns:
      The max page size value.

    • getSkip

      public Integer getSkip()
      Gets the number of items in the queried collection that will be skipped and not included in the returned result.
      Returns:
      The skip value.

    • setDimensionCombinationToFilter

      public ListMetricSeriesDefinitionOptions setDimensionCombinationToFilter(Map<String,List<String>> dimensionCombination)
      Sets the dimension key and values.

      This enables additional filtering of the metric series for the provided dimension combinations. For example, let's say we've the dimensions 'category' and 'city', so the api can query metric series for the dimension combination 'category', and 'city'.

      Parameters:
      dimensionCombination - The dimension combinations to filter by.
      Returns:
      ListMetricSeriesDefinitionOptions itself.

    • setMaxPageSize

      public ListMetricSeriesDefinitionOptions setMaxPageSize(Integer maxPageSize)
      Sets limit indicating the number of items to be included in a service returned page.
      Parameters:
      maxPageSize - The max page size value.
      Returns:
      The ListMetricSeriesDefinitionOptions object itself.

    • setSkip

      public ListMetricSeriesDefinitionOptions setSkip(Integer skip)
      Sets the number of items in the queried collection that are to be skipped and not included in the returned result.
      Parameters:
      skip - The skip value.
      Returns:
      ListMetricSeriesDefinitionOptions itself.