software.amazon.awssdk.services.devopsguru.model.PerformanceInsightsMetricDimensionGroup Maven / Gradle / Ivy
Show all versions of devopsguru Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.devopsguru.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PerformanceInsightsMetricDimensionGroup implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField GROUP_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Group")
.getter(getter(PerformanceInsightsMetricDimensionGroup::group)).setter(setter(Builder::group))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Group").build()).build();
private static final SdkField> DIMENSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Dimensions")
.getter(getter(PerformanceInsightsMetricDimensionGroup::dimensions))
.setter(setter(Builder::dimensions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(PerformanceInsightsMetricDimensionGroup::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GROUP_FIELD, DIMENSIONS_FIELD,
LIMIT_FIELD));
private static final long serialVersionUID = 1L;
private final String group;
private final List dimensions;
private final Integer limit;
private PerformanceInsightsMetricDimensionGroup(BuilderImpl builder) {
this.group = builder.group;
this.dimensions = builder.dimensions;
this.limit = builder.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)
*
*
*
*
* @return 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)
*
*
*/
public final String group() {
return group;
}
/**
* 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 {@code 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.
*/
public final boolean hasDimensions() {
return dimensions != null && !(dimensions instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasDimensions} method.
*
*
* @return 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)
*
*
*/
public final List dimensions() {
return dimensions;
}
/**
*
* The maximum number of items to fetch for this dimension group.
*
*
* @return The maximum number of items to fetch for this dimension group.
*/
public final Integer limit() {
return limit;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(group());
hashCode = 31 * hashCode + Objects.hashCode(hasDimensions() ? dimensions() : null);
hashCode = 31 * hashCode + Objects.hashCode(limit());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PerformanceInsightsMetricDimensionGroup)) {
return false;
}
PerformanceInsightsMetricDimensionGroup other = (PerformanceInsightsMetricDimensionGroup) obj;
return Objects.equals(group(), other.group()) && hasDimensions() == other.hasDimensions()
&& Objects.equals(dimensions(), other.dimensions()) && Objects.equals(limit(), other.limit());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("PerformanceInsightsMetricDimensionGroup").add("Group", group())
.add("Dimensions", hasDimensions() ? dimensions() : null).add("Limit", limit()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Group":
return Optional.ofNullable(clazz.cast(group()));
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function