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

Class DescribeWhatIfAnalysisResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.forecast.model.ForecastResponse

software.amazon.awssdk.services.forecast.model.DescribeWhatIfAnalysisResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeWhatIfAnalysisResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeWhatIfAnalysisResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeWhatIfAnalysisResponse.Builder	builder()
Instant	creationTime()	When the what-if analysis was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeRemainingInMinutes()	The approximate time remaining to complete the what-if analysis, in minutes.
String	forecastArn()	The Amazon Resource Name (ARN) of the what-if forecast.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime()	The last time the resource was modified.
String	message()	If an error occurred, an informational message about the error.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeWhatIfAnalysisResponse.Builder>	serializableBuilderClass()
String	status()	The status of the what-if analysis.
TimeSeriesSelector	timeSeriesSelector()	Returns the value of the TimeSeriesSelector property for this object.
DescribeWhatIfAnalysisResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	whatIfAnalysisArn()	The Amazon Resource Name (ARN) of the what-if analysis.
String	whatIfAnalysisName()	The name of the what-if analysis.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

whatIfAnalysisName

public final String whatIfAnalysisName()

The name of the what-if analysis.

Returns:

The name of the what-if analysis.

whatIfAnalysisArn

public final String whatIfAnalysisArn()

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

Returns:

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

forecastArn

public final String forecastArn()

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

Returns:

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

estimatedTimeRemainingInMinutes

public final Long estimatedTimeRemainingInMinutes()

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

Returns:

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

status

public final 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.

Returns:

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.

message

public final String message()

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

Returns:

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

creationTime

public final Instant creationTime()

When the what-if analysis was created.

Returns:

When the what-if analysis was created.

lastModificationTime

public final 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.

Returns:

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.

timeSeriesSelector

public final TimeSeriesSelector timeSeriesSelector()

Returns the value of the TimeSeriesSelector property for this object.

Returns:

The value of the TimeSeriesSelector property for this object.

toBuilder

public DescribeWhatIfAnalysisResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWhatIfAnalysisResponse.Builder,DescribeWhatIfAnalysisResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeWhatIfAnalysisResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeWhatIfAnalysisResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo