com.amazonaws.services.cloudwatch.model

Class CompositeAlarm

java.lang.Object

com.amazonaws.services.cloudwatch.model.CompositeAlarm

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CompositeAlarm
extends Object
implements Serializable, Cloneable

The details about a composite alarm.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositeAlarm()

Method Summary

Modifier and Type	Method and Description
CompositeAlarm	clone()
boolean	equals(Object obj)
Boolean	getActionsEnabled() Indicates whether actions should be executed during any changes to the alarm state.
List<String>	getAlarmActions() The actions to execute when this alarm transitions to the ALARM state from any other state.
String	getAlarmArn() The Amazon Resource Name (ARN) of the alarm.
Date	getAlarmConfigurationUpdatedTimestamp() The time stamp of the last update to the alarm configuration.
String	getAlarmDescription() The description of the alarm.
String	getAlarmName() The name of the alarm.
String	getAlarmRule() The rule that this alarm uses to evaluate its alarm state.
List<String>	getInsufficientDataActions() The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
List<String>	getOKActions() The actions to execute when this alarm transitions to the OK state from any other state.
String	getStateReason() An explanation for the alarm state, in text format.
String	getStateReasonData() An explanation for the alarm state, in JSON format.
Date	getStateUpdatedTimestamp() The time stamp of the last update to the alarm state.
String	getStateValue() The state value for the alarm.
int	hashCode()
Boolean	isActionsEnabled() Indicates whether actions should be executed during any changes to the alarm state.
void	setActionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state.
void	setAlarmActions(Collection<String> alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.
void	setAlarmArn(String alarmArn) The Amazon Resource Name (ARN) of the alarm.
void	setAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.
void	setAlarmDescription(String alarmDescription) The description of the alarm.
void	setAlarmName(String alarmName) The name of the alarm.
void	setAlarmRule(String alarmRule) The rule that this alarm uses to evaluate its alarm state.
void	setInsufficientDataActions(Collection<String> insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
void	setOKActions(Collection<String> oKActions) The actions to execute when this alarm transitions to the OK state from any other state.
void	setStateReason(String stateReason) An explanation for the alarm state, in text format.
void	setStateReasonData(String stateReasonData) An explanation for the alarm state, in JSON format.
void	setStateUpdatedTimestamp(Date stateUpdatedTimestamp) The time stamp of the last update to the alarm state.
void	setStateValue(String stateValue) The state value for the alarm.
String	toString() Returns a string representation of this object.
CompositeAlarm	withActionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state.
CompositeAlarm	withAlarmActions(Collection<String> alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.
CompositeAlarm	withAlarmActions(String... alarmActions) The actions to execute when this alarm transitions to the ALARM state from any other state.
CompositeAlarm	withAlarmArn(String alarmArn) The Amazon Resource Name (ARN) of the alarm.
CompositeAlarm	withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.
CompositeAlarm	withAlarmDescription(String alarmDescription) The description of the alarm.
CompositeAlarm	withAlarmName(String alarmName) The name of the alarm.
CompositeAlarm	withAlarmRule(String alarmRule) The rule that this alarm uses to evaluate its alarm state.
CompositeAlarm	withInsufficientDataActions(Collection<String> insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
CompositeAlarm	withInsufficientDataActions(String... insufficientDataActions) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
CompositeAlarm	withOKActions(Collection<String> oKActions) The actions to execute when this alarm transitions to the OK state from any other state.
CompositeAlarm	withOKActions(String... oKActions) The actions to execute when this alarm transitions to the OK state from any other state.
CompositeAlarm	withStateReason(String stateReason) An explanation for the alarm state, in text format.
CompositeAlarm	withStateReasonData(String stateReasonData) An explanation for the alarm state, in JSON format.
CompositeAlarm	withStateUpdatedTimestamp(Date stateUpdatedTimestamp) The time stamp of the last update to the alarm state.
CompositeAlarm	withStateValue(StateValue stateValue) The state value for the alarm.
CompositeAlarm	withStateValue(String stateValue) The state value for the alarm.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeAlarm

public CompositeAlarm()

Method Detail

setActionsEnabled

public void setActionsEnabled(Boolean actionsEnabled)

Indicates whether actions should be executed during any changes to the alarm state.

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.

getActionsEnabled

public Boolean getActionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

Indicates whether actions should be executed during any changes to the alarm state.

withActionsEnabled

public CompositeAlarm withActionsEnabled(Boolean actionsEnabled)

Indicates whether actions should be executed during any changes to the alarm state.

Parameters:

actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state.

Returns:

Returns a reference to this object so that method calls can be chained together.

isActionsEnabled

public Boolean isActionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

Indicates whether actions should be executed during any changes to the alarm state.

getAlarmActions

public List<String> getAlarmActions()

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

setAlarmActions

public void setAlarmActions(Collection<String> alarmActions)

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

withAlarmActions

public CompositeAlarm withAlarmActions(String... alarmActions)

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

NOTE: This method appends the values to the existing list (if any). Use setAlarmActions(java.util.Collection) or withAlarmActions(java.util.Collection) if you want to override the existing values.

Parameters:

alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

withAlarmActions

public CompositeAlarm withAlarmActions(Collection<String> alarmActions)

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

alarmActions - The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmArn

public void setAlarmArn(String alarmArn)

The Amazon Resource Name (ARN) of the alarm.

Parameters:

alarmArn - The Amazon Resource Name (ARN) of the alarm.

getAlarmArn

public String getAlarmArn()

The Amazon Resource Name (ARN) of the alarm.

Returns:

The Amazon Resource Name (ARN) of the alarm.

withAlarmArn

public CompositeAlarm withAlarmArn(String alarmArn)

The Amazon Resource Name (ARN) of the alarm.

Parameters:

alarmArn - The Amazon Resource Name (ARN) of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmConfigurationUpdatedTimestamp

public void setAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)

The time stamp of the last update to the alarm configuration.

Parameters:

alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.

getAlarmConfigurationUpdatedTimestamp

public Date getAlarmConfigurationUpdatedTimestamp()

The time stamp of the last update to the alarm configuration.

Returns:

The time stamp of the last update to the alarm configuration.

withAlarmConfigurationUpdatedTimestamp

public CompositeAlarm withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)

The time stamp of the last update to the alarm configuration.

Parameters:

alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmDescription

public void setAlarmDescription(String alarmDescription)

The description of the alarm.

Parameters:

alarmDescription - The description of the alarm.

getAlarmDescription

public String getAlarmDescription()

The description of the alarm.

Returns:

The description of the alarm.

withAlarmDescription

public CompositeAlarm withAlarmDescription(String alarmDescription)

The description of the alarm.

Parameters:

alarmDescription - The description of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmName

public void setAlarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - The name of the alarm.

getAlarmName

public String getAlarmName()

The name of the alarm.

Returns:

The name of the alarm.

withAlarmName

public CompositeAlarm withAlarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - The name of the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmRule

public void setAlarmRule(String alarmRule)

The rule that this alarm uses to evaluate its alarm state.

Parameters:

alarmRule - The rule that this alarm uses to evaluate its alarm state.

getAlarmRule

public String getAlarmRule()

The rule that this alarm uses to evaluate its alarm state.

Returns:

The rule that this alarm uses to evaluate its alarm state.

withAlarmRule

public CompositeAlarm withAlarmRule(String alarmRule)

The rule that this alarm uses to evaluate its alarm state.

Parameters:

alarmRule - The rule that this alarm uses to evaluate its alarm state.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInsufficientDataActions

public List<String> getInsufficientDataActions()

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

setInsufficientDataActions

public void setInsufficientDataActions(Collection<String> insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

withInsufficientDataActions

public CompositeAlarm withInsufficientDataActions(String... insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

NOTE: This method appends the values to the existing list (if any). Use setInsufficientDataActions(java.util.Collection) or withInsufficientDataActions(java.util.Collection) if you want to override the existing values.

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

withInsufficientDataActions

public CompositeAlarm withInsufficientDataActions(Collection<String> insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

getOKActions

public List<String> getOKActions()

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

setOKActions

public void setOKActions(Collection<String> oKActions)

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

oKActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

withOKActions

public CompositeAlarm withOKActions(String... oKActions)

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

NOTE: This method appends the values to the existing list (if any). Use setOKActions(java.util.Collection) or withOKActions(java.util.Collection) if you want to override the existing values.

Parameters:

oKActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

withOKActions

public CompositeAlarm withOKActions(Collection<String> oKActions)

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Parameters:

oKActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

Returns a reference to this object so that method calls can be chained together.

setStateReason

public void setStateReason(String stateReason)

An explanation for the alarm state, in text format.

Parameters:

stateReason - An explanation for the alarm state, in text format.

getStateReason

public String getStateReason()

An explanation for the alarm state, in text format.

Returns:

An explanation for the alarm state, in text format.

withStateReason

public CompositeAlarm withStateReason(String stateReason)

An explanation for the alarm state, in text format.

Parameters:

stateReason - An explanation for the alarm state, in text format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStateReasonData

public void setStateReasonData(String stateReasonData)

An explanation for the alarm state, in JSON format.

Parameters:

stateReasonData - An explanation for the alarm state, in JSON format.

getStateReasonData

public String getStateReasonData()

An explanation for the alarm state, in JSON format.

Returns:

An explanation for the alarm state, in JSON format.

withStateReasonData

public CompositeAlarm withStateReasonData(String stateReasonData)

An explanation for the alarm state, in JSON format.

Parameters:

stateReasonData - An explanation for the alarm state, in JSON format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStateUpdatedTimestamp

public void setStateUpdatedTimestamp(Date stateUpdatedTimestamp)

The time stamp of the last update to the alarm state.

Parameters:

stateUpdatedTimestamp - The time stamp of the last update to the alarm state.

getStateUpdatedTimestamp

public Date getStateUpdatedTimestamp()

The time stamp of the last update to the alarm state.

Returns:

The time stamp of the last update to the alarm state.

withStateUpdatedTimestamp

public CompositeAlarm withStateUpdatedTimestamp(Date stateUpdatedTimestamp)

The time stamp of the last update to the alarm state.

Parameters:

stateUpdatedTimestamp - The time stamp of the last update to the alarm state.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStateValue

public void setStateValue(String stateValue)

The state value for the alarm.

Parameters:

stateValue - The state value for the alarm.

See Also:

StateValue

getStateValue

public String getStateValue()

The state value for the alarm.

Returns:

The state value for the alarm.

See Also:

StateValue

withStateValue

public CompositeAlarm withStateValue(String stateValue)

The state value for the alarm.

Parameters:

stateValue - The state value for the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StateValue

withStateValue

public CompositeAlarm withStateValue(StateValue stateValue)

The state value for the alarm.

Parameters:

stateValue - The state value for the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StateValue

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CompositeAlarm clone()

Overrides:

clone in class Object