software.amazon.awssdk.services.autoscaling.model

Class MetricStat

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.MetricStat

All Implemented Interfaces:

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

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

This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.

For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricStat.Builder

Method Summary

Modifier and Type	Method and Description
static MetricStat.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Metric	metric() The CloudWatch metric to return, including the metric name, namespace, and dimensions.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricStat.Builder>	serializableBuilderClass()
String	stat() The statistic to return.
MetricStat.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	unit() The unit to use for the returned data points.

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

metric

public final Metric metric()

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

Returns:

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

stat

public final String stat()

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metrics for predictive scaling are Average and Sum.

Returns:

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metrics for predictive scaling are Average and Sum.

unit

public final String unit()

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Returns:

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

toBuilder

public MetricStat.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricStat.Builder,MetricStat>

builder

public static MetricStat.Builder builder()

serializableBuilderClass

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