Interface CreateWhatIfAnalysisRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateWhatIfAnalysisRequest.Builder,
,CreateWhatIfAnalysisRequest> ForecastRequest.Builder
,SdkBuilder<CreateWhatIfAnalysisRequest.Builder,
,CreateWhatIfAnalysisRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateWhatIfAnalysisRequest
-
Method Summary
Modifier and TypeMethodDescriptionforecastArn
(String forecastArn) The Amazon Resource Name (ARN) of the baseline forecast.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) A list of tags to apply to the what if forecast.tags
(Consumer<Tag.Builder>... tags) A list of tags to apply to the what if forecast.A list of tags to apply to the what if forecast.timeSeriesSelector
(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector) Defines the set of time series that are used in the what-if analysis with aTimeSeriesIdentifiers
object.timeSeriesSelector
(TimeSeriesSelector timeSeriesSelector) Defines the set of time series that are used in the what-if analysis with aTimeSeriesIdentifiers
object.whatIfAnalysisName
(String whatIfAnalysisName) The name of the what-if analysis.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, sdkFields
-
Method Details
-
whatIfAnalysisName
The name of the what-if analysis. Each name must be unique.
- Parameters:
whatIfAnalysisName
- The name of the what-if analysis. Each name must be unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forecastArn
The Amazon Resource Name (ARN) of the baseline forecast.
- Parameters:
forecastArn
- The Amazon Resource Name (ARN) of the baseline forecast.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeSeriesSelector
Defines the set of time series that are used in the what-if analysis with a
TimeSeriesIdentifiers
object. What-if analyses are performed only for the time series in this object.The
TimeSeriesIdentifiers
object needs the following information:-
DataSource
-
Format
-
Schema
- Parameters:
timeSeriesSelector
- Defines the set of time series that are used in the what-if analysis with aTimeSeriesIdentifiers
object. What-if analyses are performed only for the time series in this object.The
TimeSeriesIdentifiers
object needs the following information:-
DataSource
-
Format
-
Schema
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
timeSeriesSelector
default CreateWhatIfAnalysisRequest.Builder timeSeriesSelector(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector) Defines the set of time series that are used in the what-if analysis with a
TimeSeriesIdentifiers
object. What-if analyses are performed only for the time series in this object.The
TimeSeriesIdentifiers
object needs the following information:-
DataSource
-
Format
-
Schema
TimeSeriesSelector.Builder
avoiding the need to create one manually viaTimeSeriesSelector.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimeSeriesSelector(TimeSeriesSelector)
.- Parameters:
timeSeriesSelector
- a consumer that will call methods onTimeSeriesSelector.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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
A list of tags to apply to the what if forecast.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- 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:
-
overrideConfiguration
CreateWhatIfAnalysisRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateWhatIfAnalysisRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-