Class HardThresholdCondition
java.lang.Object
com.azure.ai.metricsadvisor.administration.models.HardThresholdCondition
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 Summary
ConstructorDescriptionHardThresholdCondition
(AnomalyDetectorDirection detectorDirection, SuppressCondition suppressCondition) Create an instance of HardThresholdCondition describing how to identify anomalies using hard-threshold mode. -
Method Summary
Modifier and TypeMethodDescriptionGets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.Gets the lowerBound value.Gets the suppress condition.Gets the upperBound value.setAnomalyDetectorDirection
(AnomalyDetectorDirection detectorDirection) Sets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.setLowerBound
(Double lowerBound) Sets the lowerBound value.setSuppressCondition
(SuppressCondition suppressCondition) Sets the suppress condition.setUpperBound
(Double upperBound) Set the upperBound value.
-
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 valueAnomalyDetectorDirection.BOTH
indicates that any data point with a value not within the range defined bylowerBound
andupperBound
should be considered as an anomaly. A valueAnomalyDetectorDirection.UP
means a data point aboveupperBound
is considered as an anomaly, a valueAnomalyDetectorDirection.DOWN
means a data point belowlowerBound
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
Gets the lowerBound value.- Returns:
- the lowerBound value.
-
getUpperBound
Gets the upperBound value.- Returns:
- the upperBound value.
-
getAnomalyDetectorDirection
Gets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.- Returns:
- the detector direction.
-
getSuppressCondition
Gets the suppress condition.- Returns:
- the suppress condition value.
-
setLowerBound
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
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
Sets the suppress condition.- Parameters:
suppressCondition
- the suppress condition- Returns:
- the HardThresholdCondition object itself.
-