software.amazon.awssdk.services.servicequotas.model

Class MetricInfo

java.lang.Object

software.amazon.awssdk.services.servicequotas.model.MetricInfo

All Implemented Interfaces:

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

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

Information about the CloudWatch metric that reflects quota usage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricInfo.Builder

Method Summary

Modifier and Type	Method and Description
static MetricInfo.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricDimensions() For responses, this returns true if the service returned a value for the MetricDimensions property.
Map<String,String>	metricDimensions() The metric dimension.
String	metricName() The name of the metric.
String	metricNamespace() The namespace of the metric.
String	metricStatisticRecommendation() The metric statistic that we recommend you use when determining quota usage.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricInfo.Builder>	serializableBuilderClass()
MetricInfo.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

metricNamespace

public final String metricNamespace()

The namespace of the metric.

Returns:

The namespace of the metric.

metricName

public final String metricName()

The name of the metric.

Returns:

The name of the metric.

hasMetricDimensions

public final boolean hasMetricDimensions()

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

metricDimensions

public final Map<String,String> metricDimensions()

The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

Returns:

The metric dimension. This is a name/value pair that is part of the identity of a metric.

metricStatisticRecommendation

public final String metricStatisticRecommendation()

The metric statistic that we recommend you use when determining quota usage.

Returns:

The metric statistic that we recommend you use when determining quota usage.

toBuilder

public MetricInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricInfo.Builder,MetricInfo>

builder

public static MetricInfo.Builder builder()

serializableBuilderClass

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