com.amazonaws.services.pi.model.ResponseResourceMetricKey Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pi 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.pi.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An object describing a Performance Insights metric and one or more dimensions for that metric.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResponseResourceMetricKey implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of a Performance Insights metric to be measured.
*
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 valid dimensions for the metric.
*
*/
private java.util.Map dimensions;
/**
*
* The name of a Performance Insights metric to be measured.
*
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 a Performance Insights metric to be measured.
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 a Performance Insights metric to be measured.
*
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 a Performance Insights metric to be measured.
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 a Performance Insights metric to be measured.
*
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 a Performance Insights metric to be measured.
*
* 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.
*
*
* -
*
* The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.
*
*
*
*
* 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 ResponseResourceMetricKey withMetric(String metric) {
setMetric(metric);
return this;
}
/**
*
* The valid dimensions for the metric.
*
*
* @return The valid dimensions for the metric.
*/
public java.util.Map getDimensions() {
return dimensions;
}
/**
*
* The valid dimensions for the metric.
*
*
* @param dimensions
* The valid dimensions for the metric.
*/
public void setDimensions(java.util.Map dimensions) {
this.dimensions = dimensions;
}
/**
*
* The valid dimensions for the metric.
*
*
* @param dimensions
* The valid dimensions for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResponseResourceMetricKey withDimensions(java.util.Map dimensions) {
setDimensions(dimensions);
return this;
}
/**
* Add a single Dimensions entry
*
* @see ResponseResourceMetricKey#withDimensions
* @returns a reference to this object so that method calls can be chained together.
*/
public ResponseResourceMetricKey addDimensionsEntry(String key, String value) {
if (null == this.dimensions) {
this.dimensions = new java.util.HashMap();
}
if (this.dimensions.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.dimensions.put(key, value);
return this;
}
/**
* Removes all the entries added into Dimensions.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResponseResourceMetricKey clearDimensionsEntries() {
this.dimensions = 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 (getDimensions() != null)
sb.append("Dimensions: ").append(getDimensions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ResponseResourceMetricKey == false)
return false;
ResponseResourceMetricKey other = (ResponseResourceMetricKey) obj;
if (other.getMetric() == null ^ this.getMetric() == null)
return false;
if (other.getMetric() != null && other.getMetric().equals(this.getMetric()) == false)
return false;
if (other.getDimensions() == null ^ this.getDimensions() == null)
return false;
if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == 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 + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
return hashCode;
}
@Override
public ResponseResourceMetricKey clone() {
try {
return (ResponseResourceMetricKey) 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.pi.model.transform.ResponseResourceMetricKeyMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}