com.amazonaws.services.cloudwatch.model.Dimension Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudwatch 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.cloudwatch.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique
* identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new
* variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name,
* and the actual instance ID as the value for that dimension.
*
*
* You can assign up to 30 dimensions to a metric.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Dimension implements Serializable, Cloneable {
/**
*
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
*
*/
private String name;
/**
*
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least one
* non-whitespace character. ASCII control characters are not supported as part of dimension values.
*
*/
private String value;
/**
*
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
*
*
* @param name
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
*
*
* @return The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are
* not supported as part of dimension names.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
*
*
* @param name
* The name of the dimension. Dimension names must contain only ASCII characters, must include at least one
* non-whitespace character, and cannot start with a colon (:). ASCII control characters are not
* supported as part of dimension names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dimension withName(String name) {
setName(name);
return this;
}
/**
*
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least one
* non-whitespace character. ASCII control characters are not supported as part of dimension values.
*
*
* @param value
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least
* one non-whitespace character. ASCII control characters are not supported as part of dimension values.
*/
public void setValue(String value) {
this.value = value;
}
/**
*
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least one
* non-whitespace character. ASCII control characters are not supported as part of dimension values.
*
*
* @return The value of the dimension. Dimension values must contain only ASCII characters and must include at least
* one non-whitespace character. ASCII control characters are not supported as part of dimension values.
*/
public String getValue() {
return this.value;
}
/**
*
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least one
* non-whitespace character. ASCII control characters are not supported as part of dimension values.
*
*
* @param value
* The value of the dimension. Dimension values must contain only ASCII characters and must include at least
* one non-whitespace character. ASCII control characters are not supported as part of dimension values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Dimension withValue(String value) {
setValue(value);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Dimension == false)
return false;
Dimension other = (Dimension) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
return hashCode;
}
@Override
public Dimension clone() {
try {
return (Dimension) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}