software.amazon.awssdk.services.forecast.model

Interface WhatIfForecastSummary.Builder

All Superinterfaces:

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

Enclosing class:

WhatIfForecastSummary

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

Method Summary

Modifier and Type	Method and Description
WhatIfForecastSummary.Builder	creationTime(Instant creationTime) When the what-if forecast was created.
WhatIfForecastSummary.Builder	lastModificationTime(Instant lastModificationTime) The last time the resource was modified.
WhatIfForecastSummary.Builder	message(String message) If an error occurred, an informational message about the error.
WhatIfForecastSummary.Builder	status(String status) The status of the what-if forecast.
WhatIfForecastSummary.Builder	whatIfAnalysisArn(String whatIfAnalysisArn) The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
WhatIfForecastSummary.Builder	whatIfForecastArn(String whatIfForecastArn) The Amazon Resource Name (ARN) of the what-if forecast.
WhatIfForecastSummary.Builder	whatIfForecastName(String whatIfForecastName) The name of the what-if 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

whatIfForecastArn

WhatIfForecastSummary.Builder whatIfForecastArn(String whatIfForecastArn)

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

Parameters:

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

whatIfForecastName

WhatIfForecastSummary.Builder whatIfForecastName(String whatIfForecastName)

The name of the what-if forecast.

Parameters:

whatIfForecastName - The name of the what-if forecast.

Returns:

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

whatIfAnalysisArn

WhatIfForecastSummary.Builder whatIfAnalysisArn(String whatIfAnalysisArn)

The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

Parameters:

whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

Returns:

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

status

WhatIfForecastSummary.Builder status(String status)

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

Parameters:

status - The status of the what-if 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 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

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

WhatIfForecastSummary.Builder creationTime(Instant creationTime)

When the what-if forecast was created.

Parameters:

creationTime - When the what-if forecast was created.

Returns:

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

lastModificationTime

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