PerformanceInsightsMetricDimensionGroup (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.devopsguru.model.PerformanceInsightsMetricDimensionGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PerformanceInsightsMetricDimensionGroup.Builder,PerformanceInsightsMetricDimensionGroup>
```
@Generated(value="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.
- To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
- To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PerformanceInsightsMetricDimensionGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PerformanceInsightsMetricDimensionGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PerformanceInsightsMetricDimensionGroup.Builder`	`builder()`
`List<String>`	`dimensions()` A list of specific dimensions from a dimension group.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`group()` The name of the dimension group.
`boolean`	`hasDimensions()` For responses, this returns true if the service returned a value for the Dimensions property.
`int`	`hashCode()`
`Integer`	`limit()` The maximum number of items to fetch for this dimension group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PerformanceInsightsMetricDimensionGroup.Builder>`	`serializableBuilderClass()`
`PerformanceInsightsMetricDimensionGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PerformanceInsightsMetricDimensionGroup.Builder,PerformanceInsightsMetricDimensionGroup>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class PerformanceInsightsMetricDimensionGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

group

hasDimensions

dimensions

limit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields