DimensionGroup (AWS SDK for Java

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DimensionGroup()

Constructors
Constructor and Description
`DimensionGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
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:
    - db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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. Valid values are:
    
    db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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)
  - getGroup
```
public String getGroup()
```
    The name of the dimension group. Valid values are:
    - db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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. Valid values are:
    
    db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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)
  - withGroup
```
public DimensionGroup withGroup(String group)
```
    The name of the dimension group. Valid values are:
    - db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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. Valid values are:
    
    db - The name of the database to which the client is connected (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, 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.
  - 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 (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, RDS PostgreSQL, Aurora MySQL, 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:
    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, RDS PostgreSQL, Aurora MySQL, 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)
  - 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 (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, RDS PostgreSQL, Aurora MySQL, 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, RDS PostgreSQL, Aurora MySQL, 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)
  - 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 (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, RDS PostgreSQL, Aurora MySQL, 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)
    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 (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, RDS PostgreSQL, Aurora MySQL, 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.
  - 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 (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, RDS PostgreSQL, Aurora MySQL, 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, RDS PostgreSQL, Aurora MySQL, 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.
  - 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.

Did this page help you?

Class DimensionGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DimensionGroup

Method Detail

setGroup

getGroup

withGroup

getDimensions

setDimensions

withDimensions

withDimensions

setLimit

getLimit

withLimit

toString

equals

hashCode

clone

marshall