software.amazon.awssdk.services.forecast.model

Class DescribeWhatIfForecastResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeWhatIfForecastResponse.Builder,DescribeWhatIfForecastResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeWhatIfForecastResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeWhatIfForecastResponse.Builder	builder()
Instant	creationTime() When the what-if forecast was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Long	estimatedTimeRemainingInMinutes() The approximate time remaining to complete the what-if forecast, in minutes.
List<String>	forecastTypes() The quantiles at which probabilistic forecasts are 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()
boolean	hasTimeSeriesTransformations() For responses, this returns true if the service returned a value for the TimeSeriesTransformations property.
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 DescribeWhatIfForecastResponse.Builder>	serializableBuilderClass()
String	status() The status of the what-if forecast.
TimeSeriesReplacementsDataSource	timeSeriesReplacementsDataSource() An array of S3Config, Schema, and Format elements that describe the replacement time series.
List<TimeSeriesTransformation>	timeSeriesTransformations() An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.
DescribeWhatIfForecastResponse.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 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 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

whatIfForecastName

public final String whatIfForecastName()

The name of the what-if forecast.

Returns:

The name of the what-if forecast.

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.

whatIfAnalysisArn

public final String whatIfAnalysisArn()

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

Returns:

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

estimatedTimeRemainingInMinutes

public final Long estimatedTimeRemainingInMinutes()

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

Returns:

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

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 forecast must be ACTIVE before you can access the forecast.

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 forecast must be ACTIVE before you can access 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 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.

hasTimeSeriesTransformations

public final boolean hasTimeSeriesTransformations()

For responses, this returns true if the service returned a value for the TimeSeriesTransformations 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.

timeSeriesTransformations

public final List<TimeSeriesTransformation> timeSeriesTransformations()

An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

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 hasTimeSeriesTransformations() method.

Returns:

An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

timeSeriesReplacementsDataSource

public final TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource()

An array of S3Config, Schema, and Format elements that describe the replacement time series.

Returns:

An array of S3Config, Schema, and Format elements that describe the replacement time series.

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 are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

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 are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

toBuilder

public DescribeWhatIfForecastResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeWhatIfForecastResponse.Builder,DescribeWhatIfForecastResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeWhatIfForecastResponse.Builder builder()

serializableBuilderClass

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