Interface CreateWhatIfForecastExportRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateWhatIfForecastExportRequest

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

Method Summary

Modifier and Type	Method	Description
default CreateWhatIfForecastExportRequest.Builder	destination(Consumer<DataDestination.Builder> destination)	The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
CreateWhatIfForecastExportRequest.Builder	destination(DataDestination destination)	The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location.
CreateWhatIfForecastExportRequest.Builder	format(String format)	The format of the exported data, CSV or PARQUET.
CreateWhatIfForecastExportRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateWhatIfForecastExportRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateWhatIfForecastExportRequest.Builder	tags(Collection<Tag> tags)	A list of tags to apply to the what if forecast.
CreateWhatIfForecastExportRequest.Builder	tags(Consumer<Tag.Builder>... tags)	A list of tags to apply to the what if forecast.
CreateWhatIfForecastExportRequest.Builder	tags(Tag... tags)	A list of tags to apply to the what if forecast.
CreateWhatIfForecastExportRequest.Builder	whatIfForecastArns(String... whatIfForecastArns)	The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExportRequest.Builder	whatIfForecastArns(Collection<String> whatIfForecastArns)	The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExportRequest.Builder	whatIfForecastExportName(String whatIfForecastExportName)	The name of the what-if forecast to export.

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

whatIfForecastExportName

CreateWhatIfForecastExportRequest.Builder whatIfForecastExportName(String whatIfForecastExportName)

The name of the what-if forecast to export.

Parameters:

whatIfForecastExportName - The name of the what-if forecast to export.

Returns:

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

whatIfForecastArns

CreateWhatIfForecastExportRequest.Builder whatIfForecastArns(Collection<String> whatIfForecastArns)

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Parameters:

whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.

Returns:

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

whatIfForecastArns

CreateWhatIfForecastExportRequest.Builder whatIfForecastArns(String... whatIfForecastArns)

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Parameters:

whatIfForecastArns - The list of what-if forecast Amazon Resource Names (ARNs) to export.

Returns:

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

destination

CreateWhatIfForecastExportRequest.Builder destination(DataDestination destination)

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Parameters:

destination - The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Returns:

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

destination

default CreateWhatIfForecastExportRequest.Builder destination(Consumer<DataDestination.Builder> destination)

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

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

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

Parameters:

destination - a consumer that will call methods on DataDestination.Builder

Returns:

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

See Also:

• destination(DataDestination)

tags

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

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

CreateWhatIfForecastExportRequest.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>)

format

CreateWhatIfForecastExportRequest.Builder format(String format)

The format of the exported data, CSV or PARQUET.

Parameters:

format - The format of the exported data, CSV or PARQUET.

Returns:

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

overrideConfiguration

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

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