Package software.amazon.awssdk.services.devopsguru.model

Class PerformanceInsightsMetricQuery

java.lang.Object
software.amazon.awssdk.services.devopsguru.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 query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

See Also:

  • Method Details

    • metric

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

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

    • groupBy

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

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

    • hasFilter

      public final boolean hasFilter()
      For responses, this returns true if the service returned a value for the Filter property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • filter

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilter() method.

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

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