Class AdditionalDataset

java.lang.Object
software.amazon.awssdk.services.forecast.model.AdditionalDataset
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdditionalDataset.Builder,AdditionalDataset>

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

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

Weather Index

The Amazon Forecast Weather Index is a built-in dataset 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 dataset that incorporates 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 additional dataset. Valid names: "holiday" and "weather".

      Returns:
      The name of the additional dataset. Valid names: "holiday" and "weather".
    • hasConfiguration

      public final boolean hasConfiguration()
      For responses, this returns true if the service returned a value for the Configuration 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.
    • configuration

      public final Map<String,List<String>> configuration()

      Weather Index

      To enable the Weather Index, do not specify a value for Configuration.

      Holidays

      Holidays

      To enable Holidays, set CountryCode to 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

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

      Returns:
      Weather Index

      To enable the Weather Index, do not specify a value for Configuration.

      Holidays

      Holidays

      To enable Holidays, set CountryCode to 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 AdditionalDataset.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<AdditionalDataset.Builder,AdditionalDataset>
      Returns:
      a builder for type T
    • builder

      public static AdditionalDataset.Builder builder()
    • serializableBuilderClass

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