MetricSeriesGroupDetectionCondition 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.MetricSeriesGroupDetectionCondition

public final class MetricSeriesGroupDetectionCondition

Conditions to detect anomalies in a group of time series.

Constructor Summary

Constructor	Description
MetricSeriesGroupDetectionCondition(DimensionKey seriesGroupKey)	Create an instance of MetricSeriesGroupAnomalyDetectionCondition.

Method Summary

Modifier and Type	Method and Description
ChangeThresholdCondition	getChangeThresholdCondition() Gets the change threshold condition to detect anomalies.
DetectionConditionOperator	getConditionOperator() Gets the logical operator applied across conditions.
HardThresholdCondition	getHardThresholdCondition() Gets the hard threshold condition to detect anomalies.
DimensionKey	getSeriesGroupKey() Get the time series key that identifies a group of series to apply the detection condition.
SmartDetectionCondition	getSmartDetectionCondition() Gets the anomaly smart detection condition.
MetricSeriesGroupDetectionCondition	setChangeThresholdCondition(ChangeThresholdCondition changeThresholdCondition) Sets the change threshold condition.
MetricSeriesGroupDetectionCondition	setConditionOperator(DetectionConditionOperator conditionOperator) Sets the logical operator to apply across conditions.
MetricSeriesGroupDetectionCondition	setHardThresholdCondition(HardThresholdCondition hardThresholdCondition) Sets the hard threshold condition.
MetricSeriesGroupDetectionCondition	setSmartDetectionCondition(SmartDetectionCondition smartDetectionCondition) Sets the smart detection condition.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

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

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.

getConditionOperator

public DetectionConditionOperator getConditionOperator()

Gets the logical operator applied across conditions.

Returns:

The logical operator applied across conditions.

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.

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.

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.

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.

setConditionOperator

public MetricSeriesGroupDetectionCondition setConditionOperator(DetectionConditionOperator conditionOperator)

Sets the logical operator to apply across conditions.

Parameters:

conditionOperator - The logical operator.

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.

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.