View Source KlifeProtocol.Messages.DeleteRecords (Klife Protocol v0.7.0)

Kafka protocol DeleteRecords message

Request versions summary:

  • Version 1 is the same as version 0. Version 2 is the first flexible version.

Response versions summary:

  • Starting in version 1, on quota violation, brokers send out responses before throttling. Version 2 is the first flexible version.

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota. (int32 | versions 0+)

  • topics: Each topic that we wanted to delete records from. ([]DeleteRecordsTopicResult | versions 0+)

    • name: The topic name. (string | versions 0+)

    • partitions: Each partition that we wanted to delete records from. ([]DeleteRecordsPartitionResult | versions 0+)

      • partition_index: The partition index. (int32 | versions 0+)

      • low_watermark: The partition low water mark. (int64 | versions 0+)

      • error_code: The deletion error code, or 0 if the deletion succeeded. (int16 | versions 0+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • topics: Each topic that we want to delete records from. ([]DeleteRecordsTopic | versions 0+)

    • name: The topic name. (string | versions 0+)

    • partitions: Each partition that we want to delete records from. ([]DeleteRecordsPartition | versions 0+)

      • partition_index: The partition index. (int32 | versions 0+)

      • offset: The deletion offset. (int64 | versions 0+)

  • timeout_ms: How long to wait for the deletion to complete, in milliseconds. (int32 | versions 0+)