software.amazon.awssdk.services.ioteventsdata.model

Class AlarmState

java.lang.Object

software.amazon.awssdk.services.ioteventsdata.model.AlarmState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlarmState.Builder,AlarmState>

@Generated(value="software.amazon.awssdk:codegen")
public final class AlarmState
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AlarmState.Builder,AlarmState>

Contains information about the current state of the alarm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AlarmState.Builder

Method Summary

Modifier and Type	Method and Description
static AlarmState.Builder	builder()
CustomerAction	customerAction() Contains information about the action that you can take to respond to the alarm.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RuleEvaluation	ruleEvaluation() Information needed to evaluate data.
List<SdkField<?>>	sdkFields()
static Class<? extends AlarmState.Builder>	serializableBuilderClass()
AlarmStateName	stateName() The name of the alarm state.
String	stateNameAsString() The name of the alarm state.
SystemEvent	systemEvent() Contains information about alarm state changes.
AlarmState.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

stateName

public final AlarmStateName stateName()

The name of the alarm state. The state name can be one of the following values:

• DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

• NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

• ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

• ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

• SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

• LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

If the service returns an enum value that is not available in the current SDK version, stateName will return AlarmStateName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateNameAsString().

Returns:

The name of the alarm state. The state name can be one of the following values:

• DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

• NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

• ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

• ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

• SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

• LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

See Also:

AlarmStateName

stateNameAsString

public final String stateNameAsString()

The name of the alarm state. The state name can be one of the following values:

• DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

• NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

• ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

• ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

• SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

• LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

If the service returns an enum value that is not available in the current SDK version, stateName will return AlarmStateName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateNameAsString().

Returns:

The name of the alarm state. The state name can be one of the following values:

• DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

• NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

• ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

• ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

• SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

• LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

See Also:

AlarmStateName

ruleEvaluation

public final RuleEvaluation ruleEvaluation()

Information needed to evaluate data.

Returns:

Information needed to evaluate data.

customerAction

public final CustomerAction 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

public final SystemEvent systemEvent()

Contains information about alarm state changes.

Returns:

Contains information about alarm state changes.

toBuilder

public AlarmState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlarmState.Builder,AlarmState>

builder

public static AlarmState.Builder builder()

serializableBuilderClass

public static Class<? extends AlarmState.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo