Class CompositeAlarm
- java.lang.Object
-
- software.amazon.awssdk.services.cloudwatch.model.CompositeAlarm
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
@Generated("software.amazon.awssdk:codegen") public final class CompositeAlarm extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
The details about a composite alarm.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CompositeAlarm.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.ActionsSuppressedBy
actionsSuppressedBy()
When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state.String
actionsSuppressedByAsString()
When the value isALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state.String
actionsSuppressedReason()
Captures the reason for action suppression.String
actionsSuppressor()
Actions will be suppressed if the suppressor alarm is in theALARM
state.Integer
actionsSuppressorExtensionPeriod()
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of theALARM
state.Integer
actionsSuppressorWaitPeriod()
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into theALARM
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'sStateValue
.Instant
stateUpdatedTimestamp()
Tracks the timestamp of any state update, even ifStateValue
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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
actionsEnabled
public final 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.
-
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
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.- 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).
-
alarmArn
public final String alarmArn()
The Amazon Resource Name (ARN) of the alarm.
- Returns:
- The Amazon Resource Name (ARN) of the alarm.
-
alarmConfigurationUpdatedTimestamp
public final Instant alarmConfigurationUpdatedTimestamp()
The time stamp of the last update to the alarm configuration.
- Returns:
- The time stamp of the last update to the alarm configuration.
-
alarmDescription
public final String alarmDescription()
The description of the alarm.
- Returns:
- The description of the alarm.
-
alarmName
public final String alarmName()
The name of the alarm.
- Returns:
- The name of the alarm.
-
alarmRule
public final String alarmRule()
The rule that this alarm uses to evaluate its alarm state.
- Returns:
- The rule that this alarm uses to evaluate its alarm state.
-
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
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.- 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).
-
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
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.- 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).
-
stateReason
public final String stateReason()
An explanation for the alarm state, in text format.
- Returns:
- An explanation for the alarm state, in text format.
-
stateReasonData
public final String stateReasonData()
An explanation for the alarm state, in JSON format.
- Returns:
- An explanation for the alarm state, in JSON format.
-
stateUpdatedTimestamp
public final Instant stateUpdatedTimestamp()
Tracks the timestamp of any state update, even if
StateValue
doesn't change.- Returns:
- Tracks the timestamp of any state update, even if
StateValue
doesn't change.
-
stateValue
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 returnStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The state value for the alarm.
- See Also:
StateValue
-
stateValueAsString
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 returnStateValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateValueAsString()
.- Returns:
- The state value for the alarm.
- See Also:
StateValue
-
stateTransitionedTimestamp
public final Instant stateTransitionedTimestamp()
The timestamp of the last change to the alarm's
StateValue
.- Returns:
- The timestamp of the last change to the alarm's
StateValue
.
-
actionsSuppressedBy
public final ActionsSuppressedBy actionsSuppressedBy()
When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. 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 returnActionsSuppressedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionsSuppressedByAsString()
.- Returns:
- When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions. - See Also:
ActionsSuppressedBy
-
actionsSuppressedByAsString
public final String actionsSuppressedByAsString()
When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. 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 returnActionsSuppressedBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionsSuppressedByAsString()
.- Returns:
- When the value is
ALARM
, it means that the actions are suppressed because the suppressor alarm is inALARM
When the value isWaitPeriod
, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into theALARM
state. The maximum waiting time is as specified inActionsSuppressorWaitPeriod
. After this time, the composite alarm performs its actions. When the value isExtensionPeriod
, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of theALARM
state. The maximum waiting time is as specified inActionsSuppressorExtensionPeriod
. After this time, the composite alarm performs its actions. - See Also:
ActionsSuppressedBy
-
actionsSuppressedReason
public final String actionsSuppressedReason()
Captures the reason for action suppression.
- Returns:
- Captures the reason for action suppression.
-
actionsSuppressor
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.- Returns:
- 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.
-
actionsSuppressorWaitPeriod
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 whenActionsSuppressor
is specified.- Returns:
- 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 whenActionsSuppressor
is specified.
-
actionsSuppressorExtensionPeriod
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 whenActionsSuppressor
is specified.- Returns:
- 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 whenActionsSuppressor
is specified.
-
toBuilder
public CompositeAlarm.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CompositeAlarm.Builder,CompositeAlarm>
-
builder
public static CompositeAlarm.Builder builder()
-
serializableBuilderClass
public static Class<? extends CompositeAlarm.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String 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.
-
-