/AWS1/CL_IOTBATCHCONFIG

Configuration settings for batching.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_maxbatchopenms TYPE /AWS1/IOTMAXBATCHOPENMS /AWS1/IOTMAXBATCHOPENMS

The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.

iv_maxbatchsize TYPE /AWS1/IOTMAXBATCHSIZE /AWS1/IOTMAXBATCHSIZE

The maximum number of messages that are batched together in a single action execution.

iv_maxbatchsizebytes TYPE /AWS1/IOTMAXBATCHSIZEBYTES /AWS1/IOTMAXBATCHSIZEBYTES

Maximum size of a message batch, in bytes.

iv_batchacrosstopics TYPE /AWS1/IOTBATCHACROSSTOPICS /AWS1/IOTBATCHACROSSTOPICS

Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false.

When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic.

Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the batchAcrossTopics setting.

---

Queryable Attributes

maxBatchOpenMs

The maximum amount of time (in milliseconds) that an outgoing call waits for other calls with which it batches messages of the same type. The higher the setting, the longer the latency of the batched HTTP Action will be.

Accessible with the following methods

Method	Description
GET_MAXBATCHOPENMS()	Getter for MAXBATCHOPENMS, with configurable default
ASK_MAXBATCHOPENMS()	Getter for MAXBATCHOPENMS w/ exceptions if field has no valu
HAS_MAXBATCHOPENMS()	Determine if MAXBATCHOPENMS has a value

maxBatchSize

The maximum number of messages that are batched together in a single action execution.

Accessible with the following methods

Method	Description
GET_MAXBATCHSIZE()	Getter for MAXBATCHSIZE, with configurable default
ASK_MAXBATCHSIZE()	Getter for MAXBATCHSIZE w/ exceptions if field has no value
HAS_MAXBATCHSIZE()	Determine if MAXBATCHSIZE has a value

maxBatchSizeBytes

Maximum size of a message batch, in bytes.

Accessible with the following methods

Method	Description
GET_MAXBATCHSIZEBYTES()	Getter for MAXBATCHSIZEBYTES, with configurable default
ASK_MAXBATCHSIZEBYTES()	Getter for MAXBATCHSIZEBYTES w/ exceptions if field has no v
HAS_MAXBATCHSIZEBYTES()	Determine if MAXBATCHSIZEBYTES has a value

batchAcrossTopics

Whether to allow batching messages from different MQTT topics into a single HTTP request. By default, only messages from the same topic are batched together. The default value is false.

When batchAcrossTopics is enabled, the error payload format changes: the topic field moves from the top level to inside each entry in the payloadsWithMetadata array, since each message in the batch may originate from a different topic.

Messages are always batched within the scope of the same account, rule name, target HTTP endpoint URL, and billing group. Messages that differ in any of these attributes are never combined into the same batch, regardless of the batchAcrossTopics setting.

Accessible with the following methods

Method	Description
GET_BATCHACROSSTOPICS()	Getter for BATCHACROSSTOPICS