software.amazon.awssdk.services.forecast.model

Interface DescribeWhatIfAnalysisResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>, ForecastResponse.Builder, SdkBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeWhatIfAnalysisResponse

public static interface DescribeWhatIfAnalysisResponse.Builder
extends ForecastResponse.Builder, SdkPojo, CopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>

Method Summary

Modifier and Type	Method and Description
DescribeWhatIfAnalysisResponse.Builder	creationTime(Instant creationTime) When the what-if analysis was created.
DescribeWhatIfAnalysisResponse.Builder	estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes) The approximate time remaining to complete the what-if analysis, in minutes.
DescribeWhatIfAnalysisResponse.Builder	forecastArn(String forecastArn) The Amazon Resource Name (ARN) of the what-if forecast.
DescribeWhatIfAnalysisResponse.Builder	lastModificationTime(Instant lastModificationTime) The last time the resource was modified.
DescribeWhatIfAnalysisResponse.Builder	message(String message) If an error occurred, an informational message about the error.
DescribeWhatIfAnalysisResponse.Builder	status(String status) The status of the what-if analysis.
default DescribeWhatIfAnalysisResponse.Builder	timeSeriesSelector(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector) Sets the value of the TimeSeriesSelector property for this object.
DescribeWhatIfAnalysisResponse.Builder	timeSeriesSelector(TimeSeriesSelector timeSeriesSelector) Sets the value of the TimeSeriesSelector property for this object.
DescribeWhatIfAnalysisResponse.Builder	whatIfAnalysisArn(String whatIfAnalysisArn) The Amazon Resource Name (ARN) of the what-if analysis.
DescribeWhatIfAnalysisResponse.Builder	whatIfAnalysisName(String whatIfAnalysisName) The name of the what-if analysis.

Methods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

whatIfAnalysisName

DescribeWhatIfAnalysisResponse.Builder whatIfAnalysisName(String whatIfAnalysisName)

The name of the what-if analysis.

Parameters:

whatIfAnalysisName - The name of the what-if analysis.

Returns:

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

whatIfAnalysisArn

DescribeWhatIfAnalysisResponse.Builder whatIfAnalysisArn(String whatIfAnalysisArn)

The Amazon Resource Name (ARN) of the what-if analysis.

Parameters:

whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.

Returns:

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

forecastArn

DescribeWhatIfAnalysisResponse.Builder forecastArn(String forecastArn)

The Amazon Resource Name (ARN) of the what-if forecast.

Parameters:

forecastArn - The Amazon Resource Name (ARN) of the what-if forecast.

Returns:

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

estimatedTimeRemainingInMinutes

DescribeWhatIfAnalysisResponse.Builder estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)

The approximate time remaining to complete the what-if analysis, in minutes.

Parameters:

estimatedTimeRemainingInMinutes - The approximate time remaining to complete the what-if analysis, in minutes.

Returns:

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

status

DescribeWhatIfAnalysisResponse.Builder status(String status)

The status of the what-if analysis. 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 what-if analysis must be ACTIVE before you can access the analysis.

Parameters:

status - The status of the what-if analysis. 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 what-if analysis must be ACTIVE before you can access the analysis.

Returns:

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

message

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

DescribeWhatIfAnalysisResponse.Builder creationTime(Instant creationTime)

When the what-if analysis was created.

Parameters:

creationTime - When the what-if analysis was created.

Returns:

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

lastModificationTime

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

timeSeriesSelector

DescribeWhatIfAnalysisResponse.Builder timeSeriesSelector(TimeSeriesSelector timeSeriesSelector)

Sets the value of the TimeSeriesSelector property for this object.

Parameters:

timeSeriesSelector - The new value for the TimeSeriesSelector property for this object.

Returns:

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

timeSeriesSelector

default DescribeWhatIfAnalysisResponse.Builder timeSeriesSelector(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector)

Sets the value of the TimeSeriesSelector property for this object. 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)