Package software.amazon.awssdk.services.ioteventsdata.model

Class CustomerAction

java.lang.Object

software.amazon.awssdk.services.ioteventsdata.model.CustomerAction

All Implemented Interfaces:

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

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

Contains information about the action that you can take to respond to the alarm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomerAction.Builder

Method Summary

Modifier and Type	Method	Description
AcknowledgeActionConfiguration	acknowledgeActionConfiguration()	Contains the configuration information of an acknowledge action.
CustomerActionName	actionName()	The name of the action.
String	actionNameAsString()	The name of the action.
static CustomerAction.Builder	builder()
DisableActionConfiguration	disableActionConfiguration()	Contains the configuration information of a disable action.
EnableActionConfiguration	enableActionConfiguration()	Contains the configuration information of an enable action.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ResetActionConfiguration	resetActionConfiguration()	Contains the configuration information of a reset action.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomerAction.Builder>	serializableBuilderClass()
SnoozeActionConfiguration	snoozeActionConfiguration()	Contains the configuration information of a snooze action.
CustomerAction.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

actionName

public final CustomerActionName actionName()

The name of the action. The action name can be one of the following values:

• SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

• ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

• DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

• ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

• RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

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

Returns:

The name of the action. The action name can be one of the following values:

• SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

• ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

• DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

• ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

• RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

See Also:

CustomerActionName

actionNameAsString

public final String actionNameAsString()

The name of the action. The action name can be one of the following values:

• SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

• ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

• DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

• ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

• RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

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

Returns:

The name of the action. The action name can be one of the following values:

• SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED.

• ENABLE - When you enable the alarm, the alarm state changes to NORMAL.

• DISABLE - When you disable the alarm, the alarm state changes to DISABLED.

• ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED.

• RESET - When you reset the alarm, the alarm state changes to NORMAL.

For more information, see the AlarmState API.

See Also:

CustomerActionName

snoozeActionConfiguration

public final SnoozeActionConfiguration snoozeActionConfiguration()

Contains the configuration information of a snooze action.

Returns:

Contains the configuration information of a snooze action.

enableActionConfiguration

public final EnableActionConfiguration enableActionConfiguration()

Contains the configuration information of an enable action.

Returns:

Contains the configuration information of an enable action.

disableActionConfiguration

public final DisableActionConfiguration disableActionConfiguration()

Contains the configuration information of a disable action.

Returns:

Contains the configuration information of a disable action.

acknowledgeActionConfiguration

public final AcknowledgeActionConfiguration acknowledgeActionConfiguration()

Contains the configuration information of an acknowledge action.

Returns:

Contains the configuration information of an acknowledge action.

resetActionConfiguration

public final ResetActionConfiguration resetActionConfiguration()

Contains the configuration information of a reset action.

Returns:

Contains the configuration information of a reset action.

toBuilder

public CustomerAction.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomerAction.Builder,CustomerAction>

builder

public static CustomerAction.Builder builder()

serializableBuilderClass

public static Class<? extends CustomerAction.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