Class AlarmState
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AlarmState.Builder,
AlarmState>
Contains information about the current state of the alarm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AlarmState.Builder
builder()
final CustomerAction
Contains information about the action that you can take to respond to the alarm.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final RuleEvaluation
Information needed to evaluate data.static Class
<? extends AlarmState.Builder> final AlarmStateName
The name of the alarm state.final String
The name of the alarm state.final SystemEvent
Contains information about alarm state changes.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stateName
The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
If the service returns an enum value that is not available in the current SDK version,
stateName
will returnAlarmStateName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateNameAsString()
.- Returns:
- The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
-
- See Also:
-
-
stateNameAsString
The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
If the service returns an enum value that is not available in the current SDK version,
stateName
will returnAlarmStateName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateNameAsString()
.- Returns:
- The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
-
- See Also:
-
-
ruleEvaluation
Information needed to evaluate data.
- Returns:
- Information needed to evaluate data.
-
customerAction
Contains information about the action that you can take to respond to the alarm.
- Returns:
- Contains information about the action that you can take to respond to the alarm.
-
systemEvent
Contains information about alarm state changes.
- Returns:
- Contains information about alarm state changes.
-
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<AlarmState.Builder,
AlarmState> - 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
-