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

Class HardThresholdCondition

java.lang.Object
com.azure.ai.metricsadvisor.administration.models.HardThresholdCondition
public final class HardThresholdCondition extends Object
Type that describes hard-threshold parameters. In hard-threshold mode, metrics advisor watch for any data points that falls out of the boundary and detect such data points as anomalies.

  • Constructor Details

    • HardThresholdCondition

      public HardThresholdCondition(AnomalyDetectorDirection detectorDirection, SuppressCondition suppressCondition)
      Create an instance of HardThresholdCondition describing how to identify anomalies using hard-threshold mode.
      Parameters:
      detectorDirection - a value AnomalyDetectorDirection.BOTH indicates that any data point with a value not within the range defined by lowerBound and upperBound should be considered as an anomaly. A value AnomalyDetectorDirection.UP means a data point above upperBound is considered as an anomaly, a value AnomalyDetectorDirection.DOWN means a data point below lowerBound is considered as an anomaly.
      suppressCondition - the condition to aggregate the anomaly detection reporting, suppressing the reporting of individual anomalies helps to avoid noises, especially if the metrics have fine granularity.

  • Method Details

    • getLowerBound

      public Double getLowerBound()
      Gets the lowerBound value.
      Returns:
      the lowerBound value.

    • getUpperBound

      public Double getUpperBound()
      Gets the upperBound value.
      Returns:
      the upperBound value.

    • getAnomalyDetectorDirection

      public AnomalyDetectorDirection getAnomalyDetectorDirection()
      Gets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.
      Returns:
      the detector direction.

    • getSuppressCondition

      public SuppressCondition getSuppressCondition()
      Gets the suppress condition.
      Returns:
      the suppress condition value.

    • setLowerBound

      public HardThresholdCondition setLowerBound(Double lowerBound)
      Sets the lowerBound value.

      lowerBound be specified when anomalyDetectorDirection is Both or Down.

      Parameters:
      lowerBound - the lowerBound value to set.
      Returns:
      the HardThresholdCondition object itself.

    • setUpperBound

      public HardThresholdCondition setUpperBound(Double upperBound)
      Set the upperBound value.

      upperBound should be specified when anomalyDetectorDirection is Both or Up.

      Parameters:
      upperBound - the upperBound value to set.
      Returns:
      the HardThresholdCondition object itself.

    • setAnomalyDetectorDirection

      public HardThresholdCondition setAnomalyDetectorDirection(AnomalyDetectorDirection detectorDirection)
      Sets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.
      Parameters:
      detectorDirection - the detector direction
      Returns:
      the HardThresholdCondition object itself.

    • setSuppressCondition

      public HardThresholdCondition setSuppressCondition(SuppressCondition suppressCondition)
      Sets the suppress condition.
      Parameters:
      suppressCondition - the suppress condition
      Returns:
      the HardThresholdCondition object itself.