com.amazonaws.services.cloudwatch.model

Class SetAlarmStateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SetAlarmStateRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm's state to ALARM will send an Amazon SNS message. This is not a permanent change. The next periodic alarm check (in about a minute) will set the alarm to its actual state. Because the alarm state change happens very quickly, it is typically only visibile in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetAlarmStateRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAlarmName() The descriptive name for the alarm.
java.lang.String	getStateReason() The reason that this alarm is set to this specific state (in human-readable text format)
java.lang.String	getStateReasonData() The reason that this alarm is set to this specific state (in machine-readable JSON format)
java.lang.String	getStateValue() The value of the state.
int	hashCode()
void	setAlarmName(java.lang.String alarmName) The descriptive name for the alarm.
void	setStateReason(java.lang.String stateReason) The reason that this alarm is set to this specific state (in human-readable text format)
void	setStateReasonData(java.lang.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(java.lang.String stateValue) The value of the state.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SetAlarmStateRequest	withAlarmName(java.lang.String alarmName) The descriptive name for the alarm.
SetAlarmStateRequest	withStateReason(java.lang.String stateReason) The reason that this alarm is set to this specific state (in human-readable text format)
SetAlarmStateRequest	withStateReasonData(java.lang.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(java.lang.String stateValue) The value of the state.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetAlarmStateRequest

public SetAlarmStateRequest()

Method Detail

getAlarmName

public java.lang.String getAlarmName()

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

Returns:

The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.

setAlarmName

public void setAlarmName(java.lang.String 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

Parameters:

alarmName -

The descriptive name for the alarm. This name must be unique within the user's AWS account. The maximum length is 255 characters.

withAlarmName

public SetAlarmStateRequest withAlarmName(java.lang.String 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

Parameters:

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 updated object so that method calls can be chained together.

getStateValue

public java.lang.String getStateValue()

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Returns:

The value of the state.

See Also:

StateValue

setStateValue

public void setStateValue(java.lang.String stateValue)

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue -

The value of the state.

See Also:

StateValue

withStateValue

public SetAlarmStateRequest withStateValue(java.lang.String 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

Parameters:

stateValue -

The value of the state.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StateValue

setStateValue

public void setStateValue(StateValue stateValue)

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue -

The value of the state.

See Also:

StateValue

withStateValue

public SetAlarmStateRequest withStateValue(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

Parameters:

stateValue -

The value of the state.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StateValue

getStateReason

public java.lang.String getStateReason()

The reason that this alarm is set to this specific state (in human-readable text format)

Constraints:
Length: 0 - 1023

Returns:

The reason that this alarm is set to this specific state (in human-readable text format)

setStateReason

public void setStateReason(java.lang.String stateReason)

The reason that this alarm is set to this specific state (in human-readable text format)

Constraints:
Length: 0 - 1023

Parameters:

stateReason -

The reason that this alarm is set to this specific state (in human-readable text format)

withStateReason

public SetAlarmStateRequest withStateReason(java.lang.String 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

Parameters:

stateReason -

The reason that this alarm is set to this specific state (in human-readable text format)

Returns:

A reference to this updated object so that method calls can be chained together.

getStateReasonData

public java.lang.String getStateReasonData()

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Constraints:
Length: 0 - 4000

Returns:

The reason that this alarm is set to this specific state (in machine-readable JSON format)

setStateReasonData

public void setStateReasonData(java.lang.String stateReasonData)

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Constraints:
Length: 0 - 4000

Parameters:

stateReasonData -

The reason that this alarm is set to this specific state (in machine-readable JSON format)

withStateReasonData

public SetAlarmStateRequest withStateReasonData(java.lang.String 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

Parameters:

stateReasonData -

The reason that this alarm is set to this specific state (in machine-readable JSON format)

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object