Interface CreateWhatIfAnalysisRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateWhatIfAnalysisRequest.Builder,CreateWhatIfAnalysisRequest>, ForecastRequest.Builder, SdkBuilder<CreateWhatIfAnalysisRequest.Builder,CreateWhatIfAnalysisRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateWhatIfAnalysisRequest

@Mutable
@NotThreadSafe
public static interface CreateWhatIfAnalysisRequest.Builder
extends ForecastRequest.Builder, SdkPojo, CopyableBuilder<CreateWhatIfAnalysisRequest.Builder,CreateWhatIfAnalysisRequest>

Method Summary

Modifier and Type	Method	Description
CreateWhatIfAnalysisRequest.Builder	forecastArn(String forecastArn)	The Amazon Resource Name (ARN) of the baseline forecast.
CreateWhatIfAnalysisRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateWhatIfAnalysisRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateWhatIfAnalysisRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the what if forecast.
CreateWhatIfAnalysisRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the what if forecast.
CreateWhatIfAnalysisRequest.Builder	tags(Tag... tags)	A list of tags to apply to the what if forecast.
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.
CreateWhatIfAnalysisRequest.Builder	timeSeriesSelector(TimeSeriesSelector timeSeriesSelector)	Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object.
CreateWhatIfAnalysisRequest.Builder	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, sdkFieldNameToField, sdkFields

Method Details

whatIfAnalysisName

CreateWhatIfAnalysisRequest.Builder whatIfAnalysisName(String 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

CreateWhatIfAnalysisRequest.Builder forecastArn(String 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

CreateWhatIfAnalysisRequest.Builder timeSeriesSelector(TimeSeriesSelector 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 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

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

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

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

Parameters:

timeSeriesSelector - a consumer that will call methods on TimeSeriesSelector.Builder

Returns:

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

See Also:

• timeSeriesSelector(TimeSeriesSelector)

tags

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

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

CreateWhatIfAnalysisRequest.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:

• tags(java.util.Collection<Tag>)

overrideConfiguration

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

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