Package software.amazon.awssdk.services.sagemakermetrics.model

Class BatchPutMetricsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemakermetrics.model.SageMakerMetricsRequest

software.amazon.awssdk.services.sagemakermetrics.model.BatchPutMetricsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchPutMetricsRequest.Builder,BatchPutMetricsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchPutMetricsRequest
extends SageMakerMetricsRequest
implements ToCopyableBuilder<BatchPutMetricsRequest.Builder,BatchPutMetricsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchPutMetricsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchPutMetricsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricData()	For responses, this returns true if the service returned a value for the MetricData property.
List<RawMetricData>	metricData()	A list of raw metric values to put.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchPutMetricsRequest.Builder>	serializableBuilderClass()
BatchPutMetricsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trialComponentName()	The name of the Trial Component to associate with the metrics.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

trialComponentName

public final String trialComponentName()

The name of the Trial Component to associate with the metrics.

Returns:

The name of the Trial Component to associate with the metrics.

hasMetricData

public final boolean hasMetricData()

For responses, this returns true if the service returned a value for the MetricData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricData

public final List<RawMetricData> metricData()

A list of raw metric values to put.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricData() method.

Returns:

A list of raw metric values to put.

toBuilder

public BatchPutMetricsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchPutMetricsRequest.Builder,BatchPutMetricsRequest>

Specified by:

toBuilder in class SageMakerMetricsRequest

builder

public static BatchPutMetricsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo