software.amazon.awssdk.services.forecast.model.InputDataConfig 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.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.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;
/**
*
*
* This object belongs to the CreatePredictor operation. If you created your predictor with
* CreateAutoPredictor, see DataConfig.
*
*
*
* The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify
* this object in the CreatePredictor request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InputDataConfig implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField DATASET_GROUP_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DatasetGroupArn").getter(getter(InputDataConfig::datasetGroupArn))
.setter(setter(Builder::datasetGroupArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DatasetGroupArn").build()).build();
private static final SdkField> SUPPLEMENTARY_FEATURES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SupplementaryFeatures")
.getter(getter(InputDataConfig::supplementaryFeatures))
.setter(setter(Builder::supplementaryFeatures))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SupplementaryFeatures").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(SupplementaryFeature::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_ARN_FIELD,
SUPPLEMENTARY_FEATURES_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("DatasetGroupArn", DATASET_GROUP_ARN_FIELD);
put("SupplementaryFeatures", SUPPLEMENTARY_FEATURES_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String datasetGroupArn;
private final List supplementaryFeatures;
private InputDataConfig(BuilderImpl builder) {
this.datasetGroupArn = builder.datasetGroupArn;
this.supplementaryFeatures = builder.supplementaryFeatures;
}
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @return The Amazon Resource Name (ARN) of the dataset group.
*/
public final String datasetGroupArn() {
return datasetGroupArn;
}
/**
* For responses, this returns true if the service returned a value for the SupplementaryFeatures 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 hasSupplementaryFeatures() {
return supplementaryFeatures != null && !(supplementaryFeatures instanceof SdkAutoConstructList);
}
/**
*
* An array of supplementary features. The only supported feature is a holiday calendar.
*
*
* 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 #hasSupplementaryFeatures} method.
*
*
* @return An array of supplementary features. The only supported feature is a holiday calendar.
*/
public final List supplementaryFeatures() {
return supplementaryFeatures;
}
@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(datasetGroupArn());
hashCode = 31 * hashCode + Objects.hashCode(hasSupplementaryFeatures() ? supplementaryFeatures() : 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 InputDataConfig)) {
return false;
}
InputDataConfig other = (InputDataConfig) obj;
return Objects.equals(datasetGroupArn(), other.datasetGroupArn())
&& hasSupplementaryFeatures() == other.hasSupplementaryFeatures()
&& Objects.equals(supplementaryFeatures(), other.supplementaryFeatures());
}
/**
* 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("InputDataConfig").add("DatasetGroupArn", datasetGroupArn())
.add("SupplementaryFeatures", hasSupplementaryFeatures() ? supplementaryFeatures() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DatasetGroupArn":
return Optional.ofNullable(clazz.cast(datasetGroupArn()));
case "SupplementaryFeatures":
return Optional.ofNullable(clazz.cast(supplementaryFeatures()));
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((InputDataConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the dataset group.
*
*
* @param datasetGroupArn
* The Amazon Resource Name (ARN) of the dataset group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder datasetGroupArn(String datasetGroupArn);
/**
*
* An array of supplementary features. The only supported feature is a holiday calendar.
*
*
* @param supplementaryFeatures
* An array of supplementary features. The only supported feature is a holiday calendar.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supplementaryFeatures(Collection supplementaryFeatures);
/**
*
* An array of supplementary features. The only supported feature is a holiday calendar.
*
*
* @param supplementaryFeatures
* An array of supplementary features. The only supported feature is a holiday calendar.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder supplementaryFeatures(SupplementaryFeature... supplementaryFeatures);
/**
*
* An array of supplementary features. The only supported feature is a holiday calendar.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.forecast.model.SupplementaryFeature.Builder} avoiding the need to
* create one manually via {@link software.amazon.awssdk.services.forecast.model.SupplementaryFeature#builder()}
* .
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.forecast.model.SupplementaryFeature.Builder#build()} is called
* immediately and its result is passed to {@link #supplementaryFeatures(List)}.
*
* @param supplementaryFeatures
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.forecast.model.SupplementaryFeature.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #supplementaryFeatures(java.util.Collection)
*/
Builder supplementaryFeatures(Consumer... supplementaryFeatures);
}
static final class BuilderImpl implements Builder {
private String datasetGroupArn;
private List supplementaryFeatures = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(InputDataConfig model) {
datasetGroupArn(model.datasetGroupArn);
supplementaryFeatures(model.supplementaryFeatures);
}
public final String getDatasetGroupArn() {
return datasetGroupArn;
}
public final void setDatasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
}
@Override
public final Builder datasetGroupArn(String datasetGroupArn) {
this.datasetGroupArn = datasetGroupArn;
return this;
}
public final List getSupplementaryFeatures() {
List result = SupplementaryFeaturesCopier.copyToBuilder(this.supplementaryFeatures);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSupplementaryFeatures(Collection supplementaryFeatures) {
this.supplementaryFeatures = SupplementaryFeaturesCopier.copyFromBuilder(supplementaryFeatures);
}
@Override
public final Builder supplementaryFeatures(Collection supplementaryFeatures) {
this.supplementaryFeatures = SupplementaryFeaturesCopier.copy(supplementaryFeatures);
return this;
}
@Override
@SafeVarargs
public final Builder supplementaryFeatures(SupplementaryFeature... supplementaryFeatures) {
supplementaryFeatures(Arrays.asList(supplementaryFeatures));
return this;
}
@Override
@SafeVarargs
public final Builder supplementaryFeatures(Consumer... supplementaryFeatures) {
supplementaryFeatures(Stream.of(supplementaryFeatures)
.map(c -> SupplementaryFeature.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public InputDataConfig build() {
return new InputDataConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}