Package com.azure.ai.metricsadvisor.administration.models

Class MetricSeriesGroupDetectionCondition

java.lang.Object
com.azure.ai.metricsadvisor.administration.models.MetricSeriesGroupDetectionCondition
public final class MetricSeriesGroupDetectionCondition extends Object
Conditions to detect anomalies in a group of time series.

  • Constructor Details

    • MetricSeriesGroupDetectionCondition

      public MetricSeriesGroupDetectionCondition(DimensionKey seriesGroupKey)
      Create an instance of MetricSeriesGroupAnomalyDetectionCondition.
      Parameters:
      seriesGroupKey - The time series key that identifies a group of series to apply the detection condition.

  • Method Details

    • getSeriesGroupKey

      public DimensionKey getSeriesGroupKey()
      Get the time series key that identifies a group of series to apply the detection condition.
      Returns:
      The time series group id.

    • getConditionOperator

      public DetectionConditionOperator getConditionOperator()
      Gets the logical operator applied across conditions.
      Returns:
      The logical operator applied across conditions.

    • getSmartDetectionCondition

      public SmartDetectionCondition getSmartDetectionCondition()
      Gets the anomaly smart detection condition.

      The smart detection condition defines the numerical value to adjust the tolerance of the anomalies, the higher the value, the narrower the band (upper/lower bounds) around time series. The series data points those are not within such boundaries are detected as anomalies.

      Returns:
      The Smart detection condition.

    • getHardThresholdCondition

      public HardThresholdCondition getHardThresholdCondition()
      Gets the hard threshold condition to detect anomalies.

      The smart detection condition defines the numerical value to adjust the tolerance of the anomalies, the higher the value, the narrower the band (upper/lower bounds) around time series. The series data points those are not within the boundaries are detected as anomalies.

      Returns:
      The hard threshold condition.

    • getChangeThresholdCondition

      public ChangeThresholdCondition getChangeThresholdCondition()
      Gets the change threshold condition to detect anomalies.

      The change threshold condition defines change percentage; the value of a data point is compared with previous data points; if the change percentage of the value is in or out of the range, then that data point is detected as anomalies.

      Returns:
      The change threshold condition.

    • setConditionOperator

      public MetricSeriesGroupDetectionCondition setConditionOperator(DetectionConditionOperator conditionOperator)
      Sets the logical operator to apply across conditions.
      Parameters:
      conditionOperator - The logical operator.
      Returns:
      The MetricSeriesGroupDetectionCondition object itself.

    • setSmartDetectionCondition

      public MetricSeriesGroupDetectionCondition setSmartDetectionCondition(SmartDetectionCondition smartDetectionCondition)
      Sets the smart detection condition.

      The smart detection condition defines the numerical value to adjust the tolerance of the anomalies, the higher the value, the narrower the band (upper/lower bounds) around time series. The series data points those are not within such boundaries are detected as anomalies.

      Parameters:
      smartDetectionCondition - The smart detection condition.
      Returns:
      The MetricSeriesGroupDetectionCondition object itself.

    • setHardThresholdCondition

      public MetricSeriesGroupDetectionCondition setHardThresholdCondition(HardThresholdCondition hardThresholdCondition)
      Sets the hard threshold condition.

      The hard threshold condition defines boundaries, the series data points those are not within the boundaries are detected as anomalies.

      Parameters:
      hardThresholdCondition - The hard threshold condition.
      Returns:
      The MetricSeriesGroupDetectionCondition object itself.

    • setChangeThresholdCondition

      public MetricSeriesGroupDetectionCondition setChangeThresholdCondition(ChangeThresholdCondition changeThresholdCondition)
      Sets the change threshold condition.

      The change threshold condition defines change percentage; the value of a data point is compared with previous data points; if the change percentage of the value is in or out of the range, then that data point is detected as anomalies.

      Parameters:
      changeThresholdCondition - The change threshold condition.
      Returns:
      The MetricSeriesGroupDetectionCondition object itself.