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)
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.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

metric

public 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.

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.

groupBy

public 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.

filter

public 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.

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MetricQuery.Builder,MetricQuery>

Returns:

a builder for type T

builder

public static MetricQuery.Builder builder()

serializableBuilderClass

public static Class<? extends MetricQuery.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.