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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateWhatIfForecastRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateWhatIfForecastRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateWhatIfForecastRequest.Buildertags(Collection<Tag> tags)A list of tags to apply to the what if forecast.CreateWhatIfForecastRequest.Buildertags(Consumer<Tag.Builder>... tags)A list of tags to apply to the what if forecast.CreateWhatIfForecastRequest.Buildertags(Tag... tags)A list of tags to apply to the what if forecast.default CreateWhatIfForecastRequest.BuildertimeSeriesReplacementsDataSource(Consumer<TimeSeriesReplacementsDataSource.Builder> timeSeriesReplacementsDataSource)The replacement time series dataset, which contains the rows that you want to change in the related time series dataset.CreateWhatIfForecastRequest.BuildertimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource)The replacement time series dataset, which contains the rows that you want to change in the related time series dataset.CreateWhatIfForecastRequest.BuildertimeSeriesTransformations(Collection<TimeSeriesTransformation> timeSeriesTransformations)The transformations that are applied to the baseline time series.CreateWhatIfForecastRequest.BuildertimeSeriesTransformations(Consumer<TimeSeriesTransformation.Builder>... timeSeriesTransformations)The transformations that are applied to the baseline time series.CreateWhatIfForecastRequest.BuildertimeSeriesTransformations(TimeSeriesTransformation... timeSeriesTransformations)The transformations that are applied to the baseline time series.CreateWhatIfForecastRequest.BuilderwhatIfAnalysisArn(String whatIfAnalysisArn)The Amazon Resource Name (ARN) of the what-if analysis.CreateWhatIfForecastRequest.BuilderwhatIfForecastName(String whatIfForecastName)The name of the what-if forecast.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
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 theTimeSeriesTransformation.Builderavoiding the need to create one manually viaTimeSeriesTransformation.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#timeSeriesTransformations(List.) - Parameters:
timeSeriesTransformations- a consumer that will call methods onTimeSeriesTransformation.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#timeSeriesTransformations(java.util.Collection)
-
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 theTimeSeriesReplacementsDataSource.Builderavoiding the need to create one manually viaTimeSeriesReplacementsDataSource.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource).- Parameters:
timeSeriesReplacementsDataSource- a consumer that will call methods onTimeSeriesReplacementsDataSource.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
timeSeriesReplacementsDataSource(TimeSeriesReplacementsDataSource)
-
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 theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tags(List.) - Parameters:
tags- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection)
-
overrideConfiguration
CreateWhatIfForecastRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateWhatIfForecastRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-