From f7f4e5b5b1a23c2e2c27eebdca279a81900544ad Mon Sep 17 00:00:00 2001 From: Ken Huang Date: Mon, 4 Nov 2024 05:46:20 +0800 Subject: [PATCH] KAFKA-17882 improve the document about "default value" of tagged structure field (#17618) Reviewers: Chia-Ping Tsai --- clients/src/main/resources/common/message/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/clients/src/main/resources/common/message/README.md b/clients/src/main/resources/common/message/README.md index dadc98164d835..8c92fd6bc9475 100644 --- a/clients/src/main/resources/common/message/README.md +++ b/clients/src/main/resources/common/message/README.md @@ -139,6 +139,12 @@ breaking compatibility. Note that tagged fields can only be added to "flexible" message versions. +#### Default Value Handling for Tagged Fields + +In Kafka's serialization mechanism, a tagged field may be omitted from the serialized message +if all its associated fields are equal to their default values, whether those defaults are explicit +or implicit. This behavior optimizes message size by avoiding the transmission of redundant data. + Flexible Versions ----------------- Kafka serialization has been improved over time to be more flexible and