Interface PerformanceInsightsMetricDimensionGroup.Builder

  • Method Details

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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)

      Parameters:
      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)

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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)

      Parameters:
      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)

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • limit

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

      Parameters:
      limit - The maximum number of items to fetch for this dimension group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.