Package software.amazon.awssdk.services.rds.model

Class Metric

java.lang.Object

software.amazon.awssdk.services.rds.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>

The representation of a metric.

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
static Metric.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReferences()	For responses, this returns true if the service returned a value for the References property.
MetricQuery	metricQuery()	The query to retrieve metric data points.
String	name()	The name of a metric.
List<MetricReference>	references()	A list of metric references (thresholds).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Metric.Builder>	serializableBuilderClass()
String	statisticsDetails()	The details of different statistics for a metric.
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

name

public final String name()

The name of a metric.

Returns:

The name of a metric.

hasReferences

public final boolean hasReferences()

For responses, this returns true if the service returned a value for the References 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.

references

public final List<MetricReference> references()

A list of metric references (thresholds).

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 hasReferences() method.

Returns:

A list of metric references (thresholds).

statisticsDetails

public final String statisticsDetails()

The details of different statistics for a metric. The description might contain markdown.

Returns:

The details of different statistics for a metric. The description might contain markdown.

metricQuery

public final MetricQuery metricQuery()

The query to retrieve metric data points.

Returns:

The query to retrieve metric data points.

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo