software.amazon.awssdk.services.forecast.model

Interface ForecastSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ForecastSummary.Builder,ForecastSummary>, SdkBuilder<ForecastSummary.Builder,ForecastSummary>, SdkPojo

Enclosing class:

ForecastSummary

public static interface ForecastSummary.Builder
extends SdkPojo, CopyableBuilder<ForecastSummary.Builder,ForecastSummary>

Method Summary

Modifier and Type	Method and Description
ForecastSummary.Builder	createdUsingAutoPredictor(Boolean createdUsingAutoPredictor) Whether the Forecast was created from an AutoPredictor.
ForecastSummary.Builder	creationTime(Instant creationTime) When the forecast creation task was created.
ForecastSummary.Builder	datasetGroupArn(String datasetGroupArn) The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
ForecastSummary.Builder	forecastArn(String forecastArn) The ARN of the forecast.
ForecastSummary.Builder	forecastName(String forecastName) The name of the forecast.
ForecastSummary.Builder	lastModificationTime(Instant lastModificationTime) The last time the resource was modified.
ForecastSummary.Builder	message(String message) If an error occurred, an informational message about the error.
ForecastSummary.Builder	predictorArn(String predictorArn) The ARN of the predictor used to generate the forecast.
ForecastSummary.Builder	status(String status) The status of the forecast.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

forecastArn

ForecastSummary.Builder forecastArn(String forecastArn)

The ARN of the forecast.

Parameters:

forecastArn - The ARN of the forecast.

Returns:

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

forecastName

ForecastSummary.Builder forecastName(String forecastName)

The name of the forecast.

Parameters:

forecastName - The name of the forecast.

Returns:

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

predictorArn

ForecastSummary.Builder predictorArn(String predictorArn)

The ARN of the predictor used to generate the forecast.

Parameters:

predictorArn - The ARN of the predictor used to generate the forecast.

Returns:

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

createdUsingAutoPredictor

ForecastSummary.Builder createdUsingAutoPredictor(Boolean createdUsingAutoPredictor)

Whether the Forecast was created from an AutoPredictor.

Parameters:

createdUsingAutoPredictor - Whether the Forecast was created from an AutoPredictor.

Returns:

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

datasetGroupArn

ForecastSummary.Builder datasetGroupArn(String datasetGroupArn)

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Parameters:

datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Returns:

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

status

ForecastSummary.Builder status(String status)

The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Parameters:

status - The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Returns:

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

message

ForecastSummary.Builder message(String message)

If an error occurred, an informational message about the error.

Parameters:

message - If an error occurred, an informational message about the error.

Returns:

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

creationTime

ForecastSummary.Builder creationTime(Instant creationTime)

When the forecast creation task was created.

Parameters:

creationTime - When the forecast creation task was created.

Returns:

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

lastModificationTime

ForecastSummary.Builder lastModificationTime(Instant lastModificationTime)

The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Parameters:

lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

• CREATE_PENDING - The CreationTime.

• CREATE_IN_PROGRESS - The current timestamp.

• CREATE_STOPPING - The current timestamp.

• CREATE_STOPPED - When the job stopped.

• ACTIVE or CREATE_FAILED - When the job finished or failed.

Returns:

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