com.amazonaws.services.forecastquery.model

Class Forecast

java.lang.Object

com.amazonaws.services.forecastquery.model.Forecast

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Forecast
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Forecast()

Method Summary

Modifier and Type	Method and Description
Forecast	addPredictionsEntry(String key, List<DataPoint> value) Add a single Predictions entry
Forecast	clearPredictionsEntries() Removes all the entries added into Predictions.
Forecast	clone()
boolean	equals(Object obj)
Map<String,List<DataPoint>>	getPredictions() The forecast.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setPredictions(Map<String,List<DataPoint>> predictions) The forecast.
String	toString() Returns a string representation of this object.
Forecast	withPredictions(Map<String,List<DataPoint>> predictions) The forecast.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Forecast

public Forecast()

Method Detail

getPredictions

public Map<String,List<DataPoint>> getPredictions()

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.

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.

setPredictions

public void setPredictions(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.

Parameters:

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.

withPredictions

public Forecast withPredictions(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addPredictionsEntry

public Forecast addPredictionsEntry(String key,
                                    List<DataPoint> value)

Add a single Predictions entry

See Also:

withPredictions(java.util.Map<java.lang.String, java.util.List<com.amazonaws.services.forecastquery.model.DataPoint>>)

clearPredictionsEntries

public Forecast clearPredictionsEntries()

Removes all the entries added into Predictions.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Forecast clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.