Interface DescribeWhatIfAnalysisResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,,DescribeWhatIfAnalysisResponse> ForecastResponse.Builder,SdkBuilder<DescribeWhatIfAnalysisResponse.Builder,,DescribeWhatIfAnalysisResponse> SdkPojo,SdkResponse.Builder
- Enclosing class:
DescribeWhatIfAnalysisResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime(Instant creationTime) When the what-if analysis was created.estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes) The approximate time remaining to complete the what-if analysis, in minutes.forecastArn(String forecastArn) The Amazon Resource Name (ARN) of the what-if forecast.lastModificationTime(Instant lastModificationTime) The last time the resource was modified.If an error occurred, an informational message about the error.The status of the what-if analysis.timeSeriesSelector(Consumer<TimeSeriesSelector.Builder> timeSeriesSelector) Sets the value of the TimeSeriesSelector property for this object.timeSeriesSelector(TimeSeriesSelector timeSeriesSelector) Sets the value of the TimeSeriesSelector property for this object.whatIfAnalysisArn(String whatIfAnalysisArn) The Amazon Resource Name (ARN) of the what-if analysis.whatIfAnalysisName(String whatIfAnalysisName) The name of the what-if analysis.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.forecast.model.ForecastResponse.Builder
build, responseMetadata, responseMetadataMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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
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
Statusof the what-if analysis must beACTIVEbefore 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
Statusof the what-if analysis must beACTIVEbefore you can access the analysis.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
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
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING- TheCreationTime. -
CREATE_IN_PROGRESS- The current timestamp. -
CREATE_STOPPING- The current timestamp. -
CREATE_STOPPED- When the job stopped. -
ACTIVEorCREATE_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- TheCreationTime. -
CREATE_IN_PROGRESS- The current timestamp. -
CREATE_STOPPING- The current timestamp. -
CREATE_STOPPED- When the job stopped. -
ACTIVEorCREATE_FAILED- When the job finished or failed.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theTimeSeriesSelector.Builderavoiding the need to create one manually viaTimeSeriesSelector.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totimeSeriesSelector(TimeSeriesSelector).- Parameters:
timeSeriesSelector- a consumer that will call methods onTimeSeriesSelector.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-