Class PerformanceInsightsMetricDimensionGroup

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

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

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

    • group

      public final String group()

      The name of the dimension group. Its valid values are:

      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.host - The host name of the connected client (all engines)

      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.sql - The SQL that is currently executing (all engines)

      • db.sql_tokenized - The SQL digest (all engines)

      • db.wait_event - The event for which the database backend is waiting (all engines)

      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

      • db.user - The user logged in to the database (all engines)

      Returns:
      The name of the dimension group. Its valid values are:

      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.host - The host name of the connected client (all engines)

      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.sql - The SQL that is currently executing (all engines)

      • db.sql_tokenized - The SQL digest (all engines)

      • db.wait_event - The event for which the database backend is waiting (all engines)

      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

      • db.user - The user logged in to the database (all engines)

    • hasDimensions

      public final boolean hasDimensions()
      For responses, this returns true if the service returned a value for the Dimensions 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.

    • dimensions

      public final List<String> dimensions()

      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

      Valid values for elements in the Dimensions array are:

      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.host.id - The host ID of the connected client (all engines)

      • db.host.name - The host name of the connected client (all engines)

      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

      • db.sql.db_id - The SQL ID generated by the database (all engines)

      • db.sql.statement - The SQL text that is being executed (all engines)

      • db.sql.tokenized_id

      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

      • db.sql_tokenized.statement - The SQL digest text (all engines)

      • db.user.id - The ID of the user logged in to the database (all engines)

      • db.user.name - The name of the user logged in to the database (all engines)

      • db.wait_event.name - The event for which the backend is waiting (all engines)

      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

      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 hasDimensions() method.

      Returns:
      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

      Valid values for elements in the Dimensions array are:

      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.host.id - The host ID of the connected client (all engines)

      • db.host.name - The host name of the connected client (all engines)

      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

      • db.sql.db_id - The SQL ID generated by the database (all engines)

      • db.sql.statement - The SQL text that is being executed (all engines)

      • db.sql.tokenized_id

      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

      • db.sql_tokenized.statement - The SQL digest text (all engines)

      • db.user.id - The ID of the user logged in to the database (all engines)

      • db.user.name - The name of the user logged in to the database (all engines)

      • db.wait_event.name - The event for which the backend is waiting (all engines)

      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

    • limit

      public final Integer limit()

      The maximum number of items to fetch for this dimension group.

      Returns:
      The maximum number of items to fetch for this dimension group.

    • toBuilder

      public PerformanceInsightsMetricDimensionGroup.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<PerformanceInsightsMetricDimensionGroup.Builder,PerformanceInsightsMetricDimensionGroup>
      Returns:
      a builder for type T

    • builder

      public static PerformanceInsightsMetricDimensionGroup.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PerformanceInsightsMetricDimensionGroup.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.