Skip to content

Commit 822f765

Browse files
ikuramshingitbook-bot
ikuramshin
authored andcommitted
GITBOOK-58: New serdes docs
1 parent 47da9a4 commit 822f765

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

configuration/serialization-serde.md

+23
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,25 @@ Big-endian 4/8 bytes representation of signed/unsigned integers.
1414

1515
Base64 (RFC4648) binary data representation. Can be useful in case if the actual data is not important, but exactly the same (byte-wise) key/value should be send.
1616

17+
#### Hex
18+
19+
[Hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) binary data representation. Bytes delimiter and case can be configured. 
20+
21+
Class name: `com.provectus.kafka.ui.serdes.builtin.HexSerde`
22+
23+
```
24+
kafka:
25+
clusters:
26+
- name: Cluster1
27+
# Other Cluster configuration omitted ...
28+
serde:
29+
- name: HexWithEditedDelimiter
30+
className: com.provectus.kafka.ui.serdes.builtin.HexSerde
31+
properties:
32+
uppercase: "false"
33+
delimiter: ":"
34+
```
35+
1736
#### String
1837

1938
Treats binary data as a string in specified encoding. Default encoding is UTF-8.
@@ -84,7 +103,9 @@ kafka:
84103
"topic.2": my.Type2
85104
```
86105

106+
#### ProtobufRawDecoder
87107

108+
Deserialize-only serde. Decodes protobuf payload without a predefined schema (like `protoc --decode_raw` command).
88109

89110
#### SchemaRegistry
90111

@@ -116,6 +137,8 @@ kafka:
116137
url: http://another-yet-schema-registry:8081
117138
```
118139

140+
141+
119142
### Setting serdes for specific topics
120143

121144
You can specify preferable serde for topics key/value. This serde will be chosen by default in UI on topic's view/produce pages. To do so, set `topicValuesPattern/topicValuesPattern` properties for the selected serde. Kafka-ui will choose a first serde that matches specified pattern.

0 commit comments

Comments
 (0)