com.azure.ai.metricsadvisor.models.MetricAnomalyFeedback 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.models;

import com.azure.ai.metricsadvisor.administration.models.AnomalyDetectionConfiguration;
import com.azure.ai.metricsadvisor.implementation.util.MetricAnomalyFeedbackHelper;
import com.azure.core.annotation.Fluent;

import java.time.OffsetDateTime;

/**
 * A feedback to indicate a set of data points as Anomaly or NotAnomaly.
 */
@Fluent
public final class MetricAnomalyFeedback extends MetricFeedback {
    private final OffsetDateTime startTime;
    private final OffsetDateTime endTime;
    private final AnomalyValue anomalyValue;
    private AnomalyDetectionConfiguration detectionConfiguration;
    private String detectionConfigurationId;

    static {
        MetricAnomalyFeedbackHelper.setAccessor(new MetricAnomalyFeedbackHelper.MetricAnomalyFeedbackAccessor() {
            @Override
            public void setDetectionConfiguration(MetricAnomalyFeedback feedback,
                AnomalyDetectionConfiguration configuration) {
                feedback.setDetectionConfiguration(configuration);
            }
        });
    }

    /**
     * Creates an instance of MetricAnomalyFeedback.
     *
     * @param startTime the start timestamp of feedback timerange
     * @param endTime the end timestamp of feedback timerange, when equals to startTime means
     * only one timestamp
     * @param anomalyValue the value of the anomaly.
     */
    public MetricAnomalyFeedback(OffsetDateTime startTime, OffsetDateTime endTime, AnomalyValue anomalyValue) {
        this.startTime = startTime;
        this.endTime = endTime;
        this.anomalyValue = anomalyValue;
    }

    /**
     * Get the value of the anomaly..
     *
     * @return the value value.
     */
    public AnomalyValue getAnomalyValue() {
        return this.anomalyValue;
    }

    /**
     * Get the start timestamp of feedback timerange.
     *
     * @return the startTime value.
     */
    public OffsetDateTime getStartTime() {
        return this.startTime;
    }

    /**
     * Get the end timestamp of feedback timerange, when equals to startTime means only one
     * timestamp.
     *
     * @return the endTime value.
     */
    public OffsetDateTime getEndTime() {
        return this.endTime;
    }

    /**
     * Get the corresponding anomaly detection configuration of this
     * feedback.
     *
     * @return the detectionConfiguration value.
     */
    public AnomalyDetectionConfiguration getDetectionConfiguration() {
        return this.detectionConfiguration;
    }

    /**
     * Set the corresponding anomaly detection configuration Id for this feedback.
     *
     * @param detectionConfigurationId the detectionConfigurationId value to set.
     * @return the MetricAnomalyFeedback object itself.
     */
    public MetricAnomalyFeedback setDetectionConfigurationId(final String detectionConfigurationId) {
        this.detectionConfigurationId = detectionConfigurationId;
        return this;
    }

    /**
     * Set the series keys value for the feedback.
     *
     * @param dimensionFilter the dimensionFilter value to set.
     *
     * @return the MetricAnomalyFeedback object itself.
     */
    @Override
    public MetricAnomalyFeedback setDimensionFilter(final DimensionKey dimensionFilter) {
        super.setDimensionFilter(dimensionFilter);
        return this;
    }

    /**
     * Get the corresponding anomaly detection configuration Id of this
     * feedback.
     *
     * @return the detectionConfigurationId value.
     */
    public String getDetectionConfigurationId() {
        return detectionConfigurationId;
    }

    void setDetectionConfiguration(AnomalyDetectionConfiguration configuration) {
        this.detectionConfiguration = configuration;
    }
}