software.amazon.awssdk.services.sagemaker.model.FinalAutoMLJobObjectiveMetric Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* 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.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 best candidate result from an AutoML training job.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FinalAutoMLJobObjectiveMetric implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(FinalAutoMLJobObjectiveMetric::typeAsString)).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)
.memberName("MetricName").getter(getter(FinalAutoMLJobObjectiveMetric::metricNameAsString))
.setter(setter(Builder::metricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MetricName").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.FLOAT).memberName("Value")
.getter(getter(FinalAutoMLJobObjectiveMetric::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final SdkField STANDARD_METRIC_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StandardMetricName").getter(getter(FinalAutoMLJobObjectiveMetric::standardMetricNameAsString))
.setter(setter(Builder::standardMetricName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StandardMetricName").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, METRIC_NAME_FIELD,
VALUE_FIELD, STANDARD_METRIC_NAME_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final String metricName;
private final Float value;
private final String standardMetricName;
private FinalAutoMLJobObjectiveMetric(BuilderImpl builder) {
this.type = builder.type;
this.metricName = builder.metricName;
this.value = builder.value;
this.standardMetricName = builder.standardMetricName;
}
/**
*
* The type of metric with the best result.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link AutoMLJobObjectiveType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of metric with the best result.
* @see AutoMLJobObjectiveType
*/
public final AutoMLJobObjectiveType type() {
return AutoMLJobObjectiveType.fromValue(type);
}
/**
*
* The type of metric with the best result.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link AutoMLJobObjectiveType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of metric with the best result.
* @see AutoMLJobObjectiveType
*/
public final String typeAsString() {
return type;
}
/**
*
* The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricName} will
* return {@link AutoMLMetricEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricNameAsString}.
*
*
* @return The name of the metric with the best result. For a description of the possible objective metrics, see
* AutoMLJobObjective$MetricName.
* @see AutoMLMetricEnum
*/
public final AutoMLMetricEnum metricName() {
return AutoMLMetricEnum.fromValue(metricName);
}
/**
*
* The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricName} will
* return {@link AutoMLMetricEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricNameAsString}.
*
*
* @return The name of the metric with the best result. For a description of the possible objective metrics, see
* AutoMLJobObjective$MetricName.
* @see AutoMLMetricEnum
*/
public final String metricNameAsString() {
return metricName;
}
/**
*
* The value of the metric with the best result.
*
*
* @return The value of the metric with the best result.
*/
public final Float value() {
return value;
}
/**
*
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #standardMetricName} will return {@link AutoMLMetricEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #standardMetricNameAsString}.
*
*
* @return The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
* @see AutoMLMetricEnum
*/
public final AutoMLMetricEnum standardMetricName() {
return AutoMLMetricEnum.fromValue(standardMetricName);
}
/**
*
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #standardMetricName} will return {@link AutoMLMetricEnum#UNKNOWN_TO_SDK_VERSION}. The raw value returned
* by the service is available from {@link #standardMetricNameAsString}.
*
*
* @return The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
* @see AutoMLMetricEnum
*/
public final String standardMetricNameAsString() {
return standardMetricName;
}
@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(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(metricNameAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
hashCode = 31 * hashCode + Objects.hashCode(standardMetricNameAsString());
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 FinalAutoMLJobObjectiveMetric)) {
return false;
}
FinalAutoMLJobObjectiveMetric other = (FinalAutoMLJobObjectiveMetric) obj;
return Objects.equals(typeAsString(), other.typeAsString())
&& Objects.equals(metricNameAsString(), other.metricNameAsString()) && Objects.equals(value(), other.value())
&& Objects.equals(standardMetricNameAsString(), other.standardMetricNameAsString());
}
/**
* 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("FinalAutoMLJobObjectiveMetric").add("Type", typeAsString())
.add("MetricName", metricNameAsString()).add("Value", value())
.add("StandardMetricName", standardMetricNameAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "MetricName":
return Optional.ofNullable(clazz.cast(metricNameAsString()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
case "StandardMetricName":
return Optional.ofNullable(clazz.cast(standardMetricNameAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FinalAutoMLJobObjectiveMetric) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The type of metric with the best result.
*
*
* @param type
* The type of metric with the best result.
* @see AutoMLJobObjectiveType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLJobObjectiveType
*/
Builder type(String type);
/**
*
* The type of metric with the best result.
*
*
* @param type
* The type of metric with the best result.
* @see AutoMLJobObjectiveType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLJobObjectiveType
*/
Builder type(AutoMLJobObjectiveType type);
/**
*
* The name of the metric with the best result. For a description of the possible objective metrics, see
* AutoMLJobObjective$MetricName.
*
*
* @param metricName
* The name of the metric with the best result. For a description of the possible objective metrics, see
*
* AutoMLJobObjective$MetricName.
* @see AutoMLMetricEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLMetricEnum
*/
Builder metricName(String metricName);
/**
*
* The name of the metric with the best result. For a description of the possible objective metrics, see
* AutoMLJobObjective$MetricName.
*
*
* @param metricName
* The name of the metric with the best result. For a description of the possible objective metrics, see
*
* AutoMLJobObjective$MetricName.
* @see AutoMLMetricEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLMetricEnum
*/
Builder metricName(AutoMLMetricEnum metricName);
/**
*
* The value of the metric with the best result.
*
*
* @param value
* The value of the metric with the best result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(Float value);
/**
*
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
*
*
* @param standardMetricName
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
* @see AutoMLMetricEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLMetricEnum
*/
Builder standardMetricName(String standardMetricName);
/**
*
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
*
*
* @param standardMetricName
* The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
* @see AutoMLMetricEnum
* @return Returns a reference to this object so that method calls can be chained together.
* @see AutoMLMetricEnum
*/
Builder standardMetricName(AutoMLMetricEnum standardMetricName);
}
static final class BuilderImpl implements Builder {
private String type;
private String metricName;
private Float value;
private String standardMetricName;
private BuilderImpl() {
}
private BuilderImpl(FinalAutoMLJobObjectiveMetric model) {
type(model.type);
metricName(model.metricName);
value(model.value);
standardMetricName(model.standardMetricName);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(AutoMLJobObjectiveType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final String getMetricName() {
return metricName;
}
public final void setMetricName(String metricName) {
this.metricName = metricName;
}
@Override
public final Builder metricName(String metricName) {
this.metricName = metricName;
return this;
}
@Override
public final Builder metricName(AutoMLMetricEnum metricName) {
this.metricName(metricName == null ? null : metricName.toString());
return this;
}
public final Float getValue() {
return value;
}
public final void setValue(Float value) {
this.value = value;
}
@Override
public final Builder value(Float value) {
this.value = value;
return this;
}
public final String getStandardMetricName() {
return standardMetricName;
}
public final void setStandardMetricName(String standardMetricName) {
this.standardMetricName = standardMetricName;
}
@Override
public final Builder standardMetricName(String standardMetricName) {
this.standardMetricName = standardMetricName;
return this;
}
@Override
public final Builder standardMetricName(AutoMLMetricEnum standardMetricName) {
this.standardMetricName(standardMetricName == null ? null : standardMetricName.toString());
return this;
}
@Override
public FinalAutoMLJobObjectiveMetric build() {
return new FinalAutoMLJobObjectiveMetric(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}