software.amazon.awssdk.services.pi.model

Class ResponseResourceMetricKey

java.lang.Object

software.amazon.awssdk.services.pi.model.ResponseResourceMetricKey

All Implemented Interfaces:

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

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

An object describing a Performance Insights metric and one or more dimensions for that metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResponseResourceMetricKey.Builder

Method Summary

Modifier and Type	Method and Description
static ResponseResourceMetricKey.Builder	builder()
Map<String,String>	dimensions() The valid dimensions for the metric.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDimensions() For responses, this returns true if the service returned a value for the Dimensions property.
int	hashCode()
String	metric() The name of a Performance Insights metric to be measured.
List<SdkField<?>>	sdkFields()
static Class<? extends ResponseResourceMetricKey.Builder>	serializableBuilderClass()
ResponseResourceMetricKey.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

metric

public final String metric()

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

Returns:

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

• db.load.avg - A scaled representation of the number of active sessions for the database engine.

• db.sampledload.avg - The raw number of active sessions for the database engine.

• The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

hasDimensions

public final boolean hasDimensions()

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

dimensions

public final Map<String,String> dimensions()

The valid dimensions for the 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 hasDimensions() method.

Returns:

The valid dimensions for the metric.

toBuilder

public ResponseResourceMetricKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResponseResourceMetricKey.Builder,ResponseResourceMetricKey>

builder

public static ResponseResourceMetricKey.Builder builder()

serializableBuilderClass

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