software.amazon.awssdk.services.personalize.model.AutoMLConfig Maven / Gradle / Ivy

Go to download
/*
 * 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.personalize.model;

import java.io.Serializable;
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.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.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;

/**
 * 
 * When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon
 * Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then
 * uses that recipe for the solution.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AutoMLConfig implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("metricName").getter(getter(AutoMLConfig::metricName)).setter(setter(Builder::metricName))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricName").build()).build();

    private static final SdkField> RECIPE_LIST_FIELD = SdkField
            .> builder(MarshallingType.LIST)
            .memberName("recipeList")
            .getter(getter(AutoMLConfig::recipeList))
            .setter(setter(Builder::recipeList))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("recipeList").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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(METRIC_NAME_FIELD,
            RECIPE_LIST_FIELD));

    private static final long serialVersionUID = 1L;

    private final String metricName;

    private final List recipeList;

    private AutoMLConfig(BuilderImpl builder) {
        this.metricName = builder.metricName;
        this.recipeList = builder.recipeList;
    }

    /**
     * 
     * The metric to optimize.
     * 
     * 
     * @return The metric to optimize.
     */
    public final String metricName() {
        return metricName;
    }

    /**
     * For responses, this returns true if the service returned a value for the RecipeList 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 hasRecipeList() {
        return recipeList != null && !(recipeList instanceof SdkAutoConstructList);
    }

    /**
     * 
     * The list of candidate recipes.
     * 
     * 
     * 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 #hasRecipeList} method.
     * 
     * 
     * @return The list of candidate recipes.
     */
    public final List recipeList() {
        return recipeList;
    }

    @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(metricName());
        hashCode = 31 * hashCode + Objects.hashCode(hasRecipeList() ? recipeList() : 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 AutoMLConfig)) {
            return false;
        }
        AutoMLConfig other = (AutoMLConfig) obj;
        return Objects.equals(metricName(), other.metricName()) && hasRecipeList() == other.hasRecipeList()
                && Objects.equals(recipeList(), other.recipeList());
    }

    /**
     * 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("AutoMLConfig").add("MetricName", metricName())
                .add("RecipeList", hasRecipeList() ? recipeList() : null).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "metricName":
            return Optional.ofNullable(clazz.cast(metricName()));
        case "recipeList":
            return Optional.ofNullable(clazz.cast(recipeList()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((AutoMLConfig) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The metric to optimize.
         * 
         * 
         * @param metricName
         *        The metric to optimize.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder metricName(String metricName);

        /**
         * 
         * The list of candidate recipes.
         * 
         * 
         * @param recipeList
         *        The list of candidate recipes.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder recipeList(Collection recipeList);

        /**
         * 
         * The list of candidate recipes.
         * 
         * 
         * @param recipeList
         *        The list of candidate recipes.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder recipeList(String... recipeList);
    }

    static final class BuilderImpl implements Builder {
        private String metricName;

        private List recipeList = DefaultSdkAutoConstructList.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(AutoMLConfig model) {
            metricName(model.metricName);
            recipeList(model.recipeList);
        }

        public final String getMetricName() {
            return metricName;
        }

        public final void setMetricName(String metricName) {
            this.metricName = metricName;
        }

        @Override
        public final Builder metricName(String metricName) {
            this.metricName = metricName;
            return this;
        }

        public final Collection getRecipeList() {
            if (recipeList instanceof SdkAutoConstructList) {
                return null;
            }
            return recipeList;
        }

        public final void setRecipeList(Collection recipeList) {
            this.recipeList = ArnListCopier.copy(recipeList);
        }

        @Override
        public final Builder recipeList(Collection recipeList) {
            this.recipeList = ArnListCopier.copy(recipeList);
            return this;
        }

        @Override
        @SafeVarargs
        public final Builder recipeList(String... recipeList) {
            recipeList(Arrays.asList(recipeList));
            return this;
        }

        @Override
        public AutoMLConfig build() {
            return new AutoMLConfig(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}