Package software.amazon.awssdk.services.iot.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IotEventsAction.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	batchMode()	Whether to process the event actions as a batch.
static IotEventsAction.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inputName()	The name of the IoT Events input.
String	messageId()	The ID of the message.
String	roleArn()	The ARN of the role that grants IoT permission to send an input to an IoT Events detector.
List<SdkField<?>>	sdkFields()
static Class<? extends IotEventsAction.Builder>	serializableBuilderClass()
IotEventsAction.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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<IotEventsAction.Builder,IotEventsAction>

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)

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