com.amazonaws.services.cloudwatch.model.PutMetricDataRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.cloudwatch.AmazonCloudWatch#putMetricData(PutMetricDataRequest) PutMetricData operation}.
*
* Publishes metric data points to Amazon CloudWatch. Amazon Cloudwatch
* associates the data points with the specified metric. If the specified
* metric does not exist, Amazon CloudWatch creates the metric.
*
*
* NOTE: If you create a metric with the PutMetricData action,
* allow up to fifteen minutes for the metric to appear in calls to the
* ListMetrics action.
*
*
* The size of a PutMetricData request is limited to 8 KB for HTTP GET
* requests and 40 KB for HTTP POST requests.
*
*
* IMPORTANT: Although the Value parameter accepts numbers of type
* Double, Amazon CloudWatch truncates values with very large exponents.
* Values with base-10 exponents greater than 126 (1 x 10^126) are
* truncated. Likewise, values with base-10 exponents less than -130 (1 x
* 10^-130) are also truncated.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#putMetricData(PutMetricDataRequest)
*/
public class PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The namespace for the metric data.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*/
private String namespace;
/**
* A list of data describing the metric.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag metricData;
/**
* The namespace for the metric data.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @return The namespace for the metric data.
*/
public String getNamespace() {
return namespace;
}
/**
* The namespace for the metric data.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace for the metric data.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
* The namespace for the metric data.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace for the metric data.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutMetricDataRequest withNamespace(String namespace) {
this.namespace = namespace;
return this;
}
/**
* A list of data describing the metric.
*
* @return A list of data describing the metric.
*/
public java.util.List getMetricData() {
if (metricData == null) {
metricData = new com.amazonaws.internal.ListWithAutoConstructFlag();
metricData.setAutoConstruct(true);
}
return metricData;
}
/**
* A list of data describing the metric.
*
* @param metricData A list of data describing the metric.
*/
public void setMetricData(java.util.Collection metricData) {
if (metricData == null) {
this.metricData = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag metricDataCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(metricData.size());
metricDataCopy.addAll(metricData);
this.metricData = metricDataCopy;
}
/**
* A list of data describing the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param metricData A list of data describing the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutMetricDataRequest withMetricData(MetricDatum... metricData) {
if (getMetricData() == null) setMetricData(new java.util.ArrayList(metricData.length));
for (MetricDatum value : metricData) {
getMetricData().add(value);
}
return this;
}
/**
* A list of data describing the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param metricData A list of data describing the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PutMetricDataRequest withMetricData(java.util.Collection metricData) {
if (metricData == null) {
this.metricData = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag metricDataCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(metricData.size());
metricDataCopy.addAll(metricData);
this.metricData = metricDataCopy;
}
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 (getMetricData() != null) sb.append("MetricData: " + getMetricData() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getMetricData() == null) ? 0 : getMetricData().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PutMetricDataRequest == false) return false;
PutMetricDataRequest other = (PutMetricDataRequest)obj;
if (other.getNamespace() == null ^ this.getNamespace() == null) return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false) return false;
if (other.getMetricData() == null ^ this.getMetricData() == null) return false;
if (other.getMetricData() != null && other.getMetricData().equals(this.getMetricData()) == false) return false;
return true;
}
}