com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeAlarmsForMetricRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the metric.
*
*/
private String metricName;
/**
*
* The namespace of the metric.
*
*/
private String namespace;
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*/
private String statistic;
/**
*
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
*
*/
private String extendedStatistic;
/**
*
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
* order for the call to succeed.
*
*/
private com.amazonaws.internal.SdkInternalList dimensions;
/**
*
* The period, in seconds, over which the statistic is applied.
*
*/
private Integer period;
/**
*
* The unit for the metric.
*
*/
private String unit;
/**
*
* 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 DescribeAlarmsForMetricRequest withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* 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 DescribeAlarmsForMetricRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*
* @param statistic
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
* @see Statistic
*/
public void setStatistic(String statistic) {
this.statistic = statistic;
}
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*
* @return The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
* @see Statistic
*/
public String getStatistic() {
return this.statistic;
}
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*
* @param statistic
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
public DescribeAlarmsForMetricRequest withStatistic(String statistic) {
setStatistic(statistic);
return this;
}
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*
* @param statistic
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
* @see Statistic
*/
public void setStatistic(Statistic statistic) {
withStatistic(statistic);
}
/**
*
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
*
*
* @param statistic
* The statistic for the metric, other than percentiles. For percentile statistics, use
* ExtendedStatistics.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Statistic
*/
public DescribeAlarmsForMetricRequest withStatistic(Statistic statistic) {
this.statistic = statistic.toString();
return this;
}
/**
*
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
*
*
* @param extendedStatistic
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
*/
public void setExtendedStatistic(String extendedStatistic) {
this.extendedStatistic = extendedStatistic;
}
/**
*
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
*
*
* @return The percentile statistic for the metric. Specify a value between p0.0 and p100.
*/
public String getExtendedStatistic() {
return this.extendedStatistic;
}
/**
*
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
*
*
* @param extendedStatistic
* The percentile statistic for the metric. Specify a value between p0.0 and p100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmsForMetricRequest withExtendedStatistic(String extendedStatistic) {
setExtendedStatistic(extendedStatistic);
return this;
}
/**
*
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
* order for the call to succeed.
*
*
* @return The dimensions associated with the metric. If the metric has any associated dimensions, you must specify
* them in order for the call to succeed.
*/
public java.util.List getDimensions() {
if (dimensions == null) {
dimensions = new com.amazonaws.internal.SdkInternalList();
}
return dimensions;
}
/**
*
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
* order for the call to succeed.
*
*
* @param dimensions
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify
* them in order for the call to succeed.
*/
public void setDimensions(java.util.Collection dimensions) {
if (dimensions == null) {
this.dimensions = null;
return;
}
this.dimensions = new com.amazonaws.internal.SdkInternalList(dimensions);
}
/**
*
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
* order for the call to succeed.
*
*
* 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
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify
* them in order for the call to succeed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmsForMetricRequest 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;
}
/**
*
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
* order for the call to succeed.
*
*
* @param dimensions
* The dimensions associated with the metric. If the metric has any associated dimensions, you must specify
* them in order for the call to succeed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmsForMetricRequest withDimensions(java.util.Collection dimensions) {
setDimensions(dimensions);
return this;
}
/**
*
* The period, in seconds, over which the statistic is applied.
*
*
* @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.
*
*
* @return The period, in seconds, over which the statistic is applied.
*/
public Integer getPeriod() {
return this.period;
}
/**
*
* The period, in seconds, over which the statistic is applied.
*
*
* @param period
* The period, in seconds, over which the statistic is applied.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeAlarmsForMetricRequest withPeriod(Integer period) {
setPeriod(period);
return this;
}
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @see StandardUnit
*/
public void setUnit(String unit) {
this.unit = unit;
}
/**
*
* The unit for the metric.
*
*
* @return The unit for the metric.
* @see StandardUnit
*/
public String getUnit() {
return this.unit;
}
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @return Returns a reference to this object so that method calls can be chained together.
* @see StandardUnit
*/
public DescribeAlarmsForMetricRequest withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @see StandardUnit
*/
public void setUnit(StandardUnit unit) {
withUnit(unit);
}
/**
*
* The unit for the metric.
*
*
* @param unit
* The unit for the metric.
* @return Returns a reference to this 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. 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 (getMetricName() != null)
sb.append("MetricName: ").append(getMetricName()).append(",");
if (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getStatistic() != null)
sb.append("Statistic: ").append(getStatistic()).append(",");
if (getExtendedStatistic() != null)
sb.append("ExtendedStatistic: ").append(getExtendedStatistic()).append(",");
if (getDimensions() != null)
sb.append("Dimensions: ").append(getDimensions()).append(",");
if (getPeriod() != null)
sb.append("Period: ").append(getPeriod()).append(",");
if (getUnit() != null)
sb.append("Unit: ").append(getUnit());
sb.append("}");
return sb.toString();
}
@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.getExtendedStatistic() == null ^ this.getExtendedStatistic() == null)
return false;
if (other.getExtendedStatistic() != null && other.getExtendedStatistic().equals(this.getExtendedStatistic()) == 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;
}
@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 + ((getExtendedStatistic() == null) ? 0 : getExtendedStatistic().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 DescribeAlarmsForMetricRequest clone() {
return (DescribeAlarmsForMetricRequest) super.clone();
}
}