com.amazonaws.services.pi.model

Class DimensionGroup

java.lang.Object

com.amazonaws.services.pi.model.DimensionGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DimensionGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DimensionGroup()

Method Summary

Modifier and Type	Method and Description
DimensionGroup	clone()
boolean	equals(Object obj)
List<String>	getDimensions() A list of specific dimensions from a dimension group.
String	getGroup() The name of the dimension group.
Integer	getLimit() The maximum number of items to fetch for this dimension group.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDimensions(Collection<String> dimensions) A list of specific dimensions from a dimension group.
void	setGroup(String group) The name of the dimension group.
void	setLimit(Integer limit) The maximum number of items to fetch for this dimension group.
String	toString() Returns a string representation of this object.
DimensionGroup	withDimensions(Collection<String> dimensions) A list of specific dimensions from a dimension group.
DimensionGroup	withDimensions(String... dimensions) A list of specific dimensions from a dimension group.
DimensionGroup	withGroup(String group) The name of the dimension group.
DimensionGroup	withLimit(Integer limit) The maximum number of items to fetch for this dimension group.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DimensionGroup

public DimensionGroup()

Method Detail

setGroup

public void setGroup(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).

Parameters:

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

getGroup

public String getGroup()

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

withGroup

public DimensionGroup withGroup(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).

Parameters:

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:

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

getDimensions

public List<String> getDimensions()

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

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

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

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

setDimensions

public void setDimensions(Collection<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

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

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

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

withDimensions

public DimensionGroup withDimensions(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

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

NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.

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

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

Returns:

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

withDimensions

public DimensionGroup withDimensions(Collection<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

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

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

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

Returns:

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

setLimit

public void setLimit(Integer 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.

getLimit

public Integer getLimit()

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

Returns:

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

withLimit

public DimensionGroup withLimit(Integer 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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DimensionGroup clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.