Google Git
Sign in
apache/pulsar-site/refs/heads/release-python-3.12.0/./static/api/python/3.1.x/pulsar.schema.schema_avro.AvroSchema.html
blob: aa4fdf9c174f6779d1cb1d4e51c466211fb96e5b [file]
<?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.schema.schema_avro.AvroSchema</title>
<meta name="generator" content="pydoctor 22.9.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 <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.schema.schema_avro.AvroSchema.html" class="internal-link" title="This class"><wbr></wbr>Avro<wbr></wbr>Schema</a></code>
</div>
<div>
<div class="childrenKindTitle">Methods</div>
<ul>
<li class="">
<div class="itemName"><code><a href="#__init__" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.__init__">__init__</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#decode" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.decode">decode</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#encode" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.encode">encode</a></code>
</div>
</li><li class="">
<div class="itemName"><code><a href="#encode_dict" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.encode_dict">encode<wbr></wbr>_dict</a></code>
</div>
</li><li class="private">
<div class="itemName"><code><a href="#_get_serialized_value" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema._get_serialized_value">_get<wbr></wbr>_serialized<wbr></wbr>_value</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Inherited Methods</div>
<ul>
<li class="">
<div class="itemName"><code><a href="pulsar.schema.schema.Schema.html#schema_info" class="internal-link" title="pulsar.schema.schema.Schema.schema_info">schema<wbr></wbr>_info</a></code>
</div>
</li><li class="private">
<div class="itemName"><code><a href="pulsar.schema.schema.Schema.html#_validate_object_type" class="internal-link" title="pulsar.schema.schema.Schema._validate_object_type">_validate<wbr></wbr>_object<wbr></wbr>_type</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Attributes</div>
<ul>
<li class="private">
<div class="itemName"><code><a href="#_schema" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema._schema">_schema</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Inherited Attributes</div>
<ul>
<li class="private">
<div class="itemName"><code><a href="pulsar.schema.schema.Schema.html#_record_cls" class="internal-link" title="pulsar.schema.schema.Schema._record_cls">_record<wbr></wbr>_cls</a></code>
</div>
</li><li class="private">
<div class="itemName"><code><a href="pulsar.schema.schema.Schema.html#_schema_info" class="internal-link" title="pulsar.schema.schema.Schema._schema_info">_schema<wbr></wbr>_info</a></code>
</div>
</li>
</ul>
</div>
</div><div>
<div class="thingTitle">
<span>Module</span>
<code><a href="pulsar.schema.schema_avro.html" class="internal-link" title="The parent of this class">schema<wbr></wbr>_avro</a></code>
</div>
<div>
<div class="childrenKindTitle">Classes</div>
<ul>
<li class=" thisobject">
<div class="itemName"><code><a href="pulsar.schema.schema_avro.AvroSchema.html" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema"><wbr></wbr>Avro<wbr></wbr>Schema</a></code>
</div>
</li>
</ul>
<div class="childrenKindTitle">Variables</div>
<ul>
<li class="">
<div class="itemName"><code><a href="pulsar.schema.schema_avro.html#HAS_AVRO" class="internal-link" title="pulsar.schema.schema_avro.HAS_AVRO">HAS<wbr></wbr>_AVRO</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="index.html" class="internal-link">pulsar</a></code><wbr></wbr>.<code><a href="pulsar.schema.html" class="internal-link" title="pulsar.schema">schema</a></code><wbr></wbr>.<code><a href="pulsar.schema.schema_avro.html" class="internal-link" title="pulsar.schema.schema_avro">schema_avro</a></code><wbr></wbr>.<code><a href="pulsar.schema.schema_avro.AvroSchema.html" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema">AvroSchema</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><code><span class="py-keyword">class</span> <span class="py-defname">AvroSchema</span>(<a href="pulsar.schema.schema.Schema.html" class="internal-link" title="pulsar.schema.schema.Schema">Schema</a>): <a href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L34" class="sourceLink">(source)</a></code></p>
<p><a href="classIndex.html#pulsar.schema.schema_avro.AvroSchema">View In Hierarchy</a></p>
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
</div>
<div id="splitTables">
<table class="children sortable" id="id49">
<tr class="method">
<td>Method</td>
<td><code><a href="#__init__" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.__init__">__init__</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#decode" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.decode">decode</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#encode" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.encode">encode</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><code><a href="#encode_dict" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema.encode_dict">encode<wbr></wbr>_dict</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method private">
<td>Method</td>
<td><code><a href="#_get_serialized_value" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema._get_serialized_value">_get<wbr></wbr>_serialized<wbr></wbr>_value</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="instancevariable private">
<td>Instance Variable</td>
<td><code><a href="#_schema" class="internal-link" title="pulsar.schema.schema_avro.AvroSchema._schema">_schema</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
<p class="inheritedFrom">
Inherited from <code><a href="pulsar.schema.schema.Schema.html" class="internal-link" title="pulsar.schema.schema.Schema">Schema</a></code>:
</p>
<table class="children sortable" id="id50">
<tr class="basemethod">
<td>Method</td>
<td><code><a href="pulsar.schema.schema.Schema.html#schema_info" class="internal-link" title="pulsar.schema.schema.Schema.schema_info">schema<wbr></wbr>_info</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod private">
<td>Method</td>
<td><code><a href="pulsar.schema.schema.Schema.html#_validate_object_type" class="internal-link" title="pulsar.schema.schema.Schema._validate_object_type">_validate<wbr></wbr>_object<wbr></wbr>_type</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="baseinstancevariable private">
<td>Instance Variable</td>
<td><code><a href="pulsar.schema.schema.Schema.html#_record_cls" class="internal-link" title="pulsar.schema.schema.Schema._record_cls">_record<wbr></wbr>_cls</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="baseinstancevariable private">
<td>Instance Variable</td>
<td><code><a href="pulsar.schema.schema.Schema.html#_schema_info" class="internal-link" title="pulsar.schema.schema.Schema._schema_info">_schema<wbr></wbr>_info</a></code></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basemethod">
<a name="pulsar.schema.schema_avro.AvroSchema.__init__">
</a>
<a name="__init__">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, record_cls, schema_definition=None):
<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L35">
(source)
</a>
<a class="headerLink" href="#__init__" title="pulsar.schema.schema_avro.AvroSchema.__init__">
</a>
</div>
<div class="docstring functionBody">
<div class="interfaceinfo">overrides <code><a href="pulsar.schema.schema.Schema.html#__init__" class="internal-link">pulsar.schema.schema.Schema.__init__</a></code></div>
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="basemethod">
<a name="pulsar.schema.schema_avro.AvroSchema.decode">
</a>
<a name="decode">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">decode</span>(self, data):
<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L78">
(source)
</a>
<a class="headerLink" href="#decode" title="pulsar.schema.schema_avro.AvroSchema.decode">
</a>
</div>
<div class="docstring functionBody">
<div class="interfaceinfo">overrides <code><a href="pulsar.schema.schema.Schema.html#decode" class="internal-link">pulsar.schema.schema.Schema.decode</a></code></div>
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="basemethod">
<a name="pulsar.schema.schema_avro.AvroSchema.encode">
</a>
<a name="encode">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">encode</span>(self, obj):
<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L60">
(source)
</a>
<a class="headerLink" href="#encode" title="pulsar.schema.schema_avro.AvroSchema.encode">
</a>
</div>
<div class="docstring functionBody">
<div class="interfaceinfo">overrides <code><a href="pulsar.schema.schema.Schema.html#encode" class="internal-link">pulsar.schema.schema.Schema.encode</a></code></div>
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="basemethod">
<a name="pulsar.schema.schema_avro.AvroSchema.encode_dict">
</a>
<a name="encode_dict">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">encode_dict</span>(self, d):
<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L72">
(source)
</a>
<a class="headerLink" href="#encode_dict" title="pulsar.schema.schema_avro.AvroSchema.encode_dict">
</a>
</div>
<div class="docstring functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="basemethod private">
<a name="pulsar.schema.schema_avro.AvroSchema._get_serialized_value">
</a>
<a name="_get_serialized_value">
</a>
<div class="functionHeader">
<span class="py-keyword">def</span> <span class="py-defname">_get_serialized_value</span>(self, x):
<a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.1.0/pulsar/schema/schema_avro.py#L45">
(source)
</a>
<a class="headerLink" href="#_get_serialized_value" title="pulsar.schema.schema_avro.AvroSchema._get_serialized_value">
</a>
</div>
<div class="docstring functionBody">
<div><p class="undocumented">Undocumented</p></div>
</div>
</div><div class="baseinstancevariable private">
<a name="pulsar.schema.schema_avro.AvroSchema._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.1.0/pulsar/schema/schema_avro.py#L40">
(source)
</a>
<a class="headerLink" href="#_schema" title="pulsar.schema.schema_avro.AvroSchema._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">
<a href="index.html">API Documentation</a> for pulsar,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
22.9.1 at 2023-03-14 14:09:17.
</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>