Package software.amazon.awssdk.services.forecast.model

Interface ForecastExportJobSummary.Builder

All Superinterfaces:

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

Enclosing class:

ForecastExportJobSummary

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

Method Summary

Modifier and Type	Method	Description
ForecastExportJobSummary.Builder	creationTime(Instant creationTime)	When the forecast export job was created.
default ForecastExportJobSummary.Builder	destination(Consumer<DataDestination.Builder> destination)	The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
ForecastExportJobSummary.Builder	destination(DataDestination destination)	The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
ForecastExportJobSummary.Builder	forecastExportJobArn(String forecastExportJobArn)	The Amazon Resource Name (ARN) of the forecast export job.
ForecastExportJobSummary.Builder	forecastExportJobName(String forecastExportJobName)	The name of the forecast export job.
ForecastExportJobSummary.Builder	lastModificationTime(Instant lastModificationTime)	The last time the resource was modified.
ForecastExportJobSummary.Builder	message(String message)	If an error occurred, an informational message about the error.
ForecastExportJobSummary.Builder	status(String status)	The status of the forecast export job.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

forecastExportJobArn

ForecastExportJobSummary.Builder forecastExportJobArn(String forecastExportJobArn)

The Amazon Resource Name (ARN) of the forecast export job.

Parameters:

forecastExportJobArn - The Amazon Resource Name (ARN) of the forecast export job.

Returns:

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

forecastExportJobName

ForecastExportJobSummary.Builder forecastExportJobName(String forecastExportJobName)

The name of the forecast export job.

Parameters:

forecastExportJobName - The name of the forecast export job.

Returns:

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

destination

ForecastExportJobSummary.Builder destination(DataDestination destination)

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Parameters:

destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Returns:

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

destination

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

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

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)

status

ForecastExportJobSummary.Builder status(String status)

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Parameters:

status - The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

Returns:

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

message

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

ForecastExportJobSummary.Builder creationTime(Instant creationTime)

When the forecast export job was created.

Parameters:

creationTime - When the forecast export job was created.

Returns:

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

lastModificationTime

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