static/api/python/3.9.x/pulsar.EncryptionContext.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.EncryptionContext</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.EncryptionContext.html" class="internal-link" title="This class"><wbr></wbr>Encryption<wbr></wbr>Context</a></code>
       </div>

       <div>


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

     <li class="">


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


     </li><li class="">


             <div class="itemName"><code><a href="#__repr__" class="internal-link" title="pulsar.EncryptionContext.__repr__">__repr__</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#__str__" class="internal-link" title="pulsar.EncryptionContext.__str__">__str__</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#algorithm" class="internal-link" title="pulsar.EncryptionContext.algorithm">algorithm</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#batch_size" class="internal-link" title="pulsar.EncryptionContext.batch_size">batch<wbr></wbr>_size</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#compression_type" class="internal-link" title="pulsar.EncryptionContext.compression_type">compression<wbr></wbr>_type</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#is_decryption_failed" class="internal-link" title="pulsar.EncryptionContext.is_decryption_failed">is<wbr></wbr>_decryption<wbr></wbr>_failed</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#keys" class="internal-link" title="pulsar.EncryptionContext.keys">keys</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#param" class="internal-link" title="pulsar.EncryptionContext.param">param</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="#uncompressed_message_size" class="internal-link" title="pulsar.EncryptionContext.uncompressed_message_size">uncompressed<wbr></wbr>_message<wbr></wbr>_size</a></code>
             </div>


     </li>
 </ul>


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

     <li class="private">


             <div class="itemName"><code><a href="#_context" class="internal-link" title="pulsar.EncryptionContext._context">_context</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div><div>

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

       <div>


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

     <li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li>
 </ul>

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

     <li class="">


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


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.AuthenticationAthenz.html" class="internal-link" title="pulsar.AuthenticationAthenz"><wbr></wbr>Authentication<wbr></wbr>Athenz</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.AuthenticationBasic.html" class="internal-link" title="pulsar.AuthenticationBasic"><wbr></wbr>Authentication<wbr></wbr>Basic</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.AuthenticationOauth2.html" class="internal-link" title="pulsar.AuthenticationOauth2"><wbr></wbr>Authentication<wbr></wbr>Oauth2</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.AuthenticationTLS.html" class="internal-link" title="pulsar.AuthenticationTLS"><wbr></wbr>Authentication<wbr></wbr>TLS</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.AuthenticationToken.html" class="internal-link" title="pulsar.AuthenticationToken"><wbr></wbr>Authentication<wbr></wbr>Token</a></code>
             </div>


     </li><li class="">


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


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.ConsoleLogger.html" class="internal-link" title="pulsar.ConsoleLogger"><wbr></wbr>Console<wbr></wbr>Logger</a></code>
             </div>


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


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


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.CryptoKeyReader.html" class="internal-link" title="pulsar.CryptoKeyReader"><wbr></wbr>Crypto<wbr></wbr>Key<wbr></wbr>Reader</a></code>
             </div>


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


             <div class="itemName"><code><a href="pulsar.EncryptionContext.html" class="internal-link" title="pulsar.EncryptionContext"><wbr></wbr>Encryption<wbr></wbr>Context</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.EncryptionKey.html" class="internal-link" title="pulsar.EncryptionKey"><wbr></wbr>Encryption<wbr></wbr>Key</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.FileLogger.html" class="internal-link" title="pulsar.FileLogger"><wbr></wbr>File<wbr></wbr>Logger</a></code>
             </div>


     </li><li class="">


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


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.MessageBatch.html" class="internal-link" title="pulsar.MessageBatch"><wbr></wbr>Message<wbr></wbr>Batch</a></code>
             </div>


     </li><li class="">


             <div class="itemName"><code><a href="pulsar.MessageId.html" class="internal-link" title="pulsar.MessageId"><wbr></wbr>Message<wbr></wbr>Id</a></code>
             </div>


     </li><li class="">


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


     </li><li class="">


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


     </li>
 </ul>

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

     <li class="private">


             <div class="itemName"><code><a href="pulsar.html#_check_type" class="internal-link" title="pulsar._check_type">_check<wbr></wbr>_type</a></code>
             </div>


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


             <div class="itemName"><code><a href="pulsar.html#_check_type_or_none" class="internal-link" title="pulsar._check_type_or_none">_check<wbr></wbr>_type<wbr></wbr>_or<wbr></wbr>_none</a></code>
             </div>


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


             <div class="itemName"><code><a href="pulsar.html#_listener_wrapper" class="internal-link" title="pulsar._listener_wrapper">_listener<wbr></wbr>_wrapper</a></code>
             </div>


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


             <div class="itemName"><code><a href="pulsar.html#_seek_arg_convert" class="internal-link" title="pulsar._seek_arg_convert">_seek<wbr></wbr>_arg<wbr></wbr>_convert</a></code>
             </div>


     </li>
 </ul>


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

     <li class="private">


             <div class="itemName"><code><a href="pulsar.html#_retype" class="internal-link" title="pulsar._retype">_retype</a></code>
             </div>


     </li>
 </ul>


       </div>
   </div>

 </nav>
         <!-- No sidebar toggle for read the docs theme, the sidebar is always
           visible when the screen is width enough.
         -->
       </div>

     </nav>

     <div class="container-fluid">

       <div id="main" class="">


         <div class="page-header">
           <h1 class="class"><code><code><a href="pulsar.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.EncryptionContext.html" class="internal-link" title="pulsar.EncryptionContext">EncryptionContext</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">EncryptionContext</span>: <a href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L214" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="#__init__" class="internal-link" title="pulsar.EncryptionContext.__init__">EncryptionContext(context)</a></code></p>
           <p><a href="classIndex.html#pulsar.EncryptionContext">View In Hierarchy</a></p>
         </div>

         <div class="moduleDocstring">
           <div><p>It contains encryption and compression information in it using which application can decrypt
 consumed message with encrypted-payload.</p></div>
         </div>

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


   <tr class="method">

     <td>Method</td>
     <td><code><a href="#__init__" class="internal-link" title="pulsar.EncryptionContext.__init__">__init__</a></code></td>
     <td>Create EncryptionContext instance.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#__repr__" class="internal-link" title="pulsar.EncryptionContext.__repr__">__repr__</a></code></td>
     <td><span class="rst-undocumented">Undocumented</span></td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#__str__" class="internal-link" title="pulsar.EncryptionContext.__str__">__str__</a></code></td>
     <td><span class="rst-undocumented">Undocumented</span></td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#algorithm" class="internal-link" title="pulsar.EncryptionContext.algorithm">algorithm</a></code></td>
     <td>Returns the encryption algorithm.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#batch_size" class="internal-link" title="pulsar.EncryptionContext.batch_size">batch<wbr></wbr>_size</a></code></td>
     <td>Returns the number of messages in the batch or -1 if the message is not batched.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#compression_type" class="internal-link" title="pulsar.EncryptionContext.compression_type">compression<wbr></wbr>_type</a></code></td>
     <td>Returns the compression type of the message.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#is_decryption_failed" class="internal-link" title="pulsar.EncryptionContext.is_decryption_failed">is<wbr></wbr>_decryption<wbr></wbr>_failed</a></code></td>
     <td>Returns whether decryption has failed for this message.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#keys" class="internal-link" title="pulsar.EncryptionContext.keys">keys</a></code></td>
     <td>Returns all EncryptionKey instances when performing encryption.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#param" class="internal-link" title="pulsar.EncryptionContext.param">param</a></code></td>
     <td>Returns the encryption param bytes.</td>
   </tr><tr class="method">

     <td>Method</td>
     <td><code><a href="#uncompressed_message_size" class="internal-link" title="pulsar.EncryptionContext.uncompressed_message_size">uncompressed<wbr></wbr>_message<wbr></wbr>_size</a></code></td>
     <td>Returns the uncompressed message size or 0 if the compression type is NONE.</td>
   </tr><tr class="instancevariable private">

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


         </div>

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


   <a name="pulsar.EncryptionContext.__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">context: <code><a href="_pulsar.EncryptionContext.html" class="internal-link" title="_pulsar.EncryptionContext">_pulsar.EncryptionContext</a></code></span>):</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L220">

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


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

     <div><p>Create EncryptionContext instance.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName" colspan="2">Parameters</td></tr><tr><td class="fieldArgContainer"><span class="fieldArg">context:</span><code><a href="_pulsar.EncryptionContext.html" class="internal-link">_pulsar.EncryptionContext</a></code></td><td class="fieldArgDesc">The underlying EncryptionContext instance from the C extension.</td></tr></table></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.__repr__">

   </a>
   <a name="__repr__">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">__repr__</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.9.0/pulsar/__init__.py#L281">

       (source)
     </a>
     <a class="headerLink" href="#__repr__" title="pulsar.EncryptionContext.__repr__">


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

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


   <a name="pulsar.EncryptionContext.__str__">

   </a>
   <a name="__str__">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">__str__</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.9.0/pulsar/__init__.py#L274">

       (source)
     </a>
     <a class="headerLink" href="#__str__" title="pulsar.EncryptionContext.__str__">


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

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


   <a name="pulsar.EncryptionContext.algorithm">

   </a>
   <a name="algorithm">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">algorithm</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.9.0/pulsar/__init__.py#L244">

       (source)
     </a>
     <a class="headerLink" href="#algorithm" title="pulsar.EncryptionContext.algorithm">


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

     <div><p>Returns the encryption algorithm.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.batch_size">

   </a>
   <a name="batch_size">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">batch_size</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/functions.html#int" class="intersphinx-link">int</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L262">

       (source)
     </a>
     <a class="headerLink" href="#batch_size" title="pulsar.EncryptionContext.batch_size">


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

     <div><p>Returns the number of messages in the batch or -1 if the message is not batched.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.compression_type">

   </a>
   <a name="compression_type">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">compression_type</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span></span>) -&gt; <code><a href="_pulsar.CompressionType.html" class="internal-link" title="_pulsar.CompressionType">CompressionType</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L250">

       (source)
     </a>
     <a class="headerLink" href="#compression_type" title="pulsar.EncryptionContext.compression_type">


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

     <div><p>Returns the compression type of the message.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.is_decryption_failed">

   </a>
   <a name="is_decryption_failed">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">is_decryption_failed</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/functions.html#bool" class="intersphinx-link">bool</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L268">

       (source)
     </a>
     <a class="headerLink" href="#is_decryption_failed" title="pulsar.EncryptionContext.is_decryption_failed">


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

     <div><p>Returns whether decryption has failed for this message.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.keys">

   </a>
   <a name="keys">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">keys</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#list" class="intersphinx-link">list</a>[<wbr></wbr><a href="pulsar.EncryptionKey.html" class="internal-link" title="pulsar.EncryptionKey">EncryptionKey</a>]</code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L231">

       (source)
     </a>
     <a class="headerLink" href="#keys" title="pulsar.EncryptionContext.keys">


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

     <div><p>Returns all EncryptionKey instances when performing encryption.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.param">

   </a>
   <a name="param">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">param</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#bytes" class="intersphinx-link">bytes</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L238">

       (source)
     </a>
     <a class="headerLink" href="#param" title="pulsar.EncryptionContext.param">


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

     <div><p>Returns the encryption param bytes.</p></div>
   </div>
 </div><div class="basemethod">


   <a name="pulsar.EncryptionContext.uncompressed_message_size">

   </a>
   <a name="uncompressed_message_size">

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


     <span class="py-keyword">def</span>&#160;<span class="py-defname">uncompressed_message_size</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/functions.html#int" class="intersphinx-link">int</a></code>:</span>
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L256">

       (source)
     </a>
     <a class="headerLink" href="#uncompressed_message_size" title="pulsar.EncryptionContext.uncompressed_message_size">


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

     <div><p>Returns the uncompressed message size or 0 if the compression type is NONE.</p></div>
   </div>
 </div><div class="baseinstancevariable private">


   <a name="pulsar.EncryptionContext._context">

   </a>
   <a name="_context">

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

     <span class="py-defname">_context</span> =
     <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.9.0/pulsar/__init__.py#L229">

       (source)
     </a>
     <a class="headerLink" href="#_context" title="pulsar.EncryptionContext._context">


       ¶
     </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>