Class MetricSpecification

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.MetricSpecification

All Implemented Interfaces:

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

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

An object containing information about a metric.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricSpecification.Builder
static enum	MetricSpecification.Type

Method Summary

Modifier and Type	Method	Description
static MetricSpecification.Builder	builder()
final CustomizedMetricSpecification	customized()	Information about a customized metric.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
static MetricSpecification	fromCustomized(Consumer<CustomizedMetricSpecification.Builder> customized)	Create an instance of this class with customized() initialized to the given value.
static MetricSpecification	fromCustomized(CustomizedMetricSpecification customized)	Create an instance of this class with customized() initialized to the given value.
static MetricSpecification	fromPredefined(Consumer<PredefinedMetricSpecification.Builder> predefined)	Create an instance of this class with predefined() initialized to the given value.
static MetricSpecification	fromPredefined(PredefinedMetricSpecification predefined)	Create an instance of this class with predefined() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final PredefinedMetricSpecification	predefined()	Information about a predefined metric.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends MetricSpecification.Builder>	serializableBuilderClass()
MetricSpecification.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.
MetricSpecification.Type	type()	Retrieve an enum value representing which member of this object is populated.

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

predefined

public final PredefinedMetricSpecification predefined()

Information about a predefined metric.

Returns:

Information about a predefined metric.

customized

public final CustomizedMetricSpecification customized()

Information about a customized metric.

Returns:

Information about a customized metric.

toBuilder

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

Returns:

a builder for type T

builder

public static MetricSpecification.Builder builder()

serializableBuilderClass

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

fromPredefined

public static MetricSpecification fromPredefined(PredefinedMetricSpecification predefined)

Create an instance of this class with predefined() initialized to the given value.

Information about a predefined metric.

Parameters:

predefined - Information about a predefined metric.

fromPredefined

public static MetricSpecification fromPredefined(Consumer<PredefinedMetricSpecification.Builder> predefined)

Create an instance of this class with predefined() initialized to the given value.

Information about a predefined metric.

Parameters:

predefined - Information about a predefined metric.

fromCustomized

public static MetricSpecification fromCustomized(CustomizedMetricSpecification customized)

Create an instance of this class with customized() initialized to the given value.

Information about a customized metric.

Parameters:

customized - Information about a customized metric.

fromCustomized

public static MetricSpecification fromCustomized(Consumer<CustomizedMetricSpecification.Builder> customized)

Create an instance of this class with customized() initialized to the given value.

Information about a customized metric.

Parameters:

customized - Information about a customized metric.

type

public MetricSpecification.Type type()

Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be MetricSpecification.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be MetricSpecification.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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.