com.amazonaws.services.cloudwatch.model

クラス SetAlarmStateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest

すべての実装されたインタフェース:

java.io.Serializable

public class SetAlarmStateRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the 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.

関連項目:

AmazonCloudWatch.setAlarmState(SetAlarmStateRequest), 直列化された形式

コンストラクタの概要

コンストラクタ

コンストラクタと説明
SetAlarmStateRequest()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
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) Constraints: Length: 0 - 1023
java.lang.String	getStateReasonData() The reason that this alarm is set to this specific state (in machine-readable JSON format) Constraints: Length: 0 - 4000
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) Constraints: Length: 0 - 1023
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
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) Returns a reference to this object so that method calls can be chained together.
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.
SetAlarmStateRequest	withStateValue(StateValue stateValue) The value of the state.
SetAlarmStateRequest	withStateValue(java.lang.String stateValue) The value of the state.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

クラスから継承されたメソッド java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

SetAlarmStateRequest

public SetAlarmStateRequest()

メソッドの詳細

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

戻り値:

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

パラメータ:

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

パラメータ:

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

getStateValue

public java.lang.String getStateValue()

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

戻り値:

The value of the state.

関連項目:

StateValue

setStateValue

public void setStateValue(java.lang.String stateValue)

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

パラメータ:

stateValue - The value of the state.

関連項目:

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

パラメータ:

stateValue - The value of the state.

関連項目:

StateValue

setStateValue

public void setStateValue(StateValue stateValue)

The value of the state.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

パラメータ:

stateValue - The value of the state.

関連項目:

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

パラメータ:

stateValue - The value of the state.

関連項目:

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

戻り値:

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

パラメータ:

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

パラメータ:

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

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

戻り値:

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

パラメータ:

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

パラメータ:

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

toString

public java.lang.String toString()

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

オーバーライド:

toString クラス内 java.lang.Object

戻り値:

A string representation of this object.

関連項目:

Object.toString()

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

オーバーライド:

equals クラス内 java.lang.Object