Package software.amazon.awssdk.services.lookoutmetrics.model

Class Metric

java.lang.Object

software.amazon.awssdk.services.lookoutmetrics.model.Metric

All Implemented Interfaces:

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

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

A calculation made by contrasting a measure and a dimension from your source data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Metric.Builder

Method Summary

Modifier and Type	Method	Description
AggregationFunction	aggregationFunction()	The function with which the metric is calculated.
String	aggregationFunctionAsString()	The function with which the metric is calculated.
static Metric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	metricName()	The name of the metric.
String	namespace()	The namespace for the metric.
List<SdkField<?>>	sdkFields()
static Class<? extends Metric.Builder>	serializableBuilderClass()
Metric.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

metricName

public final String metricName()

The name of the metric.

Returns:

The name of the metric.

aggregationFunction

public final AggregationFunction aggregationFunction()

The function with which the metric is calculated.

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

Returns:

The function with which the metric is calculated.

See Also:

AggregationFunction

aggregationFunctionAsString

public final String aggregationFunctionAsString()

The function with which the metric is calculated.

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

Returns:

The function with which the metric is calculated.

See Also:

AggregationFunction

namespace

public final String namespace()

The namespace for the metric.

Returns:

The namespace for the metric.

toBuilder

public Metric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Metric.Builder,Metric>

builder

public static Metric.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo