Class SupplementaryFeature

java.lang.Object
software.amazon.awssdk.services.forecast.model.SupplementaryFeature
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SupplementaryFeature.Builder,SupplementaryFeature>
@Generated("software.amazon.awssdk:codegen") public final class SupplementaryFeature extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SupplementaryFeature.Builder,SupplementaryFeature>

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:

  • Method Details

    • name

      public final String name()

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

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

    • value

      public final 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

      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

    • toBuilder

      public SupplementaryFeature.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SupplementaryFeature.Builder,SupplementaryFeature>
      Returns:
      a builder for type T

    • builder

      public static SupplementaryFeature.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SupplementaryFeature.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.