/*
 * Copyright 2018-2023 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 com.amazonaws.services.sagemaker.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * The configuration for a training job launched by a hyperparameter tuning job. Choose <code>Bayesian</code> for
 * Bayesian optimization, and <code>Random</code> for random search optimization. For more advanced use cases, use
 * <code>Hyperband</code>, which evaluates objective metrics for training jobs after every epoch. For more information
 * about strategies, see <a
 * href="https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html">How Hyperparameter
 * Tuning Works</a>.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/HyperParameterTuningJobStrategyConfig"
 *      target="_top">AWS API Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HyperParameterTuningJobStrategyConfig implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is only
     * supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     * <code>HyperParameterTuningJobConfig</code> API.
     * </p>
     */
    private HyperbandStrategyConfig hyperbandStrategyConfig;

    /**
     * <p>
     * The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is only
     * supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     * <code>HyperParameterTuningJobConfig</code> API.
     * </p>
     * 
     * @param hyperbandStrategyConfig
     *        The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is
     *        only supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     *        <code>HyperParameterTuningJobConfig</code> API.
     */

    public void setHyperbandStrategyConfig(HyperbandStrategyConfig hyperbandStrategyConfig) {
        this.hyperbandStrategyConfig = hyperbandStrategyConfig;
    }

    /**
     * <p>
     * The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is only
     * supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     * <code>HyperParameterTuningJobConfig</code> API.
     * </p>
     * 
     * @return The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is
     *         only supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     *         <code>HyperParameterTuningJobConfig</code> API.
     */

    public HyperbandStrategyConfig getHyperbandStrategyConfig() {
        return this.hyperbandStrategyConfig;
    }

    /**
     * <p>
     * The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is only
     * supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     * <code>HyperParameterTuningJobConfig</code> API.
     * </p>
     * 
     * @param hyperbandStrategyConfig
     *        The configuration for the object that specifies the <code>Hyperband</code> strategy. This parameter is
     *        only supported for the <code>Hyperband</code> selection for <code>Strategy</code> within the
     *        <code>HyperParameterTuningJobConfig</code> API.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public HyperParameterTuningJobStrategyConfig withHyperbandStrategyConfig(HyperbandStrategyConfig hyperbandStrategyConfig) {
        setHyperbandStrategyConfig(hyperbandStrategyConfig);
        return this;
    }

    /**
     * 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.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getHyperbandStrategyConfig() != null)
            sb.append("HyperbandStrategyConfig: ").append(getHyperbandStrategyConfig());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof HyperParameterTuningJobStrategyConfig == false)
            return false;
        HyperParameterTuningJobStrategyConfig other = (HyperParameterTuningJobStrategyConfig) obj;
        if (other.getHyperbandStrategyConfig() == null ^ this.getHyperbandStrategyConfig() == null)
            return false;
        if (other.getHyperbandStrategyConfig() != null && other.getHyperbandStrategyConfig().equals(this.getHyperbandStrategyConfig()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getHyperbandStrategyConfig() == null) ? 0 : getHyperbandStrategyConfig().hashCode());
        return hashCode;
    }

    @Override
    public HyperParameterTuningJobStrategyConfig clone() {
        try {
            return (HyperParameterTuningJobStrategyConfig) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.sagemaker.model.transform.HyperParameterTuningJobStrategyConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}