/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.devopsguru.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* 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. *
** 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)
*
* 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)
*
* The maximum number of items to fetch for this dimension group. *
*/ private Integer limit; /** ** 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* 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)
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setDimensions(java.util.Collection)} or {@link #withDimensions(java.util.Collection)} if you want to * override the existing values. *
* * @param 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)
*
* 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)
*
* 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)
*
* The maximum number of items to fetch for this dimension group. *
* * @param limit * The maximum number of items to fetch for this dimension group. */ public void setLimit(Integer limit) { this.limit = limit; } /** ** The maximum number of items to fetch for this dimension group. *
* * @return The maximum number of items to fetch for this dimension group. */ public Integer getLimit() { return this.limit; } /** ** The maximum number of items to fetch for this dimension group. *
* * @param limit * The maximum number of items to fetch for this dimension group. * @return Returns a reference to this object so that method calls can be chained together. */ public PerformanceInsightsMetricDimensionGroup withLimit(Integer limit) { setLimit(limit); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getGroup() != null) sb.append("Group: ").append(getGroup()).append(","); if (getDimensions() != null) sb.append("Dimensions: ").append(getDimensions()).append(","); if (getLimit() != null) sb.append("Limit: ").append(getLimit()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PerformanceInsightsMetricDimensionGroup == false) return false; PerformanceInsightsMetricDimensionGroup other = (PerformanceInsightsMetricDimensionGroup) obj; if (other.getGroup() == null ^ this.getGroup() == null) return false; if (other.getGroup() != null && other.getGroup().equals(this.getGroup()) == false) return false; if (other.getDimensions() == null ^ this.getDimensions() == null) return false; if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false) return false; if (other.getLimit() == null ^ this.getLimit() == null) return false; if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getGroup() == null) ? 0 : getGroup().hashCode()); hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode()); hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode()); return hashCode; } @Override public PerformanceInsightsMetricDimensionGroup clone() { try { return (PerformanceInsightsMetricDimensionGroup) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.devopsguru.model.transform.PerformanceInsightsMetricDimensionGroupMarshaller.getInstance().marshall(this, protocolMarshaller); } }