Package software.amazon.awssdk.services.forecast.model

Interface CreateWhatIfForecastRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>, ForecastRequest.Builder, SdkBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateWhatIfForecastRequest
public static interface CreateWhatIfForecastRequest.Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>

  • Method Details

    • whatIfForecastName

      CreateWhatIfForecastRequest.Builder whatIfForecastName(String whatIfForecastName)

      The name of the what-if forecast. Names must be unique within each what-if analysis.

      Parameters:
      whatIfForecastName - The name of the what-if forecast. Names must be unique within each what-if analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • whatIfAnalysisArn

      CreateWhatIfForecastRequest.Builder whatIfAnalysisArn(String whatIfAnalysisArn)

      The Amazon Resource Name (ARN) of the what-if analysis.

      Parameters:
      whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeSeriesTransformations

      CreateWhatIfForecastRequest.Builder timeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)

      The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

      Parameters:
      timeSeriesTransformations - The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeSeriesTransformations

      CreateWhatIfForecastRequest.Builder timeSeriesTransformations(TimeSeriesTransformation... timeSeriesTransformations)

      The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

      Parameters:
      timeSeriesTransformations - The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeSeriesTransformations

      CreateWhatIfForecastRequest.Builder timeSeriesTransformations(Consumer<TimeSeriesTransformation.Builder>... timeSeriesTransformations)

      The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeSeriesTransformations(List<TimeSeriesTransformation>).

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

    • timeSeriesReplacementsDataSource

      CreateWhatIfForecastRequest.Builder timeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)

      The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

      This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

      This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

      Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

      Parameters:
      timeSeriesReplacementsDataSource - The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

      This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

      This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

      Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

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

    • timeSeriesReplacementsDataSource

      default CreateWhatIfForecastRequest.Builder timeSeriesReplacementsDataSource(Consumer<TimeSeriesReplacementsDataSource.Builder> timeSeriesReplacementsDataSource)

      The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

      This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

      This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

      Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

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

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

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

    • tags

      CreateWhatIfForecastRequest.Builder tags(Collection<Tag> tags)

      A list of tags to apply to the what if forecast.

      Parameters:
      tags - A list of tags to apply to the what if forecast.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWhatIfForecastRequest.Builder tags(Tag... tags)

      A list of tags to apply to the what if forecast.

      Parameters:
      tags - A list of tags to apply to the what if forecast.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateWhatIfForecastRequest.Builder tags(Consumer<Tag.Builder>... tags)

      A list of tags to apply to the what if forecast.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

      CreateWhatIfForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateWhatIfForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.