View Source KafkaEx.Messages.ApiVersions (kafka_ex v1.0.0-rc.1)

Represents the API versions supported by a Kafka broker.

This struct contains information about which Kafka API versions the broker supports, enabling the client to negotiate compatible API versions for all operations.

Summary

Types

api_key()

The Kafka API key identifier (e.g., 0 for Produce, 1 for Fetch, 3 for Metadata, 18 for ApiVersions)

api_version()

A single API version entry

t()

Functions

build(opts \\ [])

Builds an ApiVersions struct from response data.

max_version_for_api(api_versions, api_key)

Finds the maximum supported version for a given API.

min_version_for_api(api_versions, api_key)

Finds the minimum supported version for a given API.

version_supported?(api_versions, api_key, version)

Checks if a specific API version is supported.

Types

api_key()

@type api_key() :: non_neg_integer()

The Kafka API key identifier (e.g., 0 for Produce, 1 for Fetch, 3 for Metadata, 18 for ApiVersions)

api_version()

@type api_version() :: %{
  min_version: non_neg_integer(),
  max_version: non_neg_integer()
}

A single API version entry

min_version: Minimum supported version for this API
max_version: Maximum supported version for this API

t()

@type t() :: %KafkaEx.Messages.ApiVersions{
  api_versions: %{required(api_key()) => api_version()},
  throttle_time_ms: nil | non_neg_integer()
}

Functions

build(opts \\ [])

@spec build(Keyword.t()) :: t()

Builds an ApiVersions struct from response data.

max_version_for_api(api_versions, api_key)

@spec max_version_for_api(t(), non_neg_integer()) ::
  {:ok, non_neg_integer()} | {:error, :unsupported_api}

Finds the maximum supported version for a given API.

min_version_for_api(api_versions, api_key)

@spec min_version_for_api(t(), non_neg_integer()) ::
  {:ok, non_neg_integer()} | {:error, :unsupported_api}

Finds the minimum supported version for a given API.

version_supported?(api_versions, api_key, version)

@spec version_supported?(t(), non_neg_integer(), non_neg_integer()) :: boolean()

Checks if a specific API version is supported.