MetricAlarm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.model.MetricAlarm

All Implemented Interfaces:: Serializable, Cloneable

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

Represents an alarm.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricAlarm()

Constructors
Constructor and Description
`MetricAlarm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricAlarm`	`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`	`getComparisonOperator()` The arithmetic operation to use when comparing the specified statistic and threshold.
`List<Dimension>`	`getDimensions()` The dimensions for the metric associated with the alarm.
`String`	`getEvaluateLowSampleCountPercentile()` Used only for alarms based on percentiles.
`Integer`	`getEvaluationPeriods()` The number of periods over which data is compared to the specified threshold.
`String`	`getExtendedStatistic()` The percentile statistic for the metric associated with the alarm.
`List<String>`	`getInsufficientDataActions()` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`String`	`getMetricName()` The name of the metric associated with the alarm.
`String`	`getNamespace()` The namespace of the metric associated with the alarm.
`List<String>`	`getOKActions()` The actions to execute when this alarm transitions to the `OK` state from any other state.
`Integer`	`getPeriod()` The period, in seconds, over which the statistic is applied.
`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.
`String`	`getStatistic()` The statistic for the metric associated with the alarm, other than percentile.
`Double`	`getThreshold()` The value to compare with the specified statistic.
`String`	`getTreatMissingData()` Sets how this alarm is to handle missing data points.
`String`	`getUnit()` The unit of the metric associated with 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`	`setComparisonOperator(ComparisonOperator comparisonOperator)` The arithmetic operation to use when comparing the specified statistic and threshold.
`void`	`setComparisonOperator(String comparisonOperator)` The arithmetic operation to use when comparing the specified statistic and threshold.
`void`	`setDimensions(Collection<Dimension> dimensions)` The dimensions for the metric associated with the alarm.
`void`	`setEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)` Used only for alarms based on percentiles.
`void`	`setEvaluationPeriods(Integer evaluationPeriods)` The number of periods over which data is compared to the specified threshold.
`void`	`setExtendedStatistic(String extendedStatistic)` The percentile statistic for the metric associated with the alarm.
`void`	`setInsufficientDataActions(Collection<String> insufficientDataActions)` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`void`	`setMetricName(String metricName)` The name of the metric associated with the alarm.
`void`	`setNamespace(String namespace)` The namespace of the metric associated with the alarm.
`void`	`setOKActions(Collection<String> oKActions)` The actions to execute when this alarm transitions to the `OK` state from any other state.
`void`	`setPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`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(StateValue stateValue)` The state value for the alarm.
`void`	`setStateValue(String stateValue)` The state value for the alarm.
`void`	`setStatistic(Statistic statistic)` The statistic for the metric associated with the alarm, other than percentile.
`void`	`setStatistic(String statistic)` The statistic for the metric associated with the alarm, other than percentile.
`void`	`setThreshold(Double threshold)` The value to compare with the specified statistic.
`void`	`setTreatMissingData(String treatMissingData)` Sets how this alarm is to handle missing data points.
`void`	`setUnit(StandardUnit unit)` The unit of the metric associated with the alarm.
`void`	`setUnit(String unit)` The unit of the metric associated with the alarm.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`MetricAlarm`	`withActionsEnabled(Boolean actionsEnabled)` Indicates whether actions should be executed during any changes to the alarm state.
`MetricAlarm`	`withAlarmActions(Collection<String> alarmActions)` The actions to execute when this alarm transitions to the `ALARM` state from any other state.
`MetricAlarm`	`withAlarmActions(String... alarmActions)` The actions to execute when this alarm transitions to the `ALARM` state from any other state.
`MetricAlarm`	`withAlarmArn(String alarmArn)` The Amazon Resource Name (ARN) of the alarm.
`MetricAlarm`	`withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)` The time stamp of the last update to the alarm configuration.
`MetricAlarm`	`withAlarmDescription(String alarmDescription)` The description of the alarm.
`MetricAlarm`	`withAlarmName(String alarmName)` The name of the alarm.
`MetricAlarm`	`withComparisonOperator(ComparisonOperator comparisonOperator)` The arithmetic operation to use when comparing the specified statistic and threshold.
`MetricAlarm`	`withComparisonOperator(String comparisonOperator)` The arithmetic operation to use when comparing the specified statistic and threshold.
`MetricAlarm`	`withDimensions(Collection<Dimension> dimensions)` The dimensions for the metric associated with the alarm.
`MetricAlarm`	`withDimensions(Dimension... dimensions)` The dimensions for the metric associated with the alarm.
`MetricAlarm`	`withEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)` Used only for alarms based on percentiles.
`MetricAlarm`	`withEvaluationPeriods(Integer evaluationPeriods)` The number of periods over which data is compared to the specified threshold.
`MetricAlarm`	`withExtendedStatistic(String extendedStatistic)` The percentile statistic for the metric associated with the alarm.
`MetricAlarm`	`withInsufficientDataActions(Collection<String> insufficientDataActions)` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`MetricAlarm`	`withInsufficientDataActions(String... insufficientDataActions)` The actions to execute when this alarm transitions to the `INSUFFICIENT_DATA` state from any other state.
`MetricAlarm`	`withMetricName(String metricName)` The name of the metric associated with the alarm.
`MetricAlarm`	`withNamespace(String namespace)` The namespace of the metric associated with the alarm.
`MetricAlarm`	`withOKActions(Collection<String> oKActions)` The actions to execute when this alarm transitions to the `OK` state from any other state.
`MetricAlarm`	`withOKActions(String... oKActions)` The actions to execute when this alarm transitions to the `OK` state from any other state.
`MetricAlarm`	`withPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`MetricAlarm`	`withStateReason(String stateReason)` An explanation for the alarm state, in text format.
`MetricAlarm`	`withStateReasonData(String stateReasonData)` An explanation for the alarm state, in JSON format.
`MetricAlarm`	`withStateUpdatedTimestamp(Date stateUpdatedTimestamp)` The time stamp of the last update to the alarm state.
`MetricAlarm`	`withStateValue(StateValue stateValue)` The state value for the alarm.
`MetricAlarm`	`withStateValue(String stateValue)` The state value for the alarm.
`MetricAlarm`	`withStatistic(Statistic statistic)` The statistic for the metric associated with the alarm, other than percentile.
`MetricAlarm`	`withStatistic(String statistic)` The statistic for the metric associated with the alarm, other than percentile.
`MetricAlarm`	`withThreshold(Double threshold)` The value to compare with the specified statistic.
`MetricAlarm`	`withTreatMissingData(String treatMissingData)` Sets how this alarm is to handle missing data points.
`MetricAlarm`	`withUnit(StandardUnit unit)` The unit of the metric associated with the alarm.
`MetricAlarm`	`withUnit(String unit)` The unit of the metric associated with the alarm.

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

- Constructor Detail
  - MetricAlarm
```
public MetricAlarm()
```
- Method Detail
  - 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 MetricAlarm 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.
  - 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 MetricAlarm 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.
  - 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 MetricAlarm 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.
  - 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 MetricAlarm 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.
  - 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 MetricAlarm 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.
  - 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 MetricAlarm 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 MetricAlarm 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.
  - 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 MetricAlarm 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 MetricAlarm 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.
  - 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 MetricAlarm 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 MetricAlarm 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.
  - 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 MetricAlarm 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
  - setStateValue
```
public void setStateValue(StateValue stateValue)
```
    The state value for the alarm.
    
    Parameters:
    
    stateValue - The state value for the alarm.
    
    See Also:
    
    StateValue
  - withStateValue
```
public MetricAlarm 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
  - 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 MetricAlarm 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 MetricAlarm 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 MetricAlarm 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.
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the metric associated with the alarm.
    
    Parameters:
    
    metricName - The name of the metric associated with the alarm.
  - getMetricName
```
public String getMetricName()
```
    The name of the metric associated with the alarm.
    
    Returns:
    
    The name of the metric associated with the alarm.
  - withMetricName
```
public MetricAlarm withMetricName(String metricName)
```
    The name of the metric associated with the alarm.
    
    Parameters:
    
    metricName - The name of the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespace
```
public void setNamespace(String namespace)
```
    The namespace of the metric associated with the alarm.
    
    Parameters:
    
    namespace - The namespace of the metric associated with the alarm.
  - getNamespace
```
public String getNamespace()
```
    The namespace of the metric associated with the alarm.
    
    Returns:
    
    The namespace of the metric associated with the alarm.
  - withNamespace
```
public MetricAlarm withNamespace(String namespace)
```
    The namespace of the metric associated with the alarm.
    
    Parameters:
    
    namespace - The namespace of the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatistic
```
public void setStatistic(String statistic)
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Parameters:
    
    statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    See Also:
    
    Statistic
  - getStatistic
```
public String getStatistic()
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Returns:
    
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    See Also:
    
    Statistic
  - withStatistic
```
public MetricAlarm withStatistic(String statistic)
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Parameters:
    
    statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Statistic
  - setStatistic
```
public void setStatistic(Statistic statistic)
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Parameters:
    
    statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    See Also:
    
    Statistic
  - withStatistic
```
public MetricAlarm withStatistic(Statistic statistic)
```
    The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Parameters:
    
    statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Statistic
  - setExtendedStatistic
```
public void setExtendedStatistic(String extendedStatistic)
```
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    
    Parameters:
    
    extendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
  - getExtendedStatistic
```
public String getExtendedStatistic()
```
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    
    Returns:
    
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
  - withExtendedStatistic
```
public MetricAlarm withExtendedStatistic(String extendedStatistic)
```
    The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    
    Parameters:
    
    extendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDimensions
```
public List<Dimension> getDimensions()
```
    The dimensions for the metric associated with the alarm.
    
    Returns:
    
    The dimensions for the metric associated with the alarm.
  - setDimensions
```
public void setDimensions(Collection<Dimension> dimensions)
```
    The dimensions for the metric associated with the alarm.
    
    Parameters:
    
    dimensions - The dimensions for the metric associated with the alarm.
  - withDimensions
```
public MetricAlarm withDimensions(Dimension... dimensions)
```
    The dimensions for the metric associated with the alarm.
    
    NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dimensions - The dimensions for the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public MetricAlarm withDimensions(Collection<Dimension> dimensions)
```
    The dimensions for the metric associated with the alarm.
    
    Parameters:
    
    dimensions - The dimensions for the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPeriod
```
public void setPeriod(Integer period)
```
    The period, in seconds, over which the statistic is applied.
    
    Parameters:
    
    period - The period, in seconds, over which the statistic is applied.
  - getPeriod
```
public Integer getPeriod()
```
    The period, in seconds, over which the statistic is applied.
    
    Returns:
    
    The period, in seconds, over which the statistic is applied.
  - withPeriod
```
public MetricAlarm withPeriod(Integer period)
```
    The period, in seconds, over which the statistic is applied.
    
    Parameters:
    
    period - The period, in seconds, over which the statistic is applied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    The unit of the metric associated with the alarm.
    
    Parameters:
    
    unit - The unit of the metric associated with the alarm.
    
    See Also:
    
    StandardUnit
  - getUnit
```
public String getUnit()
```
    The unit of the metric associated with the alarm.
    
    Returns:
    
    The unit of the metric associated with the alarm.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricAlarm withUnit(String unit)
```
    The unit of the metric associated with the alarm.
    
    Parameters:
    
    unit - The unit of the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - setUnit
```
public void setUnit(StandardUnit unit)
```
    The unit of the metric associated with the alarm.
    
    Parameters:
    
    unit - The unit of the metric associated with the alarm.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricAlarm withUnit(StandardUnit unit)
```
    The unit of the metric associated with the alarm.
    
    Parameters:
    
    unit - The unit of the metric associated with the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - setEvaluationPeriods
```
public void setEvaluationPeriods(Integer evaluationPeriods)
```
    The number of periods over which data is compared to the specified threshold.
    
    Parameters:
    
    evaluationPeriods - The number of periods over which data is compared to the specified threshold.
  - getEvaluationPeriods
```
public Integer getEvaluationPeriods()
```
    The number of periods over which data is compared to the specified threshold.
    
    Returns:
    
    The number of periods over which data is compared to the specified threshold.
  - withEvaluationPeriods
```
public MetricAlarm withEvaluationPeriods(Integer evaluationPeriods)
```
    The number of periods over which data is compared to the specified threshold.
    
    Parameters:
    
    evaluationPeriods - The number of periods over which data is compared to the specified threshold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThreshold
```
public void setThreshold(Double threshold)
```
    The value to compare with the specified statistic.
    
    Parameters:
    
    threshold - The value to compare with the specified statistic.
  - getThreshold
```
public Double getThreshold()
```
    The value to compare with the specified statistic.
    
    Returns:
    
    The value to compare with the specified statistic.
  - withThreshold
```
public MetricAlarm withThreshold(Double threshold)
```
    The value to compare with the specified statistic.
    
    Parameters:
    
    threshold - The value to compare with the specified statistic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComparisonOperator
```
public void setComparisonOperator(String comparisonOperator)
```
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    See Also:
    
    ComparisonOperator
  - getComparisonOperator
```
public String getComparisonOperator()
```
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Returns:
    
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public MetricAlarm withComparisonOperator(String comparisonOperator)
```
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setComparisonOperator
```
public void setComparisonOperator(ComparisonOperator comparisonOperator)
```
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public MetricAlarm withComparisonOperator(ComparisonOperator comparisonOperator)
```
    The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setTreatMissingData
```
public void setTreatMissingData(String treatMissingData)
```
    Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
    
    Parameters:
    
    treatMissingData - Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
  - getTreatMissingData
```
public String getTreatMissingData()
```
    Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
    
    Returns:
    
    Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
  - withTreatMissingData
```
public MetricAlarm withTreatMissingData(String treatMissingData)
```
    Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
    
    Parameters:
    
    treatMissingData - Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEvaluateLowSampleCountPercentile
```
public void setEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
```
    Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
    
    Parameters:
    
    evaluateLowSampleCountPercentile - Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
  - getEvaluateLowSampleCountPercentile
```
public String getEvaluateLowSampleCountPercentile()
```
    Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
    
    Returns:
    
    Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
  - withEvaluateLowSampleCountPercentile
```
public MetricAlarm withEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
```
    Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
    
    Parameters:
    
    evaluateLowSampleCountPercentile - Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    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 MetricAlarm clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class MetricAlarm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricAlarm

Method Detail

setAlarmName

getAlarmName

withAlarmName

setAlarmArn

getAlarmArn

withAlarmArn

setAlarmDescription

getAlarmDescription

withAlarmDescription

setAlarmConfigurationUpdatedTimestamp

getAlarmConfigurationUpdatedTimestamp

withAlarmConfigurationUpdatedTimestamp

setActionsEnabled

getActionsEnabled

withActionsEnabled

isActionsEnabled

getOKActions

setOKActions

withOKActions

withOKActions

getAlarmActions

setAlarmActions

withAlarmActions

withAlarmActions

getInsufficientDataActions

setInsufficientDataActions

withInsufficientDataActions

withInsufficientDataActions

setStateValue

getStateValue

withStateValue

setStateValue

withStateValue

setStateReason

getStateReason

withStateReason

setStateReasonData

getStateReasonData

withStateReasonData

setStateUpdatedTimestamp

getStateUpdatedTimestamp

withStateUpdatedTimestamp

setMetricName

getMetricName

withMetricName

setNamespace

getNamespace

withNamespace

setStatistic

getStatistic

withStatistic

setStatistic

withStatistic

setExtendedStatistic

getExtendedStatistic

withExtendedStatistic

getDimensions

setDimensions

withDimensions

withDimensions

setPeriod

getPeriod

withPeriod

setUnit

getUnit

withUnit

setUnit

withUnit

setEvaluationPeriods

getEvaluationPeriods

withEvaluationPeriods

setThreshold