com.azure.ai.metricsadvisor.administration.models.MetricWholeSeriesDetectionCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-ai-metricsadvisor Show documentation
This package contains the Microsoft Azure Cognitive Services Metrics Advisor SDK.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.ai.metricsadvisor.administration.models;

import com.azure.core.annotation.Fluent;

/**
 * Conditions to detect anomalies in all time series of a metric.
 */
@Fluent
public final class MetricWholeSeriesDetectionCondition {
    private DetectionConditionOperator conditionOperator;
    private SmartDetectionCondition smartDetectionCondition;
    private HardThresholdCondition hardThresholdCondition;
    private ChangeThresholdCondition changeThresholdCondition;

    /**
     * Creates a new instance of MetricWholeSeriesDetectionCondition.
     */
    public MetricWholeSeriesDetectionCondition() {
    }

    /**
     * Gets the logical operator applied across conditions.
     *
     * @return The logical operator applied across conditions.
     */
    public DetectionConditionOperator getConditionOperator() {
        return this.conditionOperator;
    }

    /**
     * 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.
     * 
     *
     * @return The Smart detection condition.
     */
    public SmartDetectionCondition getSmartDetectionCondition() {
        return this.smartDetectionCondition;
    }

    /**
     * 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.
     * 
     *
     * @return The hard threshold condition.
     */
    public HardThresholdCondition getHardThresholdCondition() {
        return this.hardThresholdCondition;
    }

    /**
     * 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.
     * 
     *
     * @return The change threshold condition.
     */
    public ChangeThresholdCondition getChangeThresholdCondition() {
        return this.changeThresholdCondition;
    }

    /**
     * Sets the logical operator to apply across conditions.
     *
     * @param conditionOperator The logical operator.
     * @return The MetricWholeSeriesDetectionCondition object itself.
     */
    public MetricWholeSeriesDetectionCondition setConditionOperator(DetectionConditionOperator conditionOperator) {
        this.conditionOperator = conditionOperator;
        return this;
    }

    /**
     * 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.
     * 
     *
     * @param smartDetectionCondition The smart detection condition.
     * @return The MetricWholeSeriesDetectionCondition object itself.
     */
    public MetricWholeSeriesDetectionCondition
        setSmartDetectionCondition(SmartDetectionCondition smartDetectionCondition) {
        this.smartDetectionCondition = smartDetectionCondition;
        return this;
    }

    /**
     * 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.
     * 
     *
     * @param hardThresholdCondition The hard threshold condition.
     * @return The MetricWholeSeriesDetectionCondition object itself.
     */
    public MetricWholeSeriesDetectionCondition
        setHardThresholdCondition(HardThresholdCondition hardThresholdCondition) {
        this.hardThresholdCondition = hardThresholdCondition;
        return this;
    }

    /**
     * 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.
     * 
     *
     * @param changeThresholdCondition The change threshold condition.
     * @return The MetricWholeSeriesDetectionCondition object itself.
     */
    public MetricWholeSeriesDetectionCondition
        setChangeThresholdCondition(ChangeThresholdCondition changeThresholdCondition) {
        this.changeThresholdCondition = changeThresholdCondition;
        return this;
    }
}