Class CustomerAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CustomerAction.Builder,
CustomerAction>
Contains information about the action that you can take to respond to the alarm.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionContains the configuration information of an acknowledge action.final CustomerActionName
The name of the action.final String
The name of the action.static CustomerAction.Builder
builder()
Contains the configuration information of a disable action.Contains the configuration information of an enable action.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 ResetActionConfiguration
Contains the configuration information of a reset action.static Class
<? extends CustomerAction.Builder> Contains the configuration information of a snooze action.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
-
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 toSNOOZE_DISABLED
. -
ENABLE
- When you enable the alarm, the alarm state changes toNORMAL
. -
DISABLE
- When you disable the alarm, the alarm state changes toDISABLED
. -
ACKNOWLEDGE
- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED
. -
RESET
- When you reset the alarm, the alarm state changes toNORMAL
.
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 returnCustomerActionName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionNameAsString()
.- 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 toSNOOZE_DISABLED
. -
ENABLE
- When you enable the alarm, the alarm state changes toNORMAL
. -
DISABLE
- When you disable the alarm, the alarm state changes toDISABLED
. -
ACKNOWLEDGE
- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED
. -
RESET
- When you reset the alarm, the alarm state changes toNORMAL
.
For more information, see the AlarmState API.
-
- See Also:
-
-
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 toSNOOZE_DISABLED
. -
ENABLE
- When you enable the alarm, the alarm state changes toNORMAL
. -
DISABLE
- When you disable the alarm, the alarm state changes toDISABLED
. -
ACKNOWLEDGE
- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED
. -
RESET
- When you reset the alarm, the alarm state changes toNORMAL
.
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 returnCustomerActionName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionNameAsString()
.- 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 toSNOOZE_DISABLED
. -
ENABLE
- When you enable the alarm, the alarm state changes toNORMAL
. -
DISABLE
- When you disable the alarm, the alarm state changes toDISABLED
. -
ACKNOWLEDGE
- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED
. -
RESET
- When you reset the alarm, the alarm state changes toNORMAL
.
For more information, see the AlarmState API.
-
- See Also:
-
-
snoozeActionConfiguration
Contains the configuration information of a snooze action.
- Returns:
- Contains the configuration information of a snooze action.
-
enableActionConfiguration
Contains the configuration information of an enable action.
- Returns:
- Contains the configuration information of an enable action.
-
disableActionConfiguration
Contains the configuration information of a disable action.
- Returns:
- Contains the configuration information of a disable action.
-
acknowledgeActionConfiguration
Contains the configuration information of an acknowledge action.
- Returns:
- Contains the configuration information of an acknowledge action.
-
resetActionConfiguration
Contains the configuration information of a reset action.
- Returns:
- Contains the configuration information of a reset action.
-
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<CustomerAction.Builder,
CustomerAction> - 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
-