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

public final class MetricBoundaryCondition

Defines the boundary conditions for the anomaly (abnormal data points) to be included in the alert.

Constructor Summary

Constructor	Description
MetricBoundaryCondition()	Creates a new instance of MetricBoundaryCondition.

Method Summary

Modifier and Type	Method and Description
String	getCompanionMetricId() Gets the id of the companion metric.
BoundaryDirection	getDirection() Gets the boundary direction.
Double	getLowerBoundary() Gets the lower boundary, if the detected abnormal data point is below this value then it will be included in the alert.
BoundaryMeasureType	getMeasureType() Gets the measure type that detector should use for measuring data-points.
Double	getUpperBoundary() Gets the upper boundary.
MetricBoundaryCondition	setBoundary(BoundaryDirection direction, Double lowerBoundary, Double upperBoundary) Sets the boundary.
MetricBoundaryCondition	setCompanionMetricId(String companionMetricId) Sets the companion metric id.
MetricBoundaryCondition	setCompanionMetricId(String companionMetricId, boolean alertIfMissing) Sets the companion metric id.
MetricBoundaryCondition	setMeasureType(BoundaryMeasureType measureType) Sets the measure type that detector should use for measuring data-points.
Boolean	shouldAlertIfDataPointMissing() True if alert will be triggered when the companion-metric data-points are out of boundary but the corresponding data-point is missing for the original metric.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

MetricBoundaryCondition

public MetricBoundaryCondition()

Creates a new instance of MetricBoundaryCondition.

Method Details

getCompanionMetricId

public String getCompanionMetricId()

Gets the id of the companion metric. When the companion-metric is set for a metric, the abnormal data points detected in the original metric will be included in the alert only if data points values of corresponding series in companion-metric are not within the boundary.

Returns:

The companion metric id.

getDirection

public BoundaryDirection getDirection()

Gets the boundary direction.

Returns:

The boundary direction.

getLowerBoundary

public Double getLowerBoundary()

Gets the lower boundary, if the detected abnormal data point is below this value then it will be included in the alert. This boundary is taken into consideration only if the direction is either LOWER or BOTH.

Returns:

The lower boundary.

getMeasureType

public BoundaryMeasureType getMeasureType()

Gets the measure type that detector should use for measuring data-points.

Returns:

the measure type.

getUpperBoundary

public Double getUpperBoundary()

Gets the upper boundary. if the detected abnormal data point is above this value then it will be included in the alert. This boundary is taken into consideration only if the direction is either UPPER or BOTH.

Returns:

The upper boundary.

setBoundary

public MetricBoundaryCondition setBoundary(BoundaryDirection direction, Double lowerBoundary, Double upperBoundary)

Sets the boundary.

Parameters:

direction - Both lowerBoundary and upperBoundary must be specified when the direction is BOTH. The lowerBoundary must be specified for LOWER, similarly upperBoundary must set specified for UPPER.

lowerBoundary - The lower boundary value.

upperBoundary - The upper boundary value.

Returns:

The MetricBoundaryCondition object itself.

setCompanionMetricId

public MetricBoundaryCondition setCompanionMetricId(String companionMetricId)

Sets the companion metric id. When the companion-metric is set for a metric, an anomaly detected in the original metric will be included in the alert only if data points values of corresponding series in companion-metric are not within the boundary.

Parameters:

companionMetricId - The companion metric id.

Returns:

The MetricBoundaryCondition object itself.

setCompanionMetricId

public MetricBoundaryCondition setCompanionMetricId(String companionMetricId, boolean alertIfMissing)

Sets the companion metric id. When the companion-metric is set for a metric, an anomaly detected in the original metric series will be included in the alert only if data points values of corresponding series in companion-metric are not within the boundary.

Parameters:

companionMetricId - The companion metric id.

alertIfMissing - Indicate whether or not alert should be triggered when the companion-metric data-points are out of boundary but the corresponding data-point is missing for the original metric.

Returns:

The MetricBoundaryCondition object itself.

setMeasureType

public MetricBoundaryCondition setMeasureType(BoundaryMeasureType measureType)

Sets the measure type that detector should use for measuring data-points.

Parameters:

measureType - the type of measure to use.

Returns:

The MetricBoundaryCondition object itself.

shouldAlertIfDataPointMissing

public Boolean shouldAlertIfDataPointMissing()

True if alert will be triggered when the companion-metric data-points are out of boundary but the corresponding data-point is missing for the original metric.

Returns:

True if alert is triggered for missing data-points, false otherwise.