| <?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.Producer</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.Producer.html" class="internal-link" title="This class"><wbr></wbr>Producer</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.Producer.__init__">__init__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#close" class="internal-link" title="pulsar.asyncio.Producer.close">close</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#flush" class="internal-link" title="pulsar.asyncio.Producer.flush">flush</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#last_sequence_id" class="internal-link" title="pulsar.asyncio.Producer.last_sequence_id">last<wbr></wbr>_sequence<wbr></wbr>_id</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#producer_name" class="internal-link" title="pulsar.asyncio.Producer.producer_name">producer<wbr></wbr>_name</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#send" class="internal-link" title="pulsar.asyncio.Producer.send">send</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#topic" class="internal-link" title="pulsar.asyncio.Producer.topic">topic</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| <div class="childrenKindTitle">Attributes</div> |
| <ul> |
| |
| <li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#_producer" class="internal-link" title="pulsar.asyncio.Producer._producer">_producer</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#_schema" class="internal-link" title="pulsar.asyncio.Producer._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=""> |
| |
| |
| |
| |
| |
| <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=" thisobject"> |
| |
| |
| |
| |
| |
| <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.Producer.html" class="internal-link" title="pulsar.asyncio.Producer">Producer</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">Producer</span>: <a href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/asyncio.py#L71" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="pulsar.asyncio.Producer.__init__">Producer(producer, schema)</a></code></p> |
| <p><a href="classIndex.html#pulsar.asyncio.Producer">View In Hierarchy</a></p> |
| </div> |
| |
| <div class="moduleDocstring"> |
| <div><p>The Pulsar message producer, used to publish messages on a topic.</p></div> |
| </div> |
| |
| <div id="splitTables"> |
| <table class="children sortable" id="id7"> |
| |
| |
| <tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__init__" class="internal-link" title="pulsar.asyncio.Producer.__init__">__init__</a></code></td> |
| <td>Create the producer. Users should not call this constructor directly. Instead, create the producer via <code><a href="pulsar.asyncio.Client.html#create_producer" class="internal-link" title="pulsar.asyncio.Client.create_producer">Client.create_producer</a></code>.</td> |
| </tr><tr class="method"> |
| |
| <td>Async Method</td> |
| <td><code><a href="#close" class="internal-link" title="pulsar.asyncio.Producer.close">close</a></code></td> |
| <td>Close the producer.</td> |
| </tr><tr class="method"> |
| |
| <td>Async Method</td> |
| <td><code><a href="#flush" class="internal-link" title="pulsar.asyncio.Producer.flush">flush</a></code></td> |
| <td>Flush all the messages buffered in the producer asynchronously.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#last_sequence_id" class="internal-link" title="pulsar.asyncio.Producer.last_sequence_id">last<wbr></wbr>_sequence<wbr></wbr>_id</a></code></td> |
| <td>Return the last sequence id that was published and acknowledged by this producer.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#producer_name" class="internal-link" title="pulsar.asyncio.Producer.producer_name">producer<wbr></wbr>_name</a></code></td> |
| <td>Return the producer name which could have been assigned by the system or specified by the client</td> |
| </tr><tr class="method"> |
| |
| <td>Async Method</td> |
| <td><code><a href="#send" class="internal-link" title="pulsar.asyncio.Producer.send">send</a></code></td> |
| <td>Send a message asynchronously.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#topic" class="internal-link" title="pulsar.asyncio.Producer.topic">topic</a></code></td> |
| <td>Return the topic which producer is publishing to</td> |
| </tr><tr class="instancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="#_producer" class="internal-link" title="pulsar.asyncio.Producer._producer">_producer</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.Producer._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.Producer.__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">producer: <code><a href="_pulsar.Producer.html" class="internal-link" title="_pulsar.Producer">_pulsar.Producer</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.9.0/pulsar/asyncio.py#L76"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__init__" title="pulsar.asyncio.Producer.__init__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Create the producer. |
| Users should not call this constructor directly. Instead, create the |
| producer via <code><a href="pulsar.asyncio.Client.html#create_producer" class="internal-link" title="pulsar.asyncio.Client.create_producer">Client.create_producer</a></code>.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">producer:</span><code><a href="_pulsar.Producer.html" class="internal-link">_pulsar.Producer</a></code></td><td class="fieldArgDesc">The underlying Producer 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 sent by this producer.</td></tr></table></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.asyncio.Producer.close"> |
| |
| </a> |
| <a name="close"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">async def</span> <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.9.0/pulsar/asyncio.py#L188"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#close" title="pulsar.asyncio.Producer.close"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Close the producer.</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.Producer.flush"> |
| |
| </a> |
| <a name="flush"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">async def</span> <span class="py-defname">flush</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/asyncio.py#L176"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#flush" title="pulsar.asyncio.Producer.flush"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Flush all the messages buffered in the producer 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.Producer.last_sequence_id"> |
| |
| </a> |
| <a name="last_sequence_id"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">last_sequence_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/asyncio.py#L213"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#last_sequence_id" title="pulsar.asyncio.Producer.last_sequence_id"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Return the last sequence id that was published and acknowledged by this producer.</p> |
| <p>The sequence id can be either automatically assigned or custom set on the message. |
| After recreating a producer with the same name, this will return the sequence id |
| of the last message that was published in the previous session, or -1 if no |
| message was ever published.</p> |
| </div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.asyncio.Producer.producer_name"> |
| |
| </a> |
| <a name="producer_name"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">producer_name</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/asyncio.py#L206"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#producer_name" title="pulsar.asyncio.Producer.producer_name"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Return the producer name which could have been assigned by the |
| system or specified by the client</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.asyncio.Producer.send"> |
| |
| </a> |
| <a name="send"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">async def</span> <span class="py-defname">send</span><span class="function-signature long-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">content: <code><a href="https://docs.python.org/3/library/typing.html#typing.Any" class="intersphinx-link">Any</a></code>, </span><span class="rst-sig-param">properties: <code><a href="https://docs.python.org/3/library/stdtypes.html#dict" class="intersphinx-link">dict</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><span class="rst-sig-param">partition_key: <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><span class="rst-sig-param">ordering_key: <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><span class="rst-sig-param">sequence_id: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</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><span class="rst-sig-param">replication_clusters: <code><a href="https://docs.python.org/3/library/stdtypes.html#list" class="intersphinx-link">list</a>[<wbr></wbr><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><span class="rst-sig-param">disable_replication: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</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><span class="rst-sig-param">event_timestamp: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</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><span class="rst-sig-param">deliver_at: <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</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><span class="rst-sig-param">deliver_after: <code><a href="https://docs.python.org/3/library/datetime.html#datetime.timedelta" class="intersphinx-link">timedelta</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/asyncio.py#L93"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#send" title="pulsar.asyncio.Producer.send"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Send a message asynchronously.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">content:</span><code><a href="https://docs.python.org/3/library/typing.html#typing.Any" class="intersphinx-link">Any</a></code></td><td class="fieldArgDesc">The message payload, whose type should respect the schema defined in |
| <code><a href="pulsar.asyncio.Client.html#create_producer" class="internal-link" title="pulsar.asyncio.Client.create_producer">Client.create_producer</a></code>.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">properties:</span>dict|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">A dict of application-defined string properties.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">partition<wbr></wbr>_key:</span>str|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Sets the partition key for the message routing. A hash of this key is |
| used to determine the message's topic partition.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">ordering<wbr></wbr>_key:</span>str|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Sets the ordering key for the message routing.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">sequence<wbr></wbr>_id:</span>int|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Specify a custom sequence id for the message being published.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">replication<wbr></wbr>_clusters:</span><code><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<a href="https://docs.python.org/3/library/stdtypes.html#str" class="intersphinx-link">str</a>]</code> |<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Override namespace replication clusters. Note that it is the caller's responsibility |
| to provide valid cluster names and that all clusters have been previously configured |
| as topics. Given an empty list, the message will replicate per the namespace |
| configuration.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">disable<wbr></wbr>_replication:</span>bool|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Do not replicate this message.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">event<wbr></wbr>_timestamp:</span>int|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Timestamp in millis of the timestamp of event creation</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">deliver<wbr></wbr>_at:</span>int|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Specify the message should not be delivered earlier than the specified timestamp.</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">deliver<wbr></wbr>_after:</span>timedelta|<blockquote> |
| None</blockquote> |
| </td><td class="fieldArgDesc">Specify a delay in timedelta for the delivery of the messages.</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">pulsar.MessageId</a></code></td><td class="fieldArgDesc">The message id that represents the persisted position of the message.</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.Producer.topic"> |
| |
| </a> |
| <a name="topic"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">topic</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/asyncio.py#L200"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#topic" title="pulsar.asyncio.Producer.topic"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Return the topic which producer is publishing to</p></div> |
| </div> |
| </div><div class="baseinstancevariable private"> |
| |
| |
| <a name="pulsar.asyncio.Producer._producer"> |
| |
| </a> |
| <a name="_producer"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <span class="py-defname">_producer</span> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/asyncio.py#L89"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#_producer" title="pulsar.asyncio.Producer._producer"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p class="undocumented">Undocumented</p></div> |
| |
| </div> |
| </div><div class="baseinstancevariable private"> |
| |
| |
| <a name="pulsar.asyncio.Producer._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.9.0/pulsar/asyncio.py#L90"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#_schema" title="pulsar.asyncio.Producer._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 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> |
