java.lang.Object
- org.jclouds.cloudwatch.domain.Alarm

```
@Beta
public class Alarm
extends Object
```
See Also:

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Alarm.State

Constructor Summary

Constructors
Constructor Description

Alarm(boolean areActionsEnabled, Set<String> alarmActions, String alarmARN, Date alarmConfigurationUpdatedTimestamp, String alarmDescription, String alarmName, ComparisonOperator comparisonOperator, Set<Dimension> dimensions, int evaluationPeriods, Set<String> insufficientDataActions, String metricName, String namespace, Set<String> okActions, int period, String stateReason, com.google.common.base.Optional<String> stateReasonData, Date stateUpdatedTimestamp, Alarm.State state, Statistics statistic, double threshold, com.google.common.base.Optional<Unit> unit)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean areActionsEnabled()
return whether actions are enabled if the alarm state changes

boolean equals(Object obj)

Set<String> getAlarmActions()
return list of actions to perform when the alarm state changes to Alarm.State.ALARM from any other state

String getAlarmARN()
return the Amazon Resource Name (ARN) of the alarm

Date getAlarmConfigurationUpdatedTimestamp()
return the date timestamp of when the alarm was last updated

String getAlarmDescription()
return the description of the alarm

String getAlarmName()
return the name of the alarm

ComparisonOperator getComparisonOperator()
return the arithmetic operation to use when comparing the specified statistic and threshold

Set<Dimension> getDimensions()
return the list of dimensions associated with the alarm's associated metric

int getEvaluationPeriods()
return the number of periods over which data is compared to the specified threshold

Set<String> getInsufficientDataActions()
return the list of actions to execute when this alarm transitions into an Alarm.State.INSUFFICIENT_DATA state from any other state

String getMetricName()
return the name of the alarm's metric

String getNamespace()
return the namespace of alarm's associated metric

Set<String> getOkActions()
return the list of actions to execute when this alarm transitions into an Alarm.State.OK state from any other state

int getPeriod()
return the period in seconds over which the statistic is applied

Alarm.State getState()
return the state value for the alarm

String getStateReason()
return the human-readable explanation for the alarm's state

com.google.common.base.Optional<String> getStateReasonData()
return the explanation for the alarm's state in machine-readable JSON format

Date getStateUpdatedTimestamp()
return the time stamp of the last update to the alarm's state

Statistics getStatistic()
return the statistic to apply to the alarm's associated metric

double getThreshold()
return the value against which the specified statistic is compared

com.google.common.base.Optional<Unit> getUnit()
return the unit of the alarm's associated metric

int hashCode()

String toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Alarm

public Alarm(boolean areActionsEnabled,
             Set<String> alarmActions,
             String alarmARN,
             Date alarmConfigurationUpdatedTimestamp,
             String alarmDescription,
             String alarmName,
             ComparisonOperator comparisonOperator,
             Set<Dimension> dimensions,
             int evaluationPeriods,
             Set<String> insufficientDataActions,
             String metricName,
             String namespace,
             Set<String> okActions,
             int period,
             String stateReason,
             com.google.common.base.Optional<String> stateReasonData,
             Date stateUpdatedTimestamp,
             Alarm.State state,
             Statistics statistic,
             double threshold,
             com.google.common.base.Optional<Unit> unit)

Method Detail
- areActionsEnabled
```
public boolean areActionsEnabled()
```
  return whether actions are enabled if the alarm state changes
- getAlarmActions
```
public Set<String> getAlarmActions()
```
  return list of actions to perform when the alarm state changes to Alarm.State.ALARM from any other state
- getAlarmARN
```
public String getAlarmARN()
```
  return the Amazon Resource Name (ARN) of the alarm
- getAlarmConfigurationUpdatedTimestamp
```
public Date getAlarmConfigurationUpdatedTimestamp()
```
  return the date timestamp of when the alarm was last updated
- getAlarmDescription
```
public String getAlarmDescription()
```
  return the description of the alarm
- getAlarmName
```
public String getAlarmName()
```
  return the name of the alarm
- getComparisonOperator
```
public ComparisonOperator getComparisonOperator()
```
  return the arithmetic operation to use when comparing the specified statistic and threshold
- getDimensions
```
public Set<Dimension> getDimensions()
```
  return the list of dimensions associated with the alarm's associated metric
- getEvaluationPeriods
```
public int getEvaluationPeriods()
```
  return the number of periods over which data is compared to the specified threshold
- getInsufficientDataActions
```
public Set<String> getInsufficientDataActions()
```
  return the list of actions to execute when this alarm transitions into an Alarm.State.INSUFFICIENT_DATA state from any other state
- getMetricName
```
public String getMetricName()
```
  return the name of the alarm's metric
- getNamespace
```
public String getNamespace()
```
  return the namespace of alarm's associated metric
- getOkActions
```
public Set<String> getOkActions()
```
  return the list of actions to execute when this alarm transitions into an Alarm.State.OK state from any other state
- getPeriod
```
public int getPeriod()
```
  return the period in seconds over which the statistic is applied
- getStateReason
```
public String getStateReason()
```
  return the human-readable explanation for the alarm's state
- getStateReasonData
```
public com.google.common.base.Optional<String> getStateReasonData()
```
  return the explanation for the alarm's state in machine-readable JSON format
- getStateUpdatedTimestamp
```
public Date getStateUpdatedTimestamp()
```
  return the time stamp of the last update to the alarm's state
- getState
```
public Alarm.State getState()
```
  return the state value for the alarm
- getStatistic
```
public Statistics getStatistic()
```
  return the statistic to apply to the alarm's associated metric
- getThreshold
```
public double getThreshold()
```
  return the value against which the specified statistic is compared
- getUnit
```
public com.google.common.base.Optional<Unit> getUnit()
```
  return the unit of the alarm's associated metric
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Modifier and Type	Method	Description
`boolean`	`areActionsEnabled()`	return whether actions are enabled if the alarm state changes
`boolean`	`equals(Object obj)`
`Set<String>`	`getAlarmActions()`	return list of actions to perform when the alarm state changes to `Alarm.State.ALARM` from any other state
`String`	`getAlarmARN()`	return the Amazon Resource Name (ARN) of the alarm
`Date`	`getAlarmConfigurationUpdatedTimestamp()`	return the date timestamp of when the alarm was last updated
`String`	`getAlarmDescription()`	return the description of the alarm
`String`	`getAlarmName()`	return the name of the alarm
`ComparisonOperator`	`getComparisonOperator()`	return the arithmetic operation to use when comparing the specified statistic and threshold
`Set<Dimension>`	`getDimensions()`	return the list of dimensions associated with the alarm's associated metric
`int`	`getEvaluationPeriods()`	return the number of periods over which data is compared to the specified threshold
`Set<String>`	`getInsufficientDataActions()`	return the list of actions to execute when this alarm transitions into an `Alarm.State.INSUFFICIENT_DATA` state from any other state
`String`	`getMetricName()`	return the name of the alarm's metric
`String`	`getNamespace()`	return the namespace of alarm's associated metric
`Set<String>`	`getOkActions()`	return the list of actions to execute when this alarm transitions into an `Alarm.State.OK` state from any other state
`int`	`getPeriod()`	return the period in seconds over which the statistic is applied
`Alarm.State`	`getState()`	return the state value for the alarm
`String`	`getStateReason()`	return the human-readable explanation for the alarm's state
`com.google.common.base.Optional<String>`	`getStateReasonData()`	return the explanation for the alarm's state in machine-readable JSON format
`Date`	`getStateUpdatedTimestamp()`	return the time stamp of the last update to the alarm's state
`Statistics`	`getStatistic()`	return the statistic to apply to the alarm's associated metric
`double`	`getThreshold()`	return the value against which the specified statistic is compared
`com.google.common.base.Optional<Unit>`	`getUnit()`	return the unit of the alarm's associated metric
`int`	`hashCode()`
`String`	`toString()`

Class Alarm

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Alarm

Method Detail

areActionsEnabled

getAlarmActions

getAlarmARN

getAlarmConfigurationUpdatedTimestamp

getAlarmDescription

getAlarmName

getComparisonOperator

getDimensions

getEvaluationPeriods

getInsufficientDataActions

getMetricName

getNamespace

getOkActions

getPeriod

getStateReason

getStateReasonData

getStateUpdatedTimestamp

getState

getStatistic

getThreshold

getUnit

hashCode

equals

toString