Buffer Payloads

These actions provide ability to buffer multiple event payloads into a single batch event.

Buffer Payloads Actions

Buffer

Buffers payload of the events received and releases them as a single combined event with array of input payloads in either of the following cases:

  • When the runner performs a commit operation, based on its settings or a commit command received.

  • When the number of buffered events reaches the buffer size provided in event parameters.

Event metadata fields applicable for this action are as follows:

Field
Definition
Example
Default

Input Element

Json path for payload element to buffer

parameters

-

Output Element

Json path for payload element to output buffered data

batch

-

With event metadata parameters as:

Parameter
Definition
Example
Default

Input Pattern

JMES path for transforming input element

{"id": productid}

-

Output Pattern

JMES path for transforming buffered data, which is an array

@[?id>0]

-

Buffer ID

Unique id for buffering similar payloads together

product_ids

-

Buffer Size

Max number of records to buffer

10

-

circle-info

bufferSize is defined at action level instead of handler level. This allows real-time changes for different buffer types without rebuilding the handler.

This action can improve performance for handlers that support batched requests, such as bulk writes or batched rule calculations.

Last updated