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

Class DimensionGroup

  • All Implemented Interfaces:
    Serializable, SdkPojo, ToCopyableBuilder<DimensionGroup.Builder,​DimensionGroup>
    @Generated("software.amazon.awssdk:codegen")
public final class DimensionGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DimensionGroup.Builder,​DimensionGroup>

    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 - The hash of a running SQL statement, generated by Performance Insights.

    • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi-.

    • db.sql.statement - The full text of the SQL statement that is running, for example, SELECT * FROM employees.

    • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights.

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

    See Also:
    Serialized Form

    • Method Detail

      • group

        public final String group()

        The name of the dimension group. Valid values are as follows:

        • db - The name of the database to which the client is connected. The following values are permitted:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Aurora MySQL

          • Amazon RDS MySQL

          • Amazon RDS MariaDB

          • Amazon DocumentDB

        • db.application - The name of the application that is connected to the database. The following values are permitted:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Amazon DocumentDB

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

        • db.query - The query that is currently running (only Amazon DocumentDB).

        • db.query_tokenized - The digest query (only Amazon DocumentDB).

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

        • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

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

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

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

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

        • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

        Returns:
        The name of the dimension group. Valid values are as follows:

        • db - The name of the database to which the client is connected. The following values are permitted:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Aurora MySQL

          • Amazon RDS MySQL

          • Amazon RDS MariaDB

          • Amazon DocumentDB

        • db.application - The name of the application that is connected to the database. The following values are permitted:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Amazon DocumentDB

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

        • db.query - The query that is currently running (only Amazon DocumentDB).

        • db.query_tokenized - The digest query (only Amazon DocumentDB).

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

        • db.sql - The text of the SQL statement that is currently running (all engines except Amazon DocumentDB).

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

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

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

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

        • db.wait_state - The event for which the database backend is waiting (only Amazon DocumentDB).

      • 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. Valid values are as follows:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Amazon DocumentDB

        • 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. Valid values are as follows:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Aurora MySQL

          • Amazon RDS MySQL

          • Amazon RDS MariaDB

          • Amazon DocumentDB

        • db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

        • db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

        • db.query.tokenized_id

        • db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

        • db.session_type.name - The type of the current session (only Amazon DocumentDB).

        • db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

        • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

        • db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

        • db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

        • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

        • db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

        • db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

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

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

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

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

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

        • db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

        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. Valid values are as follows:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Amazon DocumentDB

        • 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. Valid values are as follows:

          • Aurora PostgreSQL

          • Amazon RDS PostgreSQL

          • Aurora MySQL

          • Amazon RDS MySQL

          • Amazon RDS MariaDB

          • Amazon DocumentDB

        • db.query.id - The query ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.db_id - The query ID generated by the database (only Amazon DocumentDB).

        • db.query.statement - The text of the query that is being run (only Amazon DocumentDB).

        • db.query.tokenized_id

        • db.query.tokenized.id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.tokenized.db_id - The query digest ID generated by Performance Insights (only Amazon DocumentDB).

        • db.query.tokenized.statement - The text of the query digest (only Amazon DocumentDB).

        • db.session_type.name - The type of the current session (only Amazon DocumentDB).

        • db.sql.id - The hash of the full, non-tokenized SQL statement generated by Performance Insights (all engines except Amazon DocumentDB).

        • db.sql.db_id - Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins with pi- (all engines except Amazon DocumentDB).

        • db.sql.statement - The full text of the SQL statement that is running, as in SELECT * FROM employees (all engines except Amazon DocumentDB)

        • db.sql.tokenized_id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). The db.sql.tokenized_id dimension fetches the value of the db.sql_tokenized.id dimension. Amazon RDS returns db.sql.tokenized_id from the db.sql dimension group.

        • db.sql_tokenized.id - The hash of the SQL digest generated by Performance Insights (all engines except Amazon DocumentDB). In the console, db.sql_tokenized.id is called the Support ID because Amazon Web Services Support can look at this data to help you troubleshoot database issues.

        • db.sql_tokenized.db_id - Either the native database ID used to refer to the SQL statement, or a synthetic ID such as pi-2372568224 that Performance Insights generates if the native database ID isn't available (all engines except Amazon DocumentDB).

        • db.sql_tokenized.statement - The text of the SQL digest, as in SELECT * FROM employees WHERE employee_id = ? (all engines except Amazon DocumentDB)

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

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

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

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

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

        • db.wait_state.name - The event for which the backend is waiting (only Amazon DocumentDB).

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

      • hashCode

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

      • equals

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

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