static/api/python/3.3.x/pulsar.MessageId.html - pulsar-site - Git at Google

 <?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 23.4.1">

     </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="search-help-button" title="Help" onclick="toggleSearchHelpText()"><img src="fonts/info.svg" alt="Help" /></a>
             </span>
           </div>
         </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="#deserialize" class="internal-link" title="pulsar.MessageId.deserialize">deserialize</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="#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.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.__about__.html" class="internal-link" title="pulsar.__about__">__about__</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>
 </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.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>
 </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 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 class="hint" id="search-help-box">
             <p class="rst-last">

               Search bar offers the following options:
               <ul>
                   <li>
                     <strong>Term presence.</strong> The below example searches for documents that
                       must contain “foo”, might contain “bar” and must not contain “baz”: <code>+foo bar -baz</code>
                   </li>

                   <li>
                     <strong>Wildcards.</strong> The below example searches for documents with words beginning with “foo”: <code>foo*</code>
                   </li>

                   <li>
                     <strong>Search in specific fields.</strong> The following search matches all objects
                     in "twisted.mail" that matches “search”: <code>+qname:twisted.mail.* +search</code>

                     <p>
                       Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'.
                       Last two fields are only applicable if "search in docstrings" is enabled.
                     </p>
                   </li>

                   <li>
                     <strong>Fuzzy matches.</strong> The following search matches all documents
                     that have a word within 1 edit distance of “foo”: <code>foo~1</code>
                   </li>
               </ul>

             </p>
           </div>

           <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: 8px;">
             <p>Results provided by <a href="https://lunrjs.com">Lunr.js</a></p>
           </div>
         </div>

         <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.3.0/pulsar/__init__.py#L70" 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="id52">


   <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="#__init__" class="internal-link" title="pulsar.MessageId.__init__">__init__</a></code></td>
     <td><span class="undocumented">Undocumented</span></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="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="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="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="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="undocumented">Undocumented</span></td>
   </tr>
 </table>


         </div>

         <div id="childList">
           <div class="basestaticmethod">


   <a name="pulsar.MessageId.deserialize">

   </a>
   <a name="deserialize">

   </a>
   <div class="functionHeader">

     @<a href="https://docs.python.org/3/library/functions.html#staticmethod" class="intersphinx-link">staticmethod</a><br />
     <span class="py-keyword">def</span> <span class="py-defname">deserialize</span><span class="function-signature">(message_id_bytes)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L108">

       (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></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">(self, partition=-1, ledger_id=-1, entry_id=-1, batch_index=-1)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L83">

       (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.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">(self)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L95">

       (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">(self)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L92">

       (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">(self)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L89">

       (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">(self)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L98">

       (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">(self)</span>:
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L101">

       (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.3.0/pulsar/__init__.py#L74">

       (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.3.0/pulsar/__init__.py#L75">

       (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> =
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L84">

       (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">
       <a href="index.html">API Documentation</a> for _pulsar/pulsar,
     generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
       23.4.1 at 2023-08-30 15:10:14.
     </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>