Class ForecastComputation

java.lang.Object
software.amazon.awssdk.services.quicksight.model.ForecastComputation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>
@Generated("software.amazon.awssdk:codegen") public final class ForecastComputation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>

The forecast computation configuration.

See Also:

  • Method Details

    • 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.

    • seasonality

      public final ForecastComputationSeasonality seasonality()

      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:

    • 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:

    • customSeasonalityValue

      public final Integer customSeasonalityValue()

      The custom seasonality value setup of a forecast computation.

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

    • toBuilder

      public ForecastComputation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ForecastComputation.Builder,ForecastComputation>
      Returns:
      a builder for type T

    • builder

      public static ForecastComputation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ForecastComputation.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.