Skip to content

Commit 01a3a47

Browse files
committed
Add API documents
1 parent 5e6adc2 commit 01a3a47

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

pulsar/__init__.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,21 @@ def deserialize(message_id_bytes, topic: Optional[str] = None) -> _pulsar.Messag
135135
"""
136136
Deserialize a message id object from a previously
137137
serialized bytes sequence.
138+
139+
Parameters
140+
----------
141+
topic: str, optional
142+
For multi-topics consumers, the topic name is required to deserialize the message id.
143+
144+
.. code-block:: python
145+
146+
msg = consumer.receive()
147+
topic = msg.topic_name()
148+
msg_id_bytes = msg.message_id().serialize()
149+
# Store topic and msg_id_bytes somewhere
150+
# Later, deserialize the message id
151+
msg_id = MessageId.deserialize(msg_id_bytes, topic=topic)
152+
138153
"""
139154
msg_id = _pulsar.MessageId.deserialize(message_id_bytes)
140155
if topic is not None:

0 commit comments

Comments
 (0)