Package software.amazon.awssdk.services.rds.model

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

Modifier and Type	Method	Description
default PerformanceInsightsMetricQuery.Builder	groupBy(Consumer<PerformanceInsightsMetricDimensionGroup.Builder> groupBy)	A specification for how to aggregate the data points from a query result.
PerformanceInsightsMetricQuery.Builder	groupBy(PerformanceInsightsMetricDimensionGroup groupBy)	A specification for how to aggregate the data points from a query result.
PerformanceInsightsMetricQuery.Builder	metric(String metric)	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, sdkFieldNameToField, sdkFields

Method Detail

groupBy

PerformanceInsightsMetricQuery.Builder groupBy(PerformanceInsightsMetricDimensionGroup 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 the PerformanceInsightsMetricDimensionGroup.Builder avoiding the need to create one manually via PerformanceInsightsMetricDimensionGroup.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupBy(PerformanceInsightsMetricDimensionGroup).

Parameters:

groupBy - a consumer that will call methods on PerformanceInsightsMetricDimensionGroup.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

groupBy(PerformanceInsightsMetricDimensionGroup)

metric

PerformanceInsightsMetricQuery.Builder metric(String 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 and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.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 and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

Returns:

Returns a reference to this object so that method calls can be chained together.