Package software.amazon.awssdk.services.forecastquery.model

Class Forecast

java.lang.Object

software.amazon.awssdk.services.forecastquery.model.Forecast

All Implemented Interfaces:

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

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

Provides information about a forecast. Returned as part of the QueryForecast response.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Forecast.Builder

Method Summary

Modifier and Type	Method	Description
static Forecast.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPredictions()	For responses, this returns true if the service returned a value for the Predictions property.
Map<String,List<DataPoint>>	predictions()	The forecast.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Forecast.Builder>	serializableBuilderClass()
Forecast.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

hasPredictions

public final boolean hasPredictions()

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

predictions

public final Map<String,List<DataPoint>> predictions()

The forecast.

The string of the string-to-array map is one of the following values:

• p10

• p50

• p90

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

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

Returns:

The forecast.

The string of the string-to-array map is one of the following values:

• p10

• p50

• p90

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

toBuilder

public Forecast.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Forecast.Builder,Forecast>

builder

public static Forecast.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo