com.azure.ai.metricsadvisor.models.MetricPeriodFeedback 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.core.annotation.Fluent;

/**
 * The Feedback that helps the service in estimating period(seasonality)
 * of the time series.
 */
@Fluent
public final class MetricPeriodFeedback extends MetricFeedback {
    private final PeriodType periodType;
    private final int periodValue;

    /**
     * Creates an instance of MetricPeriodFeedback.
     *
     * @param periodType the type of setting period.
     * @param periodValue the number of intervals a period contains.
     */
    public MetricPeriodFeedback(PeriodType periodType, int periodValue) {
        this.periodType = periodType;
        this.periodValue = periodValue;
    }

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

    /**
     * Get the type of setting period.
     *
     * @return the periodType value.
     */
    public PeriodType getPeriodType() {
        return this.periodType;
    }

    /**
     * Get the value of the period feedback.
     * The number of intervals a period contains, when no period set to 0.
     *
     * @return the value value.
     */
    public int getPeriodValue() {
        return this.periodValue;
    }
}