software.amazon.awssdk.services.devopsguru.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 and Description
PerformanceInsightsMetricQuery.Builder	filter(Map<String,String> filter) One or more filters to apply to a Performance Insights GetResourceMetrics API query.
default PerformanceInsightsMetricQuery.Builder	groupBy(Consumer<PerformanceInsightsMetricDimensionGroup.Builder> groupBy) The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query.
PerformanceInsightsMetricQuery.Builder	groupBy(PerformanceInsightsMetricDimensionGroup groupBy) The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query.
PerformanceInsightsMetricQuery.Builder	metric(String metric) The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

metric

PerformanceInsightsMetricQuery.Builder metric(String 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 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 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 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.

groupBy

PerformanceInsightsMetricQuery.Builder groupBy(PerformanceInsightsMetricDimensionGroup 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 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.

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 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.

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)

filter

PerformanceInsightsMetricQuery.Builder filter(Map<String,String> 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 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.

Returns:

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