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

Kafka protocol DescribeCluster message

Request versions summary:

  • Version 1 adds EndpointType for KIP-919 support.

Response versions summary:

  • Version 1 adds the EndpointType field, and makes MISMATCHED_ENDPOINT_TYPE and UNSUPPORTED_ENDPOINT_TYPE valid top-level response error codes.

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 top-level error code, or 0 if there was no error (int16 | versions 0+)

  • error_message: The top-level error message, or null if there was no error. (string | versions 0+)

  • endpoint_type: The endpoint type that was described. 1=brokers, 2=controllers. (int8 | versions 1+)

  • cluster_id: The cluster ID that responding broker belongs to. (string | versions 0+)

  • controller_id: The ID of the controller broker. (int32 | versions 0+)

  • brokers: Each broker in the response. ([]DescribeClusterBroker | versions 0+)

    • broker_id: The broker ID. (int32 | versions 0+)

    • host: The broker hostname. (string | versions 0+)

    • port: The broker port. (int32 | versions 0+)

    • rack: The rack of the broker, or null if it has not been assigned to a rack. (string | versions 0+)

  • cluster_authorized_operations: 32-bit bitfield to represent authorized operations for this cluster. (int32 | 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:

  • include_cluster_authorized_operations: Whether to include cluster authorized operations. (bool | versions 0+)

  • endpoint_type: The endpoint type to describe. 1=brokers, 2=controllers. (int8 | versions 1+)