| <?xml version="1.0" encoding="utf-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| "DTD/xhtml1-strict.dtd"> |
| <html> |
| |
| |
| <head> |
| |
| <title>pulsar.MessageId</title> |
| <meta name="generator" content="pydoctor 25.4.0"> |
| |
| </meta> |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1 maximum-scale=1" /> |
| <link rel="stylesheet" type="text/css" href="apidocs.css" /> |
| <link rel="stylesheet" type="text/css" href="readthedocstheme.css" /> |
| <link rel="stylesheet" type="text/css" href="extra.css" /> |
| |
| </head> |
| |
| <body> |
| |
| |
| |
| <nav class="navbar navbar-default mainnavbar"> |
| |
| |
| <div class="container-fluid"> |
| |
| |
| <div class="navbar-header"> |
| |
| <div class="navlinks"> |
| <span class="navbar-brand"> |
| pulsar/_pulsar <a href="index.html">API Documentation</a> |
| </span> |
| |
| <a href="moduleIndex.html"> |
| Modules |
| </a> |
| |
| <a href="classIndex.html"> |
| Classes |
| </a> |
| |
| <a href="nameIndex.html"> |
| Names |
| </a> |
| |
| <div id="search-box-container"> |
| <div class="input-group"> |
| <input id="search-box" type="search" name="search-query" placeholder="Search..." aria-label="Search" minlength="2" class="form-control" autocomplete="off" /> |
| |
| <span class="input-group-btn"> |
| <a style="display: none;" class="btn btn-default" id="search-clear-button" title="Clear" onclick="clearSearch()"><img src="fonts/x-circle.svg" alt="Clear" /></a> |
| <a class="btn btn-default" id="apidocs-help-button" title="Help" href="apidocs-help.html"><img src="fonts/info.svg" alt="Help" /></a> |
| </span> |
| </div> |
| </div> |
| |
| </div> |
| |
| <div id="search-results-container" style="display: none;"> |
| |
| <div id="search-buttons"> |
| <span class="label label-default" id="search-docstrings-button"> |
| <label class="checkbox-inline"> |
| <input type="checkbox" id="toggle-search-in-docstrings-checkbox" value="false" onclick="toggleSearchInDocstrings()"> |
| search in docstrings |
| </input> |
| </label> |
| </span> |
| |
| </div> |
| |
| <noscript> |
| <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1> |
| </noscript> |
| |
| <div id="search-status"> </div> |
| |
| <div class="warning" id="search-warn-box" style="display: none;"> |
| <p class="rst-last"><span id="search-warn"></span></p> |
| </div> |
| |
| <table id="search-results"> |
| <!-- Filled dynamically by JS --> |
| </table> |
| |
| <div style="margin-top: 10px;"> |
| <p>For more information on the search, visit the <a href="apidocs-help.html#rst-search">help page</a>.</p> |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| |
| |
| <!-- Side navigation --> |
| <div class="sidebarcontainer"> |
| <nav class="sidebar"> |
| |
| |
| <div> |
| |
| <div class="thingTitle"> |
| <span>Class</span> |
| <code class="thisobject"><a href="pulsar.MessageId.html" class="internal-link" title="This class"><wbr></wbr>Message<wbr></wbr>Id</a></code> |
| </div> |
| |
| <div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="childrenKindTitle">Methods</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#wrap" class="internal-link" title="pulsar.MessageId.wrap">wrap</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#deserialize" class="internal-link" title="pulsar.MessageId.deserialize">deserialize</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__eq__" class="internal-link" title="pulsar.MessageId.__eq__">__eq__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__ge__" class="internal-link" title="pulsar.MessageId.__ge__">__ge__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__gt__" class="internal-link" title="pulsar.MessageId.__gt__">__gt__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__init__" class="internal-link" title="pulsar.MessageId.__init__">__init__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__le__" class="internal-link" title="pulsar.MessageId.__le__">__le__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__lt__" class="internal-link" title="pulsar.MessageId.__lt__">__lt__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__ne__" class="internal-link" title="pulsar.MessageId.__ne__">__ne__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__str__" class="internal-link" title="pulsar.MessageId.__str__">__str__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#batch_index" class="internal-link" title="pulsar.MessageId.batch_index">batch<wbr></wbr>_index</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#entry_id" class="internal-link" title="pulsar.MessageId.entry_id">entry<wbr></wbr>_id</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#ledger_id" class="internal-link" title="pulsar.MessageId.ledger_id">ledger<wbr></wbr>_id</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#partition" class="internal-link" title="pulsar.MessageId.partition">partition</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#serialize" class="internal-link" title="pulsar.MessageId.serialize">serialize</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| <div class="childrenKindTitle">Attributes</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#earliest" class="internal-link" title="pulsar.MessageId.earliest">earliest</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#latest" class="internal-link" title="pulsar.MessageId.latest">latest</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#_msg_id" class="internal-link" title="pulsar.MessageId._msg_id">_msg<wbr></wbr>_id</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| </div> |
| </div><div> |
| |
| <div class="thingTitle"> |
| <span>Package</span> |
| <code><a href="pulsar.html" class="internal-link" title="The parent of this class">pulsar</a></code> |
| </div> |
| |
| <div> |
| |
| |
| <div class="childrenKindTitle">Modules</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.__about__.html" class="internal-link" title="pulsar.__about__">__about__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.asyncio.html" class="internal-link" title="pulsar.asyncio">asyncio</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.exceptions.html" class="internal-link" title="pulsar.exceptions">exceptions</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.functions.html" class="internal-link" title="pulsar.functions">functions</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.html" class="internal-link" title="pulsar.schema">schema</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.tableview.html" class="internal-link" title="pulsar.tableview">tableview</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| <div class="childrenKindTitle">Classes</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Authentication.html" class="internal-link" title="pulsar.Authentication"><wbr></wbr>Authentication</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.AuthenticationAthenz.html" class="internal-link" title="pulsar.AuthenticationAthenz"><wbr></wbr>Authentication<wbr></wbr>Athenz</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.AuthenticationBasic.html" class="internal-link" title="pulsar.AuthenticationBasic"><wbr></wbr>Authentication<wbr></wbr>Basic</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.AuthenticationOauth2.html" class="internal-link" title="pulsar.AuthenticationOauth2"><wbr></wbr>Authentication<wbr></wbr>Oauth2</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.AuthenticationTLS.html" class="internal-link" title="pulsar.AuthenticationTLS"><wbr></wbr>Authentication<wbr></wbr>TLS</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.AuthenticationToken.html" class="internal-link" title="pulsar.AuthenticationToken"><wbr></wbr>Authentication<wbr></wbr>Token</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Client.html" class="internal-link" title="pulsar.Client"><wbr></wbr>Client</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.ConsoleLogger.html" class="internal-link" title="pulsar.ConsoleLogger"><wbr></wbr>Console<wbr></wbr>Logger</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Consumer.html" class="internal-link" title="pulsar.Consumer"><wbr></wbr>Consumer</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.ConsumerBatchReceivePolicy.html" class="internal-link" title="pulsar.ConsumerBatchReceivePolicy"><wbr></wbr>Consumer<wbr></wbr>Batch<wbr></wbr>Receive<wbr></wbr>Policy</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.ConsumerDeadLetterPolicy.html" class="internal-link" title="pulsar.ConsumerDeadLetterPolicy"><wbr></wbr>Consumer<wbr></wbr>Dead<wbr></wbr>Letter<wbr></wbr>Policy</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.ConsumerKeySharedPolicy.html" class="internal-link" title="pulsar.ConsumerKeySharedPolicy"><wbr></wbr>Consumer<wbr></wbr>Key<wbr></wbr>Shared<wbr></wbr>Policy</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.CryptoKeyReader.html" class="internal-link" title="pulsar.CryptoKeyReader"><wbr></wbr>Crypto<wbr></wbr>Key<wbr></wbr>Reader</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.EncryptionContext.html" class="internal-link" title="pulsar.EncryptionContext"><wbr></wbr>Encryption<wbr></wbr>Context</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.EncryptionKey.html" class="internal-link" title="pulsar.EncryptionKey"><wbr></wbr>Encryption<wbr></wbr>Key</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.FileLogger.html" class="internal-link" title="pulsar.FileLogger"><wbr></wbr>File<wbr></wbr>Logger</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message"><wbr></wbr>Message</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.MessageBatch.html" class="internal-link" title="pulsar.MessageBatch"><wbr></wbr>Message<wbr></wbr>Batch</a></code> |
| </div> |
| |
| |
| </li><li class=" thisobject"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId"><wbr></wbr>Message<wbr></wbr>Id</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Producer.html" class="internal-link" title="pulsar.Producer"><wbr></wbr>Producer</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.Reader.html" class="internal-link" title="pulsar.Reader"><wbr></wbr>Reader</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| <div class="childrenKindTitle">Functions</div> |
| <ul> |
| |
| <li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.html#_check_type" class="internal-link" title="pulsar._check_type">_check<wbr></wbr>_type</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.html#_check_type_or_none" class="internal-link" title="pulsar._check_type_or_none">_check<wbr></wbr>_type<wbr></wbr>_or<wbr></wbr>_none</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.html#_listener_wrapper" class="internal-link" title="pulsar._listener_wrapper">_listener<wbr></wbr>_wrapper</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.html#_seek_arg_convert" class="internal-link" title="pulsar._seek_arg_convert">_seek<wbr></wbr>_arg<wbr></wbr>_convert</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| <div class="childrenKindTitle">Variables</div> |
| <ul> |
| |
| <li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.html#_retype" class="internal-link" title="pulsar._retype">_retype</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| </nav> |
| <!-- No sidebar toggle for read the docs theme, the sidebar is always |
| visible when the screen is width enough. |
| --> |
| </div> |
| |
| </nav> |
| |
| <div class="container-fluid"> |
| |
| <div id="main" class=""> |
| |
| |
| |
| |
| |
| <div class="page-header"> |
| <h1 class="class"><code><code><a href="pulsar.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">MessageId</a></code></code></h1> |
| <div id="showPrivate"> |
| <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button> |
| </div> |
| </div> |
| |
| <div class="categoryHeader"> |
| class documentation |
| </div> |
| |
| <div class="extrasDocstring"> |
| <p class="class-signature"><code><span class="py-keyword">class</span> <span class="py-defname">MessageId</span>: <a href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L72" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="pulsar.MessageId.__init__">MessageId(partition, ledger_id, entry_id, batch_index)</a></code></p> |
| <p><a href="classIndex.html#pulsar.MessageId">View In Hierarchy</a></p> |
| </div> |
| |
| <div class="moduleDocstring"> |
| <div><p>Represents a message id.</p></div> |
| </div> |
| |
| <div id="splitTables"> |
| <table class="children sortable" id="id59"> |
| |
| |
| <tr class="classmethod"> |
| |
| <td>Class Method</td> |
| <td><code><a href="#wrap" class="internal-link" title="pulsar.MessageId.wrap">wrap</a></code></td> |
| <td>Wrap the underlying MessageId type from the C extension to the Python type.</td> |
| </tr><tr class="staticmethod"> |
| |
| <td>Static Method</td> |
| <td><code><a href="#deserialize" class="internal-link" title="pulsar.MessageId.deserialize">deserialize</a></code></td> |
| <td>Deserialize a message id object from a previously serialized bytes sequence.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__eq__" class="internal-link" title="pulsar.MessageId.__eq__">__eq__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__ge__" class="internal-link" title="pulsar.MessageId.__ge__">__ge__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__gt__" class="internal-link" title="pulsar.MessageId.__gt__">__gt__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__init__" class="internal-link" title="pulsar.MessageId.__init__">__init__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__le__" class="internal-link" title="pulsar.MessageId.__le__">__le__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__lt__" class="internal-link" title="pulsar.MessageId.__lt__">__lt__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__ne__" class="internal-link" title="pulsar.MessageId.__ne__">__ne__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__str__" class="internal-link" title="pulsar.MessageId.__str__">__str__</a></code></td> |
| <td>Returns the string representation of the message id.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#batch_index" class="internal-link" title="pulsar.MessageId.batch_index">batch<wbr></wbr>_index</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#entry_id" class="internal-link" title="pulsar.MessageId.entry_id">entry<wbr></wbr>_id</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#ledger_id" class="internal-link" title="pulsar.MessageId.ledger_id">ledger<wbr></wbr>_id</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#partition" class="internal-link" title="pulsar.MessageId.partition">partition</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#serialize" class="internal-link" title="pulsar.MessageId.serialize">serialize</a></code></td> |
| <td>Returns a bytes representation of the message id. This byte sequence can be stored and later deserialized.</td> |
| </tr><tr class="instancevariable"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="#earliest" class="internal-link" title="pulsar.MessageId.earliest">earliest</a></code></td> |
| <td>Represents the earliest message stored in a topic</td> |
| </tr><tr class="instancevariable"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="#latest" class="internal-link" title="pulsar.MessageId.latest">latest</a></code></td> |
| <td>Represents the latest message published on a topic</td> |
| </tr><tr class="instancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="#_msg_id" class="internal-link" title="pulsar.MessageId._msg_id">_msg<wbr></wbr>_id</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| |
| <div id="childList"> |
| <div class="baseclassmethod"> |
| |
| |
| <a name="pulsar.MessageId.wrap"> |
| |
| </a> |
| <a name="wrap"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <div><span class="decorator">@<a href="https://docs.python.org/3/library/functions.html#classmethod" class="intersphinx-link">classmethod</a><br /></span></div> |
| <span class="py-keyword">def</span> <span class="py-defname">wrap</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">cls</span>, </span><span class="rst-sig-param">msg_id: <code><a href="_pulsar.MessageId.html" class="internal-link" title="_pulsar.MessageId">_pulsar.MessageId</a></code></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L160"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#wrap" title="pulsar.MessageId.wrap"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Wrap the underlying MessageId type from the C extension to the Python type.</p></div> |
| </div> |
| </div><div class="basestaticmethod"> |
| |
| |
| <a name="pulsar.MessageId.deserialize"> |
| |
| </a> |
| <a name="deserialize"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <div><span class="decorator">@<a href="https://docs.python.org/3/library/functions.html#staticmethod" class="intersphinx-link">staticmethod</a><br /></span></div> |
| <span class="py-keyword">def</span> <span class="py-defname">deserialize</span><span class="function-signature">(<span class="rst-sig-param">message_id_bytes, </span><span class="rst-sig-param">topic: <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a> | <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a></span>) -> <code><a href="_pulsar.MessageId.html" class="internal-link" title="_pulsar.MessageId">_pulsar.MessageId</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L134"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#deserialize" title="pulsar.MessageId.deserialize"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Deserialize a message id object from a previously |
| serialized bytes sequence.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">message<wbr></wbr>_id<wbr></wbr>_bytes</span></td><td class="fieldArgDesc"><span class="undocumented">Undocumented</span></td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">topic:</span><code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>, <em>optional</em></td><td class="fieldArgDesc"><p>For multi-topics consumers, the topic name is required to deserialize the message id.</p> |
| <pre class="py-doctest"> |
| msg = consumer.receive() |
| topic = msg.topic_name() |
| msg_id_bytes = msg.message_id().serialize() |
| <span class="py-comment"># Store topic and msg_id_bytes somewhere</span> |
| <span class="py-comment"># Later, deserialize the message id</span> |
| msg_id = MessageId.deserialize(msg_id_bytes, topic=topic)</pre></td></tr></table><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><code><a href="_pulsar.MessageId.html" class="internal-link" title="_pulsar.MessageId">_pulsar.MessageId</a></code></td><td class="fieldArgDesc"><span class="undocumented">Undocumented</span></td></tr></table></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__eq__"> |
| |
| </a> |
| <a name="__eq__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__eq__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L116"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__eq__" title="pulsar.MessageId.__eq__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__ge__"> |
| |
| </a> |
| <a name="__ge__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__ge__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L128"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__ge__" title="pulsar.MessageId.__ge__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__gt__"> |
| |
| </a> |
| <a name="__gt__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__gt__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L131"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__gt__" title="pulsar.MessageId.__gt__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__init__"> |
| |
| </a> |
| <a name="__init__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__init__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">partition=-1, </span><span class="rst-sig-param">ledger_id=-1, </span><span class="rst-sig-param">entry_id=-1, </span><span class="rst-sig-param">batch_index=-1</span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L85"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__init__" title="pulsar.MessageId.__init__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__le__"> |
| |
| </a> |
| <a name="__le__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__le__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L122"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__le__" title="pulsar.MessageId.__le__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__lt__"> |
| |
| </a> |
| <a name="__lt__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__lt__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L125"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__lt__" title="pulsar.MessageId.__lt__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__ne__"> |
| |
| </a> |
| <a name="__ne__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__ne__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">other</span>) -> <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L119"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__ne__" title="pulsar.MessageId.__ne__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.__str__"> |
| |
| </a> |
| <a name="__str__"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">__str__</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -> <code><a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a></code>:</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L110"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__str__" title="pulsar.MessageId.__str__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Returns the string representation of the message id.</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.batch_index"> |
| |
| </a> |
| <a name="batch_index"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">batch_index</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L97"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#batch_index" title="pulsar.MessageId.batch_index"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.entry_id"> |
| |
| </a> |
| <a name="entry_id"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">entry_id</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L94"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#entry_id" title="pulsar.MessageId.entry_id"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.ledger_id"> |
| |
| </a> |
| <a name="ledger_id"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">ledger_id</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L91"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#ledger_id" title="pulsar.MessageId.ledger_id"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.partition"> |
| |
| </a> |
| <a name="partition"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">partition</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L100"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#partition" title="pulsar.MessageId.partition"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.MessageId.serialize"> |
| |
| </a> |
| <a name="serialize"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">serialize</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L103"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#serialize" title="pulsar.MessageId.serialize"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Returns a bytes representation of the message id. |
| This byte sequence can be stored and later deserialized.</p></div> |
| </div> |
| </div><div class="baseinstancevariable"> |
| |
| |
| <a name="pulsar.MessageId.earliest"> |
| |
| </a> |
| <a name="earliest"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <span class="py-defname">earliest</span> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L88"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#earliest" title="pulsar.MessageId.earliest"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p>Represents the earliest message stored in a topic</p></div> |
| |
| </div> |
| </div><div class="baseinstancevariable"> |
| |
| |
| <a name="pulsar.MessageId.latest"> |
| |
| </a> |
| <a name="latest"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <span class="py-defname">latest</span> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L89"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#latest" title="pulsar.MessageId.latest"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p>Represents the latest message published on a topic</p></div> |
| |
| </div> |
| </div><div class="baseinstancevariable private"> |
| |
| |
| <a name="pulsar.MessageId._msg_id"> |
| |
| </a> |
| <a name="_msg_id"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <span class="py-defname">_msg_id</span>: <code><a href="_pulsar.MessageId.html" class="internal-link" title="_pulsar.MessageId">_pulsar.MessageId</a></code> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L86"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#_msg_id" title="pulsar.MessageId._msg_id"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| |
| <footer class="navbar navbar-default"> |
| <hr /> |
| |
| |
| <div class="container-fluid"> |
| <a href="index.html">API Documentation</a> for pulsar/_pulsar, |
| generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> |
| 25.4.0 at 2025-12-30 16:47:40. |
| </div> |
| |
| <script src="ajax.js" type="text/javascript"></script> |
| <script src="searchlib.js" type="text/javascript"></script> |
| <script src="search.js" type="text/javascript"></script> |
| |
| </footer> |
| |
| <script src="pydoctor.js" type="text/javascript"></script> |
| |
| </body> |
| </html> |
