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

Class WhatIfForecastSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.WhatIfForecastSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WhatIfForecastSummary.Builder,WhatIfForecastSummary>

@Generated("software.amazon.awssdk:codegen")
public final class WhatIfForecastSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WhatIfForecastSummary.Builder,WhatIfForecastSummary>

Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. To get the complete set of properties, call the DescribeWhatIfForecast operation, and provide the WhatIfForecastArn that is listed in the summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WhatIfForecastSummary.Builder

Method Summary

Modifier and Type	Method	Description
static WhatIfForecastSummary.Builder	builder()
Instant	creationTime()	When the what-if forecast was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
List<SdkField<?>>	sdkFields()
static Class<? extends WhatIfForecastSummary.Builder>	serializableBuilderClass()
String	status()	The status of the what-if forecast.
WhatIfForecastSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	whatIfAnalysisArn()	The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
String	whatIfForecastArn()	The Amazon Resource Name (ARN) of the what-if forecast.
String	whatIfForecastName()	The name of the what-if forecast.

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

whatIfForecastArn

public final String whatIfForecastArn()

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

Returns:

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

whatIfForecastName

public final String whatIfForecastName()

The name of the what-if forecast.

Returns:

The name of the what-if forecast.

whatIfAnalysisArn

public final String whatIfAnalysisArn()

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

Returns:

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

status

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

Returns:

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.

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 forecast was created.

Returns:

When the what-if forecast 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.

toBuilder

public WhatIfForecastSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WhatIfForecastSummary.Builder,WhatIfForecastSummary>

builder

public static WhatIfForecastSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo