Class MetricAlarm
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MetricAlarm.Builder,
MetricAlarm>
The details about a metric alarm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether actions should be executed during any changes to the alarm state.The actions to execute when this alarm transitions to theALARM
state from any other state.final String
alarmArn()
The Amazon Resource Name (ARN) of the alarm.final Instant
The time stamp of the last update to the alarm configuration.final String
The description of the alarm.final String
The name of the alarm.static MetricAlarm.Builder
builder()
final ComparisonOperator
The arithmetic operation to use when comparing the specified statistic and threshold.final String
The arithmetic operation to use when comparing the specified statistic and threshold.final Integer
The number of data points that must be breaching to trigger the alarm.The dimensions for the metric associated with the alarm.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Used only for alarms based on percentiles.final Integer
The number of periods over which data is compared to the specified threshold.final EvaluationState
If the value of this field isPARTIAL_DATA
, the alarm is being evaluated based on only partial data.final String
If the value of this field isPARTIAL_DATA
, the alarm is being evaluated based on only partial data.final String
The percentile statistic for the metric associated with the alarm.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AlarmActions property.final boolean
For responses, this returns true if the service returned a value for the Dimensions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InsufficientDataActions property.final boolean
For responses, this returns true if the service returned a value for the Metrics property.final boolean
For responses, this returns true if the service returned a value for the OKActions property.The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.final String
The name of the metric associated with the alarm, if this is an alarm based on a single metric.final List
<MetricDataQuery> metrics()
An array of MetricDataQuery structures, used in an alarm based on a metric math expression.final String
The namespace of the metric associated with the alarm.The actions to execute when this alarm transitions to theOK
state from any other state.final Integer
period()
The period, in seconds, over which the statistic is applied.static Class
<? extends MetricAlarm.Builder> final String
An explanation for the alarm state, in text format.final String
An explanation for the alarm state, in JSON format.final Instant
The date and time that the alarm'sStateValue
most recently changed.final Instant
The time stamp of the last update to the value of either theStateValue
orEvaluationState
parameters.final StateValue
The state value for the alarm.final String
The state value for the alarm.final Statistic
The statistic for the metric associated with the alarm, other than percentile.final String
The statistic for the metric associated with the alarm, other than percentile.final Double
The value to compare with the specified statistic.final String
In an alarm based on an anomaly detection model, this is the ID of theANOMALY_DETECTION_BAND
function used as the threshold for the alarm.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Sets how this alarm is to handle missing data points.final StandardUnit
unit()
The unit of the metric associated with the alarm.final String
The unit of the metric associated with the alarm.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
alarmName
The name of the alarm.
- Returns:
- The name of the alarm.
-
alarmArn
The Amazon Resource Name (ARN) of the alarm.
- Returns:
- The Amazon Resource Name (ARN) of the alarm.
-
alarmDescription
The description of the alarm.
- Returns:
- The description of the alarm.
-
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
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.
-
hasOkActions
public final boolean hasOkActions()For responses, this returns true if the service returned a value for the OKActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOkActions()
method.- 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).
-
hasAlarmActions
public final boolean hasAlarmActions()For responses, this returns true if the service returned a value for the AlarmActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAlarmActions()
method.- 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).
-
hasInsufficientDataActions
public final boolean hasInsufficientDataActions()For responses, this returns true if the service returned a value for the InsufficientDataActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInsufficientDataActions()
method.- 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
The state value for the alarm.
If the service returns an enum value that is not available in the current SDK version,
stateValue
will returnStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The state value for the alarm.
- See Also:
-
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 returnStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The state value for the alarm.
- See Also:
-
stateReason
An explanation for the alarm state, in text format.
- Returns:
- An explanation for the alarm state, in text format.
-
stateReasonData
An explanation for the alarm state, in JSON format.
- Returns:
- An explanation for the alarm state, in JSON format.
-
stateUpdatedTimestamp
The time stamp of the last update to the value of either the
StateValue
orEvaluationState
parameters.- Returns:
- The time stamp of the last update to the value of either the
StateValue
orEvaluationState
parameters.
-
metricName
The name of the metric associated with the alarm, if this is an alarm based on a single metric.
- Returns:
- The name of the metric associated with the alarm, if this is an alarm based on a single metric.
-
namespace
The namespace of the metric associated with the alarm.
- Returns:
- The namespace of the metric associated with the alarm.
-
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 returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use
ExtendedStatistic
. - See Also:
-
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 returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use
ExtendedStatistic
. - See Also:
-
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.
-
hasDimensions
public final boolean hasDimensions()For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
dimensions
The dimensions for the metric associated with the alarm.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDimensions()
method.- Returns:
- The dimensions for the metric associated with the alarm.
-
period
The period, in seconds, over which the statistic is applied.
- Returns:
- The period, in seconds, over which the statistic is applied.
-
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 returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of the metric associated with the alarm.
- See Also:
-
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 returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of the metric associated with the alarm.
- See Also:
-
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.
-
datapointsToAlarm
The number of data points that must be breaching to trigger the alarm.
- Returns:
- The number of data points that must be breaching to trigger the alarm.
-
threshold
The value to compare with the specified statistic.
- Returns:
- The value to compare with the specified statistic.
-
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- 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:
-
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- 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:
-
treatMissingData
Sets how this alarm is to handle missing data points. The valid values are
breaching
,notBreaching
,ignore
, andmissing
. For more information, see Configuring how CloudWatch alarms treat missing data.If this parameter is omitted, the default behavior of
missing
is used.- Returns:
- Sets how this alarm is to handle missing data points. The valid values are
breaching
,notBreaching
,ignore
, andmissing
. For more information, see Configuring how CloudWatch alarms treat missing data.If this parameter is omitted, the default behavior of
missing
is used.
-
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. Ifevaluate
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. Ifevaluate
or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
-
hasMetrics
public final boolean hasMetrics()For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetrics()
method.- Returns:
- 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.
-
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.- Returns:
- 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.
-
evaluationState
If the value of this field is
PARTIAL_DATA
, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.If the service returns an enum value that is not available in the current SDK version,
evaluationState
will returnEvaluationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromevaluationStateAsString()
.- Returns:
- If the value of this field is
PARTIAL_DATA
, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries. - See Also:
-
evaluationStateAsString
If the value of this field is
PARTIAL_DATA
, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.If the service returns an enum value that is not available in the current SDK version,
evaluationState
will returnEvaluationState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromevaluationStateAsString()
.- Returns:
- If the value of this field is
PARTIAL_DATA
, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries. - See Also:
-
stateTransitionedTimestamp
The date and time that the alarm's
StateValue
most recently changed.- Returns:
- The date and time that the alarm's
StateValue
most recently changed.
-
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 interfaceToCopyableBuilder<MetricAlarm.Builder,
MetricAlarm> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-