Package com.azure.ai.anomalydetector.models

Class ChangePointDetectRequest

  • public final class ChangePointDetectRequest
extends Object
    The request of change point detection.

    • Constructor Detail

      • ChangePointDetectRequest

        public ChangePointDetectRequest()

    • Method Detail

      • getSeries

        public List<TimeSeriesPoint> getSeries()
        Get the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.
        Returns:
        the series value.

      • setSeries

        public ChangePointDetectRequest setSeries​(List<TimeSeriesPoint> series)
        Set the series property: Time series data points. Points should be sorted by timestamp in ascending order to match the change point detection result.
        Parameters:
        series - the series value to set.
        Returns:
        the ChangePointDetectRequest object itself.

      • getGranularity

        public TimeGranularity getGranularity()
        Get the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.
        Returns:
        the granularity value.

      • setGranularity

        public ChangePointDetectRequest setGranularity​(TimeGranularity granularity)
        Set the granularity property: Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.
        Parameters:
        granularity - the granularity value to set.
        Returns:
        the ChangePointDetectRequest object itself.

      • getCustomInterval

        public Integer getCustomInterval()
        Get the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
        Returns:
        the customInterval value.

      • setCustomInterval

        public ChangePointDetectRequest setCustomInterval​(Integer customInterval)
        Set the customInterval property: Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
        Parameters:
        customInterval - the customInterval value to set.
        Returns:
        the ChangePointDetectRequest object itself.

      • getPeriod

        public Integer getPeriod()
        Get the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
        Returns:
        the period value.

      • setPeriod

        public ChangePointDetectRequest setPeriod​(Integer period)
        Set the period property: Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
        Parameters:
        period - the period value to set.
        Returns:
        the ChangePointDetectRequest object itself.

      • getStableTrendWindow

        public Integer getStableTrendWindow()
        Get the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.
        Returns:
        the stableTrendWindow value.

      • setStableTrendWindow

        public ChangePointDetectRequest setStableTrendWindow​(Integer stableTrendWindow)
        Set the stableTrendWindow property: Optional argument, advanced model parameter, a default stableTrendWindow will be used in detection.
        Parameters:
        stableTrendWindow - the stableTrendWindow value to set.
        Returns:
        the ChangePointDetectRequest object itself.

      • getThreshold

        public Float getThreshold()
        Get the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.
        Returns:
        the threshold value.

      • setThreshold

        public ChangePointDetectRequest setThreshold​(Float threshold)
        Set the threshold property: Optional argument, advanced model parameter, between 0.0-1.0, the lower the value is, the larger the trend error will be which means less change point will be accepted.
        Parameters:
        threshold - the threshold value to set.
        Returns:
        the ChangePointDetectRequest object itself.