
software.amazon.awssdk.services.forecast.model.CreateDatasetGroupRequest 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.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.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 CreateDatasetGroupRequest extends ForecastRequest implements
ToCopyableBuilder {
private static final SdkField DATASET_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetGroupName").getter(getter(CreateDatasetGroupRequest::datasetGroupName))
.setter(setter(Builder::datasetGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetGroupName").build()).build();
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Domain")
.getter(getter(CreateDatasetGroupRequest::domainAsString)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain").build()).build();
private static final SdkField> DATASET_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DatasetArns")
.getter(getter(CreateDatasetGroupRequest::datasetArns))
.setter(setter(Builder::datasetArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateDatasetGroupRequest::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_GROUP_NAME_FIELD,
DOMAIN_FIELD, DATASET_ARNS_FIELD, TAGS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String datasetGroupName;
private final String domain;
private final List datasetArns;
private final List tags;
private CreateDatasetGroupRequest(BuilderImpl builder) {
super(builder);
this.datasetGroupName = builder.datasetGroupName;
this.domain = builder.domain;
this.datasetArns = builder.datasetArns;
this.tags = builder.tags;
}
/**
*
* A name for the dataset group.
*
*
* @return A name for the dataset group.
*/
public final String datasetGroupName() {
return datasetGroupName;
}
/**
*
* The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value
* specified for the Domain
parameter of the CreateDataset operation must
* match.
*
*
* The Domain
and DatasetType
that you choose determine the fields that must be present in
* training data that you import to a dataset. For example, if you choose the RETAIL
domain and
* TARGET_TIME_SERIES
as the DatasetType
, Amazon Forecast requires that
* item_id
, timestamp
, and demand
fields are present in your data. For more
* information, see Dataset
* groups.
*
*
* 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 group. When you add a dataset to a dataset group, this value and
* the value specified for the Domain
parameter of the CreateDataset operation
* must match.
*
* The Domain
and DatasetType
that you choose determine the fields that must be
* present in training data that you import to a dataset. For example, if you choose the RETAIL
* domain and TARGET_TIME_SERIES
as the DatasetType
, Amazon Forecast requires that
* item_id
, timestamp
, and demand
fields are present in your data.
* For more information, see Dataset groups.
* @see Domain
*/
public final Domain domain() {
return Domain.fromValue(domain);
}
/**
*
* The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value
* specified for the Domain
parameter of the CreateDataset operation must
* match.
*
*
* The Domain
and DatasetType
that you choose determine the fields that must be present in
* training data that you import to a dataset. For example, if you choose the RETAIL
domain and
* TARGET_TIME_SERIES
as the DatasetType
, Amazon Forecast requires that
* item_id
, timestamp
, and demand
fields are present in your data. For more
* information, see Dataset
* groups.
*
*
* 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 group. When you add a dataset to a dataset group, this value and
* the value specified for the Domain
parameter of the CreateDataset operation
* must match.
*
* The Domain
and DatasetType
that you choose determine the fields that must be
* present in training data that you import to a dataset. For example, if you choose the RETAIL
* domain and TARGET_TIME_SERIES
as the DatasetType
, Amazon Forecast requires that
* item_id
, timestamp
, and demand
fields are present in your data.
* For more information, see Dataset groups.
* @see Domain
*/
public final String domainAsString() {
return domain;
}
/**
* For responses, this returns true if the service returned a value for the DatasetArns 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 hasDatasetArns() {
return datasetArns != null && !(datasetArns instanceof SdkAutoConstructList);
}
/**
*
* An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
*
*
* 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 #hasDatasetArns} method.
*
*
* @return An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
*/
public final List datasetArns() {
return datasetArns;
}
/**
* 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 group 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 group 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 extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(datasetGroupName());
hashCode = 31 * hashCode + Objects.hashCode(domainAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasDatasetArns() ? datasetArns() : null);
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 CreateDatasetGroupRequest)) {
return false;
}
CreateDatasetGroupRequest other = (CreateDatasetGroupRequest) obj;
return Objects.equals(datasetGroupName(), other.datasetGroupName())
&& Objects.equals(domainAsString(), other.domainAsString()) && hasDatasetArns() == other.hasDatasetArns()
&& Objects.equals(datasetArns(), other.datasetArns()) && 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("CreateDatasetGroupRequest").add("DatasetGroupName", datasetGroupName())
.add("Domain", domainAsString()).add("DatasetArns", hasDatasetArns() ? datasetArns() : null)
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DatasetGroupName":
return Optional.ofNullable(clazz.cast(datasetGroupName()));
case "Domain":
return Optional.ofNullable(clazz.cast(domainAsString()));
case "DatasetArns":
return Optional.ofNullable(clazz.cast(datasetArns()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("DatasetGroupName", DATASET_GROUP_NAME_FIELD);
map.put("Domain", DOMAIN_FIELD);
map.put("DatasetArns", DATASET_ARNS_FIELD);
map.put("Tags", TAGS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function