Interface PerformanceInsightsMetricQuery.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>,SdkBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>,SdkPojo
- Enclosing class:
- PerformanceInsightsMetricQuery
public static interface PerformanceInsightsMetricQuery.Builder extends SdkPojo, CopyableBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PerformanceInsightsMetricQuery.Builderfilter(Map<String,String> filter)One or more filters to apply to a Performance InsightsGetResourceMetricsAPI query.default PerformanceInsightsMetricQuery.BuildergroupBy(Consumer<PerformanceInsightsMetricDimensionGroup.Builder> groupBy)The specification for how to aggregate the data points from a Performance InsightsGetResourceMetricsAPI query.PerformanceInsightsMetricQuery.BuildergroupBy(PerformanceInsightsMetricDimensionGroup groupBy)The specification for how to aggregate the data points from a Performance InsightsGetResourceMetricsAPI query.PerformanceInsightsMetricQuery.Buildermetric(String metric)The name of the meteric used used when querying an Performance InsightsGetResourceMetricsAPI 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 Detail
-
metric
PerformanceInsightsMetricQuery.Builder metric(String metric)
The name of the meteric used used when querying an Performance Insights
GetResourceMetricsAPI for anomaly metrics.Valid values for
Metricare:-
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.avganddb.sampledload.avgare the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avgshowing the scaled values,db.sampledload.avgshowing the raw values, anddb.sampledload.avgless thandb.load.avg. For most use cases, you can querydb.load.avgonly.- Parameters:
metric- The name of the meteric used used when querying an Performance InsightsGetResourceMetricsAPI for anomaly metrics.Valid values for
Metricare:-
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.avganddb.sampledload.avgare the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, withdb.load.avgshowing the scaled values,db.sampledload.avgshowing the raw values, anddb.sampledload.avgless thandb.load.avg. For most use cases, you can querydb.load.avgonly.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
groupBy
PerformanceInsightsMetricQuery.Builder groupBy(PerformanceInsightsMetricDimensionGroup groupBy)
The specification for how to aggregate the data points from a Performance Insights
GetResourceMetricsAPI 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 InsightsGetResourceMetricsAPI 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 theGetResourceMetricsAPI 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.Builderavoiding the need to create one manually viaPerformanceInsightsMetricDimensionGroup.builder().When the
Consumercompletes,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:
groupBy(PerformanceInsightsMetricDimensionGroup)
-
filter
PerformanceInsightsMetricQuery.Builder filter(Map<String,String> filter)
One or more filters to apply to a Performance Insights
GetResourceMetricsAPI query. Restrictions:-
Any number of filters by the same dimension, as specified in the
GroupByparameter. -
A single filter for any other dimension in this dimension group.
- Parameters:
filter- One or more filters to apply to a Performance InsightsGetResourceMetricsAPI query. Restrictions:-
Any number of filters by the same dimension, as specified in the
GroupByparameter. -
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.
-
-
-