software.amazon.awssdk.services.forecast.model

Class DescribeForecastResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeForecastResponse.Builder,DescribeForecastResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeForecastResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeForecastResponse.Builder	builder()
Instant	creationTime() When the forecast creation task was created.
String	datasetGroupArn() The ARN of the dataset group that provided the data used to train the predictor.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeRemainingInMinutes() The estimated time remaining in minutes for the forecast job to complete.
String	forecastArn() The forecast ARN as specified in the request.
String	forecastName() The name of the forecast.
List<String>	forecastTypes() The quantiles at which probabilistic forecasts were generated.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasForecastTypes() For responses, this returns true if the service returned a value for the ForecastTypes property.
int	hashCode()
Instant	lastModificationTime() The last time the resource was modified.
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 DescribeForecastResponse.Builder>	serializableBuilderClass()
String	status() The status of the forecast.
TimeSeriesSelector	timeSeriesSelector() The time series to include in the forecast.
DescribeForecastResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

forecastArn

public final String forecastArn()

The forecast ARN as specified in the request.

Returns:

The forecast ARN as specified in the request.

forecastName

public final String forecastName()

The name of the forecast.

Returns:

The name of the forecast.

hasForecastTypes

public final boolean hasForecastTypes()

For responses, this returns true if the service returned a value for the ForecastTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

forecastTypes

public final List<String> forecastTypes()

The quantiles at which probabilistic forecasts were generated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastTypes() method.

Returns:

The quantiles at which probabilistic forecasts were generated.

predictorArn

public final 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 final String datasetGroupArn()

The ARN of the dataset group that provided the data used to train the predictor.

Returns:

The ARN of the dataset group that provided the data used to train the predictor.

estimatedTimeRemainingInMinutes

public final Long estimatedTimeRemainingInMinutes()

The estimated time remaining in minutes for the forecast job to complete.

Returns:

The estimated time remaining in minutes for the forecast job to complete.

status

public final String status()

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

• CREATE_STOPPING, CREATE_STOPPED

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

Returns:

When the forecast creation task 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()

The time series to include in the forecast.

Returns:

The time series to include in the forecast.

toBuilder

public DescribeForecastResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeForecastResponse.Builder,DescribeForecastResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeForecastResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeForecastResponse.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