Package software.amazon.awssdk.services.pi.model

Interface MetricQuery.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MetricQuery.Builder,MetricQuery>, SdkBuilder<MetricQuery.Builder,MetricQuery>, SdkPojo
Enclosing class:
MetricQuery
public static interface MetricQuery.Builder extends SdkPojo, CopyableBuilder<MetricQuery.Builder,MetricQuery>

  • Method Details

    • metric

      MetricQuery.Builder metric(String metric)

      The name of a Performance Insights metric to be measured.

      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.

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

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

    • groupBy

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

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

      Parameters:
      groupBy - a consumer that will call methods on DimensionGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filter

      MetricQuery.Builder filter(Map<String,String> filter)

      One or more filters to apply in the request. 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 in the request. 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.