Class IotEventsAction

java.lang.Object
software.amazon.awssdk.services.iot.model.IotEventsAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IotEventsAction.Builder,IotEventsAction>
@Generated("software.amazon.awssdk:codegen") public final class IotEventsAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IotEventsAction.Builder,IotEventsAction>

Sends an input to an IoT Events detector.

See Also:

  • Method Details

    • inputName

      public final String inputName()

      The name of the IoT Events input.

      Returns:
      The name of the IoT Events input.

    • messageId

      public final String messageId()

      The ID of the message. The default messageId is a new UUID value.

      When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

      Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

      Returns:
      The ID of the message. The default messageId is a new UUID value.

      When batchMode is true, you can't specify a messageId--a new UUID value will be assigned.

      Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an IoT Events detector.

    • batchMode

      public final Boolean batchMode()

      Whether to process the event actions as a batch. The default value is false.

      When batchMode is true, you can't specify a messageId.

      When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

      Returns:
      Whether to process the event actions as a batch. The default value is false.

      When batchMode is true, you can't specify a messageId.

      When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when it's sent to IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

    • roleArn

      public final String roleArn()

      The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

      Returns:
      The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").

    • toBuilder

      public IotEventsAction.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<IotEventsAction.Builder,IotEventsAction>
      Returns:
      a builder for type T

    • builder

      public static IotEventsAction.Builder builder()

    • serializableBuilderClass

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