Class Message

Represents a message read from a source.

Index

Constructors

Properties

eventTime headers keys offset payload userMetadata?

Constructors

constructor

new Message(
    payload: Buffer,
    offset: Offset,
    eventTime: Date,
    keys: string[],
    headers: Record<string, string>,
    userMetadata?: source.UserMetadata,
): source.Message
Create a new source message.
Parameters
- payload: Buffer
  The message payload
- offset: Offset
  Position in the source
- eventTime: Date
  Event timestamp
- keys: string[]
  Routing keys
- headers: Record<string, string>
  Message headers
- OptionaluserMetadata: source.UserMetadata
  Optional user metadata
Returns source.Message
- Defined in index.ts:2524

Properties

eventTime

eventTime: Date

Event time of the message

headers

headers: Record<string, string>

Headers attached to the message

keys

keys: string[]

Keys for routing the message

offset

offset: Offset

The offset/position of this message in the source

payload

payload: Buffer

The message payload

`Optional`userMetadata

userMetadata?: source.UserMetadata

Optional user metadata