Interface PerformanceInsightsMetricQuery.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PerformanceInsightsMetricQuery.Builder,
,PerformanceInsightsMetricQuery> SdkBuilder<PerformanceInsightsMetricQuery.Builder,
,PerformanceInsightsMetricQuery> SdkPojo
- Enclosing class:
PerformanceInsightsMetricQuery
-
Method Summary
Modifier and TypeMethodDescriptionA specification for how to aggregate the data points from a query result.A specification for how to aggregate the data points from a query result.The name of a Performance Insights metric to be measured.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
groupBy
default PerformanceInsightsMetricQuery.Builder groupBy(Consumer<PerformanceInsightsMetricDimensionGroup.Builder> 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.
This is a convenience method that creates an instance of thePerformanceInsightsMetricDimensionGroup.Builder
avoiding the need to create one manually viaPerformanceInsightsMetricDimensionGroup.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed togroupBy(PerformanceInsightsMetricDimensionGroup)
.- Parameters:
groupBy
- a consumer that will call methods onPerformanceInsightsMetricDimensionGroup.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metric
The name of a Performance Insights metric to be measured.
Valid Values:
-
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.- Parameters:
metric
- The name of a Performance Insights metric to be measured.Valid Values:
-
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:
- Returns a reference to this object so that method calls can be chained together.
-
-