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

/**
 * 
 * Describes the resource configuration for hyperparameter optimization (HPO).
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class HPOResourceConfig implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField MAX_NUMBER_OF_TRAINING_JOBS_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("maxNumberOfTrainingJobs").getter(getter(HPOResourceConfig::maxNumberOfTrainingJobs))
            .setter(setter(Builder::maxNumberOfTrainingJobs))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxNumberOfTrainingJobs").build())
            .build();

    private static final SdkField MAX_PARALLEL_TRAINING_JOBS_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("maxParallelTrainingJobs").getter(getter(HPOResourceConfig::maxParallelTrainingJobs))
            .setter(setter(Builder::maxParallelTrainingJobs))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxParallelTrainingJobs").build())
            .build();

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

    private static final long serialVersionUID = 1L;

    private final String maxNumberOfTrainingJobs;

    private final String maxParallelTrainingJobs;

    private HPOResourceConfig(BuilderImpl builder) {
        this.maxNumberOfTrainingJobs = builder.maxNumberOfTrainingJobs;
        this.maxParallelTrainingJobs = builder.maxParallelTrainingJobs;
    }

    /**
     * 
     * The maximum number of training jobs when you create a solution version. The maximum value for
     * maxNumberOfTrainingJobs is 40.
     * 
     * 
     * @return The maximum number of training jobs when you create a solution version. The maximum value for
     *         maxNumberOfTrainingJobs is 40.
     */
    public final String maxNumberOfTrainingJobs() {
        return maxNumberOfTrainingJobs;
    }

    /**
     * 
     * The maximum number of parallel training jobs when you create a solution version. The maximum value for
     * maxParallelTrainingJobs is 10.
     * 
     * 
     * @return The maximum number of parallel training jobs when you create a solution version. The maximum value for
     *         maxParallelTrainingJobs is 10.
     */
    public final String maxParallelTrainingJobs() {
        return maxParallelTrainingJobs;
    }

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

    /**
     * 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("HPOResourceConfig").add("MaxNumberOfTrainingJobs", maxNumberOfTrainingJobs())
                .add("MaxParallelTrainingJobs", maxParallelTrainingJobs()).build();
    }

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

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

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

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

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The maximum number of training jobs when you create a solution version. The maximum value for
         * maxNumberOfTrainingJobs is 40.
         * 
         * 
         * @param maxNumberOfTrainingJobs
         *        The maximum number of training jobs when you create a solution version. The maximum value for
         *        maxNumberOfTrainingJobs is 40.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder maxNumberOfTrainingJobs(String maxNumberOfTrainingJobs);

        /**
         * 
         * The maximum number of parallel training jobs when you create a solution version. The maximum value for
         * maxParallelTrainingJobs is 10.
         * 
         * 
         * @param maxParallelTrainingJobs
         *        The maximum number of parallel training jobs when you create a solution version. The maximum value for
         *        maxParallelTrainingJobs is 10.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder maxParallelTrainingJobs(String maxParallelTrainingJobs);
    }

    static final class BuilderImpl implements Builder {
        private String maxNumberOfTrainingJobs;

        private String maxParallelTrainingJobs;

        private BuilderImpl() {
        }

        private BuilderImpl(HPOResourceConfig model) {
            maxNumberOfTrainingJobs(model.maxNumberOfTrainingJobs);
            maxParallelTrainingJobs(model.maxParallelTrainingJobs);
        }

        public final String getMaxNumberOfTrainingJobs() {
            return maxNumberOfTrainingJobs;
        }

        public final void setMaxNumberOfTrainingJobs(String maxNumberOfTrainingJobs) {
            this.maxNumberOfTrainingJobs = maxNumberOfTrainingJobs;
        }

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

        public final String getMaxParallelTrainingJobs() {
            return maxParallelTrainingJobs;
        }

        public final void setMaxParallelTrainingJobs(String maxParallelTrainingJobs) {
            this.maxParallelTrainingJobs = maxParallelTrainingJobs;
        }

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

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

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