software.amazon.awssdk.services.iot.model

Interface IotEventsAction.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IotEventsAction.Builder,IotEventsAction>, SdkBuilder<IotEventsAction.Builder,IotEventsAction>, SdkPojo

Enclosing class:

IotEventsAction

public static interface IotEventsAction.Builder
extends SdkPojo, CopyableBuilder<IotEventsAction.Builder,IotEventsAction>

Method Summary

Modifier and Type	Method and Description
IotEventsAction.Builder	batchMode(Boolean batchMode) Whether to process the event actions as a batch.
IotEventsAction.Builder	inputName(String inputName) The name of the AWS IoT Events input.
IotEventsAction.Builder	messageId(String messageId) The ID of the message.
IotEventsAction.Builder	roleArn(String roleArn) The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

inputName

IotEventsAction.Builder inputName(String inputName)

The name of the AWS IoT Events input.

Parameters:

inputName - The name of the AWS IoT Events input.

Returns:

Returns a reference to this object so that method calls can be chained together.

messageId

IotEventsAction.Builder messageId(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 AWS IoT Events detector.

Parameters:

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 AWS IoT Events detector.

Returns:

Returns a reference to this object so that method calls can be chained together.

batchMode

IotEventsAction.Builder batchMode(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 AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Parameters:

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 AWS IoT Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

IotEventsAction.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.