software.amazon.awssdk.services.forecast.model.AdditionalDataset Maven / Gradle / Ivy
Show all versions of forecast Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.forecast.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AdditionalDataset implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(AdditionalDataset::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField>> CONFIGURATION_FIELD = SdkField
.>> builder(MarshallingType.MAP)
.memberName("Configuration")
.getter(getter(AdditionalDataset::configuration))
.setter(setter(Builder::configuration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Configuration").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField.> builder(MarshallingType.LIST)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder()
.location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build())
.build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
CONFIGURATION_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Name", NAME_FIELD);
put("Configuration", CONFIGURATION_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String name;
private final Map> configuration;
private AdditionalDataset(BuilderImpl builder) {
this.name = builder.name;
this.configuration = builder.configuration;
}
/**
*
* The name of the additional dataset. Valid names: "holiday" and "weather".
*
*
* @return The name of the additional dataset. Valid names: "holiday" and "weather".
*/
public final String name() {
return name;
}
/**
* 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 {@code 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.
*/
public final boolean hasConfiguration() {
return configuration != null && !(configuration instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasConfiguration} method.
*
*
* @return 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
*
*
*/
public final Map> configuration() {
return configuration;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(hasConfiguration() ? configuration() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AdditionalDataset)) {
return false;
}
AdditionalDataset other = (AdditionalDataset) obj;
return Objects.equals(name(), other.name()) && hasConfiguration() == other.hasConfiguration()
&& Objects.equals(configuration(), other.configuration());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("AdditionalDataset").add("Name", name())
.add("Configuration", hasConfiguration() ? configuration() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Configuration":
return Optional.ofNullable(clazz.cast(configuration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((AdditionalDataset) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the additional dataset. Valid names: "holiday" and "weather".
*
*
* @param name
* The name of the additional dataset. Valid names: "holiday" and "weather".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* 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
*
*
*
*
* @param 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
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configuration(Map> configuration);
}
static final class BuilderImpl implements Builder {
private String name;
private Map> configuration = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AdditionalDataset model) {
name(model.name);
configuration(model.configuration);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final Map> getConfiguration() {
if (configuration instanceof SdkAutoConstructMap) {
return null;
}
return configuration;
}
public final void setConfiguration(Map> configuration) {
this.configuration = ConfigurationCopier.copy(configuration);
}
@Override
public final Builder configuration(Map> configuration) {
this.configuration = ConfigurationCopier.copy(configuration);
return this;
}
@Override
public AdditionalDataset build() {
return new AdditionalDataset(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}