com.amazonaws.services.personalize.model.HPOObjective Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-personalize Show documentation
The AWS Java SDK for Amazon Personalize module holds the client classes that are used for communicating with Amazon Personalize Service
The newest version!
/*
 * Copyright 2019-2024 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.personalize.model;

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

/**
 * 
 * The metric to optimize during hyperparameter optimization (HPO).
 * 
 * 
 * 
 * Amazon Personalize doesn't support configuring the hpoObjective at this time.
 * 
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HPOObjective implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The type of the metric. Valid values are Maximize and Minimize.
     * 
     */
    private String type;
    /**
     * 
     * The name of the metric.
     * 
     */
    private String metricName;
    /**
     * 
     * A regular expression for finding the metric in the training job logs.
     * 
     */
    private String metricRegex;

    /**
     * 
     * The type of the metric. Valid values are Maximize and Minimize.
     * 
     * 
     * @param type
     *        The type of the metric. Valid values are Maximize and Minimize.
     */

    public void setType(String type) {
        this.type = type;
    }

    /**
     * 
     * The type of the metric. Valid values are Maximize and Minimize.
     * 
     * 
     * @return The type of the metric. Valid values are Maximize and Minimize.
     */

    public String getType() {
        return this.type;
    }

    /**
     * 
     * The type of the metric. Valid values are Maximize and Minimize.
     * 
     * 
     * @param type
     *        The type of the metric. Valid values are Maximize and Minimize.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public HPOObjective withType(String type) {
        setType(type);
        return this;
    }

    /**
     * 
     * The name of the metric.
     * 
     * 
     * @param metricName
     *        The name of the metric.
     */

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

    /**
     * 
     * The name of the metric.
     * 
     * 
     * @return The name of the metric.
     */

    public String getMetricName() {
        return this.metricName;
    }

    /**
     * 
     * The name of the metric.
     * 
     * 
     * @param metricName
     *        The name of the metric.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public HPOObjective withMetricName(String metricName) {
        setMetricName(metricName);
        return this;
    }

    /**
     * 
     * A regular expression for finding the metric in the training job logs.
     * 
     * 
     * @param metricRegex
     *        A regular expression for finding the metric in the training job logs.
     */

    public void setMetricRegex(String metricRegex) {
        this.metricRegex = metricRegex;
    }

    /**
     * 
     * A regular expression for finding the metric in the training job logs.
     * 
     * 
     * @return A regular expression for finding the metric in the training job logs.
     */

    public String getMetricRegex() {
        return this.metricRegex;
    }

    /**
     * 
     * A regular expression for finding the metric in the training job logs.
     * 
     * 
     * @param metricRegex
     *        A regular expression for finding the metric in the training job logs.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public HPOObjective withMetricRegex(String metricRegex) {
        setMetricRegex(metricRegex);
        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 (getType() != null)
            sb.append("Type: ").append(getType()).append(",");
        if (getMetricName() != null)
            sb.append("MetricName: ").append(getMetricName()).append(",");
        if (getMetricRegex() != null)
            sb.append("MetricRegex: ").append(getMetricRegex());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof HPOObjective == false)
            return false;
        HPOObjective other = (HPOObjective) obj;
        if (other.getType() == null ^ this.getType() == null)
            return false;
        if (other.getType() != null && other.getType().equals(this.getType()) == false)
            return false;
        if (other.getMetricName() == null ^ this.getMetricName() == null)
            return false;
        if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false)
            return false;
        if (other.getMetricRegex() == null ^ this.getMetricRegex() == null)
            return false;
        if (other.getMetricRegex() != null && other.getMetricRegex().equals(this.getMetricRegex()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
        hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
        hashCode = prime * hashCode + ((getMetricRegex() == null) ? 0 : getMetricRegex().hashCode());
        return hashCode;
    }

    @Override
    public HPOObjective clone() {
        try {
            return (HPOObjective) 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.personalize.model.transform.HPOObjectiveMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}