Class FinalAutoMLJobObjectiveMetric

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.FinalAutoMLJobObjectiveMetric

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FinalAutoMLJobObjectiveMetric.Builder,FinalAutoMLJobObjectiveMetric>

@Generated("software.amazon.awssdk:codegen")
public final class FinalAutoMLJobObjectiveMetric
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FinalAutoMLJobObjectiveMetric.Builder,FinalAutoMLJobObjectiveMetric>

The best candidate result from an AutoML training job.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FinalAutoMLJobObjectiveMetric.Builder

Method Summary

Modifier and Type	Method	Description
static FinalAutoMLJobObjectiveMetric.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final AutoMLMetricEnum	metricName()	The name of the metric with the best result.
final String	metricNameAsString()	The name of the metric with the best result.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends FinalAutoMLJobObjectiveMetric.Builder>	serializableBuilderClass()
final AutoMLMetricEnum	standardMetricName()	The name of the standard metric.
final String	standardMetricNameAsString()	The name of the standard metric.
FinalAutoMLJobObjectiveMetric.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final AutoMLJobObjectiveType	type()	The type of metric with the best result.
final String	typeAsString()	The type of metric with the best result.
final Float	value()	The value of the metric with the best result.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

type

public final AutoMLJobObjectiveType 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, type will return AutoMLJobObjectiveType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of metric with the best result.

See Also:

• AutoMLJobObjectiveType

typeAsString

public final String typeAsString()

The type of metric with the best result.

If the service returns an enum value that is not available in the current SDK version, type will return AutoMLJobObjectiveType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of metric with the best result.

See Also:

• AutoMLJobObjectiveType

metricName

public final AutoMLMetricEnum 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, metricName will return AutoMLMetricEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

See Also:

• AutoMLMetricEnum

metricNameAsString

public final String metricNameAsString()

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, metricName will return AutoMLMetricEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

See Also:

• AutoMLMetricEnum

value

public final Float value()

The value of the metric with the best result.

Returns:

The value of the metric with the best result.

standardMetricName

public final AutoMLMetricEnum 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, standardMetricName will return AutoMLMetricEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from standardMetricNameAsString().

Returns:

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

See Also:

• AutoMLMetricEnum

standardMetricNameAsString

public final String standardMetricNameAsString()

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, standardMetricName will return AutoMLMetricEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from standardMetricNameAsString().

Returns:

The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.

See Also:

• AutoMLMetricEnum

toBuilder

public FinalAutoMLJobObjectiveMetric.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FinalAutoMLJobObjectiveMetric.Builder,FinalAutoMLJobObjectiveMetric>

Returns:

a builder for type T

builder

public static FinalAutoMLJobObjectiveMetric.Builder builder()

serializableBuilderClass

public static Class<? extends FinalAutoMLJobObjectiveMetric.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.