public class MetricAlarm extends Object implements Serializable, Cloneable
The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.
Constructor and Description |
---|
MetricAlarm() |
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's state.
|
List<String> |
getAlarmActions()
The list of actions to execute when this alarm transitions into an
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 for 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 list of dimensions associated with the alarm's associated metric.
|
Integer |
getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
|
List<String> |
getInsufficientDataActions()
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
String |
getMetricName()
The name of the alarm's metric.
|
String |
getNamespace()
The namespace of alarm's associated metric.
|
List<String> |
getOKActions()
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
Integer |
getPeriod()
The period in seconds over which the statistic is applied.
|
String |
getStateReason()
A human-readable explanation for the alarm's state.
|
String |
getStateReasonData()
An explanation for the alarm's state in machine-readable JSON format
|
Date |
getStateUpdatedTimestamp()
The time stamp of the last update to the alarm's state.
|
String |
getStateValue()
The state value for the alarm.
|
String |
getStatistic()
The statistic to apply to the alarm's associated metric.
|
Double |
getThreshold()
The value against which the specified statistic is compared.
|
String |
getUnit()
The unit of the alarm's associated metric.
|
int |
hashCode() |
Boolean |
isActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm's state.
|
void |
setActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm's state.
|
void |
setAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an
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 for 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 list of dimensions associated with the alarm's associated metric.
|
void |
setEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
void |
setInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
void |
setMetricName(String metricName)
The name of the alarm's metric.
|
void |
setNamespace(String namespace)
The namespace of alarm's associated metric.
|
void |
setOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
void |
setPeriod(Integer period)
The period in seconds over which the statistic is applied.
|
void |
setStateReason(String stateReason)
A human-readable explanation for the alarm's state.
|
void |
setStateReasonData(String stateReasonData)
An explanation for the alarm's state in machine-readable JSON format
|
void |
setStateUpdatedTimestamp(Date stateUpdatedTimestamp)
The time stamp of the last update to the alarm's 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 to apply to the alarm's associated metric.
|
void |
setStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
|
void |
setThreshold(Double threshold)
The value against which the specified statistic is compared.
|
void |
setUnit(StandardUnit unit)
The unit of the alarm's associated metric.
|
void |
setUnit(String unit)
The unit of the alarm's associated metric.
|
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's state.
|
MetricAlarm |
withAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. |
MetricAlarm |
withAlarmActions(String... alarmActions)
The list of actions to execute when this alarm transitions into an
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 for 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 list of dimensions associated with the alarm's associated metric.
|
MetricAlarm |
withDimensions(Dimension... dimensions)
The list of dimensions associated with the alarm's associated metric.
|
MetricAlarm |
withEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
MetricAlarm |
withInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
MetricAlarm |
withInsufficientDataActions(String... insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
MetricAlarm |
withMetricName(String metricName)
The name of the alarm's metric.
|
MetricAlarm |
withNamespace(String namespace)
The namespace of alarm's associated metric.
|
MetricAlarm |
withOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
MetricAlarm |
withOKActions(String... oKActions)
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
MetricAlarm |
withPeriod(Integer period)
The period in seconds over which the statistic is applied.
|
MetricAlarm |
withStateReason(String stateReason)
A human-readable explanation for the alarm's state.
|
MetricAlarm |
withStateReasonData(String stateReasonData)
An explanation for the alarm's state in machine-readable JSON format
|
MetricAlarm |
withStateUpdatedTimestamp(Date stateUpdatedTimestamp)
The time stamp of the last update to the alarm's 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 to apply to the alarm's associated metric.
|
MetricAlarm |
withStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
|
MetricAlarm |
withThreshold(Double threshold)
The value against which the specified statistic is compared.
|
MetricAlarm |
withUnit(StandardUnit unit)
The unit of the alarm's associated metric.
|
MetricAlarm |
withUnit(String unit)
The unit of the alarm's associated metric.
|
public void setAlarmName(String alarmName)
The name of the alarm.
alarmName
- The name of the alarm.public String getAlarmName()
The name of the alarm.
public MetricAlarm withAlarmName(String alarmName)
The name of the alarm.
alarmName
- The name of the alarm.public void setAlarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
alarmArn
- The Amazon Resource Name (ARN) of the alarm.public String getAlarmArn()
The Amazon Resource Name (ARN) of the alarm.
public MetricAlarm withAlarmArn(String alarmArn)
The Amazon Resource Name (ARN) of the alarm.
alarmArn
- The Amazon Resource Name (ARN) of the alarm.public void setAlarmDescription(String alarmDescription)
The description for the alarm.
alarmDescription
- The description for the alarm.public String getAlarmDescription()
The description for the alarm.
public MetricAlarm withAlarmDescription(String alarmDescription)
The description for the alarm.
alarmDescription
- The description for the alarm.public void setAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.public Date getAlarmConfigurationUpdatedTimestamp()
The time stamp of the last update to the alarm configuration.
public MetricAlarm withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)
The time stamp of the last update to the alarm configuration.
alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.public void setActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm's state.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm's state.public Boolean getActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm's state.
public MetricAlarm withActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm's state.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm's state.public Boolean isActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm's state.
public List<String> getOKActions()
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public void setOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
oKActions
- The list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public MetricAlarm withOKActions(String... oKActions)
The list of actions to execute when this alarm transitions into an 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.
oKActions
- The list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public MetricAlarm withOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
oKActions
- The list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public List<String> getAlarmActions()
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
ALARM
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).public void setAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
alarmActions
- The list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public MetricAlarm withAlarmActions(String... alarmActions)
The list of actions to execute when this alarm transitions into an 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.
alarmActions
- The list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public MetricAlarm withAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
alarmActions
- The list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).public List<String> getInsufficientDataActions()
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
public void setInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
insufficientDataActions
- The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
public MetricAlarm withInsufficientDataActions(String... insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
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.
insufficientDataActions
- The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
public MetricAlarm withInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
insufficientDataActions
- The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
The current WSDL lists this attribute as UnknownActions
.
public void setStateValue(String stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
public String getStateValue()
The state value for the alarm.
StateValue
public MetricAlarm withStateValue(String stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
public void setStateValue(StateValue stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
public MetricAlarm withStateValue(StateValue stateValue)
The state value for the alarm.
stateValue
- The state value for the alarm.StateValue
public void setStateReason(String stateReason)
A human-readable explanation for the alarm's state.
stateReason
- A human-readable explanation for the alarm's state.public String getStateReason()
A human-readable explanation for the alarm's state.
public MetricAlarm withStateReason(String stateReason)
A human-readable explanation for the alarm's state.
stateReason
- A human-readable explanation for the alarm's state.public void setStateReasonData(String stateReasonData)
An explanation for the alarm's state in machine-readable JSON format
stateReasonData
- An explanation for the alarm's state in machine-readable JSON formatpublic String getStateReasonData()
An explanation for the alarm's state in machine-readable JSON format
public MetricAlarm withStateReasonData(String stateReasonData)
An explanation for the alarm's state in machine-readable JSON format
stateReasonData
- An explanation for the alarm's state in machine-readable JSON formatpublic void setStateUpdatedTimestamp(Date stateUpdatedTimestamp)
The time stamp of the last update to the alarm's state.
stateUpdatedTimestamp
- The time stamp of the last update to the alarm's state.public Date getStateUpdatedTimestamp()
The time stamp of the last update to the alarm's state.
public MetricAlarm withStateUpdatedTimestamp(Date stateUpdatedTimestamp)
The time stamp of the last update to the alarm's state.
stateUpdatedTimestamp
- The time stamp of the last update to the alarm's state.public void setMetricName(String metricName)
The name of the alarm's metric.
metricName
- The name of the alarm's metric.public String getMetricName()
The name of the alarm's metric.
public MetricAlarm withMetricName(String metricName)
The name of the alarm's metric.
metricName
- The name of the alarm's metric.public void setNamespace(String namespace)
The namespace of alarm's associated metric.
namespace
- The namespace of alarm's associated metric.public String getNamespace()
The namespace of alarm's associated metric.
public MetricAlarm withNamespace(String namespace)
The namespace of alarm's associated metric.
namespace
- The namespace of alarm's associated metric.public void setStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public String getStatistic()
The statistic to apply to the alarm's associated metric.
Statistic
public MetricAlarm withStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public void setStatistic(Statistic statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public MetricAlarm withStatistic(Statistic statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public List<Dimension> getDimensions()
The list of dimensions associated with the alarm's associated metric.
public void setDimensions(Collection<Dimension> dimensions)
The list of dimensions associated with the alarm's associated metric.
dimensions
- The list of dimensions associated with the alarm's associated metric.public MetricAlarm withDimensions(Dimension... dimensions)
The list of dimensions associated with the alarm's associated metric.
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.
dimensions
- The list of dimensions associated with the alarm's associated metric.public MetricAlarm withDimensions(Collection<Dimension> dimensions)
The list of dimensions associated with the alarm's associated metric.
dimensions
- The list of dimensions associated with the alarm's associated metric.public void setPeriod(Integer period)
The period in seconds over which the statistic is applied.
period
- The period in seconds over which the statistic is applied.public Integer getPeriod()
The period in seconds over which the statistic is applied.
public MetricAlarm withPeriod(Integer period)
The period in seconds over which the statistic is applied.
period
- The period in seconds over which the statistic is applied.public void setUnit(String unit)
The unit of the alarm's associated metric.
unit
- The unit of the alarm's associated metric.StandardUnit
public String getUnit()
The unit of the alarm's associated metric.
StandardUnit
public MetricAlarm withUnit(String unit)
The unit of the alarm's associated metric.
unit
- The unit of the alarm's associated metric.StandardUnit
public void setUnit(StandardUnit unit)
The unit of the alarm's associated metric.
unit
- The unit of the alarm's associated metric.StandardUnit
public MetricAlarm withUnit(StandardUnit unit)
The unit of the alarm's associated metric.
unit
- The unit of the alarm's associated metric.StandardUnit
public void setEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold.public Integer getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
public MetricAlarm withEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold.public void setThreshold(Double threshold)
The value against which the specified statistic is compared.
threshold
- The value against which the specified statistic is compared.public Double getThreshold()
The value against which the specified statistic is compared.
public MetricAlarm withThreshold(Double threshold)
The value against which the specified statistic is compared.
threshold
- The value against which the specified statistic is compared.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.
comparisonOperator
- The arithmetic operation to use when comparing the specified Statistic
and
Threshold
. The specified Statistic
value is used as the first operand.ComparisonOperator
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.
Statistic
and
Threshold
. The specified Statistic
value is used as the first operand.ComparisonOperator
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.
comparisonOperator
- The arithmetic operation to use when comparing the specified Statistic
and
Threshold
. The specified Statistic
value is used as the first operand.ComparisonOperator
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.
comparisonOperator
- The arithmetic operation to use when comparing the specified Statistic
and
Threshold
. The specified Statistic
value is used as the first operand.ComparisonOperator
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.
comparisonOperator
- The arithmetic operation to use when comparing the specified Statistic
and
Threshold
. The specified Statistic
value is used as the first operand.ComparisonOperator
public String toString()
toString
in class Object
Object.toString()
public MetricAlarm clone()
Copyright © 2016. All rights reserved.