software.amazon.awssdk.services.sagemaker.model.AutoParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating with Amazon SageMaker Service
There is a newer version: 2.29.39
Show newest version
/*
 * 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.sagemaker.model;

import java.io.Serializable;
import java.util.Arrays;
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.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * The name and an example value of the hyperparameter that you want to use in Autotune. If Automatic model tuning (AMT)
 * determines that your hyperparameter is eligible for Autotune, an optimal hyperparameter range is selected for you.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class AutoParameter implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
            .getter(getter(AutoParameter::name)).setter(setter(Builder::name))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();

    private static final SdkField VALUE_HINT_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("ValueHint").getter(getter(AutoParameter::valueHint)).setter(setter(Builder::valueHint))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ValueHint").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_HINT_FIELD));

    private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();

    private static final long serialVersionUID = 1L;

    private final String name;

    private final String valueHint;

    private AutoParameter(BuilderImpl builder) {
        this.name = builder.name;
        this.valueHint = builder.valueHint;
    }

    /**
     * 
     * The name of the hyperparameter to optimize using Autotune.
     * 
     * 
     * @return The name of the hyperparameter to optimize using Autotune.
     */
    public final String name() {
        return name;
    }

    /**
     * 
     * An example value of the hyperparameter to optimize using Autotune.
     * 
     * 
     * @return An example value of the hyperparameter to optimize using Autotune.
     */
    public final String valueHint() {
        return valueHint;
    }

    @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(name());
        hashCode = 31 * hashCode + Objects.hashCode(valueHint());
        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 AutoParameter)) {
            return false;
        }
        AutoParameter other = (AutoParameter) obj;
        return Objects.equals(name(), other.name()) && Objects.equals(valueHint(), other.valueHint());
    }

    /**
     * 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("AutoParameter").add("Name", name()).add("ValueHint", valueHint()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "Name":
            return Optional.ofNullable(clazz.cast(name()));
        case "ValueHint":
            return Optional.ofNullable(clazz.cast(valueHint()));
        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("Name", NAME_FIELD);
        map.put("ValueHint", VALUE_HINT_FIELD);
        return Collections.unmodifiableMap(map);
    }

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

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

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

        /**
         * 
         * An example value of the hyperparameter to optimize using Autotune.
         * 
         * 
         * @param valueHint
         *        An example value of the hyperparameter to optimize using Autotune.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder valueHint(String valueHint);
    }

    static final class BuilderImpl implements Builder {
        private String name;

        private String valueHint;

        private BuilderImpl() {
        }

        private BuilderImpl(AutoParameter model) {
            name(model.name);
            valueHint(model.valueHint);
        }

        public final String getName() {
            return name;
        }

        public final void setName(String name) {
            this.name = name;
        }

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

        public final String getValueHint() {
            return valueHint;
        }

        public final void setValueHint(String valueHint) {
            this.valueHint = valueHint;
        }

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

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

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

        @Override
        public Map> sdkFieldNameToField() {
            return SDK_NAME_TO_FIELD;
        }
    }
}