static/api/python/3.11.x/pulsar.asyncio.Consumer.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.asyncio.Consumer</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.asyncio.Consumer.html" class="internal-link" title="This class"><wbr></wbr>Consumer</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Methods</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="#__init__" class="internal-link" title="pulsar.asyncio.Consumer.__init__">__init__</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#acknowledge" class="internal-link" title="pulsar.asyncio.Consumer.acknowledge">acknowledge</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#acknowledge_cumulative" class="internal-link" title="pulsar.asyncio.Consumer.acknowledge_cumulative">acknowledge<wbr></wbr>_cumulative</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#close" class="internal-link" title="pulsar.asyncio.Consumer.close">close</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#consumer_name" class="internal-link" title="pulsar.asyncio.Consumer.consumer_name">consumer<wbr></wbr>_name</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#get_last_message_id" class="internal-link" title="pulsar.asyncio.Consumer.get_last_message_id">get<wbr></wbr>_last<wbr></wbr>_message<wbr></wbr>_id</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#negative_acknowledge" class="internal-link" title="pulsar.asyncio.Consumer.negative_acknowledge">negative<wbr></wbr>_acknowledge</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#receive" class="internal-link" title="pulsar.asyncio.Consumer.receive">receive</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#redeliver_unacknowledged_messages" class="internal-link" title="pulsar.asyncio.Consumer.redeliver_unacknowledged_messages">redeliver<wbr></wbr>_unacknowledged<wbr></wbr>_messages</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#seek" class="internal-link" title="pulsar.asyncio.Consumer.seek">seek</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#subscription_name" class="internal-link" title="pulsar.asyncio.Consumer.subscription_name">subscription<wbr></wbr>_name</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#topic" class="internal-link" title="pulsar.asyncio.Consumer.topic">topic</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#unsubscribe" class="internal-link" title="pulsar.asyncio.Consumer.unsubscribe">unsubscribe</a></code>
             </div>


     </li>
 </ul>


         <div class="childrenKindTitle">Attributes</div>
         <ul>

     <li class="private">


             <div class="itemName"><code><a href="#_consumer" class="internal-link" title="pulsar.asyncio.Consumer._consumer">_consumer</a></code>
             </div>


     </li><li class="private">


             <div class="itemName"><code><a href="#_schema" class="internal-link" title="pulsar.asyncio.Consumer._schema">_schema</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div><div>

       <div class="thingTitle">
         <span>Module</span>
         <code><a href="pulsar.asyncio.html" class="internal-link" title="The parent of this class">asyncio</a></code>
       </div>

       <div>


         <div class="childrenKindTitle">Classes</div>
         <ul>

     <li class="">


             <div class="itemName"><code><a href="pulsar.asyncio.Client.html" class="internal-link" title="pulsar.asyncio.Client"><wbr></wbr>Client</a></code>
             </div>


     </li><li class=" thisobject">


             <div class="itemName"><code><a href="pulsar.asyncio.Consumer.html" class="internal-link" title="pulsar.asyncio.Consumer"><wbr></wbr>Consumer</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.asyncio.Producer.html" class="internal-link" title="pulsar.asyncio.Producer"><wbr></wbr>Producer</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException"><wbr></wbr>Pulsar<wbr></wbr>Exception</a></code>
             </div>


     </li>
 </ul>

         <div class="childrenKindTitle">Functions</div>
         <ul>

     <li class="private">


             <div class="itemName"><code><a href="pulsar.asyncio.html#_set_future" class="internal-link" title="pulsar.asyncio._set_future">_set<wbr></wbr>_future</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.asyncio.html" class="internal-link" title="pulsar.asyncio">asyncio</a></code><wbr></wbr>.<code><a href="pulsar.asyncio.Consumer.html" class="internal-link" title="pulsar.asyncio.Consumer">Consumer</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">Consumer</span>: <a href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L231" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="pulsar.asyncio.Consumer.__init__">Consumer(consumer, schema)</a></code></p>
           <p><a href="classIndex.html#pulsar.asyncio.Consumer">View In Hierarchy</a></p>
         </div>

         <div class="moduleDocstring">
           <div><p>The Pulsar message consumer, used to subscribe to messages from a topic.</p></div>
         </div>

         <div id="splitTables">
           <table class="children sortable" id="id8">


   <tr class="method">

     <td>Method</td>
     <td><code><a href="#__init__" class="internal-link" title="pulsar.asyncio.Consumer.__init__">__init__</a></code></td>
     <td>Create the consumer. Users should not call this constructor directly. Instead, create the consumer via <code><a href="pulsar.asyncio.Client.html#subscribe" class="internal-link" title="pulsar.asyncio.Client.subscribe">Client.subscribe</a></code>.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#acknowledge" class="internal-link" title="pulsar.asyncio.Consumer.acknowledge">acknowledge</a></code></td>
     <td>Acknowledge the reception of a single message asynchronously.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#acknowledge_cumulative" class="internal-link" title="pulsar.asyncio.Consumer.acknowledge_cumulative">acknowledge<wbr></wbr>_cumulative</a></code></td>
     <td>Acknowledge the reception of all the messages in the stream up to (and including) the provided message asynchronously.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#close" class="internal-link" title="pulsar.asyncio.Consumer.close">close</a></code></td>
     <td>Close the consumer asynchronously.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#consumer_name" class="internal-link" title="pulsar.asyncio.Consumer.consumer_name">consumer<wbr></wbr>_name</a></code></td>
     <td>Return the consumer name.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#get_last_message_id" class="internal-link" title="pulsar.asyncio.Consumer.get_last_message_id">get<wbr></wbr>_last<wbr></wbr>_message<wbr></wbr>_id</a></code></td>
     <td>Asynchronously get the last message id.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#negative_acknowledge" class="internal-link" title="pulsar.asyncio.Consumer.negative_acknowledge">negative<wbr></wbr>_acknowledge</a></code></td>
     <td>Acknowledge the failure to process a single message asynchronously.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#receive" class="internal-link" title="pulsar.asyncio.Consumer.receive">receive</a></code></td>
     <td>Receive a single message asynchronously.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#redeliver_unacknowledged_messages" class="internal-link" title="pulsar.asyncio.Consumer.redeliver_unacknowledged_messages">redeliver<wbr></wbr>_unacknowledged<wbr></wbr>_messages</a></code></td>
     <td>Redelivers all the unacknowledged messages. In failover mode, the request is ignored if the consumer is not active for the given topic. In shared mode, the consumer's messages to be redelivered are distributed across all the connected consumers...</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#seek" class="internal-link" title="pulsar.asyncio.Consumer.seek">seek</a></code></td>
     <td>Reset the subscription associated with this consumer to a specific message id or publish timestamp asynchronously.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#subscription_name" class="internal-link" title="pulsar.asyncio.Consumer.subscription_name">subscription<wbr></wbr>_name</a></code></td>
     <td>Return the subscription name.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#topic" class="internal-link" title="pulsar.asyncio.Consumer.topic">topic</a></code></td>
     <td>Return the topic this consumer is subscribed to.</td>
   </tr><tr class="method">

     <td>Async Method</td>
     <td><code><a href="#unsubscribe" class="internal-link" title="pulsar.asyncio.Consumer.unsubscribe">unsubscribe</a></code></td>
     <td>Unsubscribe the current consumer from the topic asynchronously.</td>
   </tr><tr class="instancevariable private">

     <td>Instance Variable</td>
     <td><code><a href="#_consumer" class="internal-link" title="pulsar.asyncio.Consumer._consumer">_consumer</a></code></td>
     <td><span class="rst-undocumented">Undocumented</span></td>
   </tr><tr class="instancevariable private">

     <td>Instance Variable</td>
     <td><code><a href="#_schema" class="internal-link" title="pulsar.asyncio.Consumer._schema">_schema</a></code></td>
     <td><span class="rst-undocumented">Undocumented</span></td>
   </tr>
 </table>


         </div>

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


   <a name="pulsar.asyncio.Consumer.__init__">

   </a>
   <a name="__init__">

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


     <span class="py-keyword">def</span>&#160;<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">consumer: <code><a href="_pulsar.Consumer.html" class="internal-link" title="_pulsar.Consumer">_pulsar.Consumer</a></code>, </span><span class="rst-sig-param">schema: <code><a href="pulsar.schema.schema.Schema.html" class="internal-link" title="pulsar.schema.schema.Schema">pulsar.schema.Schema</a></code></span>):</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L236">

       (source)
     </a>
     <a class="headerLink" href="#__init__" title="pulsar.asyncio.Consumer.__init__">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Create the consumer.
 Users should not call this constructor directly. Instead, create the
 consumer via <code><a href="pulsar.asyncio.Client.html#subscribe" class="internal-link" title="pulsar.asyncio.Client.subscribe">Client.subscribe</a></code>.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">consumer:</span><code><a href="_pulsar.Consumer.html" class="internal-link">_pulsar.Consumer</a></code></td><td class="fieldArgDesc">The underlying Consumer object from the C extension.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">schema:</span><code><a href="pulsar.schema.schema.Schema.html" class="internal-link" title="pulsar.schema.schema.Schema">pulsar.schema.Schema</a></code></td><td class="fieldArgDesc">The schema of the data that will be received by this consumer.</td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.acknowledge">

   </a>
   <a name="acknowledge">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">acknowledge</span><span class="function-signature long-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">message: <code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">pulsar.Message</a> | <a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">pulsar.MessageId</a> | <a href="_pulsar.Message.html" class="internal-link" title="_pulsar.Message">_pulsar.Message</a> | <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.11.0/pulsar/asyncio.py#L273">

       (source)
     </a>
     <a class="headerLink" href="#acknowledge" title="pulsar.asyncio.Consumer.acknowledge">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Acknowledge the reception of a single message asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">message:</span><code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">Message</a></code>, <code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">MessageId</a></code>, <code><a href="_pulsar.Message.html" class="internal-link">_pulsar.Message</a></code>, <code><a href="_pulsar.MessageId.html" class="internal-link">_pulsar.MessageId</a></code></td><td class="fieldArgDesc">The received message or message id.</td></tr></table><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.acknowledge_cumulative">

   </a>
   <a name="acknowledge_cumulative">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">acknowledge_cumulative</span><span class="function-signature long-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">message: <code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">pulsar.Message</a> | <a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">pulsar.MessageId</a> | <a href="_pulsar.Message.html" class="internal-link" title="_pulsar.Message">_pulsar.Message</a> | <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.11.0/pulsar/asyncio.py#L300">

       (source)
     </a>
     <a class="headerLink" href="#acknowledge_cumulative" title="pulsar.asyncio.Consumer.acknowledge_cumulative">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Acknowledge the reception of all the messages in the stream up to (and
 including) the provided message asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">message:</span><code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">Message</a></code>, <code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">MessageId</a></code>, <code><a href="_pulsar.Message.html" class="internal-link">_pulsar.Message</a></code>, <code><a href="_pulsar.MessageId.html" class="internal-link">_pulsar.MessageId</a></code></td><td class="fieldArgDesc">The received message or message id.</td></tr></table><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.close">

   </a>
   <a name="close">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">close</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.11.0/pulsar/asyncio.py#L397">

       (source)
     </a>
     <a class="headerLink" href="#close" title="pulsar.asyncio.Consumer.close">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Close the consumer asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.consumer_name">

   </a>
   <a name="consumer_name">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">consumer_name</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <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.11.0/pulsar/asyncio.py#L441">

       (source)
     </a>
     <a class="headerLink" href="#consumer_name" title="pulsar.asyncio.Consumer.consumer_name">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Return the consumer name.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.get_last_message_id">

   </a>
   <a name="get_last_message_id">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">get_last_message_id</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <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.11.0/pulsar/asyncio.py#L409">

       (source)
     </a>
     <a class="headerLink" href="#get_last_message_id" title="pulsar.asyncio.Consumer.get_last_message_id">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Asynchronously get the last message id.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.negative_acknowledge">

   </a>
   <a name="negative_acknowledge">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">negative_acknowledge</span><span class="function-signature long-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">message: <code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">pulsar.Message</a> | <a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">pulsar.MessageId</a> | <a href="_pulsar.Message.html" class="internal-link" title="_pulsar.Message">_pulsar.Message</a> | <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.11.0/pulsar/asyncio.py#L330">

       (source)
     </a>
     <a class="headerLink" href="#negative_acknowledge" title="pulsar.asyncio.Consumer.negative_acknowledge">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Acknowledge the failure to process a single message asynchronously.</p>
 <p>When a message is "negatively acked" it will be marked for redelivery after
 some fixed delay. The delay is configurable when constructing the consumer
 with <a class="rst-external rst-reference" href="mailto:{@link" target="_top">{@link</a> ConsumerConfiguration#setNegativeAckRedeliveryDelayMs}.
 This call is not blocking.</p>
 <table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">message:</span><code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">pulsar.Message</a> | <a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">pulsar.MessageId</a> | <a href="_pulsar.Message.html" class="internal-link" title="_pulsar.Message">_pulsar.Message</a> | <a href="_pulsar.MessageId.html" class="internal-link" title="_pulsar.MessageId">_pulsar.MessageId</a></code></td><td class="fieldArgDesc">The received message or message id.</td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.receive">

   </a>
   <a name="receive">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">receive</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <code><a href="pulsar.Message.html" class="internal-link" title="pulsar.Message">pulsar.Message</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L252">

       (source)
     </a>
     <a class="headerLink" href="#receive" title="pulsar.asyncio.Consumer.receive">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Receive a single message asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Returns</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.Message.html" class="internal-link">pulsar.Message</a></code></td><td class="fieldArgDesc">The message received.</td></tr></table><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.redeliver_unacknowledged_messages">

   </a>
   <a name="redeliver_unacknowledged_messages">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">redeliver_unacknowledged_messages</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.11.0/pulsar/asyncio.py#L418">

       (source)
     </a>
     <a class="headerLink" href="#redeliver_unacknowledged_messages" title="pulsar.asyncio.Consumer.redeliver_unacknowledged_messages">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Redelivers all the unacknowledged messages. In failover mode, the
 request is ignored if the consumer is not active for the given topic. In
 shared mode, the consumer's messages to be redelivered are distributed
 across all the connected consumers. This is a non-blocking call and
 doesn't throw an exception. In case the connection breaks, the messages
 are redelivered after reconnect.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.seek">

   </a>
   <a name="seek">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">seek</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">messageid: <code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">pulsar.MessageId</a> | <a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code></span>):</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L367">

       (source)
     </a>
     <a class="headerLink" href="#seek" title="pulsar.asyncio.Consumer.seek">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Reset the subscription associated with this consumer to a specific
 message id or publish timestamp asynchronously.</p>
 <p>The message id can either be a specific message or represent the first
 or last messages in the topic.</p>
 <table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">messageid:</span><code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId">MessageId</a></code> or <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code></td><td class="fieldArgDesc">The message id for seek, OR an integer event time (timestamp) to
 seek to</td></tr></table><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.subscription_name">

   </a>
   <a name="subscription_name">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">subscription_name</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <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.11.0/pulsar/asyncio.py#L435">

       (source)
     </a>
     <a class="headerLink" href="#subscription_name" title="pulsar.asyncio.Consumer.subscription_name">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Return the subscription name.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.topic">

   </a>
   <a name="topic">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">topic</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <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.11.0/pulsar/asyncio.py#L429">

       (source)
     </a>
     <a class="headerLink" href="#topic" title="pulsar.asyncio.Consumer.topic">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Return the topic this consumer is subscribed to.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.asyncio.Consumer.unsubscribe">

   </a>
   <a name="unsubscribe">

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


     <span class="py-keyword">async&#160;def</span>&#160;<span class="py-defname">unsubscribe</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.11.0/pulsar/asyncio.py#L355">

       (source)
     </a>
     <a class="headerLink" href="#unsubscribe" title="pulsar.asyncio.Consumer.unsubscribe">


       ¶
     </a>
   </div>
   <div class="docstring functionBody">

     <div><p>Unsubscribe the current consumer from the topic asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Raises</td></tr><tr><td class="fieldArgContainer"><code><a href="pulsar.asyncio.PulsarException.html" class="internal-link" title="pulsar.asyncio.PulsarException">PulsarException</a></code></td><td></td></tr></table></div>
   </div>
 </div><div class="baseinstancevariable private">


   <a name="pulsar.asyncio.Consumer._consumer">

   </a>
   <a name="_consumer">

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

     <span class="py-defname">_consumer</span> =
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L249">

       (source)
     </a>
     <a class="headerLink" href="#_consumer" title="pulsar.asyncio.Consumer._consumer">


       ¶
     </a>
   </div>
   <div class="functionBody">

     <div><p class="undocumented">Undocumented</p></div>

   </div>
 </div><div class="baseinstancevariable private">


   <a name="pulsar.asyncio.Consumer._schema">

   </a>
   <a name="_schema">

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

     <span class="py-defname">_schema</span> =
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.11.0/pulsar/asyncio.py#L250">

       (source)
     </a>
     <a class="headerLink" href="#_schema" title="pulsar.asyncio.Consumer._schema">


       ¶
     </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 2026-04-16 16:39:30.
     </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>