public class SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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.
NOOP
Constructor and Description |
---|
SetAlarmStateRequest() |
Modifier and Type | Method and Description |
---|---|
SetAlarmStateRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAlarmName()
The descriptive name for the alarm.
|
String |
getStateReason()
The reason that this alarm is set to this specific state (in
human-readable text format)
|
String |
getStateReasonData()
The reason that this alarm is set to this specific state (in
machine-readable JSON format)
|
String |
getStateValue()
The value of the state.
|
int |
hashCode() |
void |
setAlarmName(String alarmName)
The descriptive name for the alarm.
|
void |
setStateReason(String stateReason)
The reason that this alarm is set to this specific state (in
human-readable text format)
|
void |
setStateReasonData(String stateReasonData)
The reason that this alarm is set to this specific state (in
machine-readable JSON format)
|
void |
setStateValue(StateValue stateValue)
The value of the state.
|
void |
setStateValue(String stateValue)
The value of the state.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
SetAlarmStateRequest |
withAlarmName(String alarmName)
The descriptive name for the alarm.
|
SetAlarmStateRequest |
withStateReason(String stateReason)
The reason that this alarm is set to this specific state (in
human-readable text format)
|
SetAlarmStateRequest |
withStateReasonData(String stateReasonData)
The reason that this alarm is set to this specific state (in
machine-readable JSON format)
|
SetAlarmStateRequest |
withStateValue(StateValue stateValue)
The value of the state.
|
SetAlarmStateRequest |
withStateValue(String stateValue)
The value of the state.
|
copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getAlarmName()
Constraints:
Length: 1 - 255
public void setAlarmName(String alarmName)
Constraints:
Length: 1 - 255
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 SetAlarmStateRequest withAlarmName(String alarmName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 255
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 String getStateValue()
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
StateValue
public void setStateValue(String stateValue)
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
stateValue
- The value of the state.StateValue
public SetAlarmStateRequest withStateValue(String stateValue)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
stateValue
- The value of the state.StateValue
public void setStateValue(StateValue stateValue)
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
stateValue
- The value of the state.StateValue
public SetAlarmStateRequest withStateValue(StateValue stateValue)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA
stateValue
- The value of the state.StateValue
public String getStateReason()
Constraints:
Length: 0 - 1023
public void setStateReason(String stateReason)
Constraints:
Length: 0 - 1023
stateReason
- The reason that this alarm is set to this specific state (in
human-readable text format)public SetAlarmStateRequest withStateReason(String stateReason)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 1023
stateReason
- The reason that this alarm is set to this specific state (in
human-readable text format)public String getStateReasonData()
Constraints:
Length: 0 - 4000
public void setStateReasonData(String stateReasonData)
Constraints:
Length: 0 - 4000
stateReasonData
- The reason that this alarm is set to this specific state (in
machine-readable JSON format)public SetAlarmStateRequest withStateReasonData(String stateReasonData)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 4000
stateReasonData
- The reason that this alarm is set to this specific state (in
machine-readable JSON format)public String toString()
toString
in class Object
Object.toString()
public SetAlarmStateRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.