com.amazonaws.services.devopsguru.model.PerformanceInsightsMetricQuery Maven / Gradle / Ivy
Show all versions of aws-java-sdk-devopsguru Show documentation
/*
* Copyright 2019-2024 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 single query to be processed. Use these parameters to query the Performance Insights
* GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see
* GetResourceMetrics
* in the Amazon RDS Performance Insights API Reference.
*
*
* 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 AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PerformanceInsightsMetricQuery implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for
* anomaly metrics.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active sessions
* is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and
* db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*/
private String metric;
/**
*
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within
* that group, unless you provide the names of specific dimensions within that group. You can also request that
* Performance Insights return a limited number of values for a dimension.
*
*/
private PerformanceInsightsMetricDimensionGroup groupBy;
/**
*
* One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*/
private java.util.Map filter;
/**
*
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for
* anomaly metrics.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active sessions
* is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and
* db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*
* @param metric
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics
* API for anomaly metrics.
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database
* engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active
* sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw
* values, and db.sampledload.avg less than db.load.avg. For most use cases, you
* can query db.load.avg only.
*/
public void setMetric(String metric) {
this.metric = metric;
}
/**
*
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for
* anomaly metrics.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active sessions
* is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and
* db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*
* @return The name of the meteric used used when querying an Performance Insights GetResourceMetrics
* API for anomaly metrics.
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database
* engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active
* sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw
* values, and db.sampledload.avg less than db.load.avg. For most use cases, you
* can query db.load.avg only.
*/
public String getMetric() {
return this.metric;
}
/**
*
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for
* anomaly metrics.
*
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active sessions
* is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and
* db.sampledload.avg less than db.load.avg. For most use cases, you can query
* db.load.avg only.
*
*
* @param metric
* The name of the meteric used used when querying an Performance Insights GetResourceMetrics
* API for anomaly metrics.
*
* Valid values for Metric are:
*
*
* -
*
* db.load.avg - a scaled representation of the number of active sessions for the database
* engine.
*
*
* -
*
* db.sampledload.avg - the raw number of active sessions for the database engine.
*
*
*
*
* If the number of active sessions is less than an internal Performance Insights threshold,
* db.load.avg and db.sampledload.avg are the same value. If the number of active
* sessions is greater than the internal threshold, Performance Insights samples the active sessions, with
* db.load.avg showing the scaled values, db.sampledload.avg showing the raw
* values, and db.sampledload.avg less than db.load.avg. For most use cases, you
* can query db.load.avg only.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PerformanceInsightsMetricQuery withMetric(String metric) {
setMetric(metric);
return this;
}
/**
*
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within
* that group, unless you provide the names of specific dimensions within that group. You can also request that
* Performance Insights return a limited number of values for a dimension.
*
*
* @param groupBy
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions
* within that group, unless you provide the names of specific dimensions within that group. You can also
* request that Performance Insights return a limited number of values for a dimension.
*/
public void setGroupBy(PerformanceInsightsMetricDimensionGroup groupBy) {
this.groupBy = groupBy;
}
/**
*
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within
* that group, unless you provide the names of specific dimensions within that group. You can also request that
* Performance Insights return a limited number of values for a dimension.
*
*
* @return The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions
* within that group, unless you provide the names of specific dimensions within that group. You can also
* request that Performance Insights return a limited number of values for a dimension.
*/
public PerformanceInsightsMetricDimensionGroup getGroupBy() {
return this.groupBy;
}
/**
*
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within
* that group, unless you provide the names of specific dimensions within that group. You can also request that
* Performance Insights return a limited number of values for a dimension.
*
*
* @param groupBy
* The specification for how to aggregate the data points from a Performance Insights
* GetResourceMetrics API query. The Performance Insights query returns all of the dimensions
* within that group, unless you provide the names of specific dimensions within that group. You can also
* request that Performance Insights return a limited number of values for a dimension.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PerformanceInsightsMetricQuery withGroupBy(PerformanceInsightsMetricDimensionGroup groupBy) {
setGroupBy(groupBy);
return this;
}
/**
*
* One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*
* @return One or more filters to apply to a Performance Insights GetResourceMetrics API query.
* Restrictions:
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*/
public java.util.Map getFilter() {
return filter;
}
/**
*
* One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*
* @param filter
* One or more filters to apply to a Performance Insights GetResourceMetrics API query.
* Restrictions:
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*/
public void setFilter(java.util.Map filter) {
this.filter = filter;
}
/**
*
* One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
*
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
*
*
* @param filter
* One or more filters to apply to a Performance Insights GetResourceMetrics API query.
* Restrictions:
*
* -
*
* Any number of filters by the same dimension, as specified in the GroupBy parameter.
*
*
* -
*
* A single filter for any other dimension in this dimension group.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PerformanceInsightsMetricQuery withFilter(java.util.Map filter) {
setFilter(filter);
return this;
}
/**
* Add a single Filter entry
*
* @see PerformanceInsightsMetricQuery#withFilter
* @returns a reference to this object so that method calls can be chained together.
*/
public PerformanceInsightsMetricQuery addFilterEntry(String key, String value) {
if (null == this.filter) {
this.filter = new java.util.HashMap();
}
if (this.filter.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.filter.put(key, value);
return this;
}
/**
* Removes all the entries added into Filter.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PerformanceInsightsMetricQuery clearFilterEntries() {
this.filter = null;
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 (getMetric() != null)
sb.append("Metric: ").append(getMetric()).append(",");
if (getGroupBy() != null)
sb.append("GroupBy: ").append(getGroupBy()).append(",");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PerformanceInsightsMetricQuery == false)
return false;
PerformanceInsightsMetricQuery other = (PerformanceInsightsMetricQuery) obj;
if (other.getMetric() == null ^ this.getMetric() == null)
return false;
if (other.getMetric() != null && other.getMetric().equals(this.getMetric()) == false)
return false;
if (other.getGroupBy() == null ^ this.getGroupBy() == null)
return false;
if (other.getGroupBy() != null && other.getGroupBy().equals(this.getGroupBy()) == false)
return false;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMetric() == null) ? 0 : getMetric().hashCode());
hashCode = prime * hashCode + ((getGroupBy() == null) ? 0 : getGroupBy().hashCode());
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
return hashCode;
}
@Override
public PerformanceInsightsMetricQuery clone() {
try {
return (PerformanceInsightsMetricQuery) 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.PerformanceInsightsMetricQueryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}