Interface PerformanceInsightsMetricQuery.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PerformanceInsightsMetricQuery.Builder,
,PerformanceInsightsMetricQuery> SdkBuilder<PerformanceInsightsMetricQuery.Builder,
,PerformanceInsightsMetricQuery> SdkPojo
- Enclosing class:
PerformanceInsightsMetricQuery
-
Method Summary
Modifier and TypeMethodDescriptionOne or more filters to apply to a Performance InsightsGetResourceMetrics
API query.The specification for how to aggregate the data points from a Performance InsightsGetResourceMetrics
API query.The specification for how to aggregate the data points from a Performance InsightsGetResourceMetrics
API query.The name of the meteric used used when querying an Performance InsightsGetResourceMetrics
API for anomaly metrics.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
-
metric
The name of the meteric used used when querying an Performance Insights
GetResourceMetrics
API for anomaly metrics.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
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 the meteric used used when querying an Performance InsightsGetResourceMetrics
API for anomaly metrics.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
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.
-
-
groupBy
The specification for how to aggregate the data points from a Performance Insights
GetResourceMetrics
API query. The Performance Insights query returns 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
- The specification for how to aggregate the data points from a Performance InsightsGetResourceMetrics
API query. The Performance Insights query returns 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) The specification for how to aggregate the data points from a Performance Insights
This is a convenience method that creates an instance of theGetResourceMetrics
API query. The Performance Insights query returns 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.PerformanceInsightsMetricDimensionGroup.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:
-
filter
One or more filters to apply to a Performance Insights
GetResourceMetrics
API query. 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.
- Parameters:
filter
- One or more filters to apply to a Performance InsightsGetResourceMetrics
API query. 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-