Interface Datum

Input datum for sink operations. Provides access to message data, metadata, and unique ID.

interface Datum {
    id: string;
    keys: string[];
    getEventtime(): Date;
    getHeaders(): Record<string, string>;
    getValue(): Buffer;
    getWatermark(): Date;
    systemMetadata(): sink.SystemMetadata;
    userMetadata(): sink.UserMetadata;
}

Index

Properties

Methods

getEventtime getHeaders getValue getWatermark systemMetadata userMetadata

Properties

id

id: string

Unique identifier for the message. Used for tracking and responding to individual messages.

keys

keys: string[]

Set of keys in the (key, value) terminology of map/reduce paradigm. Used for routing and partitioning messages.

Methods

getEventtime

getEventtime(): Date
Get the event time of the message.

Returns Date
The event time as a Date
- Defined in index.ts:988

getHeaders

getHeaders(): Record<string, string>
Get the message headers.

Returns Record<string, string>
A record of header key-value pairs
- Defined in index.ts:993

getValue

getValue(): Buffer
Get the message payload.

Returns Buffer
The message value as a Buffer
- Defined in index.ts:978

getWatermark

getWatermark(): Date
Get the watermark timestamp.

Returns Date
The watermark as a Date
- Defined in index.ts:983

systemMetadata

systemMetadata(): sink.SystemMetadata
Get the system-provided metadata for this message.

Returns sink.SystemMetadata
The system metadata object
- Defined in index.ts:1003

userMetadata

userMetadata(): sink.UserMetadata
Get the user-defined metadata for this message.

Returns sink.UserMetadata
The user metadata object
- Defined in index.ts:998