Interface ForecastComputation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ForecastComputation.Builder,ForecastComputation>, SdkBuilder<ForecastComputation.Builder,ForecastComputation>, SdkPojo
Enclosing class:
ForecastComputation
public static interface ForecastComputation.Builder extends SdkPojo, CopyableBuilder<ForecastComputation.Builder,ForecastComputation>

  • Method Details

    • computationId

      ForecastComputation.Builder computationId(String computationId)

      The ID for a computation.

      Parameters:
      computationId - The ID for a computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ForecastComputation.Builder name(String name)

      The name of a computation.

      Parameters:
      name - The name of a computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • time

      ForecastComputation.Builder time(DimensionField time)

      The time field that is used in a computation.

      Parameters:
      time - The time field that is used in a computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • time

      default ForecastComputation.Builder time(Consumer<DimensionField.Builder> time)

      The time field that is used in a computation.

      This is a convenience method that creates an instance of the DimensionField.Builder avoiding the need to create one manually via DimensionField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to time(DimensionField).

      Parameters:
      time - a consumer that will call methods on DimensionField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • value

      ForecastComputation.Builder value(MeasureField value)

      The value field that is used in a computation.

      Parameters:
      value - The value field that is used in a computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • value

      default ForecastComputation.Builder value(Consumer<MeasureField.Builder> value)

      The value field that is used in a computation.

      This is a convenience method that creates an instance of the MeasureField.Builder avoiding the need to create one manually via MeasureField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to value(MeasureField).

      Parameters:
      value - a consumer that will call methods on MeasureField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • periodsForward

      ForecastComputation.Builder periodsForward(Integer periodsForward)

      The periods forward setup of a forecast computation.

      Parameters:
      periodsForward - The periods forward setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • periodsBackward

      ForecastComputation.Builder periodsBackward(Integer periodsBackward)

      The periods backward setup of a forecast computation.

      Parameters:
      periodsBackward - The periods backward setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • upperBoundary

      ForecastComputation.Builder upperBoundary(Double upperBoundary)

      The upper boundary setup of a forecast computation.

      Parameters:
      upperBoundary - The upper boundary setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lowerBoundary

      ForecastComputation.Builder lowerBoundary(Double lowerBoundary)

      The lower boundary setup of a forecast computation.

      Parameters:
      lowerBoundary - The lower boundary setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • predictionInterval

      ForecastComputation.Builder predictionInterval(Integer predictionInterval)

      The prediction interval setup of a forecast computation.

      Parameters:
      predictionInterval - The prediction interval setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • seasonality

      ForecastComputation.Builder seasonality(String seasonality)

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

      • AUTOMATIC

      • CUSTOM: Checks the custom seasonality value.

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

      • AUTOMATIC

      • CUSTOM: Checks the custom seasonality value.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • seasonality

      ForecastComputation.Builder seasonality(ForecastComputationSeasonality seasonality)

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

      • AUTOMATIC

      • CUSTOM: Checks the custom seasonality value.

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

      • AUTOMATIC

      • CUSTOM: Checks the custom seasonality value.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customSeasonalityValue

      ForecastComputation.Builder customSeasonalityValue(Integer customSeasonalityValue)

      The custom seasonality value setup of a forecast computation.

      Parameters:
      customSeasonalityValue - The custom seasonality value setup of a forecast computation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.