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

Kafka protocol ApiVersions message

Request versions summary:

  • Versions 0 through 2 of ApiVersionsRequest are the same.
  • Version 3 is the first flexible version and adds ClientSoftwareName and ClientSoftwareVersion.

Response versions summary:

  • Version 1 adds throttle time to the response.
  • Starting in version 2, on quota violation, brokers send out responses before throttling.
  • Version 3 is the first flexible version. Tagged fields are only supported in the body but not in the header. The length of the header must not change in order to guarantee the backward compatibility.
  • Starting from Apache Kafka 2.4 (KIP-511), ApiKeys field is populated with the supported versions of the ApiVersionsRequest when an UNSUPPORTED_VERSION error is returned.

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:

  • error_code: The top-level error code. (int16 | versions 0+)

  • api_keys: The APIs supported by the broker. ([]ApiVersion | versions 0+)

    • api_key: The API index. (int16 | versions 0+)

    • min_version: The minimum supported version, inclusive. (int16 | versions 0+)

    • max_version: The maximum supported version, inclusive. (int16 | versions 0+)

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

  • supported_features: Features supported by the broker. ([]SupportedFeatureKey | versions 3+)

    • name: The name of the feature. (string | versions 3+)

    • min_version: The minimum supported version for the feature. (int16 | versions 3+)

    • max_version: The maximum supported version for the feature. (int16 | versions 3+)

  • finalized_features_epoch: The monotonically increasing epoch for the finalized features information. Valid values are >= 0. A value of -1 is special and represents unknown epoch. (int64 | versions 3+)

  • finalized_features: List of cluster-wide finalized features. The information is valid only if FinalizedFeaturesEpoch >= 0. ([]FinalizedFeatureKey | versions 3+)

    • name: The name of the feature. (string | versions 3+)

    • max_version_level: The cluster-wide finalized max version level for the feature. (int16 | versions 3+)

    • min_version_level: The cluster-wide finalized min version level for the feature. (int16 | versions 3+)

  • zk_migration_ready: Set by a KRaft controller if the required configurations for ZK migration are present (bool | versions 3+)

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:

  • client_software_name: The name of the client. (string | versions 3+)

  • client_software_version: The version of the client. (string | versions 3+)