Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

KafkaRecords are produced by Kafka collections agents, and consumed by Kafka forwarding agents.

Field

Description

context (any)

An optional field for user-defined information.

errorMessage (string)

Automatically populated if an error occurs during forwarding of the message.

headers (list<RecordHeader (Kafka)>)

An optional list of headers.

key (bytearray)

An optional field for the key.

offset (long)

A read-only field with the offset of the collected message.

outstandingRecordCnt (int)

A read-only field indicating how many records are left to send.

partition (int)

The partition the message was collected from or

is

will be forwarded to. Automatically set.

timestamp (long)

The collection or forwarding time which is set automatically.

topic (string)

The topic the message was collected from or

is

will be forwarded to.

value (bytearray)

The contents of the message.

Note!

When forwarding a message to Kafka, all fields are optional, except for topic and value.