Module api 

ApiVersions, Metadata, and Produce codecs.

Structs

ApiVersion

One key in an ApiVersions response.

ApiVersionsRequest

Java ApiVersionsRequest helpers.

ApiVersionsResponse

ApiVersions response body.

Broker

One broker in a Metadata response.

FinalizedFeatureKey

One finalized feature in ApiVersions v3+ tagged field 2 (KIP-482).

MetadataRequest

Java MetadataRequest helpers.

MetadataRequestTopic

One topic in a Metadata request (v10+ TopicId + nullable Name).

MetadataResponse

Metadata response body.

NodeEndpoint

Produce v10+ / Fetch v16+ NodeEndpoint (KIP-951).

PartitionMetadata

One partition in a Metadata response.

ProducePartitionData

One partition in a Produce request.

ProducePartitionResponse

One partition in a Produce response.

ProduceRecordError

One record that caused a Produce batch to be dropped (KIP-467).

ProduceRequest

Java ProduceRequest version helpers (KIP-890 transaction V2).

ProduceResponse

Java ProduceResponse helpers.

ProduceTopicData

One topic in a Produce request.

SupportedFeatureKey

One broker-supported feature in ApiVersions v3+ tagged field 0 (KIP-482).

TopicMetadata

One topic in a Metadata response.

Functions

decode_api_versions_handshake

Parse an ApiVersions body, falling back to v0 when the sent version does not leftover-empty (KIP-511: brokers 2.4+ answer an unsupported request with a v0 UNSUPPORTED_VERSION body).

decode_api_versions_request

Decode ApiVersions v0–v4: (software_name, software_version). Empty on v0–v2.

decode_api_versions_response

Decode ApiVersions v0–v4 (classic v0–2, flexible v3–v4).

decode_metadata_request

Decode Metadata request: topic names (None is all topics), allow.auto.create.topics, IncludeTopicAuthorizedOperations, and IncludeClusterAuthorizedOperations (last; false outside v8–v10).

decode_metadata_request_topics

Decode Metadata: every topic (Name and/or TopicId) plus flags.

decode_metadata_response

Decode Metadata.

decode_produce_request

Decode Produce: (transactional_id, acks, timeout_ms, topics).

decode_produce_response

Decode Produce into per-partition results, v10+ NodeEndpoints, and ThrottleTimeMs.

encode_api_versions_request

Encode ApiVersions v0–v4.

encode_api_versions_response

Encode ApiVersions v0–v4 (used by the mock broker).

encode_metadata_request

Encode Metadata. topics = None asks for all topics.

encode_metadata_request_topics

Encode Metadata Topics of Name and/or TopicId (v10+).

encode_metadata_request_topics_with_include_cluster_authorized_operations

Encode Metadata with IncludeClusterAuthorizedOperations (JSON 8-10).

encode_metadata_request_with

Encode Metadata with IncludeTopicAuthorizedOperations (v8+).

encode_metadata_response

Encode Metadata (used by the mock broker).

encode_produce_request

Encode Produce v3–v8 (classic) or v9–v12 (flexible).

encode_produce_response

Encode Produce: one response per partition (mock broker).

encode_produce_response_with_endpoints

Encode Produce plus top-level NodeEndpoints (v10+ tagged field 0).

encode_produce_response_with_throttle

Encode Produce v3–v12 with ThrottleTimeMs.

negotiate_api_versions

Send ApiVersions at client max (v4) and retry once on UNSUPPORTED_VERSION (KIP-511).