@Generated(value="software.amazon.awssdk:codegen") public final class MetricAlarm extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricAlarm.Builder,MetricAlarm>
The details about a metric alarm.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricAlarm.Builder |
Modifier and Type | Method and 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.
|
Instant |
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() |
ComparisonOperator |
comparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold.
|
String |
comparisonOperatorAsString()
The arithmetic operation to use when comparing the specified statistic and threshold.
|
Integer |
datapointsToAlarm()
The number of data points that must be breaching to trigger the alarm.
|
List<Dimension> |
dimensions()
The dimensions for the metric associated with the alarm.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
evaluateLowSampleCountPercentile()
Used only for alarms based on percentiles.
|
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAlarmActions()
Returns true if the AlarmActions property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasDimensions()
Returns true if the Dimensions property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasInsufficientDataActions()
Returns true if the InsufficientDataActions property was specified by the sender (it may be empty), or false if
the sender did not specify the value (it will be empty).
|
boolean |
hasMetrics()
Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
boolean |
hasOkActions()
Returns true if the OKActions property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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, if this is an alarm based on a single metric.
|
List<MetricDataQuery> |
metrics()
An array of MetricDataQuery structures, used in an alarm based on a metric math expression.
|
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.
|
List<SdkField<?>> |
sdkFields() |
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.
|
Instant |
stateUpdatedTimestamp()
The time stamp of the last update to the alarm state.
|
StateValue |
stateValue()
The state value for the alarm.
|
String |
stateValueAsString()
The state value for the alarm.
|
Statistic |
statistic()
The statistic for the metric associated with the alarm, other than percentile.
|
String |
statisticAsString()
The statistic for the metric associated with the alarm, other than percentile.
|
Double |
threshold()
The value to compare with the specified statistic.
|
String |
thresholdMetricId()
In an alarm based on an anomaly detection model, this is the ID of the
ANOMALY_DETECTION_BAND
function used as the threshold for the alarm. |
MetricAlarm.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
treatMissingData()
Sets how this alarm is to handle missing data points.
|
StandardUnit |
unit()
The unit of the metric associated with the alarm.
|
String |
unitAsString()
The unit of the metric associated with the alarm.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String alarmName()
The name of the alarm.
public final String alarmArn()
The Amazon Resource Name (ARN) of the alarm.
public final String alarmDescription()
The description of the alarm.
public final Instant alarmConfigurationUpdatedTimestamp()
The time stamp of the last update to the alarm configuration.
public final Boolean actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
public final boolean hasOkActions()
public final 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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasOkActions()
to see if a value was sent in this field.
OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).public final boolean hasAlarmActions()
public final 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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAlarmActions()
to see if a value was sent in this field.
ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).public final boolean hasInsufficientDataActions()
public final 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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasInsufficientDataActions()
to see if a value was sent in this field.
INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).public final StateValue stateValue()
The state value for the alarm.
If the service returns an enum value that is not available in the current SDK version, stateValue
will
return StateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateValueAsString()
.
StateValue
public final String stateValueAsString()
The state value for the alarm.
If the service returns an enum value that is not available in the current SDK version, stateValue
will
return StateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
stateValueAsString()
.
StateValue
public final String stateReason()
An explanation for the alarm state, in text format.
public final String stateReasonData()
An explanation for the alarm state, in JSON format.
public final Instant stateUpdatedTimestamp()
The time stamp of the last update to the alarm state.
public final String metricName()
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
public final String namespace()
The namespace of the metric associated with the alarm.
public final Statistic statistic()
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
If the service returns an enum value that is not available in the current SDK version, statistic
will
return Statistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statisticAsString()
.
ExtendedStatistic
.Statistic
public final String statisticAsString()
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
If the service returns an enum value that is not available in the current SDK version, statistic
will
return Statistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statisticAsString()
.
ExtendedStatistic
.Statistic
public final String extendedStatistic()
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
public final boolean hasDimensions()
public final List<Dimension> dimensions()
The dimensions for the metric associated with the alarm.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDimensions()
to see if a value was sent in this field.
public final Integer period()
The period, in seconds, over which the statistic is applied.
public final StandardUnit unit()
The unit of the metric associated with the alarm.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
StandardUnit
public final String unitAsString()
The unit of the metric associated with the alarm.
If the service returns an enum value that is not available in the current SDK version, unit
will return
StandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
unitAsString()
.
StandardUnit
public final Integer evaluationPeriods()
The number of periods over which data is compared to the specified threshold.
public final Integer datapointsToAlarm()
The number of data points that must be breaching to trigger the alarm.
public final Double threshold()
The value to compare with the specified statistic.
public final ComparisonOperator comparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from comparisonOperatorAsString()
.
ComparisonOperator
public final String comparisonOperatorAsString()
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned
by the service is available from comparisonOperatorAsString()
.
ComparisonOperator
public final String treatMissingData()
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of
missing
is used.
missing
is used.public final 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.
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.public final boolean hasMetrics()
public final List<MetricDataQuery> metrics()
An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either
retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the
alarm watches. This expression by designated by having ReturnData
set to true.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasMetrics()
to see if a value was sent in this field.
ReturnData
set to true.public final String thresholdMetricId()
In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.
ANOMALY_DETECTION_BAND
function used as the threshold for the alarm.public MetricAlarm.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricAlarm.Builder,MetricAlarm>
public static MetricAlarm.Builder builder()
public static Class<? extends MetricAlarm.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.