com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest 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#describeAlarms(DescribeAlarmsRequest) DescribeAlarms operation}.
*
* Retrieves alarms with the specified names. If no name is specified,
* all alarms for the user are returned. Alarms can be retrieved by using
* only a prefix for the alarm name, the alarm state, or a prefix for any
* action.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#describeAlarms(DescribeAlarmsRequest)
*/
public class DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A list of alarm names to retrieve information for.
*
* Constraints:
* Length: 0 - 100
*/
private com.amazonaws.internal.ListWithAutoConstructFlag alarmNames;
/**
* The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*
* Constraints:
* Length: 1 - 255
*/
private String alarmNamePrefix;
/**
* The state value to be used in matching alarms.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*/
private String stateValue;
/**
* The action name prefix.
*
* Constraints:
* Length: 1 - 1024
*/
private String actionPrefix;
/**
* The maximum number of alarm descriptions to retrieve.
*
* Constraints:
* Range: 1 - 100
*/
private Integer maxRecords;
/**
* The token returned by a previous call to indicate that there is more
* data available.
*/
private String nextToken;
/**
* A list of alarm names to retrieve information for.
*
* Constraints:
* Length: 0 - 100
*
* @return A list of alarm names to retrieve information for.
*/
public java.util.List getAlarmNames() {
if (alarmNames == null) {
alarmNames = new com.amazonaws.internal.ListWithAutoConstructFlag();
alarmNames.setAutoConstruct(true);
}
return alarmNames;
}
/**
* A list of alarm names to retrieve information for.
*
* Constraints:
* Length: 0 - 100
*
* @param alarmNames A list of alarm names to retrieve information for.
*/
public void setAlarmNames(java.util.Collection alarmNames) {
if (alarmNames == null) {
this.alarmNames = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag alarmNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(alarmNames.size());
alarmNamesCopy.addAll(alarmNames);
this.alarmNames = alarmNamesCopy;
}
/**
* A list of alarm names to retrieve information for.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 100
*
* @param alarmNames A list of alarm names to retrieve information for.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsRequest withAlarmNames(String... alarmNames) {
if (getAlarmNames() == null) setAlarmNames(new java.util.ArrayList(alarmNames.length));
for (String value : alarmNames) {
getAlarmNames().add(value);
}
return this;
}
/**
* A list of alarm names to retrieve information for.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 100
*
* @param alarmNames A list of alarm names to retrieve information for.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsRequest withAlarmNames(java.util.Collection alarmNames) {
if (alarmNames == null) {
this.alarmNames = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag alarmNamesCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(alarmNames.size());
alarmNamesCopy.addAll(alarmNames);
this.alarmNames = alarmNamesCopy;
}
return this;
}
/**
* The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*
* Constraints:
* Length: 1 - 255
*
* @return The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*/
public String getAlarmNamePrefix() {
return alarmNamePrefix;
}
/**
* The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmNamePrefix The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*/
public void setAlarmNamePrefix(String alarmNamePrefix) {
this.alarmNamePrefix = alarmNamePrefix;
}
/**
* The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmNamePrefix The alarm name prefix. AlarmNames cannot be specified if
* this parameter is specified.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsRequest withAlarmNamePrefix(String alarmNamePrefix) {
this.alarmNamePrefix = alarmNamePrefix;
return this;
}
/**
* The state value to be used in matching alarms.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @return The state value to be used in matching alarms.
*
* @see StateValue
*/
public String getStateValue() {
return stateValue;
}
/**
* The state value to be used in matching alarms.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The state value to be used in matching alarms.
*
* @see StateValue
*/
public void setStateValue(String stateValue) {
this.stateValue = stateValue;
}
/**
* The state value to be used in matching alarms.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The state value to be used in matching alarms.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StateValue
*/
public DescribeAlarmsRequest withStateValue(String stateValue) {
this.stateValue = stateValue;
return this;
}
/**
* The state value to be used in matching alarms.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The state value to be used in matching alarms.
*
* @see StateValue
*/
public void setStateValue(StateValue stateValue) {
this.stateValue = stateValue.toString();
}
/**
* The state value to be used in matching alarms.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The state value to be used in matching alarms.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StateValue
*/
public DescribeAlarmsRequest withStateValue(StateValue stateValue) {
this.stateValue = stateValue.toString();
return this;
}
/**
* The action name prefix.
*
* Constraints:
* Length: 1 - 1024
*
* @return The action name prefix.
*/
public String getActionPrefix() {
return actionPrefix;
}
/**
* The action name prefix.
*
* Constraints:
* Length: 1 - 1024
*
* @param actionPrefix The action name prefix.
*/
public void setActionPrefix(String actionPrefix) {
this.actionPrefix = actionPrefix;
}
/**
* The action name prefix.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1024
*
* @param actionPrefix The action name prefix.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsRequest withActionPrefix(String actionPrefix) {
this.actionPrefix = actionPrefix;
return this;
}
/**
* The maximum number of alarm descriptions to retrieve.
*
* Constraints:
* Range: 1 - 100
*
* @return The maximum number of alarm descriptions to retrieve.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of alarm descriptions to retrieve.
*
* Constraints:
* Range: 1 - 100
*
* @param maxRecords The maximum number of alarm descriptions to retrieve.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of alarm descriptions to retrieve.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 100
*
* @param maxRecords The maximum number of alarm descriptions to retrieve.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAlarmsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
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 DescribeAlarmsRequest 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 (getAlarmNames() != null) sb.append("AlarmNames: " + getAlarmNames() + ",");
if (getAlarmNamePrefix() != null) sb.append("AlarmNamePrefix: " + getAlarmNamePrefix() + ",");
if (getStateValue() != null) sb.append("StateValue: " + getStateValue() + ",");
if (getActionPrefix() != null) sb.append("ActionPrefix: " + getActionPrefix() + ",");
if (getMaxRecords() != null) sb.append("MaxRecords: " + getMaxRecords() + ",");
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 + ((getAlarmNames() == null) ? 0 : getAlarmNames().hashCode());
hashCode = prime * hashCode + ((getAlarmNamePrefix() == null) ? 0 : getAlarmNamePrefix().hashCode());
hashCode = prime * hashCode + ((getStateValue() == null) ? 0 : getStateValue().hashCode());
hashCode = prime * hashCode + ((getActionPrefix() == null) ? 0 : getActionPrefix().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().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 DescribeAlarmsRequest == false) return false;
DescribeAlarmsRequest other = (DescribeAlarmsRequest)obj;
if (other.getAlarmNames() == null ^ this.getAlarmNames() == null) return false;
if (other.getAlarmNames() != null && other.getAlarmNames().equals(this.getAlarmNames()) == false) return false;
if (other.getAlarmNamePrefix() == null ^ this.getAlarmNamePrefix() == null) return false;
if (other.getAlarmNamePrefix() != null && other.getAlarmNamePrefix().equals(this.getAlarmNamePrefix()) == false) return false;
if (other.getStateValue() == null ^ this.getStateValue() == null) return false;
if (other.getStateValue() != null && other.getStateValue().equals(this.getStateValue()) == false) return false;
if (other.getActionPrefix() == null ^ this.getActionPrefix() == null) return false;
if (other.getActionPrefix() != null && other.getActionPrefix().equals(this.getActionPrefix()) == false) return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null) return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == 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;
}
}