software.amazon.awssdk.services.forecast.model.CreateDatasetRequest 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.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateDatasetRequest extends ForecastRequest implements
ToCopyableBuilder {
private static final SdkField DATASET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetName").getter(getter(CreateDatasetRequest::datasetName)).setter(setter(Builder::datasetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetName").build()).build();
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Domain")
.getter(getter(CreateDatasetRequest::domainAsString)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain").build()).build();
private static final SdkField DATASET_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetType").getter(getter(CreateDatasetRequest::datasetTypeAsString))
.setter(setter(Builder::datasetType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetType").build()).build();
private static final SdkField DATA_FREQUENCY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataFrequency").getter(getter(CreateDatasetRequest::dataFrequency))
.setter(setter(Builder::dataFrequency))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataFrequency").build()).build();
private static final SdkField SCHEMA_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Schema")
.getter(getter(CreateDatasetRequest::schema)).setter(setter(Builder::schema)).constructor(Schema::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Schema").build()).build();
private static final SdkField ENCRYPTION_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("EncryptionConfig")
.getter(getter(CreateDatasetRequest::encryptionConfig)).setter(setter(Builder::encryptionConfig))
.constructor(EncryptionConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionConfig").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateDatasetRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DATASET_NAME_FIELD,
DOMAIN_FIELD, DATASET_TYPE_FIELD, DATA_FREQUENCY_FIELD, SCHEMA_FIELD, ENCRYPTION_CONFIG_FIELD, TAGS_FIELD));
private final String datasetName;
private final String domain;
private final String datasetType;
private final String dataFrequency;
private final Schema schema;
private final EncryptionConfig encryptionConfig;
private final List tags;
private CreateDatasetRequest(BuilderImpl builder) {
super(builder);
this.datasetName = builder.datasetName;
this.domain = builder.domain;
this.datasetType = builder.datasetType;
this.dataFrequency = builder.dataFrequency;
this.schema = builder.schema;
this.encryptionConfig = builder.encryptionConfig;
this.tags = builder.tags;
}
/**
*
* A name for the dataset.
*
*
* @return A name for the dataset.
*/
public final String datasetName() {
return datasetName;
}
/**
*
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
* specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
*
* The Domain and DatasetType that you choose determine the fields that must be present in
* the training data that you import to the dataset. For example, if you choose the RETAIL domain and
* TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id,
* timestamp, and demand fields to be present in your data. For more information, see Importing datasets.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link Domain#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The domain associated with the dataset. When you add a dataset to a dataset group, this value and the
* value specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be
* present in your data. For more information, see Importing
* datasets.
* @see Domain
*/
public final Domain domain() {
return Domain.fromValue(domain);
}
/**
*
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
* specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
*
* The Domain and DatasetType that you choose determine the fields that must be present in
* the training data that you import to the dataset. For example, if you choose the RETAIL domain and
* TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id,
* timestamp, and demand fields to be present in your data. For more information, see Importing datasets.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #domain} will
* return {@link Domain#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #domainAsString}.
*
*
* @return The domain associated with the dataset. When you add a dataset to a dataset group, this value and the
* value specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be
* present in your data. For more information, see Importing
* datasets.
* @see Domain
*/
public final String domainAsString() {
return domain;
}
/**
*
* The dataset type. Valid values depend on the chosen Domain.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #datasetType} will
* return {@link DatasetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #datasetTypeAsString}.
*
*
* @return The dataset type. Valid values depend on the chosen Domain.
* @see DatasetType
*/
public final DatasetType datasetType() {
return DatasetType.fromValue(datasetType);
}
/**
*
* The dataset type. Valid values depend on the chosen Domain.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #datasetType} will
* return {@link DatasetType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #datasetTypeAsString}.
*
*
* @return The dataset type. Valid values depend on the chosen Domain.
* @see DatasetType
*/
public final String datasetTypeAsString() {
return datasetType;
}
/**
*
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
*
*
* Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute).
* For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that
* would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60
* minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:
*
*
* -
*
* Minute - 1-59
*
*
* -
*
* Hour - 1-23
*
*
* -
*
* Day - 1-6
*
*
* -
*
* Week - 1-4
*
*
* -
*
* Month - 1-11
*
*
* -
*
* Year - 1
*
*
*
*
* Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify
* "3M".
*
*
* @return The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
*
* Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min
* (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot
* specify a value that would overlap with the next larger frequency. That means, for example, you cannot
* specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each
* frequency are the following:
*
*
* -
*
* Minute - 1-59
*
*
* -
*
* Hour - 1-23
*
*
* -
*
* Day - 1-6
*
*
* -
*
* Week - 1-4
*
*
* -
*
* Month - 1-11
*
*
* -
*
* Year - 1
*
*
*
*
* Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you
* specify "3M".
*/
public final String dataFrequency() {
return dataFrequency;
}
/**
*
* The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset
* Domain and DatasetType that you choose determine the minimum required fields in your
* training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and
* Dataset Types.
*
*
* @return The schema for the dataset. The schema attributes and their order must match the fields in your data. The
* dataset Domain and DatasetType that you choose determine the minimum required
* fields in your training data. For information about the required fields for a specific dataset domain and
* type, see Dataset Domains
* and Dataset Types.
*/
public final Schema schema() {
return schema;
}
/**
*
* An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can
* assume to access the key.
*
*
* @return An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the key.
*/
public final EncryptionConfig encryptionConfig() {
return encryptionConfig;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists
* of a key and an optional value, both of which you define.
*
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services may have
* restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
* in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
* keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values
* can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast
* considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of
* aws do not count against your tags per resource limit.
*
*
*
*
* 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 #hasTags} method.
*
*
* @return The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services may
* have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces
* representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a
* prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with
* this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key
* does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags
* with only the key prefix of aws do not count against your tags per resource limit.
*
*
*/
public final List tags() {
return tags;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(datasetName());
hashCode = 31 * hashCode + Objects.hashCode(domainAsString());
hashCode = 31 * hashCode + Objects.hashCode(datasetTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(dataFrequency());
hashCode = 31 * hashCode + Objects.hashCode(schema());
hashCode = 31 * hashCode + Objects.hashCode(encryptionConfig());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateDatasetRequest)) {
return false;
}
CreateDatasetRequest other = (CreateDatasetRequest) obj;
return Objects.equals(datasetName(), other.datasetName()) && Objects.equals(domainAsString(), other.domainAsString())
&& Objects.equals(datasetTypeAsString(), other.datasetTypeAsString())
&& Objects.equals(dataFrequency(), other.dataFrequency()) && Objects.equals(schema(), other.schema())
&& Objects.equals(encryptionConfig(), other.encryptionConfig()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateDatasetRequest").add("DatasetName", datasetName()).add("Domain", domainAsString())
.add("DatasetType", datasetTypeAsString()).add("DataFrequency", dataFrequency()).add("Schema", schema())
.add("EncryptionConfig", encryptionConfig()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DatasetName":
return Optional.ofNullable(clazz.cast(datasetName()));
case "Domain":
return Optional.ofNullable(clazz.cast(domainAsString()));
case "DatasetType":
return Optional.ofNullable(clazz.cast(datasetTypeAsString()));
case "DataFrequency":
return Optional.ofNullable(clazz.cast(dataFrequency()));
case "Schema":
return Optional.ofNullable(clazz.cast(schema()));
case "EncryptionConfig":
return Optional.ofNullable(clazz.cast(encryptionConfig()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDatasetRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* A name for the dataset.
*
*
* @param datasetName
* A name for the dataset.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetName(String datasetName);
/**
*
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
* specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be present
* in your data. For more information, see Importing datasets.
*
*
* @param domain
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the
* value specified for the Domain parameter of the CreateDatasetGroup operation must match.
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be
* present in your data. For more information, see Importing
* datasets.
* @see Domain
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
Builder domain(String domain);
/**
*
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
* specified for the Domain parameter of the CreateDatasetGroup
* operation must match.
*
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be present
* in your data. For more information, see Importing datasets.
*
*
* @param domain
* The domain associated with the dataset. When you add a dataset to a dataset group, this value and the
* value specified for the Domain parameter of the CreateDatasetGroup operation must match.
*
* The Domain and DatasetType that you choose determine the fields that must be
* present in the training data that you import to the dataset. For example, if you choose the
* RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon
* Forecast requires item_id, timestamp, and demand fields to be
* present in your data. For more information, see Importing
* datasets.
* @see Domain
* @return Returns a reference to this object so that method calls can be chained together.
* @see Domain
*/
Builder domain(Domain domain);
/**
*
* The dataset type. Valid values depend on the chosen Domain.
*
*
* @param datasetType
* The dataset type. Valid values depend on the chosen Domain.
* @see DatasetType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetType
*/
Builder datasetType(String datasetType);
/**
*
* The dataset type. Valid values depend on the chosen Domain.
*
*
* @param datasetType
* The dataset type. Valid values depend on the chosen Domain.
* @see DatasetType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DatasetType
*/
Builder datasetType(DatasetType datasetType);
/**
*
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
*
*
* Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min
* (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a
* value that would overlap with the next larger frequency. That means, for example, you cannot specify a
* frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the
* following:
*
*
* -
*
* Minute - 1-59
*
*
* -
*
* Hour - 1-23
*
*
* -
*
* Day - 1-6
*
*
* -
*
* Week - 1-4
*
*
* -
*
* Month - 1-11
*
*
* -
*
* Year - 1
*
*
*
*
* Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you specify
* "3M".
*
*
* @param dataFrequency
* The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
*
* Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min
* (Minute). For example, "1D" indicates every day and "15min" indicates every 15 minutes. You cannot
* specify a value that would overlap with the next larger frequency. That means, for example, you cannot
* specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each
* frequency are the following:
*
*
* -
*
* Minute - 1-59
*
*
* -
*
* Hour - 1-23
*
*
* -
*
* Day - 1-6
*
*
* -
*
* Week - 1-4
*
*
* -
*
* Month - 1-11
*
*
* -
*
* Year - 1
*
*
*
*
* Thus, if you want every other week forecasts, specify "2W". Or, if you want quarterly forecasts, you
* specify "3M".
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataFrequency(String dataFrequency);
/**
*
* The schema for the dataset. The schema attributes and their order must match the fields in your data. The
* dataset Domain and DatasetType that you choose determine the minimum required
* fields in your training data. For information about the required fields for a specific dataset domain and
* type, see Dataset
* Domains and Dataset Types.
*
*
* @param schema
* The schema for the dataset. The schema attributes and their order must match the fields in your data.
* The dataset Domain and DatasetType that you choose determine the minimum
* required fields in your training data. For information about the required fields for a specific
* dataset domain and type, see Dataset Domains
* and Dataset Types.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder schema(Schema schema);
/**
*
* The schema for the dataset. The schema attributes and their order must match the fields in your data. The
* dataset Domain and DatasetType that you choose determine the minimum required
* fields in your training data. For information about the required fields for a specific dataset domain and
* type, see Dataset
* Domains and Dataset Types.
*
* This is a convenience method that creates an instance of the {@link Schema.Builder} avoiding the need to
* create one manually via {@link Schema#builder()}.
*
*
* When the {@link Consumer} completes, {@link Schema.Builder#build()} is called immediately and its result is
* passed to {@link #schema(Schema)}.
*
* @param schema
* a consumer that will call methods on {@link Schema.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #schema(Schema)
*/
default Builder schema(Consumer schema) {
return schema(Schema.builder().applyMutation(schema).build());
}
/**
*
* An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the key.
*
*
* @param encryptionConfig
* An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon
* Forecast can assume to access the key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionConfig(EncryptionConfig encryptionConfig);
/**
*
* An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast
* can assume to access the key.
*
* This is a convenience method that creates an instance of the {@link EncryptionConfig.Builder} avoiding the
* need to create one manually via {@link EncryptionConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link EncryptionConfig.Builder#build()} is called immediately and its
* result is passed to {@link #encryptionConfig(EncryptionConfig)}.
*
* @param encryptionConfig
* a consumer that will call methods on {@link EncryptionConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #encryptionConfig(EncryptionConfig)
*/
default Builder encryptionConfig(Consumer encryptionConfig) {
return encryptionConfig(EncryptionConfig.builder().applyMutation(encryptionConfig).build());
}
/**
*
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services may have
* restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces
* representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
* for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not, then
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit.
*
*
*
*
* @param tags
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services
* may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and
* spaces representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a
* prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with
* this prefix. Values can have this prefix. If a tag value has aws as its prefix but the
* key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags.
* Tags with only the key prefix of aws do not count against your tags per resource limit.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services may have
* restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces
* representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
* for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not, then
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit.
*
*
*
*
* @param tags
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services
* may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and
* spaces representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a
* prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with
* this prefix. Values can have this prefix. If a tag value has aws as its prefix but the
* key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags.
* Tags with only the key prefix of aws do not count against your tags per resource limit.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag
* consists of a key and an optional value, both of which you define.
*
*
* The following basic restrictions apply to tags:
*
*
* -
*
* Maximum number of tags per resource - 50.
*
*
* -
*
* For each resource, each tag key must be unique, and each tag key can have only one value.
*
*
* -
*
* Maximum key length - 128 Unicode characters in UTF-8.
*
*
* -
*
* Maximum value length - 256 Unicode characters in UTF-8.
*
*
* -
*
* If your tagging schema is used across multiple services and resources, remember that other services may have
* restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces
* representable in UTF-8, and the following characters: + - = . _ : / @.
*
*
* -
*
* Tag keys and values are case sensitive.
*
*
* -
*
* Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix
* for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix.
* Values can have this prefix. If a tag value has aws as its prefix but the key does not, then
* Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key
* prefix of aws do not count against your tags per resource limit.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.forecast.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ForecastRequest.BuilderImpl implements Builder {
private String datasetName;
private String domain;
private String datasetType;
private String dataFrequency;
private Schema schema;
private EncryptionConfig encryptionConfig;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateDatasetRequest model) {
super(model);
datasetName(model.datasetName);
domain(model.domain);
datasetType(model.datasetType);
dataFrequency(model.dataFrequency);
schema(model.schema);
encryptionConfig(model.encryptionConfig);
tags(model.tags);
}
public final String getDatasetName() {
return datasetName;
}
public final void setDatasetName(String datasetName) {
this.datasetName = datasetName;
}
@Override
public final Builder datasetName(String datasetName) {
this.datasetName = datasetName;
return this;
}
public final String getDomain() {
return domain;
}
public final void setDomain(String domain) {
this.domain = domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
@Override
public final Builder domain(Domain domain) {
this.domain(domain == null ? null : domain.toString());
return this;
}
public final String getDatasetType() {
return datasetType;
}
public final void setDatasetType(String datasetType) {
this.datasetType = datasetType;
}
@Override
public final Builder datasetType(String datasetType) {
this.datasetType = datasetType;
return this;
}
@Override
public final Builder datasetType(DatasetType datasetType) {
this.datasetType(datasetType == null ? null : datasetType.toString());
return this;
}
public final String getDataFrequency() {
return dataFrequency;
}
public final void setDataFrequency(String dataFrequency) {
this.dataFrequency = dataFrequency;
}
@Override
public final Builder dataFrequency(String dataFrequency) {
this.dataFrequency = dataFrequency;
return this;
}
public final Schema.Builder getSchema() {
return schema != null ? schema.toBuilder() : null;
}
public final void setSchema(Schema.BuilderImpl schema) {
this.schema = schema != null ? schema.build() : null;
}
@Override
public final Builder schema(Schema schema) {
this.schema = schema;
return this;
}
public final EncryptionConfig.Builder getEncryptionConfig() {
return encryptionConfig != null ? encryptionConfig.toBuilder() : null;
}
public final void setEncryptionConfig(EncryptionConfig.BuilderImpl encryptionConfig) {
this.encryptionConfig = encryptionConfig != null ? encryptionConfig.build() : null;
}
@Override
public final Builder encryptionConfig(EncryptionConfig encryptionConfig) {
this.encryptionConfig = encryptionConfig;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateDatasetRequest build() {
return new CreateDatasetRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}