Package software.amazon.awssdk.services.cloudwatch.model

Class MetricAlarm

java.lang.Object

software.amazon.awssdk.services.cloudwatch.model.MetricAlarm

All Implemented Interfaces:

ToCopyableBuilder<MetricAlarm.Builder,MetricAlarm>

@Generated("software.amazon.awssdk:codegen")
public class MetricAlarm
extends Object
implements ToCopyableBuilder<MetricAlarm.Builder,MetricAlarm>

Represents an alarm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricAlarm.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	actionsEnabled()	Indicates whether actions should be executed during any changes to the alarm state.
List<String>	alarmActions()	The actions to execute when this alarm transitions to the ALARM state from any other state.
String	alarmArn()	The Amazon Resource Name (ARN) of the alarm.
Date	alarmConfigurationUpdatedTimestamp()	The time stamp of the last update to the alarm configuration.
String	alarmDescription()	The description of the alarm.
String	alarmName()	The name of the alarm.
static MetricAlarm.Builder	builder()
String	comparisonOperator()	The arithmetic operation to use when comparing the specified statistic and threshold.
List<Dimension>	dimensions()	The dimensions for the metric associated with the alarm.
boolean	equals(Object obj)
String	evaluateLowSampleCountPercentile()
Integer	evaluationPeriods()	The number of periods over which data is compared to the specified threshold.
String	extendedStatistic()	The percentile statistic for the metric associated with the alarm.
int	hashCode()
List<String>	insufficientDataActions()	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
String	metricName()	The name of the metric associated with the alarm.
String	namespace()	The namespace of the metric associated with the alarm.
List<String>	okActions()	The actions to execute when this alarm transitions to the OK state from any other state.
Integer	period()	The period, in seconds, over which the statistic is applied.
static Class<? extends MetricAlarm.Builder>	serializableBuilderClass()
String	stateReason()	An explanation for the alarm state, in text format.
String	stateReasonData()	An explanation for the alarm state, in JSON format.
Date	stateUpdatedTimestamp()	The time stamp of the last update to the alarm state.
String	stateValue()	The state value for the alarm.
String	statistic()	The statistic for the metric associated with the alarm, other than percentile.
Double	threshold()	The value to compare with the specified statistic.
MetricAlarm.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	treatMissingData()
String	unit()	The unit of the metric associated with the alarm.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

alarmName

public String alarmName()

The name of the alarm.

Returns:

The name of the alarm.

alarmArn

public String alarmArn()

The Amazon Resource Name (ARN) of the alarm.

Returns:

The Amazon Resource Name (ARN) of the alarm.

alarmDescription

public String alarmDescription()

The description of the alarm.

Returns:

The description of the alarm.

alarmConfigurationUpdatedTimestamp

public Date alarmConfigurationUpdatedTimestamp()

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

Returns:

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

actionsEnabled

public Boolean actionsEnabled()

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.

okActions

public List<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).

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).

alarmActions

public List<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).

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).

insufficientDataActions

public List<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).

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).

stateValue

public String stateValue()

The state value for the alarm.

Returns:

The state value for the alarm.

See Also:

StateValue

stateReason

public String stateReason()

An explanation for the alarm state, in text format.

Returns:

An explanation for the alarm state, in text format.

stateReasonData

public String stateReasonData()

An explanation for the alarm state, in JSON format.

Returns:

An explanation for the alarm state, in JSON format.

stateUpdatedTimestamp

public Date stateUpdatedTimestamp()

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

Returns:

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

metricName

public String metricName()

The name of the metric associated with the alarm.

Returns:

The name of the metric associated with the alarm.

namespace

public String namespace()

The namespace of the metric associated with the alarm.

Returns:

The namespace of the metric associated with the alarm.

statistic

public String statistic()

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

extendedStatistic

public String extendedStatistic()

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.

dimensions

public List<Dimension> dimensions()

The dimensions for the metric associated with the alarm.

Returns:

The dimensions for the metric associated with the alarm.

period

public Integer period()

The period, in seconds, over which the statistic is applied.

Returns:

The period, in seconds, over which the statistic is applied.

unit

public String unit()

The unit of the metric associated with the alarm.

Returns:

The unit of the metric associated with the alarm.

See Also:

StandardUnit

evaluationPeriods

public Integer evaluationPeriods()

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.

threshold

public Double threshold()

The value to compare with the specified statistic.

Returns:

The value to compare with the specified statistic.

comparisonOperator

public String comparisonOperator()

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

treatMissingData

public String treatMissingData()

Returns:

evaluateLowSampleCountPercentile

public String evaluateLowSampleCountPercentile()

Returns:

toBuilder

public MetricAlarm.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MetricAlarm.Builder,MetricAlarm>

Returns:

a builder for type T

builder

public static MetricAlarm.Builder builder()

serializableBuilderClass

public static Class<? extends MetricAlarm.Builder> serializableBuilderClass()

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