HardThresholdCondition Class

Package:

com.azure.ai.metricsadvisor.administration.models

Maven Artifact:

com.azure:azure-ai-metricsadvisor:1.2.4

• java.lang.Object
• • com.azure.ai.metricsadvisor.administration.models.HardThresholdCondition

public final class 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

Constructor	Description
HardThresholdCondition(AnomalyDetectorDirection detectorDirection, SuppressCondition suppressCondition)	Create an instance of HardThresholdCondition describing how to identify anomalies using hard-threshold mode.

Method Summary

Modifier and Type	Method and Description
AnomalyDetectorDirection	getAnomalyDetectorDirection() Gets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.
Double	getLowerBound() Gets the lowerBound value.
SuppressCondition	getSuppressCondition() Gets the suppress condition.
Double	getUpperBound() Gets the upperBound value.
HardThresholdCondition	setAnomalyDetectorDirection(AnomalyDetectorDirection detectorDirection) Sets the direction that detector should use when comparing data point value against lowerBound and/or upperBound.
HardThresholdCondition	setLowerBound(Double lowerBound) Sets the lowerBound value.
HardThresholdCondition	setSuppressCondition(SuppressCondition suppressCondition) Sets the suppress condition.
HardThresholdCondition	setUpperBound(Double upperBound) Set the upperBound value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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 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 UP means a data point above upperBound is considered as an anomaly, a value 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

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.

getLowerBound

public Double getLowerBound()

Gets the lowerBound value.

Returns:

the lowerBound value.

getSuppressCondition

public SuppressCondition getSuppressCondition()

Gets the suppress condition.

Returns:

the suppress condition value.

getUpperBound

public Double getUpperBound()

Gets the upperBound value.

Returns:

the upperBound value.

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.

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.

setSuppressCondition

public HardThresholdCondition setSuppressCondition(SuppressCondition suppressCondition)

Sets the suppress condition.

Parameters:

suppressCondition - the suppress condition

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.