software.amazon.awssdk.services.forecast.model

Class ForecastSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.ForecastSummary

All Implemented Interfaces:

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

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

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ForecastSummary.Builder

Method Summary

Modifier and Type	Method and Description
static ForecastSummary.Builder	builder()
Instant	creationTime() When the forecast creation task was created.
String	datasetGroupArn() The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forecastArn() The ARN of the forecast.
String	forecastName() The name of the forecast.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime() Initially, the same as CreationTime (status is CREATE_PENDING).
String	message() If an error occurred, an informational message about the error.
String	predictorArn() The ARN of the predictor used to generate the forecast.
List<SdkField<?>>	sdkFields()
static Class<? extends ForecastSummary.Builder>	serializableBuilderClass()
String	status() The status of the forecast.
ForecastSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

forecastArn

public String forecastArn()

The ARN of the forecast.

Returns:

The ARN of the forecast.

forecastName

public String forecastName()

The name of the forecast.

Returns:

The name of the forecast.

predictorArn

public String predictorArn()

The ARN of the predictor used to generate the forecast.

Returns:

The ARN of the predictor used to generate the forecast.

datasetGroupArn

public String datasetGroupArn()

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Returns:

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

status

public String status()

The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

Returns:

The status of the forecast. States include:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

message

public 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 Instant creationTime()

When the forecast creation task was created.

Returns:

When the forecast creation task was created.

lastModificationTime

public Instant lastModificationTime()

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Returns:

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

toBuilder

public ForecastSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ForecastSummary.Builder,ForecastSummary>

builder

public static ForecastSummary.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo