| <?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.ConsumerKeySharedPolicy</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.ConsumerKeySharedPolicy.html" class="internal-link" title="This class"><wbr></wbr>Consumer<wbr></wbr>Key<wbr></wbr>Shared<wbr></wbr>Policy</a></code> |
| </div> |
| |
| <div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="childrenKindTitle">Methods</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#__init__" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.__init__">__init__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#policy" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.policy">policy</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| <div class="childrenKindTitle">Attributes</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#allow_out_of_order_delivery" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.allow_out_of_order_delivery">allow<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_order<wbr></wbr>_delivery</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#key_shared_mode" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.key_shared_mode">key<wbr></wbr>_shared<wbr></wbr>_mode</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#sticky_ranges" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.sticky_ranges">sticky<wbr></wbr>_ranges</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#_policy" class="internal-link" title="pulsar.ConsumerKeySharedPolicy._policy">_policy</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=" thisobject"> |
| |
| |
| |
| |
| |
| <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=""> |
| |
| |
| |
| |
| |
| <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.ConsumerKeySharedPolicy.html" class="internal-link" title="pulsar.ConsumerKeySharedPolicy">ConsumerKeySharedPolicy</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">ConsumerKeySharedPolicy</span>: <a href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1559" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.__init__">ConsumerKeySharedPolicy(key_shared_mode, allow_out_of_order_delivery, sticky_ranges)</a></code></p> |
| <p><a href="classIndex.html#pulsar.ConsumerKeySharedPolicy">View In Hierarchy</a></p> |
| </div> |
| |
| <div class="moduleDocstring"> |
| <div><p>Consumer key shared policy is used to configure the consumer behaviour when the ConsumerType is KeyShared.</p></div> |
| </div> |
| |
| <div id="splitTables"> |
| <table class="children sortable" id="id66"> |
| |
| |
| <tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#__init__" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.__init__">__init__</a></code></td> |
| <td>Wrapper KeySharedPolicy.</td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#policy" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.policy">policy</a></code></td> |
| <td>Returns the actual KeySharedPolicy.</td> |
| </tr><tr class="property"> |
| |
| <td>Property</td> |
| <td><code><a href="#allow_out_of_order_delivery" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.allow_out_of_order_delivery">allow<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_order<wbr></wbr>_delivery</a></code></td> |
| <td>Returns whether out of order delivery is enabled</td> |
| </tr><tr class="property"> |
| |
| <td>Property</td> |
| <td><code><a href="#key_shared_mode" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.key_shared_mode">key<wbr></wbr>_shared<wbr></wbr>_mode</a></code></td> |
| <td>Returns the key shared mode</td> |
| </tr><tr class="property"> |
| |
| <td>Property</td> |
| <td><code><a href="#sticky_ranges" class="internal-link" title="pulsar.ConsumerKeySharedPolicy.sticky_ranges">sticky<wbr></wbr>_ranges</a></code></td> |
| <td>Returns the actual sticky ranges</td> |
| </tr><tr class="instancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="#_policy" class="internal-link" title="pulsar.ConsumerKeySharedPolicy._policy">_policy</a></code></td> |
| <td><span class="undocumented">Undocumented</span></td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| |
| <div id="childList"> |
| <div class="basemethod"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy.__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, key_shared_mode: <code><a href="_pulsar.KeySharedMode.html" class="internal-link" title="_pulsar.KeySharedMode">KeySharedMode</a></code> = KeySharedMode.AutoSplit, allow_out_of_order_delivery: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = <a href="https://docs.python.org/3/library/constants.html#False" class="intersphinx-link">False</a>, sticky_ranges: <code><a href="https://docs.python.org/3/library/typing.html#typing.Optional" class="intersphinx-link">Optional</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.Tuple" class="intersphinx-link">Tuple</a>[<wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>, <wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>]]]</code> = <a href="https://docs.python.org/3/library/constants.html#None" class="intersphinx-link">None</a>)</span>: |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1563"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#__init__" title="pulsar.ConsumerKeySharedPolicy.__init__"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Wrapper KeySharedPolicy.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">key<wbr></wbr>_shared<wbr></wbr>_mode:</span><code><a href="_pulsar.KeySharedMode.html" class="internal-link" title="_pulsar.KeySharedMode">KeySharedMode</a></code>, <em>optional</em></td><td class="fieldArgDesc">Set the key shared mode. eg: KeySharedMode.Sticky or KeysharedMode.AutoSplit</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">allow<wbr></wbr>_out<wbr></wbr>_of<wbr></wbr>_order<wbr></wbr>_delivery:</span><code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code>, <em>optional</em></td><td class="fieldArgDesc"><p>Set whether to allow for out of order delivery |
| If it is enabled, it relaxes the ordering requirement and allows the broker to send out-of-order |
| messages in case of failures. This makes it faster for new consumers to join without being stalled by |
| an existing slow consumer.</p> |
| <p>If this is True, a single consumer still receives all keys, but they may come in different orders.</p> |
| </td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">sticky<wbr></wbr>_ranges:</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/typing.html#typing.Tuple" class="intersphinx-link">Tuple</a>[<a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a></code>, <code><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>]]</code>, <em>optional</em></td><td class="fieldArgDesc">Set the ranges used with sticky mode. The integers can be from 0 to 2^16 (0 <= val < 65,536)</td></tr></table></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy.policy"> |
| |
| </a> |
| <a name="policy"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">policy</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#L1620"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#policy" title="pulsar.ConsumerKeySharedPolicy.policy"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| |
| <div><p>Returns the actual KeySharedPolicy.</p></div> |
| </div> |
| </div><div class="baseproperty"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy.allow_out_of_order_delivery"> |
| |
| </a> |
| <a name="allow_out_of_order_delivery"> |
| |
| </a> |
| <div class="functionHeader"> |
| @<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br /> |
| <span class="py-defname">allow_out_of_order_delivery</span>: <code><a href="https://docs.python.org/3/library/functions.html#bool" class="intersphinx-link">bool</a></code> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1606"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#allow_out_of_order_delivery" title="pulsar.ConsumerKeySharedPolicy.allow_out_of_order_delivery"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p>Returns whether out of order delivery is enabled</p></div> |
| |
| </div> |
| </div><div class="baseproperty"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy.key_shared_mode"> |
| |
| </a> |
| <a name="key_shared_mode"> |
| |
| </a> |
| <div class="functionHeader"> |
| @<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br /> |
| <span class="py-defname">key_shared_mode</span>: <code><a href="_pulsar.KeySharedMode.html" class="internal-link" title="_pulsar.KeySharedMode">KeySharedMode</a></code> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1599"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#key_shared_mode" title="pulsar.ConsumerKeySharedPolicy.key_shared_mode"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p>Returns the key shared mode</p></div> |
| |
| </div> |
| </div><div class="baseproperty"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy.sticky_ranges"> |
| |
| </a> |
| <a name="sticky_ranges"> |
| |
| </a> |
| <div class="functionHeader"> |
| @<a href="https://docs.python.org/3/library/functions.html#property" class="intersphinx-link">property</a><br /> |
| <span class="py-defname">sticky_ranges</span>: <code><a href="https://docs.python.org/3/library/typing.html#typing.List" class="intersphinx-link">List</a>[<wbr></wbr><a href="https://docs.python.org/3/library/typing.html#typing.Tuple" class="intersphinx-link">Tuple</a>[<wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>, <wbr></wbr><a href="https://docs.python.org/3/library/functions.html#int" class="intersphinx-link">int</a>]]</code> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1613"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#sticky_ranges" title="pulsar.ConsumerKeySharedPolicy.sticky_ranges"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="functionBody"> |
| |
| <div><p>Returns the actual sticky ranges</p></div> |
| |
| </div> |
| </div><div class="baseinstancevariable private"> |
| |
| |
| <a name="pulsar.ConsumerKeySharedPolicy._policy"> |
| |
| </a> |
| <a name="_policy"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| <span class="py-defname">_policy</span> = |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.3.0/pulsar/__init__.py#L1592"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#_policy" title="pulsar.ConsumerKeySharedPolicy._policy"> |
| |
| |
| ¶ |
| </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> |
