com.amazonaws.services.forecast.model

Class SupplementaryFeature

java.lang.Object

com.amazonaws.services.forecast.model.SupplementaryFeature

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.

Weather Index

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

Holidays

Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SupplementaryFeature()

Method Summary

Modifier and Type	Method and Description
SupplementaryFeature	clone()
boolean	equals(Object obj)
String	getName() The name of the feature.
String	getValue() Weather Index
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setName(String name) The name of the feature.
void	setValue(String value) Weather Index
String	toString() Returns a string representation of this object.
SupplementaryFeature	withName(String name) The name of the feature.
SupplementaryFeature	withValue(String value) Weather Index

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SupplementaryFeature

public SupplementaryFeature()

Method Detail

setName

public void setName(String name)

The name of the feature. Valid values: "holiday" and "weather".

Parameters:

name - The name of the feature. Valid values: "holiday" and "weather".

getName

public String getName()

The name of the feature. Valid values: "holiday" and "weather".

Returns:

The name of the feature. Valid values: "holiday" and "weather".

withName

public SupplementaryFeature withName(String name)

The name of the feature. Valid values: "holiday" and "weather".

Parameters:

name - The name of the feature. Valid values: "holiday" and "weather".

Returns:

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

setValue

public void setValue(String value)

Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

Parameters:

value - Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

getValue

public String getValue()

Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

Returns:

Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

withValue

public SupplementaryFeature withValue(String value)

Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

Parameters:

value - Weather Index

To enable the Weather Index, set the value to "true"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

• "AL" - ALBANIA

• "AR" - ARGENTINA

• "AT" - AUSTRIA

• "AU" - AUSTRALIA

• "BA" - BOSNIA HERZEGOVINA

• "BE" - BELGIUM

• "BG" - BULGARIA

• "BO" - BOLIVIA

• "BR" - BRAZIL

• "BY" - BELARUS

• "CA" - CANADA

• "CL" - CHILE

• "CO" - COLOMBIA

• "CR" - COSTA RICA

• "HR" - CROATIA

• "CZ" - CZECH REPUBLIC

• "DK" - DENMARK

• "EC" - ECUADOR

• "EE" - ESTONIA

• "ET" - ETHIOPIA

• "FI" - FINLAND

• "FR" - FRANCE

• "DE" - GERMANY

• "GR" - GREECE

• "HU" - HUNGARY

• "IS" - ICELAND

• "IN" - INDIA

• "IE" - IRELAND

• "IT" - ITALY

• "JP" - JAPAN

• "KZ" - KAZAKHSTAN

• "KR" - KOREA

• "LV" - LATVIA

• "LI" - LIECHTENSTEIN

• "LT" - LITHUANIA

• "LU" - LUXEMBOURG

• "MK" - MACEDONIA

• "MT" - MALTA

• "MX" - MEXICO

• "MD" - MOLDOVA

• "ME" - MONTENEGRO

• "NL" - NETHERLANDS

• "NZ" - NEW ZEALAND

• "NI" - NICARAGUA

• "NG" - NIGERIA

• "NO" - NORWAY

• "PA" - PANAMA

• "PY" - PARAGUAY

• "PE" - PERU

• "PL" - POLAND

• "PT" - PORTUGAL

• "RO" - ROMANIA

• "RU" - RUSSIA

• "RS" - SERBIA

• "SK" - SLOVAKIA

• "SI" - SLOVENIA

• "ZA" - SOUTH AFRICA

• "ES" - SPAIN

• "SE" - SWEDEN

• "CH" - SWITZERLAND

• "UA" - UKRAINE

• "AE" - UNITED ARAB EMIRATES

• "US" - UNITED STATES

• "UK" - UNITED KINGDOM

• "UY" - URUGUAY

• "VE" - VENEZUELA

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 SupplementaryFeature clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo