software.amazon.awssdk.services.devopsguru.model

Class PerformanceInsightsMetricsDetail

java.lang.Object

software.amazon.awssdk.services.devopsguru.model.PerformanceInsightsMetricsDetail

All Implemented Interfaces:

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

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

Details about Performance Insights metrics.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

• To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.

• To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PerformanceInsightsMetricsDetail.Builder

Method Summary

Modifier and Type	Method and Description
static PerformanceInsightsMetricsDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReferenceData() For responses, this returns true if the service returned a value for the ReferenceData property.
boolean	hasStatsAtAnomaly() For responses, this returns true if the service returned a value for the StatsAtAnomaly property.
boolean	hasStatsAtBaseline() For responses, this returns true if the service returned a value for the StatsAtBaseline property.
String	metricDisplayName() The name used for a specific Performance Insights metric.
PerformanceInsightsMetricQuery	metricQuery() A single query to be processed for the metric.
List<PerformanceInsightsReferenceData>	referenceData() For more information, see PerformanceInsightsReferenceData .
List<SdkField<?>>	sdkFields()
static Class<? extends PerformanceInsightsMetricsDetail.Builder>	serializableBuilderClass()
List<PerformanceInsightsStat>	statsAtAnomaly() The metric statistics during the anomalous period detected by DevOps Guru;
List<PerformanceInsightsStat>	statsAtBaseline() Typical metric statistics that are not considered anomalous.
PerformanceInsightsMetricsDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	unit() The unit of measure for a 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

metricDisplayName

public final String metricDisplayName()

The name used for a specific Performance Insights metric.

Returns:

The name used for a specific Performance Insights metric.

unit

public final String unit()

The unit of measure for a metric. For example, a session or a process.

Returns:

The unit of measure for a metric. For example, a session or a process.

metricQuery

public final PerformanceInsightsMetricQuery metricQuery()

A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

Returns:

A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

hasReferenceData

public final boolean hasReferenceData()

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

referenceData

public final List<PerformanceInsightsReferenceData> referenceData()

For more information, see PerformanceInsightsReferenceData .

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

Returns:

For more information, see PerformanceInsightsReferenceData .

hasStatsAtAnomaly

public final boolean hasStatsAtAnomaly()

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

statsAtAnomaly

public final List<PerformanceInsightsStat> statsAtAnomaly()

The metric statistics during the anomalous period detected by DevOps Guru;

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

Returns:

The metric statistics during the anomalous period detected by DevOps Guru;

hasStatsAtBaseline

public final boolean hasStatsAtBaseline()

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

statsAtBaseline

public final List<PerformanceInsightsStat> statsAtBaseline()

Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

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

Returns:

Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

toBuilder

public PerformanceInsightsMetricsDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PerformanceInsightsMetricsDetail.Builder,PerformanceInsightsMetricsDetail>

builder

public static PerformanceInsightsMetricsDetail.Builder builder()

serializableBuilderClass

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