com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest 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#setAlarmState(SetAlarmStateRequest) SetAlarmState operation}.
*
* Temporarily sets the state of an alarm. When the updated
* StateValue differs from the previous value, the action
* configured for the appropriate state is invoked. This is not a
* permanent change. The next periodic alarm check (in about a minute)
* will set the alarm to its actual state.
*
*
* @see com.amazonaws.services.cloudwatch.AmazonCloudWatch#setAlarmState(SetAlarmStateRequest)
*/
public class SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*
* Constraints:
* Length: 1 - 255
*/
private String alarmName;
/**
* The value of the state.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*/
private String stateValue;
/**
* The reason that this alarm is set to this specific state (in
* human-readable text format)
*
* Constraints:
* Length: 0 - 1023
*/
private String stateReason;
/**
* The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*
* Constraints:
* Length: 0 - 4000
*/
private String stateReasonData;
/**
* The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*
* Constraints:
* Length: 1 - 255
*
* @return The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*/
public String getAlarmName() {
return alarmName;
}
/**
* The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmName The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*/
public void setAlarmName(String alarmName) {
this.alarmName = alarmName;
}
/**
* The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 255
*
* @param alarmName The descriptive name for the alarm. This name must be unique within
* the user's AWS account. The maximum length is 255 characters.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetAlarmStateRequest withAlarmName(String alarmName) {
this.alarmName = alarmName;
return this;
}
/**
* The value of the state.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @return The value of the state.
*
* @see StateValue
*/
public String getStateValue() {
return stateValue;
}
/**
* The value of the state.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The value of the state.
*
* @see StateValue
*/
public void setStateValue(String stateValue) {
this.stateValue = stateValue;
}
/**
* The value of the state.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The value of the state.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StateValue
*/
public SetAlarmStateRequest withStateValue(String stateValue) {
this.stateValue = stateValue;
return this;
}
/**
* The value of the state.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The value of the state.
*
* @see StateValue
*/
public void setStateValue(StateValue stateValue) {
this.stateValue = stateValue.toString();
}
/**
* The value of the state.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: OK, ALARM, INSUFFICIENT_DATA
*
* @param stateValue The value of the state.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see StateValue
*/
public SetAlarmStateRequest withStateValue(StateValue stateValue) {
this.stateValue = stateValue.toString();
return this;
}
/**
* The reason that this alarm is set to this specific state (in
* human-readable text format)
*
* Constraints:
* Length: 0 - 1023
*
* @return The reason that this alarm is set to this specific state (in
* human-readable text format)
*/
public String getStateReason() {
return stateReason;
}
/**
* The reason that this alarm is set to this specific state (in
* human-readable text format)
*
* Constraints:
* Length: 0 - 1023
*
* @param stateReason The reason that this alarm is set to this specific state (in
* human-readable text format)
*/
public void setStateReason(String stateReason) {
this.stateReason = stateReason;
}
/**
* The reason that this alarm is set to this specific state (in
* human-readable text format)
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 1023
*
* @param stateReason The reason that this alarm is set to this specific state (in
* human-readable text format)
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetAlarmStateRequest withStateReason(String stateReason) {
this.stateReason = stateReason;
return this;
}
/**
* The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*
* Constraints:
* Length: 0 - 4000
*
* @return The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*/
public String getStateReasonData() {
return stateReasonData;
}
/**
* The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*
* Constraints:
* Length: 0 - 4000
*
* @param stateReasonData The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*/
public void setStateReasonData(String stateReasonData) {
this.stateReasonData = stateReasonData;
}
/**
* The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 4000
*
* @param stateReasonData The reason that this alarm is set to this specific state (in
* machine-readable JSON format)
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public SetAlarmStateRequest withStateReasonData(String stateReasonData) {
this.stateReasonData = stateReasonData;
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 (getAlarmName() != null) sb.append("AlarmName: " + getAlarmName() + ",");
if (getStateValue() != null) sb.append("StateValue: " + getStateValue() + ",");
if (getStateReason() != null) sb.append("StateReason: " + getStateReason() + ",");
if (getStateReasonData() != null) sb.append("StateReasonData: " + getStateReasonData() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAlarmName() == null) ? 0 : getAlarmName().hashCode());
hashCode = prime * hashCode + ((getStateValue() == null) ? 0 : getStateValue().hashCode());
hashCode = prime * hashCode + ((getStateReason() == null) ? 0 : getStateReason().hashCode());
hashCode = prime * hashCode + ((getStateReasonData() == null) ? 0 : getStateReasonData().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof SetAlarmStateRequest == false) return false;
SetAlarmStateRequest other = (SetAlarmStateRequest)obj;
if (other.getAlarmName() == null ^ this.getAlarmName() == null) return false;
if (other.getAlarmName() != null && other.getAlarmName().equals(this.getAlarmName()) == 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.getStateReason() == null ^ this.getStateReason() == null) return false;
if (other.getStateReason() != null && other.getStateReason().equals(this.getStateReason()) == false) return false;
if (other.getStateReasonData() == null ^ this.getStateReasonData() == null) return false;
if (other.getStateReasonData() != null && other.getStateReasonData().equals(this.getStateReasonData()) == false) return false;
return true;
}
}