software.amazon.awssdk.services.personalize.model.HPOObjective Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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;
/**
*
* The metric to optimize during hyperparameter optimization (HPO).
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HPOObjective implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(HPOObjective::type)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(HPOObjective::metricName)).setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricName").build()).build();
private static final SdkField METRIC_REGEX_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(HPOObjective::metricRegex)).setter(setter(Builder::metricRegex))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricRegex").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, METRIC_NAME_FIELD,
METRIC_REGEX_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final String metricName;
private final String metricRegex;
private HPOObjective(BuilderImpl builder) {
this.type = builder.type;
this.metricName = builder.metricName;
this.metricRegex = builder.metricRegex;
}
/**
*
* The data type of the metric.
*
*
* @return The data type of the metric.
*/
public String type() {
return type;
}
/**
*
* The name of the metric.
*
*
* @return The name of the metric.
*/
public String metricName() {
return metricName;
}
/**
*
* 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 metricRegex() {
return metricRegex;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(type());
hashCode = 31 * hashCode + Objects.hashCode(metricName());
hashCode = 31 * hashCode + Objects.hashCode(metricRegex());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof HPOObjective)) {
return false;
}
HPOObjective other = (HPOObjective) obj;
return Objects.equals(type(), other.type()) && Objects.equals(metricName(), other.metricName())
&& Objects.equals(metricRegex(), other.metricRegex());
}
/**
* 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 String toString() {
return ToString.builder("HPOObjective").add("Type", type()).add("MetricName", metricName())
.add("MetricRegex", metricRegex()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "type":
return Optional.ofNullable(clazz.cast(type()));
case "metricName":
return Optional.ofNullable(clazz.cast(metricName()));
case "metricRegex":
return Optional.ofNullable(clazz.cast(metricRegex()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HPOObjective) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The data type of the metric.
*
*
* @param type
* The data type of the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder type(String type);
/**
*
* 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.
*/
Builder metricName(String metricName);
/**
*
* 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.
*/
Builder metricRegex(String metricRegex);
}
static final class BuilderImpl implements Builder {
private String type;
private String metricName;
private String metricRegex;
private BuilderImpl() {
}
private BuilderImpl(HPOObjective model) {
type(model.type);
metricName(model.metricName);
metricRegex(model.metricRegex);
}
public final String getType() {
return type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
public final void setType(String type) {
this.type = type;
}
public final String getMetricName() {
return metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
public final String getMetricRegex() {
return metricRegex;
}
@Override
public final Builder metricRegex(String metricRegex) {
this.metricRegex = metricRegex;
return this;
}
public final void setMetricRegex(String metricRegex) {
this.metricRegex = metricRegex;
}
@Override
public HPOObjective build() {
return new HPOObjective(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy