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

Class MetricSingleSeriesDetectionCondition

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

  • Constructor Details

    • MetricSingleSeriesDetectionCondition

      public MetricSingleSeriesDetectionCondition(DimensionKey seriesKey)
      Create an instance of MetricSingleSeriesAnomalyDetectionCondition.
      Parameters:
      seriesKey - The time series key that identifies the series to apply the detection condition.

  • Method Details

    • getSeriesKey

      public DimensionKey getSeriesKey()
      Get the time series key.
      Returns:
      The time series key.

    • 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 MetricSingleSeriesDetectionCondition setConditionOperator(DetectionConditionOperator conditionOperator)
      Sets the logical operator to apply across conditions.
      Parameters:
      conditionOperator - The logical operator.
      Returns:
      The MetricSingleSeriesDetectionCondition object itself.

    • setSmartDetectionCondition

      public MetricSingleSeriesDetectionCondition 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 MetricSingleSeriesDetectionCondition object itself.

    • setHardThresholdCondition

      public MetricSingleSeriesDetectionCondition 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 MetricSingleSeriesDetectionCondition object itself.

    • setChangeThresholdCondition

      public MetricSingleSeriesDetectionCondition 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 MetricSingleSeriesDetectionCondition object itself.