com.amazonaws.services.cloudwatch.model.ListMetricsRequest 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#listMetrics(ListMetricsRequest) ListMetrics operation}.
*
* Returns a list of valid metrics stored for the AWS account owner.
* Returned metrics can be used with GetMetricStatistics to
* obtain statistical data for a given metric.
*
*
* NOTE: Up to 500 results are returned for any one call. To
* retrieve further results, use returned NextToken values with
* subsequent ListMetrics operations.
*
*
* 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.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#listMetrics(ListMetricsRequest)
*/
public class ListMetricsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The namespace to filter against.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*/
private String namespace;
/**
* The name of the metric to filter against.
*
* Constraints:
* Length: 1 - 255
*/
private String metricName;
/**
* A list of dimensions to filter against.
*
* Constraints:
* Length: 0 - 10
*/
private com.amazonaws.internal.ListWithAutoConstructFlag dimensions;
/**
* The token returned by a previous call to indicate that there is more
* data available.
*/
private String nextToken;
/**
* The namespace to filter against.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @return The namespace to filter against.
*/
public String getNamespace() {
return namespace;
}
/**
* The namespace to filter against.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace to filter against.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
* The namespace to filter against.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace to filter against.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListMetricsRequest withNamespace(String namespace) {
this.namespace = namespace;
return this;
}
/**
* The name of the metric to filter against.
*
* Constraints:
* Length: 1 - 255
*
* @return The name of the metric to filter against.
*/
public String getMetricName() {
return metricName;
}
/**
* The name of the metric to filter against.
*
* Constraints:
* Length: 1 - 255
*
* @param metricName The name of the metric to filter against.
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
* The name of the metric to filter against.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
*
* @param metricName The name of the metric to filter against.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListMetricsRequest withMetricName(String metricName) {
this.metricName = metricName;
return this;
}
/**
* A list of dimensions to filter against.
*
* Constraints:
* Length: 0 - 10
*
* @return A list of dimensions to filter against.
*/
public java.util.List getDimensions() {
if (dimensions == null) {
dimensions = new com.amazonaws.internal.ListWithAutoConstructFlag();
dimensions.setAutoConstruct(true);
}
return dimensions;
}
/**
* A list of dimensions to filter against.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions A list of dimensions to filter against.
*/
public void setDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag dimensionsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dimensions.size());
dimensionsCopy.addAll(dimensions);
this.dimensions = dimensionsCopy;
}
/**
* A list of dimensions to filter against.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions A list of dimensions to filter against.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListMetricsRequest withDimensions(DimensionFilter... dimensions) {
if (getDimensions() == null) setDimensions(new java.util.ArrayList(dimensions.length));
for (DimensionFilter value : dimensions) {
getDimensions().add(value);
}
return this;
}
/**
* A list of dimensions to filter against.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions A list of dimensions to filter against.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListMetricsRequest withDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag dimensionsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(dimensions.size());
dimensionsCopy.addAll(dimensions);
this.dimensions = dimensionsCopy;
}
return this;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* @return The token returned by a previous call to indicate that there is more
* data available.
*/
public String getNextToken() {
return nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* The token returned by a previous call to indicate that there is more
* data available.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token returned by a previous call to indicate that there is more
* data available.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListMetricsRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
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() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() );
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 + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ListMetricsRequest == false) return false;
ListMetricsRequest other = (ListMetricsRequest)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;
if (other.getNextToken() == null ^ this.getNextToken() == null) return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false;
return true;
}
}