software.amazon.awssdk.services.pi.model

Class MetricQuery

java.lang.Object

software.amazon.awssdk.services.pi.model.MetricQuery

All Implemented Interfaces:

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

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

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricQuery.Builder

Method Summary

Modifier and Type	Method and Description
static MetricQuery.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,String>	filter() One or more filters to apply in the request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
DimensionGroup	groupBy() A specification for how to aggregate the data points from a query result.
boolean	hasFilter() Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	metric() The name of a Performance Insights metric to be measured.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricQuery.Builder>	serializableBuilderClass()
MetricQuery.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.

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.

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.

groupBy

public final DimensionGroup groupBy()

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Returns:

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

hasFilter

public final boolean hasFilter()

Returns true if the Filter property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filter

public final Map<String,String> filter()

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy parameter.

• A single filter for any other dimension in this dimension group.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilter() to see if a value was sent in this field.

Returns:

One or more filters to apply in the request. Restrictions:

• Any number of filters by the same dimension, as specified in the GroupBy parameter.

• A single filter for any other dimension in this dimension group.

toBuilder

public MetricQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricQuery.Builder,MetricQuery>

builder

public static MetricQuery.Builder builder()

serializableBuilderClass

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