AnomalyDetectionConfiguration Class

Package:

com.azure.ai.metricsadvisor.administration.models

Maven Artifact:

com.azure:azure-ai-metricsadvisor:1.2.3

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

public final class AnomalyDetectionConfiguration

Configuration to detect anomalies in metric time series.

Constructor Summary

Constructor	Description
AnomalyDetectionConfiguration(String name)	Create a new instance of MetricAnomalyDetectionConfiguration.

Method Summary

Modifier and Type	Method and Description
AnomalyDetectionConfiguration	addSeriesGroupDetectionCondition(MetricSeriesGroupDetectionCondition groupCondition) Adds anomaly detection condition for a specific group of time series.
AnomalyDetectionConfiguration	addSingleSeriesDetectionCondition(MetricSingleSeriesDetectionCondition seriesCondition) Adds anomaly detection condition for a specific time series.
String	getDescription() Gets the configuration description.
String	getId() Gets the configuration id.
String	getMetricId() Gets the id of metric for which the configuration is applied.
String	getName() Gets the configuration name.
List<MetricSingleSeriesDetectionCondition>	getSeriesDetectionConditions() Gets the list of anomaly detection conditions, where each list entry describes detection conditions for a specific time series.
List<MetricSeriesGroupDetectionCondition>	getSeriesGroupDetectionConditions() Gets the list of anomaly detection conditions, where each list entry describes detection conditions for a group of time series.
MetricWholeSeriesDetectionCondition	getWholeSeriesDetectionCondition() Gets the common anomaly detection conditions for all time series in the metric.
AnomalyDetectionConfiguration	removeSeriesGroupDetectionCondition(DimensionKey seriesGroupKey) Removes anomaly detection condition for a specific group of time series.
AnomalyDetectionConfiguration	removeSingleSeriesDetectionCondition(DimensionKey seriesKey) Removes anomaly detection condition for a specific time series.
AnomalyDetectionConfiguration	setDescription(String description) Sets the configuration description.
AnomalyDetectionConfiguration	setName(String name) Sets the configuration name.
AnomalyDetectionConfiguration	setWholeSeriesDetectionCondition(MetricWholeSeriesDetectionCondition wholeSeriesCondition) Sets the common anomaly detection conditions for all time series of the metric.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AnomalyDetectionConfiguration

public AnomalyDetectionConfiguration(String name)

Create a new instance of MetricAnomalyDetectionConfiguration.

Parameters:

name - The configuration name.

Method Details

addSeriesGroupDetectionCondition

public AnomalyDetectionConfiguration addSeriesGroupDetectionCondition(MetricSeriesGroupDetectionCondition groupCondition)

Adds anomaly detection condition for a specific group of time series.

Parameters:

groupCondition - The detection conditions for a group of time series, a null value for this parameter is ignored.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

addSingleSeriesDetectionCondition

public AnomalyDetectionConfiguration addSingleSeriesDetectionCondition(MetricSingleSeriesDetectionCondition seriesCondition)

Adds anomaly detection condition for a specific time series.

Parameters:

seriesCondition - The detection conditions for a specific time series, a null value for this parameter is ignored.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

getDescription

public String getDescription()

Gets the configuration description.

Returns:

The configuration description.

getId

public String getId()

Gets the configuration id.

Returns:

The configuration id.

getMetricId

public String getMetricId()

Gets the id of metric for which the configuration is applied.

Returns:

The metric id.

getName

public String getName()

Gets the configuration name.

Returns:

The configuration name.

getSeriesDetectionConditions

public List getSeriesDetectionConditions()

Gets the list of anomaly detection conditions, where each list entry describes detection conditions for a specific time series.

Returns:

The list of anomaly detection conditions for time series.

getSeriesGroupDetectionConditions

public List getSeriesGroupDetectionConditions()

Gets the list of anomaly detection conditions, where each list entry describes detection conditions for a group of time series.

Returns:

The list of anomaly detection conditions for time series group.

getWholeSeriesDetectionCondition

public MetricWholeSeriesDetectionCondition getWholeSeriesDetectionCondition()

Gets the common anomaly detection conditions for all time series in the metric.

Returns:

The detection conditions for all time series.

removeSeriesGroupDetectionCondition

public AnomalyDetectionConfiguration removeSeriesGroupDetectionCondition(DimensionKey seriesGroupKey)

Removes anomaly detection condition for a specific group of time series.

Parameters:

seriesGroupKey - Identifies the time series group to remove the conditions for, null value for this parameter is ignored.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

removeSingleSeriesDetectionCondition

public AnomalyDetectionConfiguration removeSingleSeriesDetectionCondition(DimensionKey seriesKey)

Removes anomaly detection condition for a specific time series.

Parameters:

seriesKey - The key identifying the time series, a null value for this parameter is ignored.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

setDescription

public AnomalyDetectionConfiguration setDescription(String description)

Sets the configuration description.

Parameters:

description - The configuration description.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

setName

public AnomalyDetectionConfiguration setName(String name)

Sets the configuration name.

Parameters:

name - The configuration name.

Returns:

The MetricAnomalyDetectionConfiguration object itself.

setWholeSeriesDetectionCondition

public AnomalyDetectionConfiguration setWholeSeriesDetectionCondition(MetricWholeSeriesDetectionCondition wholeSeriesCondition)

Sets the common anomaly detection conditions for all time series of the metric.

Parameters:

wholeSeriesCondition - The detection conditions for all time series, a null value for this parameter is ignored.

Returns:

The MetricAnomalyDetectionConfiguration object itself.