Class ForecastComputation

    • Method Detail

      • computationId

        public final String computationId()

        The ID for a computation.

        Returns:
        The ID for a computation.
      • name

        public final String name()

        The name of a computation.

        Returns:
        The name of a computation.
      • time

        public final DimensionField time()

        The time field that is used in a computation.

        Returns:
        The time field that is used in a computation.
      • value

        public final MeasureField value()

        The value field that is used in a computation.

        Returns:
        The value field that is used in a computation.
      • periodsForward

        public final Integer periodsForward()

        The periods forward setup of a forecast computation.

        Returns:
        The periods forward setup of a forecast computation.
      • periodsBackward

        public final Integer periodsBackward()

        The periods backward setup of a forecast computation.

        Returns:
        The periods backward setup of a forecast computation.
      • upperBoundary

        public final Double upperBoundary()

        The upper boundary setup of a forecast computation.

        Returns:
        The upper boundary setup of a forecast computation.
      • lowerBoundary

        public final Double lowerBoundary()

        The lower boundary setup of a forecast computation.

        Returns:
        The lower boundary setup of a forecast computation.
      • predictionInterval

        public final Integer predictionInterval()

        The prediction interval setup of a forecast computation.

        Returns:
        The prediction interval setup of a forecast computation.
      • seasonalityAsString

        public final String seasonalityAsString()

        The seasonality setup of a forecast computation. Choose one of the following options:

        • AUTOMATIC

        • CUSTOM: Checks the custom seasonality value.

        If the service returns an enum value that is not available in the current SDK version, seasonality will return ForecastComputationSeasonality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from seasonalityAsString().

        Returns:
        The seasonality setup of a forecast computation. Choose one of the following options:

        • AUTOMATIC

        • CUSTOM: Checks the custom seasonality value.

        See Also:
        ForecastComputationSeasonality
      • customSeasonalityValue

        public final Integer customSeasonalityValue()

        The custom seasonality value setup of a forecast computation.

        Returns:
        The custom seasonality value setup of a forecast computation.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)