com.amazonaws.services.cloudwatch.model.Metric Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatch Show documentation
/*
* Copyright 2010-2016 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.cloudwatch.model;
import java.io.Serializable;
/**
*
* The Metric data type contains information about a specific
* metric. If you call ListMetrics, Amazon CloudWatch returns information
* contained by this data type.
*
*
* The example in the Examples section publishes two metrics named buffers and
* latency. Both metrics are in the examples namespace. Both metrics have two
* dimensions, InstanceID and InstanceType.
*
*/
public class Metric implements Serializable, Cloneable {
/**
*
* The namespace of the metric.
*
*/
private String namespace;
/**
*
* The name of the metric.
*
*/
private String metricName;
/**
*
* A list of dimensions associated with the metric.
*
*/
private com.amazonaws.internal.SdkInternalList dimensions;
/**
*
* The namespace of the metric.
*
*
* @param namespace
* The namespace of the metric.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
*
* The namespace of the metric.
*
*
* @return The namespace of the metric.
*/
public String getNamespace() {
return this.namespace;
}
/**
*
* The namespace of the metric.
*
*
* @param namespace
* The namespace of the metric.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Metric withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The name of the metric.
*
*
* @param metricName
* The name of the metric.
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
*
* The name of the metric.
*
*
* @return The name of the metric.
*/
public String getMetricName() {
return this.metricName;
}
/**
*
* The name of the metric.
*
*
* @param metricName
* The name of the metric.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Metric withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* A list of dimensions associated with the metric.
*
*
* @return A list of dimensions associated with the metric.
*/
public java.util.List getDimensions() {
if (dimensions == null) {
dimensions = new com.amazonaws.internal.SdkInternalList();
}
return dimensions;
}
/**
*
* A list of dimensions associated with the metric.
*
*
* @param dimensions
* A list of dimensions associated with the metric.
*/
public void setDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
return;
}
this.dimensions = new com.amazonaws.internal.SdkInternalList(
dimensions);
}
/**
*
* A list of dimensions associated with the metric.
*
*
* 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 dimensions associated with the metric.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Metric withDimensions(Dimension... dimensions) {
if (this.dimensions == null) {
setDimensions(new com.amazonaws.internal.SdkInternalList(
dimensions.length));
}
for (Dimension ele : dimensions) {
this.dimensions.add(ele);
}
return this;
}
/**
*
* A list of dimensions associated with the metric.
*
*
* @param dimensions
* A list of dimensions associated with the metric.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public Metric withDimensions(java.util.Collection dimensions) {
setDimensions(dimensions);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getNamespace() != null)
sb.append("Namespace: " + getNamespace() + ",");
if (getMetricName() != null)
sb.append("MetricName: " + getMetricName() + ",");
if (getDimensions() != null)
sb.append("Dimensions: " + 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 Metric == false)
return false;
Metric other = (Metric) obj;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null
&& other.getNamespace().equals(this.getNamespace()) == false)
return false;
if (other.getMetricName() == null ^ this.getMetricName() == null)
return false;
if (other.getMetricName() != null
&& other.getMetricName().equals(this.getMetricName()) == 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
+ ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode
+ ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode
+ ((getDimensions() == null) ? 0 : getDimensions().hashCode());
return hashCode;
}
@Override
public Metric clone() {
try {
return (Metric) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}