software.amazon.awssdk.services.pi.model

Class PerformanceInsightsMetric

java.lang.Object

software.amazon.awssdk.services.pi.model.PerformanceInsightsMetric

All Implemented Interfaces:

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

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

This data type helps to determine Performance Insights metric to render for the insight.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PerformanceInsightsMetric.Builder

Method Summary

Modifier and Type	Method and Description
static PerformanceInsightsMetric.Builder	builder()
Map<String,String>	dimensions() A dimension map that contains the dimensions for this partition.
String	displayName() The Performance Insights metric name.
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 Performance Insights metric.
List<SdkField<?>>	sdkFields()
static Class<? extends PerformanceInsightsMetric.Builder>	serializableBuilderClass()
PerformanceInsightsMetric.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Double	value() The value of the metric.

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 Performance Insights metric.

Returns:

The Performance Insights metric.

displayName

public final String displayName()

The Performance Insights metric name.

Returns:

The Performance Insights metric name.

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()

A dimension map that contains the dimensions for this partition.

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:

A dimension map that contains the dimensions for this partition.

value

public final Double value()

The value of the metric. For example, 9 for db.load.avg.

Returns:

The value of the metric. For example, 9 for db.load.avg.

toBuilder

public PerformanceInsightsMetric.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PerformanceInsightsMetric.Builder,PerformanceInsightsMetric>

builder

public static PerformanceInsightsMetric.Builder builder()

serializableBuilderClass

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