com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest 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#describeAlarmsForMetric(DescribeAlarmsForMetricRequest) DescribeAlarmsForMetric operation}.
*
* Retrieves all alarms for a single metric. Specify a statistic,
* period, or unit to filter the set of alarms further.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#describeAlarmsForMetric(DescribeAlarmsForMetricRequest)
*/
public class DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the metric.
*
* Constraints:
* Length: 1 - 255
*/
private String metricName;
/**
* The namespace of the metric.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*/
private String namespace;
/**
* The statistic for the metric.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*/
private String statistic;
/**
* The list of dimensions associated with the metric.
*
* Constraints:
* Length: 0 - 10
*/
private com.amazonaws.internal.ListWithAutoConstructFlag dimensions;
/**
* The period in seconds over which the statistic is applied.
*
* Constraints:
* Range: 60 -
*/
private Integer period;
/**
* The unit for the metric.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*/
private String unit;
/**
* The name of the metric.
*
* Constraints:
* Length: 1 - 255
*
* @return The name of the metric.
*/
public String getMetricName() {
return metricName;
}
/**
* The name of the metric.
*
* Constraints:
* Length: 1 - 255
*
* @param metricName The name of the metric.
*/
public void setMetricName(String metricName) {
this.metricName = metricName;
}
/**
* The name of the metric.
*
* 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsForMetricRequest withMetricName(String metricName) {
this.metricName = metricName;
return this;
}
/**
* The namespace of the metric.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @return The namespace of the metric.
*/
public String getNamespace() {
return namespace;
}
/**
* The namespace of the metric.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace of the metric.
*/
public void setNamespace(String namespace) {
this.namespace = namespace;
}
/**
* The namespace of the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
* Pattern: [^:].*
*
* @param namespace The namespace of the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsForMetricRequest withNamespace(String namespace) {
this.namespace = namespace;
return this;
}
/**
* The statistic for the metric.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*
* @return The statistic for the metric.
*
* @see Statistic
*/
public String getStatistic() {
return statistic;
}
/**
* The statistic for the metric.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*
* @param statistic The statistic for the metric.
*
* @see Statistic
*/
public void setStatistic(String statistic) {
this.statistic = statistic;
}
/**
* The statistic for the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*
* @param statistic The statistic for the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see Statistic
*/
public DescribeAlarmsForMetricRequest withStatistic(String statistic) {
this.statistic = statistic;
return this;
}
/**
* The statistic for the metric.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*
* @param statistic The statistic for the metric.
*
* @see Statistic
*/
public void setStatistic(Statistic statistic) {
this.statistic = statistic.toString();
}
/**
* The statistic for the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: SampleCount, Average, Sum, Minimum, Maximum
*
* @param statistic The statistic for the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see Statistic
*/
public DescribeAlarmsForMetricRequest withStatistic(Statistic statistic) {
this.statistic = statistic.toString();
return this;
}
/**
* The list of dimensions associated with the metric.
*
* Constraints:
* Length: 0 - 10
*
* @return The list of dimensions associated with the metric.
*/
public java.util.List getDimensions() {
if (dimensions == null) {
dimensions = new com.amazonaws.internal.ListWithAutoConstructFlag();
dimensions.setAutoConstruct(true);
}
return dimensions;
}
/**
* The list of dimensions associated with the metric.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions The list of dimensions associated with the metric.
*/
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;
}
/**
* The list of dimensions associated with the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions The list of dimensions associated with the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsForMetricRequest withDimensions(Dimension... dimensions) {
if (getDimensions() == null) setDimensions(new java.util.ArrayList(dimensions.length));
for (Dimension value : dimensions) {
getDimensions().add(value);
}
return this;
}
/**
* The list of dimensions associated with the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 10
*
* @param dimensions The list of dimensions associated with the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsForMetricRequest 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 period in seconds over which the statistic is applied.
*
* Constraints:
* Range: 60 -
*
* @return The period in seconds over which the statistic is applied.
*/
public Integer getPeriod() {
return period;
}
/**
* The period in seconds over which the statistic is applied.
*
* Constraints:
* Range: 60 -
*
* @param period The period in seconds over which the statistic is applied.
*/
public void setPeriod(Integer period) {
this.period = period;
}
/**
* The period in seconds over which the statistic is applied.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 60 -
*
* @param period The period in seconds over which the statistic is applied.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsForMetricRequest withPeriod(Integer period) {
this.period = period;
return this;
}
/**
* The unit for the metric.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*
* @return The unit for the metric.
*
* @see StandardUnit
*/
public String getUnit() {
return unit;
}
/**
* The unit for the metric.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*
* @param unit The unit for the metric.
*
* @see StandardUnit
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
* The unit for the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*
* @param unit The unit for the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StandardUnit
*/
public DescribeAlarmsForMetricRequest withUnit(String unit) {
this.unit = unit;
return this;
}
/**
* The unit for the metric.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*
* @param unit The unit for the metric.
*
* @see StandardUnit
*/
public void setUnit(StandardUnit unit) {
this.unit = unit.toString();
}
/**
* The unit for the metric.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
*
* @param unit The unit for the metric.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StandardUnit
*/
public DescribeAlarmsForMetricRequest withUnit(StandardUnit unit) {
this.unit = unit.toString();
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 (getMetricName() != null) sb.append("MetricName: " + getMetricName() + ",");
if (getNamespace() != null) sb.append("Namespace: " + getNamespace() + ",");
if (getStatistic() != null) sb.append("Statistic: " + getStatistic() + ",");
if (getDimensions() != null) sb.append("Dimensions: " + getDimensions() + ",");
if (getPeriod() != null) sb.append("Period: " + getPeriod() + ",");
if (getUnit() != null) sb.append("Unit: " + getUnit() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getStatistic() == null) ? 0 : getStatistic().hashCode());
hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode());
hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeAlarmsForMetricRequest == false) return false;
DescribeAlarmsForMetricRequest other = (DescribeAlarmsForMetricRequest)obj;
if (other.getMetricName() == null ^ this.getMetricName() == null) return false;
if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false) return false;
if (other.getNamespace() == null ^ this.getNamespace() == null) return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false) return false;
if (other.getStatistic() == null ^ this.getStatistic() == null) return false;
if (other.getStatistic() != null && other.getStatistic().equals(this.getStatistic()) == 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.getPeriod() == null ^ this.getPeriod() == null) return false;
if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == false) return false;
if (other.getUnit() == null ^ this.getUnit() == null) return false;
if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false) return false;
return true;
}
}