software.amazon.awssdk.services.personalize.model.TunedHPOParams 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.Collections;
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.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;

/**
 * 
 * If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of the best performing model.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class TunedHPOParams implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField> ALGORITHM_HYPER_PARAMETERS_FIELD = SdkField
            .> builder(MarshallingType.MAP)
            .memberName("algorithmHyperParameters")
            .getter(getter(TunedHPOParams::algorithmHyperParameters))
            .setter(setter(Builder::algorithmHyperParameters))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("algorithmHyperParameters").build(),
                    MapTrait.builder()
                            .keyLocationName("key")
                            .valueLocationName("value")
                            .valueFieldInfo(
                                    SdkField. builder(MarshallingType.STRING)
                                            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
                                                    .locationName("value").build()).build()).build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
            .asList(ALGORITHM_HYPER_PARAMETERS_FIELD));

    private static final long serialVersionUID = 1L;

    private final Map algorithmHyperParameters;

    private TunedHPOParams(BuilderImpl builder) {
        this.algorithmHyperParameters = builder.algorithmHyperParameters;
    }

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

    /**
     * 
     * A list of the hyperparameter values of the best performing model.
     * 
     * 
     * 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 #hasAlgorithmHyperParameters} method.
     * 
     * 
     * @return A list of the hyperparameter values of the best performing model.
     */
    public final Map algorithmHyperParameters() {
        return algorithmHyperParameters;
    }

    @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(hasAlgorithmHyperParameters() ? algorithmHyperParameters() : 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 TunedHPOParams)) {
            return false;
        }
        TunedHPOParams other = (TunedHPOParams) obj;
        return hasAlgorithmHyperParameters() == other.hasAlgorithmHyperParameters()
                && Objects.equals(algorithmHyperParameters(), other.algorithmHyperParameters());
    }

    /**
     * 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("TunedHPOParams")
                .add("AlgorithmHyperParameters", hasAlgorithmHyperParameters() ? algorithmHyperParameters() : null).build();
    }

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

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * A list of the hyperparameter values of the best performing model.
         * 
         * 
         * @param algorithmHyperParameters
         *        A list of the hyperparameter values of the best performing model.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder algorithmHyperParameters(Map algorithmHyperParameters);
    }

    static final class BuilderImpl implements Builder {
        private Map algorithmHyperParameters = DefaultSdkAutoConstructMap.getInstance();

        private BuilderImpl() {
        }

        private BuilderImpl(TunedHPOParams model) {
            algorithmHyperParameters(model.algorithmHyperParameters);
        }

        public final Map getAlgorithmHyperParameters() {
            if (algorithmHyperParameters instanceof SdkAutoConstructMap) {
                return null;
            }
            return algorithmHyperParameters;
        }

        public final void setAlgorithmHyperParameters(Map algorithmHyperParameters) {
            this.algorithmHyperParameters = HyperParametersCopier.copy(algorithmHyperParameters);
        }

        @Override
        public final Builder algorithmHyperParameters(Map algorithmHyperParameters) {
            this.algorithmHyperParameters = HyperParametersCopier.copy(algorithmHyperParameters);
            return this;
        }

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

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