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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<CustomerAction.Builder,CustomerAction>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.