Class MetricQuery
- All Implemented Interfaces:
Serializable
,SdkPojo
,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 data points for the specified metric. Optionally, you can request that the data
points be aggregated by dimension group (GroupBy
), and return only those data points that match your
criteria (Filter
).
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetricQuery.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filter()
One or more filters to apply in the request.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final DimensionGroup
groupBy()
A specification for how to aggregate the data points from a query result.final boolean
For responses, this returns true if the service returned a value for the Filter property.final int
hashCode()
final String
metric()
The name of a Performance Insights metric to be measured.static Class
<? extends MetricQuery.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.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
anddb.sampledload.avg
are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avg
showing the scaled values,db.sampledload.avg
showing the raw values, anddb.sampledload.avg
less thandb.load.avg
. For most use cases, you can querydb.load.avg
only. -
-
-
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()For responses, this returns true if the service returned a value for the Filter property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.
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
hasFilter()
method.- 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
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 interfaceToCopyableBuilder<MetricQuery.Builder,
MetricQuery> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-