Package software.amazon.awssdk.services.sagemaker.model

Class MetricDatum

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.MetricDatum

All Implemented Interfaces:

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

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

Information about the metric for a candidate produced by an AutoML job.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricDatum.Builder

Method Summary

Modifier and Type	Method	Description
static MetricDatum.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.
final String	metricNameAsString()	The name of the metric.
final List<SdkField<?>>	sdkFields()
static Class<? extends MetricDatum.Builder>	serializableBuilderClass()
final MetricSetSource	set()	The dataset split from which the AutoML job produced the metric.
final String	setAsString()	The dataset split from which the AutoML job produced the metric.
final AutoMLMetricExtendedEnum	standardMetricName()	The name of the standard metric.
final String	standardMetricNameAsString()	The name of the standard metric.
MetricDatum.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 Float	value()	The value of the metric.

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

metricName

public final AutoMLMetricEnum metricName()

The name of the metric.

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.

See Also:

• AutoMLMetricEnum

metricNameAsString

public final String metricNameAsString()

The name of the metric.

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.

See Also:

• AutoMLMetricEnum

value

public final Float value()

The value of the metric.

Returns:

The value of the metric.

set

public final MetricSetSource set()

The dataset split from which the AutoML job produced the metric.

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

Returns:

The dataset split from which the AutoML job produced the metric.

See Also:

• MetricSetSource

setAsString

public final String setAsString()

The dataset split from which the AutoML job produced the metric.

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

Returns:

The dataset split from which the AutoML job produced the metric.

See Also:

• MetricSetSource

standardMetricName

public final AutoMLMetricExtendedEnum standardMetricName()

The name of the standard metric.

For definitions 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 AutoMLMetricExtendedEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from standardMetricNameAsString().

Returns:

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

See Also:

• AutoMLMetricExtendedEnum

standardMetricNameAsString

public final String standardMetricNameAsString()

The name of the standard metric.

For definitions 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 AutoMLMetricExtendedEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from standardMetricNameAsString().

Returns:

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

See Also:

• AutoMLMetricExtendedEnum

toBuilder

public MetricDatum.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<MetricDatum.Builder,MetricDatum>

Returns:

a builder for type T

builder

public static MetricDatum.Builder builder()

serializableBuilderClass

public static Class<? extends MetricDatum.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.