public final class MetricBoundaryCondition extends Object
Constructor and Description |
---|
MetricBoundaryCondition() |
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.
|
public BoundaryDirection getDirection()
public Double getLowerBoundary()
BoundaryDirection.LOWER
or BoundaryDirection.BOTH
.public Double getUpperBoundary()
BoundaryDirection.UPPER
or BoundaryDirection.BOTH
.public String getCompanionMetricId()
public Boolean shouldAlertIfDataPointMissing()
public BoundaryMeasureType getMeasureType()
public MetricBoundaryCondition setBoundary(BoundaryDirection direction, Double lowerBoundary, Double upperBoundary)
direction
- Both lowerBoundary
and upperBoundary
must be specified
when the direction is BoundaryDirection.BOTH
. The lowerBoundary
must be specified for BoundaryDirection.LOWER
, similarly upperBoundary
must set specified for BoundaryDirection.UPPER
.lowerBoundary
- The lower boundary value.upperBoundary
- The upper boundary value.public MetricBoundaryCondition setCompanionMetricId(String companionMetricId)
companionMetricId
- The companion metric id.public MetricBoundaryCondition setCompanionMetricId(String companionMetricId, boolean alertIfMissing)
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.public MetricBoundaryCondition setMeasureType(BoundaryMeasureType measureType)
measureType
- the type of measure to use.Copyright © 2021 Microsoft Corporation. All rights reserved.