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

Class PerformanceInsightsMetricQuery

java.lang.Object
software.amazon.awssdk.services.rds.model.PerformanceInsightsMetricQuery
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>
@Generated("software.amazon.awssdk:codegen") public final class PerformanceInsightsMetricQuery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>

A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (GroupBy) and return only those data points that match your criteria (Filter).

Constraints:

  • Must be a valid Performance Insights query.

See Also:

  • Method Details

    • groupBy

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

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

    • metric

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

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

    • toBuilder

      public PerformanceInsightsMetricQuery.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PerformanceInsightsMetricQuery.Builder,PerformanceInsightsMetricQuery>
      Returns:
      a builder for type T

    • builder

      public static PerformanceInsightsMetricQuery.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PerformanceInsightsMetricQuery.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.