| <?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.definition.String</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.schema.definition.String.html" class="internal-link" title="This class"><wbr></wbr>String</a></code> |
| </div> |
| |
| <div> |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="childrenKindTitle">Methods</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#default" class="internal-link" title="pulsar.schema.definition.String.default">default</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#python_type" class="internal-link" title="pulsar.schema.definition.String.python_type">python<wbr></wbr>_type</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#type" class="internal-link" title="pulsar.schema.definition.String.type">type</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="#validate_type" class="internal-link" title="pulsar.schema.definition.String.validate_type">validate<wbr></wbr>_type</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| <div class="childrenKindTitle">Inherited Methods</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#__init__" class="internal-link" title="pulsar.schema.definition.Field.__init__">__init__</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#required_default" class="internal-link" title="pulsar.schema.definition.Field.required_default">required<wbr></wbr>_default</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#schema" class="internal-link" title="pulsar.schema.definition.Field.schema">schema</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#schema_info" class="internal-link" title="pulsar.schema.definition.Field.schema_info">schema<wbr></wbr>_info</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| |
| |
| |
| <div class="childrenKindTitle">Inherited Attributes</div> |
| <ul> |
| |
| <li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#_default" class="internal-link" title="pulsar.schema.definition.Field._default">_default</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#_required" class="internal-link" title="pulsar.schema.definition.Field._required">_required</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html#_required_default" class="internal-link" title="pulsar.schema.definition.Field._required_default">_required<wbr></wbr>_default</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| </div> |
| </div><div> |
| |
| <div class="thingTitle"> |
| <span>Module</span> |
| <code><a href="pulsar.schema.definition.html" class="internal-link" title="The parent of this class">definition</a></code> |
| </div> |
| |
| <div> |
| |
| |
| |
| |
| |
| <div class="childrenKindTitle">Classes</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Array.html" class="internal-link" title="pulsar.schema.definition.Array"><wbr></wbr>Array</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Boolean.html" class="internal-link" title="pulsar.schema.definition.Boolean"><wbr></wbr>Boolean</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Bytes.html" class="internal-link" title="pulsar.schema.definition.Bytes"><wbr></wbr>Bytes</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.CustomEnum.html" class="internal-link" title="pulsar.schema.definition.CustomEnum"><wbr></wbr>Custom<wbr></wbr>Enum</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Double.html" class="internal-link" title="pulsar.schema.definition.Double"><wbr></wbr>Double</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Field.html" class="internal-link" title="pulsar.schema.definition.Field"><wbr></wbr>Field</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Float.html" class="internal-link" title="pulsar.schema.definition.Float"><wbr></wbr>Float</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Integer.html" class="internal-link" title="pulsar.schema.definition.Integer"><wbr></wbr>Integer</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Long.html" class="internal-link" title="pulsar.schema.definition.Long"><wbr></wbr>Long</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Map.html" class="internal-link" title="pulsar.schema.definition.Map"><wbr></wbr>Map</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Null.html" class="internal-link" title="pulsar.schema.definition.Null"><wbr></wbr>Null</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.Record.html" class="internal-link" title="pulsar.schema.definition.Record"><wbr></wbr>Record</a></code> |
| </div> |
| |
| |
| </li><li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.RecordMeta.html" class="internal-link" title="pulsar.schema.definition.RecordMeta"><wbr></wbr>Record<wbr></wbr>Meta</a></code> |
| </div> |
| |
| |
| </li><li class=" thisobject"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.String.html" class="internal-link" title="pulsar.schema.definition.String"><wbr></wbr>String</a></code> |
| </div> |
| |
| |
| </li> |
| </ul> |
| |
| <div class="childrenKindTitle">Functions</div> |
| <ul> |
| |
| <li class=""> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.html#is_unicode" class="internal-link" title="pulsar.schema.definition.is_unicode">is<wbr></wbr>_unicode</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.html#_check_record_or_field" class="internal-link" title="pulsar.schema.definition._check_record_or_field">_check<wbr></wbr>_record<wbr></wbr>_or<wbr></wbr>_field</a></code> |
| </div> |
| |
| |
| </li><li class="private"> |
| |
| |
| |
| |
| |
| <div class="itemName"><code><a href="pulsar.schema.definition.html#_string_representation" class="internal-link" title="pulsar.schema.definition._string_representation">_string<wbr></wbr>_representation</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.schema.html" class="internal-link" title="pulsar.schema">schema</a></code><wbr></wbr>.<code><a href="pulsar.schema.definition.html" class="internal-link" title="pulsar.schema.definition">definition</a></code><wbr></wbr>.<code><a href="pulsar.schema.definition.String.html" class="internal-link" title="pulsar.schema.definition.String">String</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">String</span>(<a href="pulsar.schema.definition.Field.html" class="internal-link" title="pulsar.schema.definition.Field">Field</a>): <a href="https://github.com/apache/pulsar-client-python/tree/v3.8.0/pulsar/schema/definition.py#L354" class="sourceLink">(source)</a></code></p><p>Constructor: <code><a href="pulsar.schema.definition.Field.html#__init__" class="internal-link" title="pulsar.schema.definition.Field.__init__">String(default, required, required_default)</a></code></p> |
| <p><a href="classIndex.html#pulsar.schema.definition.String">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="id37"> |
| |
| |
| <tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#default" class="internal-link" title="pulsar.schema.definition.String.default">default</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#python_type" class="internal-link" title="pulsar.schema.definition.String.python_type">python<wbr></wbr>_type</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#type" class="internal-link" title="pulsar.schema.definition.String.type">type</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="method"> |
| |
| <td>Method</td> |
| <td><code><a href="#validate_type" class="internal-link" title="pulsar.schema.definition.String.validate_type">validate<wbr></wbr>_type</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr> |
| </table> |
| |
| <p class="inheritedFrom"> |
| Inherited from <code><a href="pulsar.schema.definition.Field.html" class="internal-link" title="pulsar.schema.definition.Field">Field</a></code>: |
| </p> |
| <table class="children sortable" id="id38"> |
| |
| |
| <tr class="basemethod"> |
| |
| <td>Method</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#__init__" class="internal-link" title="pulsar.schema.definition.Field.__init__">__init__</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="basemethod"> |
| |
| <td>Method</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#required_default" class="internal-link" title="pulsar.schema.definition.Field.required_default">required<wbr></wbr>_default</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="basemethod"> |
| |
| <td>Method</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#schema" class="internal-link" title="pulsar.schema.definition.Field.schema">schema</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="basemethod"> |
| |
| <td>Method</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#schema_info" class="internal-link" title="pulsar.schema.definition.Field.schema_info">schema<wbr></wbr>_info</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="baseinstancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#_default" class="internal-link" title="pulsar.schema.definition.Field._default">_default</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="baseinstancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#_required" class="internal-link" title="pulsar.schema.definition.Field._required">_required</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr><tr class="baseinstancevariable private"> |
| |
| <td>Instance Variable</td> |
| <td><code><a href="pulsar.schema.definition.Field.html#_required_default" class="internal-link" title="pulsar.schema.definition.Field._required_default">_required<wbr></wbr>_default</a></code></td> |
| <td><span class="rst-undocumented">Undocumented</span></td> |
| </tr> |
| </table> |
| |
| |
| |
| </div> |
| |
| <div id="childList"> |
| <div class="basemethod"> |
| |
| |
| <a name="pulsar.schema.definition.String.default"> |
| |
| </a> |
| <a name="default"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">default</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.8.0/pulsar/schema/definition.py#L373"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#default" title="pulsar.schema.definition.String.default"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| <div class="interfaceinfo">overrides <code><a href="pulsar.schema.definition.Field.html#default" class="internal-link">pulsar.schema.definition.Field.default</a></code></div> |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.schema.definition.String.python_type"> |
| |
| </a> |
| <a name="python_type"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">python_type</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.8.0/pulsar/schema/definition.py#L358"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#python_type" title="pulsar.schema.definition.String.python_type"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| <div class="interfaceinfo">overrides <code><a href="pulsar.schema.definition.Field.html#python_type" class="internal-link">pulsar.schema.definition.Field.python_type</a></code></div> |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.schema.definition.String.type"> |
| |
| </a> |
| <a name="type"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">type</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.8.0/pulsar/schema/definition.py#L355"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#type" title="pulsar.schema.definition.String.type"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| <div class="interfaceinfo">overrides <code><a href="pulsar.schema.definition.Field.html#type" class="internal-link">pulsar.schema.definition.Field.type</a></code></div> |
| <div><p class="undocumented">Undocumented</p></div> |
| </div> |
| </div><div class="basemethod"> |
| |
| |
| <a name="pulsar.schema.definition.String.validate_type"> |
| |
| </a> |
| <a name="validate_type"> |
| |
| </a> |
| <div class="functionHeader"> |
| |
| |
| <span class="py-keyword">def</span> <span class="py-defname">validate_type</span><span class="function-signature">(<span class="rst-sig-param"><span class="rst-undocumented">self</span>, </span><span class="rst-sig-param">name, </span><span class="rst-sig-param">val</span>):</span> |
| <a class="sourceLink" href="https://github.com/apache/pulsar-client-python/tree/v3.8.0/pulsar/schema/definition.py#L361"> |
| |
| (source) |
| </a> |
| <a class="headerLink" href="#validate_type" title="pulsar.schema.definition.String.validate_type"> |
| |
| |
| ¶ |
| </a> |
| </div> |
| <div class="docstring functionBody"> |
| <div class="interfaceinfo">overrides <code><a href="pulsar.schema.definition.Field.html#validate_type" class="internal-link">pulsar.schema.definition.Field.validate_type</a></code></div> |
| <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-07-19 14:22:25. |
| </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> |
