View Source KlifeProtocol.Messages.DescribeLogDirs (Klife Protocol v0.5.0)

Kafka protocol DescribeLogDirs message

Request versions summary:

  • Version 1 is the same as version 0. Version 2 is the first flexible version. Version 3 is the same as version 2 (new field in response). Version 4 is the same as version 2 (new fields in response).

Response versions summary:

  • Starting in version 1, on quota violation, brokers send out responses before throttling.

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+)

  • error_code: The error code, or 0 if there was no error. (int16 | versions 3+)

  • results: The log directories. ([]DescribeLogDirsResult | versions 0+)

    • error_code: The error code, or 0 if there was no error. (int16 | versions 0+)

    • log_dir: The absolute log directory path. (string | versions 0+)

    • topics: Each topic. ([]DescribeLogDirsTopic | versions 0+)

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

      • partitions: ([]DescribeLogDirsPartition | versions 0+)

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

        • partition_size: The size of the log segments in this partition in bytes. (int64 | versions 0+)

        • offset_lag: The lag of the log's LEO w.r.t. partition's HW (if it is the current log for the partition) or current replica's LEO (if it is the future log for the partition) (int64 | versions 0+)

        • is_future_key: True if this log is created by AlterReplicaLogDirsRequest and will replace the current log of the replica in the future. (bool | versions 0+)

    • total_bytes: The total size in bytes of the volume the log directory is in. (int64 | versions 4+)

    • usable_bytes: The usable size in bytes of the volume the log directory is in. (int64 | versions 4+)

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 describe log directories for, or null for all topics. ([]DescribableLogDirTopic | versions 0+)

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

    • partitions: The partition indexes. ([]int32 | versions 0+)