pulsar.MessageId

class documentation

class MessageId: (source)

Constructor: MessageId(partition, ledger_id, entry_id, batch_index)

View In Hierarchy

Represents a message id.

Class Method wrap Wrap the underlying MessageId type from the C extension to the Python type.
Static Method deserialize Deserialize a message id object from a previously serialized bytes sequence.
Method __eq__ Undocumented
Method __ge__ Undocumented
Method __gt__ Undocumented
Method __init__ Undocumented
Method __le__ Undocumented
Method __lt__ Undocumented
Method __ne__ Undocumented
Method __str__ Returns the string representation of the message id.
Method batch_index Undocumented
Method entry_id Undocumented
Method ledger_id Undocumented
Method partition Undocumented
Method serialize Returns a bytes representation of the message id. This byte sequence can be stored and later deserialized.
Instance Variable earliest Represents the earliest message stored in a topic
Instance Variable latest Represents the latest message published on a topic
Instance Variable _msg_id Undocumented
def wrap(cls, msg_id: _pulsar.MessageId): (source)

Wrap the underlying MessageId type from the C extension to the Python type.

def deserialize(message_id_bytes, topic: str | None = None) -> _pulsar.MessageId: (source)

Deserialize a message id object from a previously serialized bytes sequence.

Parameters
message_id_bytesUndocumented
topic:str, optional

For multi-topics consumers, the topic name is required to deserialize the message id.

msg = consumer.receive()
topic = msg.topic_name()
msg_id_bytes = msg.message_id().serialize()
# Store topic and msg_id_bytes somewhere
# Later, deserialize the message id
msg_id = MessageId.deserialize(msg_id_bytes, topic=topic)
Returns
_pulsar.MessageIdUndocumented
def __eq__(self, other) -> bool: (source)

Undocumented

def __ge__(self, other) -> bool: (source)

Undocumented

def __gt__(self, other) -> bool: (source)

Undocumented

def __init__(self, partition=-1, ledger_id=-1, entry_id=-1, batch_index=-1): (source)

Undocumented

def __le__(self, other) -> bool: (source)

Undocumented

def __lt__(self, other) -> bool: (source)

Undocumented

def __ne__(self, other) -> bool: (source)

Undocumented

def __str__(self) -> str: (source)

Returns the string representation of the message id.

def batch_index(self): (source)

Undocumented

def entry_id(self): (source)

Undocumented

def ledger_id(self): (source)

Undocumented

def partition(self): (source)

Undocumented

def serialize(self): (source)

Returns a bytes representation of the message id. This byte sequence can be stored and later deserialized.

earliest = (source)

Represents the earliest message stored in a topic

latest = (source)

Represents the latest message published on a topic

_msg_id: _pulsar.MessageId = (source)

Undocumented