Interface ProcessFunctionOptions

Legend

Namespace
Variable
Function
Function with type parameter
Type alias
Type alias with type parameter

Interface
Interface with type parameter
Property

Enumeration

Class

Overrides for controlling what the SDK does when you push data to the next stream step when using the push method with the enrich and batch operations.

Hierarchy

ProcessCallbackOptions
- ProcessFunctionOptions

Index

Properties

Optional eid

eid?: string

Overriding the source eid to use for correlation

Optional event

event?: string

deprecated: Do not use

Optional event_source_timestamp

event_source_timestamp?: number

Overriding the default event_source_timestamp from the source event

Optional partial

partial?: boolean

When turning 1 event into many events you don't want to checkpoint this one event instead you want to wait until you've generated the many events and so this attribute tells the SDK not to checkpoint yet because

NOTE: in this case you are responsible for sending a non-partial event (one with no paylod perhaps) at the end with partial: false to cause the final checkpoint to occur.

default: false

Optional queue

queue?: string

Overriding the default queue to send the event to

Optional units

units?: number

Overriding the default units from the source event