| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>apache_beam.typehints.schemas module — Apache Beam documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.typehints.trivial_inference module" href="apache_beam.typehints.trivial_inference.html" /> |
| <link rel="prev" title="apache_beam.typehints.row_type module" href="apache_beam.typehints.row_type.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> Apache Beam |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.typehints.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.decorators.html">apache_beam.typehints.decorators module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.decorators_test_py3.html">apache_beam.typehints.decorators_test_py3 module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.native_type_compatibility.html">apache_beam.typehints.native_type_compatibility module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.opcodes.html">apache_beam.typehints.opcodes module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.row_type.html">apache_beam.typehints.row_type module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.typehints.schemas module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.trivial_inference.html">apache_beam.typehints.trivial_inference module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.trivial_inference_test_py3.html">apache_beam.typehints.trivial_inference_test_py3 module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typecheck.html">apache_beam.typehints.typecheck module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typecheck_test_py3.html">apache_beam.typehints.typecheck_test_py3 module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typed_pipeline_test_py3.html">apache_beam.typehints.typed_pipeline_test_py3 module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typehints.html">apache_beam.typehints.typehints module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typehints_test_py3.html">apache_beam.typehints.typehints_test_py3 module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><a href="apache_beam.typehints.html">apache_beam.typehints package</a> »</li> |
| |
| <li>apache_beam.typehints.schemas module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.typehints.schemas.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-apache_beam.typehints.schemas"> |
| <span id="apache-beam-typehints-schemas-module"></span><h1>apache_beam.typehints.schemas module<a class="headerlink" href="#module-apache_beam.typehints.schemas" title="Permalink to this headline">¶</a></h1> |
| <p>Support for mapping python types to proto Schemas and back again.</p> |
| <p>Imposes a mapping between common Python types and Beam portable schemas |
| (<a class="reference external" href="https://s.apache.org/beam-schemas">https://s.apache.org/beam-schemas</a>):</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Python</span> <span class="n">Schema</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">int8</span> <span class="o"><-----></span> <span class="n">BYTE</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">int16</span> <span class="o"><-----></span> <span class="n">INT16</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">int32</span> <span class="o"><-----></span> <span class="n">INT32</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">int64</span> <span class="o"><-----></span> <span class="n">INT64</span> |
| <span class="nb">int</span> <span class="o">------></span> <span class="n">INT64</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">float32</span> <span class="o"><-----></span> <span class="n">FLOAT</span> |
| <span class="n">np</span><span class="o">.</span><span class="n">float64</span> <span class="o"><-----></span> <span class="n">DOUBLE</span> |
| <span class="nb">float</span> <span class="o">------></span> <span class="n">DOUBLE</span> |
| <span class="nb">bool</span> <span class="o"><-----></span> <span class="n">BOOLEAN</span> |
| <span class="nb">str</span><span class="o">/</span><span class="n">unicode</span> <span class="o"><-----></span> <span class="n">STRING</span> |
| <span class="nb">bytes</span> <span class="o"><-----></span> <span class="n">BYTES</span> |
| <span class="n">ByteString</span> <span class="o">------></span> <span class="n">BYTES</span> |
| <span class="n">Timestamp</span> <span class="o"><-----></span> <span class="n">LogicalType</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s2">"beam:logical_type:micros_instant:v1"</span><span class="p">)</span> |
| <span class="n">Mapping</span> <span class="o"><-----></span> <span class="n">MapType</span> |
| <span class="n">Sequence</span> <span class="o"><-----></span> <span class="n">ArrayType</span> |
| <span class="n">NamedTuple</span> <span class="o"><-----></span> <span class="n">RowType</span> |
| <span class="n">beam</span><span class="o">.</span><span class="n">Row</span> <span class="o">------></span> <span class="n">RowType</span> |
| </pre></div> |
| </div> |
| <p>Note that some of these mappings are provided as conveniences, |
| but they are lossy and will not survive a roundtrip from python to Beam schemas |
| and back. For example, the Python type <code class="code docutils literal notranslate"><span class="pre">int</span></code> will map to <code class="code docutils literal notranslate"><span class="pre">INT64</span></code> in |
| Beam schemas but converting that back to a Python type will yield |
| <code class="code docutils literal notranslate"><span class="pre">np.int64</span></code>.</p> |
| <p><code class="code docutils literal notranslate"><span class="pre">nullable=True</span></code> on a Beam <code class="code docutils literal notranslate"><span class="pre">FieldType</span></code> is represented in Python by |
| wrapping the type in <code class="code docutils literal notranslate"><span class="pre">Optional</span></code>.</p> |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.SchemaTypeRegistry"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">SchemaTypeRegistry</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTypeRegistry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTypeRegistry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTypeRegistry.add"> |
| <code class="descname">add</code><span class="sig-paren">(</span><em>typing</em>, <em>schema</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTypeRegistry.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTypeRegistry.add" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTypeRegistry.get_typing_by_id"> |
| <code class="descname">get_typing_by_id</code><span class="sig-paren">(</span><em>unique_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTypeRegistry.get_typing_by_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTypeRegistry.get_typing_by_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTypeRegistry.get_schema_by_id"> |
| <code class="descname">get_schema_by_id</code><span class="sig-paren">(</span><em>unique_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTypeRegistry.get_schema_by_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTypeRegistry.get_schema_by_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.named_fields_to_schema"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">named_fields_to_schema</code><span class="sig-paren">(</span><em>names_and_types</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#named_fields_to_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.named_fields_to_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.named_fields_from_schema"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">named_fields_from_schema</code><span class="sig-paren">(</span><em>schema</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#named_fields_from_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.named_fields_from_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.typing_to_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">typing_to_runner_api</code><span class="sig-paren">(</span><em>type_</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#typing_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.typing_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.typing_from_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">typing_from_runner_api</code><span class="sig-paren">(</span><em>fieldtype_proto</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#typing_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.typing_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.named_tuple_from_schema"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">named_tuple_from_schema</code><span class="sig-paren">(</span><em>schema</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#named_tuple_from_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.named_tuple_from_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.named_tuple_to_schema"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">named_tuple_to_schema</code><span class="sig-paren">(</span><em>named_tuple</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#named_tuple_to_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.named_tuple_to_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.schema_from_element_type"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">schema_from_element_type</code><span class="sig-paren">(</span><em>element_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#schema_from_element_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.schema_from_element_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get a schema for the given PCollection element_type.</p> |
| <p>Returns schema as a list of (name, python_type) tuples</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.named_fields_from_element_type"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">named_fields_from_element_type</code><span class="sig-paren">(</span><em>element_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#named_fields_from_element_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.named_fields_from_element_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.LogicalTypeRegistry"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">LogicalTypeRegistry</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalTypeRegistry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalTypeRegistry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalTypeRegistry.add"> |
| <code class="descname">add</code><span class="sig-paren">(</span><em>urn</em>, <em>logical_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalTypeRegistry.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalTypeRegistry.add" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalTypeRegistry.get_logical_type_by_urn"> |
| <code class="descname">get_logical_type_by_urn</code><span class="sig-paren">(</span><em>urn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalTypeRegistry.get_logical_type_by_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalTypeRegistry.get_logical_type_by_urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalTypeRegistry.get_urn_by_logial_type"> |
| <code class="descname">get_urn_by_logial_type</code><span class="sig-paren">(</span><em>logical_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalTypeRegistry.get_urn_by_logial_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalTypeRegistry.get_urn_by_logial_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalTypeRegistry.get_logical_type_by_language_type"> |
| <code class="descname">get_logical_type_by_language_type</code><span class="sig-paren">(</span><em>representation_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalTypeRegistry.get_logical_type_by_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalTypeRegistry.get_logical_type_by_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.LogicalType"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">LogicalType</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Generic" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Generic</span></code></a></p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.urn"> |
| <em class="property">classmethod </em><code class="descname">urn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.urn" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the URN used to identify this logical type</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.language_type"> |
| <em class="property">classmethod </em><code class="descname">language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the language type this LogicalType encodes.</p> |
| <p>The returned type should match LanguageT</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.representation_type"> |
| <em class="property">classmethod </em><code class="descname">representation_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the type of the representation this LogicalType uses to encode the |
| language type.</p> |
| <p>The returned type should match RepresentationT</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.argument_type"> |
| <em class="property">classmethod </em><code class="descname">argument_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the type of the argument used for variations of this LogicalType.</p> |
| <p>The returned type should match ArgT</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.argument"> |
| <code class="descname">argument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.argument" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Return the argument for this instance of the LogicalType.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.to_representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert an instance of LanguageT to RepresentationT.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Convert an instance of RepresentationT to LanguageT.</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.register_logical_type"> |
| <em class="property">classmethod </em><code class="descname">register_logical_type</code><span class="sig-paren">(</span><em>logical_type_cls</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.register_logical_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.register_logical_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Register an implementation of LogicalType.</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.from_typing"> |
| <em class="property">classmethod </em><code class="descname">from_typing</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.from_typing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.from_typing" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Construct an instance of a registered LogicalType implementation given a |
| typing.</p> |
| <p>Raises ValueError if no registered LogicalType implementation can encode the |
| given typing.</p> |
| </dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.LogicalType.from_runner_api"> |
| <em class="property">classmethod </em><code class="descname">from_runner_api</code><span class="sig-paren">(</span><em>logical_type_proto</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#LogicalType.from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.LogicalType.from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Construct an instance of a registered LogicalType implementation given a |
| proto LogicalType.</p> |
| <p>Raises ValueError if no LogicalType registered for the given URN.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.NoArgumentLogicalType"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">NoArgumentLogicalType</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#NoArgumentLogicalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.NoArgumentLogicalType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.LogicalType" title="apache_beam.typehints.schemas.LogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.LogicalType</span></code></a></p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.NoArgumentLogicalType.argument_type"> |
| <em class="property">classmethod </em><code class="descname">argument_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#NoArgumentLogicalType.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.NoArgumentLogicalType.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.NoArgumentLogicalType.argument"> |
| <code class="descname">argument</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#NoArgumentLogicalType.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.NoArgumentLogicalType.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstantRepresentation"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">MicrosInstantRepresentation</code><span class="sig-paren">(</span><em>seconds</em>, <em>micros</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstantRepresentation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of MicrosInstantRepresentation(seconds, micros)</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstantRepresentation.micros"> |
| <code class="descname">micros</code><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstantRepresentation.micros" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstantRepresentation.seconds"> |
| <code class="descname">seconds</code><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstantRepresentation.seconds" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.typehints.trivial_inference.html" class="btn btn-neutral float-right" title="apache_beam.typehints.trivial_inference module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.typehints.row_type.html" class="btn btn-neutral float-left" title="apache_beam.typehints.row_type module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |