@Generated(value="software.amazon.awssdk:codegen") public final class CompositeAlarm extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
The details about a composite alarm.
Modifier and Type | Class and Description |
---|---|
static interface |
CompositeAlarm.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
|
ActionsSuppressedBy |
actionsSuppressedBy()
When the value is
ALARM , it means that the actions are suppressed because the suppressor alarm is in
ALARM When the value is WaitPeriod , it means that the actions are suppressed because
the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. |
String |
actionsSuppressedByAsString()
When the value is
ALARM , it means that the actions are suppressed because the suppressor alarm is in
ALARM When the value is WaitPeriod , it means that the actions are suppressed because
the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. |
String |
actionsSuppressedReason()
Captures the reason for action suppression.
|
String |
actionsSuppressor()
Actions will be suppressed if the suppressor alarm is in the
ALARM state. |
Integer |
actionsSuppressorExtensionPeriod()
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARM state. |
Integer |
actionsSuppressorWaitPeriod()
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into 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.
|
String |
alarmRule()
The rule that this alarm uses to evaluate its alarm state.
|
static CompositeAlarm.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAlarmActions()
For responses, this returns true if the service returned a value for the AlarmActions property.
|
int |
hashCode() |
boolean |
hasInsufficientDataActions()
For responses, this returns true if the service returned a value for the InsufficientDataActions property.
|
boolean |
hasOkActions()
For responses, this returns true if the service returned a value for the OKActions property.
|
List<String> |
insufficientDataActions()
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
|
List<String> |
okActions()
The actions to execute when this alarm transitions to the OK state from any other state.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CompositeAlarm.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 |
stateTransitionedTimestamp()
The timestamp of the last change to the alarm's
StateValue . |
Instant |
stateUpdatedTimestamp()
Tracks the timestamp of any state update, even if
StateValue doesn't change. |
StateValue |
stateValue()
The state value for the alarm.
|
String |
stateValueAsString()
The state value for the alarm.
|
CompositeAlarm.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Boolean actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
public final boolean hasAlarmActions()
isEmpty()
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.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.
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.
public final String alarmArn()
The Amazon Resource Name (ARN) of the alarm.
public final Instant alarmConfigurationUpdatedTimestamp()
The time stamp of the last update to the alarm configuration.
public final String alarmDescription()
The description of the alarm.
public final String alarmName()
The name of the alarm.
public final String alarmRule()
The rule that this alarm uses to evaluate its alarm state.
public final boolean hasInsufficientDataActions()
isEmpty()
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.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.
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.
public final boolean hasOkActions()
isEmpty()
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.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.
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.
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()
Tracks the timestamp of any state update, even if StateValue
doesn't change.
StateValue
doesn't change.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 Instant stateTransitionedTimestamp()
The timestamp of the last change to the alarm's StateValue
.
StateValue
.public final ActionsSuppressedBy actionsSuppressedBy()
When the value is ALARM
, it means that the actions are suppressed because the suppressor alarm is in
ALARM
When the value is WaitPeriod
, it means that the actions are suppressed because
the composite alarm is waiting for the suppressor alarm to go into into the ALARM
state. The maximum
waiting time is as specified in ActionsSuppressorWaitPeriod
. After this time, the composite alarm
performs its actions. When the value is ExtensionPeriod
, it means that the actions are suppressed
because the composite alarm is waiting after the suppressor alarm went out of the ALARM
state. The
maximum waiting time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the
composite alarm performs its actions.
If the service returns an enum value that is not available in the current SDK version,
actionsSuppressedBy
will return ActionsSuppressedBy.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from actionsSuppressedByAsString()
.
ALARM
, it means that the actions are suppressed because the suppressor
alarm is in ALARM
When the value is WaitPeriod
, it means that the actions are
suppressed because the composite alarm is waiting for the suppressor alarm to go into into the
ALARM
state. The maximum waiting time is as specified in
ActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When
the value is ExtensionPeriod
, it means that the actions are suppressed because the composite
alarm is waiting after the suppressor alarm went out of the ALARM
state. The maximum waiting
time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the composite
alarm performs its actions.ActionsSuppressedBy
public final String actionsSuppressedByAsString()
When the value is ALARM
, it means that the actions are suppressed because the suppressor alarm is in
ALARM
When the value is WaitPeriod
, it means that the actions are suppressed because
the composite alarm is waiting for the suppressor alarm to go into into the ALARM
state. The maximum
waiting time is as specified in ActionsSuppressorWaitPeriod
. After this time, the composite alarm
performs its actions. When the value is ExtensionPeriod
, it means that the actions are suppressed
because the composite alarm is waiting after the suppressor alarm went out of the ALARM
state. The
maximum waiting time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the
composite alarm performs its actions.
If the service returns an enum value that is not available in the current SDK version,
actionsSuppressedBy
will return ActionsSuppressedBy.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from actionsSuppressedByAsString()
.
ALARM
, it means that the actions are suppressed because the suppressor
alarm is in ALARM
When the value is WaitPeriod
, it means that the actions are
suppressed because the composite alarm is waiting for the suppressor alarm to go into into the
ALARM
state. The maximum waiting time is as specified in
ActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When
the value is ExtensionPeriod
, it means that the actions are suppressed because the composite
alarm is waiting after the suppressor alarm went out of the ALARM
state. The maximum waiting
time is as specified in ActionsSuppressorExtensionPeriod
. After this time, the composite
alarm performs its actions.ActionsSuppressedBy
public final String actionsSuppressedReason()
Captures the reason for action suppression.
public final String actionsSuppressor()
Actions will be suppressed if the suppressor alarm is in the ALARM
state.
ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
ALARM
state.
ActionsSuppressor
can be an AlarmName or an Amazon Resource Name (ARN) from an existing
alarm.public final Integer actionsSuppressorWaitPeriod()
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the
ALARM
state. After this time, the composite alarm performs its actions.
WaitPeriod
is required only when ActionsSuppressor
is specified.
ALARM
state. After this time, the composite alarm performs its actions.
WaitPeriod
is required only when ActionsSuppressor
is specified.
public final Integer actionsSuppressorExtensionPeriod()
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the
ALARM
state. After this time, the composite alarm performs its actions.
ExtensionPeriod
is required only when ActionsSuppressor
is specified.
ALARM
state. After this time, the composite alarm performs its actions.
ExtensionPeriod
is required only when ActionsSuppressor
is specified.
public CompositeAlarm.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
public static CompositeAlarm.Builder builder()
public static Class<? extends CompositeAlarm.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.