class kafka.OffsetAndMetadata(offset=None, metadata='', leader_epoch=-1)

Container for committed group offset data.

The Kafka offset commit API allows users to provide additional metadata (in the form of a string) when an offset is committed. This can be useful (for example) to store information about which node made the commit, what time the commit was made, etc.

Keyword Arguments:
  • offset (int) – The offset to be committed

  • metadata (str) – Non-null metadata

  • leader_epoch (int) – The last known epoch from the leader / broker

leader_epoch

Alias for field number 2

metadata

Alias for field number 1

offset

Alias for field number 0