| |
| |
| <!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 2.47.0 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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.sharded_key_type module" href="apache_beam.typehints.sharded_key_type.html" /> |
| <link rel="prev" title="apache_beam.typehints.schema_registry module" href="apache_beam.typehints.schema_registry.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 class="version"> |
| 2.47.0 |
| </div> |
| |
| |
| |
| |
| <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.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.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"><a class="reference internal" href="apache_beam.typehints.html#subpackages">Subpackages</a></li> |
| <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.arrow_batching_microbenchmark.html">apache_beam.typehints.arrow_batching_microbenchmark module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.arrow_type_compatibility.html">apache_beam.typehints.arrow_type_compatibility module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.batch.html">apache_beam.typehints.batch module</a></li> |
| <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.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.pandas_type_compatibility.html">apache_beam.typehints.pandas_type_compatibility module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.pytorch_type_compatibility.html">apache_beam.typehints.pytorch_type_compatibility 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"><a class="reference internal" href="apache_beam.typehints.schema_registry.html">apache_beam.typehints.schema_registry 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.sharded_key_type.html">apache_beam.typehints.sharded_key_type 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.typecheck.html">apache_beam.typehints.typecheck module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.typehints.html">apache_beam.typehints.typehints 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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> |
| </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">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">Decimal</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:fixed_decimal: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>One direction mapping of Python types from Beam portable schemas:</p> |
| <blockquote> |
| <div><dl class="docutils"> |
| <dt>bytes</dt> |
| <dd><—— LogicalType(urn=”beam:logical_type:fixed_bytes:v1”) |
| <—— LogicalType(urn=”beam:logical_type:var_bytes:v1”)</dd> |
| <dt>str</dt> |
| <dd><—— LogicalType(urn=”beam:logical_type:fixed_char:v1”) |
| <—— LogicalType(urn=”beam:logical_type:var_char:v1”)</dd> |
| <dt>Timestamp</dt> |
| <dd><—— LogicalType(urn=”beam:logical_type:millis_instant:v1”)</dd> |
| </dl> |
| </div></blockquote> |
| <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> |
| <p>This module is intended for internal use only. Nothing defined here provides |
| any backwards-compatibility guarantee.</p> |
| <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: Union[Dict[str, type], Sequence[Tuple[str, type]]], schema_id: Optional[str] = None, schema_options: Optional[Sequence[Tuple[str, Any]]] = None, field_options: Optional[Dict[str, Sequence[Tuple[str, Any]]]] = None, schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></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_: type</em>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.FieldType<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: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → type<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.value_to_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">value_to_runner_api</code><span class="sig-paren">(</span><em>type_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em>, <em>value</em>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.FieldValue<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#value_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.value_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.value_from_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">value_from_runner_api</code><span class="sig-paren">(</span><em>type_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em>, <em>value_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldValue</em>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.FieldValue<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#value_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.value_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.option_to_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">option_to_runner_api</code><span class="sig-paren">(</span><em>option: Tuple[str, Any], schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.Option<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#option_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.option_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.typehints.schemas.option_from_runner_api"> |
| <code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">option_from_runner_api</code><span class="sig-paren">(</span><em>option_proto: org.apache.beam.model.pipeline.v1.schema_pb2.Option</em>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → Tuple[str, Any]<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#option_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.option_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">SchemaTranslation</code><span class="sig-paren">(</span><em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation" 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.11)"><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.SchemaTranslation.typing_to_runner_api"> |
| <code class="descname">typing_to_runner_api</code><span class="sig-paren">(</span><em>type_: type</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.FieldType<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.typing_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.typing_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.atomic_value_from_runner_api"> |
| <code class="descname">atomic_value_from_runner_api</code><span class="sig-paren">(</span><em>atomic_type: <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f2e3a60fb20></em>, <em>atomic_value: org.apache.beam.model.pipeline.v1.schema_pb2.AtomicTypeValue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.atomic_value_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.atomic_value_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.atomic_value_to_runner_api"> |
| <code class="descname">atomic_value_to_runner_api</code><span class="sig-paren">(</span><em>atomic_type: <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f2e3a60fb20></em>, <em>value</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.AtomicTypeValue<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.atomic_value_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.atomic_value_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.value_from_runner_api"> |
| <code class="descname">value_from_runner_api</code><span class="sig-paren">(</span><em>type_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em>, <em>value_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldValue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.value_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.value_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.value_to_runner_api"> |
| <code class="descname">value_to_runner_api</code><span class="sig-paren">(</span><em>typing_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.value_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.value_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.option_from_runner_api"> |
| <code class="descname">option_from_runner_api</code><span class="sig-paren">(</span><em>option_proto: org.apache.beam.model.pipeline.v1.schema_pb2.Option</em><span class="sig-paren">)</span> → Tuple[str, Any]<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.option_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.option_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.option_to_runner_api"> |
| <code class="descname">option_to_runner_api</code><span class="sig-paren">(</span><em>option: Tuple[str, Any]</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.Option<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.option_to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.option_to_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.typing_from_runner_api"> |
| <code class="descname">typing_from_runner_api</code><span class="sig-paren">(</span><em>fieldtype_proto: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.typing_from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.typing_from_runner_api" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.SchemaTranslation.named_tuple_from_schema"> |
| <code class="descname">named_tuple_from_schema</code><span class="sig-paren">(</span><em>schema: org.apache.beam.model.pipeline.v1.schema_pb2.Schema</em><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#SchemaTranslation.named_tuple_from_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.SchemaTranslation.named_tuple_from_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </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>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → type<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>, <em>schema_registry: apache_beam.typehints.schema_registry.SchemaTypeRegistry = <apache_beam.typehints.schema_registry.SchemaTypeRegistry object></em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.Schema<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: type</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.Schema<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: type</em><span class="sig-paren">)</span> → List[Tuple[str, type]]<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.11)"><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.11)"><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><em>value</em><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><em>value</em><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.PassThroughLogicalType"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">PassThroughLogicalType</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PassThroughLogicalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PassThroughLogicalType" 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> |
| <p>A base class for LogicalTypes that use the same type as the underlying |
| representation type.</p> |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.PassThroughLogicalType.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PassThroughLogicalType.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PassThroughLogicalType.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.PassThroughLogicalType.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#PassThroughLogicalType.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PassThroughLogicalType.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.PassThroughLogicalType.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PassThroughLogicalType.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PassThroughLogicalType.to_representation_type" 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.11)"><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> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.MillisInstant"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">MillisInstant</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#MillisInstant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MillisInstant" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.NoArgumentLogicalType" title="apache_beam.typehints.schemas.NoArgumentLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.NoArgumentLogicalType</span></code></a></p> |
| <p>Millisecond-precision instant logical type handles values consistent with |
| that encoded by <code class="docutils literal notranslate"><span class="pre">InstantCoder</span></code> in the Java SDK.</p> |
| <p>This class handles <a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.utils.timestamp.Timestamp</span></code></a> language |
| type as <a class="reference internal" href="#apache_beam.typehints.schemas.MicrosInstant" title="apache_beam.typehints.schemas.MicrosInstant"><code class="xref py py-class docutils literal notranslate"><span class="pre">MicrosInstant</span></code></a>, but it only provides millisecond precision, |
| because it is aimed to handle data encoded by Java sdk’s InstantCoder which |
| has same precision level.</p> |
| <p>Timestamp is handled by <cite>MicrosInstant</cite> by default. In some scenario, such as |
| read from cross-language transform with rows containing InstantCoder encoded |
| timestamps, one may need to override the mapping of Timetamp to MillisInstant. |
| To do this, re-register this class with |
| <a class="reference internal" href="#apache_beam.typehints.schemas.LogicalType.register_logical_type" title="apache_beam.typehints.schemas.LogicalType.register_logical_type"><code class="xref py py-func docutils literal notranslate"><span class="pre">register_logical_type()</span></code></a>.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MillisInstant.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#MillisInstant.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MillisInstant.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MillisInstant.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#MillisInstant.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MillisInstant.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MillisInstant.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#MillisInstant.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MillisInstant.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.MillisInstant.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#MillisInstant.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MillisInstant.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">MicrosInstant</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#MicrosInstant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.NoArgumentLogicalType" title="apache_beam.typehints.schemas.NoArgumentLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.NoArgumentLogicalType</span></code></a></p> |
| <p>Microsecond-precision instant logical type that handles <code class="docutils literal notranslate"><span class="pre">Timestamp</span></code>.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant.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#MicrosInstant.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant.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#MicrosInstant.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant.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#MicrosInstant.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#MicrosInstant.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant.to_representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.MicrosInstant.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#MicrosInstant.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.MicrosInstant.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">PythonCallable</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PythonCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.NoArgumentLogicalType" title="apache_beam.typehints.schemas.NoArgumentLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.NoArgumentLogicalType</span></code></a></p> |
| <p>A logical type for PythonCallableSource objects.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable.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#PythonCallable.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable.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#PythonCallable.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable.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#PythonCallable.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PythonCallable.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable.to_representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.PythonCallable.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#PythonCallable.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.PythonCallable.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">FixedPrecisionDecimalArgumentRepresentation</code><span class="sig-paren">(</span><em>precision</em>, <em>scale</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation" 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.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of FixedPrecisionDecimalArgumentRepresentation(precision, scale)</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation.precision"> |
| <code class="descname">precision</code><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation.precision" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation.scale"> |
| <code class="descname">scale</code><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalArgumentRepresentation.scale" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">DecimalLogicalType</code><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#DecimalLogicalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.NoArgumentLogicalType" title="apache_beam.typehints.schemas.NoArgumentLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.NoArgumentLogicalType</span></code></a></p> |
| <p>A logical type for decimal objects handling values consistent with that |
| encoded by <code class="docutils literal notranslate"><span class="pre">BigDecimalCoder</span></code> in the Java SDK.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType.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#DecimalLogicalType.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType.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#DecimalLogicalType.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType.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#DecimalLogicalType.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#DecimalLogicalType.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType.to_representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.DecimalLogicalType.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#DecimalLogicalType.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.DecimalLogicalType.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">FixedPrecisionDecimalLogicalType</code><span class="sig-paren">(</span><em>precision=-1</em>, <em>scale=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedPrecisionDecimalLogicalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType" 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> |
| <p>A wrapper of DecimalLogicalType that contains the precision value.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.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#FixedPrecisionDecimalLogicalType.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.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#FixedPrecisionDecimalLogicalType.representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.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#FixedPrecisionDecimalLogicalType.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.to_representation_type"> |
| <code class="descname">to_representation_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedPrecisionDecimalLogicalType.to_representation_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.to_representation_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedPrecisionDecimalLogicalType.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.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#FixedPrecisionDecimalLogicalType.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.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#FixedPrecisionDecimalLogicalType.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedPrecisionDecimalLogicalType.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">FixedBytes</code><span class="sig-paren">(</span><em>length: numpy.int32</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedBytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.PassThroughLogicalType" title="apache_beam.typehints.schemas.PassThroughLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.PassThroughLogicalType</span></code></a></p> |
| <p>A logical type for fixed-length bytes.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes.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#FixedBytes.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes.language_type"> |
| <em class="property">classmethod </em><code class="descname">language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedBytes.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value: bytes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedBytes.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes.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#FixedBytes.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedBytes.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#FixedBytes.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedBytes.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">VariableBytes</code><span class="sig-paren">(</span><em>max_length: numpy.int32 = 2147483647</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableBytes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.PassThroughLogicalType" title="apache_beam.typehints.schemas.PassThroughLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.PassThroughLogicalType</span></code></a></p> |
| <p>A logical type for variable-length bytes with specified maximum length.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes.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#VariableBytes.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes.language_type"> |
| <em class="property">classmethod </em><code class="descname">language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableBytes.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value: bytes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableBytes.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes.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#VariableBytes.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.VariableBytes.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#VariableBytes.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableBytes.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.FixedString"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">FixedString</code><span class="sig-paren">(</span><em>length: numpy.int32</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedString"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.PassThroughLogicalType" title="apache_beam.typehints.schemas.PassThroughLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.PassThroughLogicalType</span></code></a></p> |
| <p>A logical type for fixed-length string.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedString.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#FixedString.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedString.language_type"> |
| <em class="property">classmethod </em><code class="descname">language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedString.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedString.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#FixedString.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.FixedString.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#FixedString.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.FixedString.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#FixedString.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.FixedString.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.typehints.schemas.VariableString"> |
| <em class="property">class </em><code class="descclassname">apache_beam.typehints.schemas.</code><code class="descname">VariableString</code><span class="sig-paren">(</span><em>max_length: numpy.int32 = 2147483647</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableString"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.typehints.schemas.PassThroughLogicalType" title="apache_beam.typehints.schemas.PassThroughLogicalType"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.typehints.schemas.PassThroughLogicalType</span></code></a></p> |
| <p>A logical type for variable-length string with specified maximum length.</p> |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableString.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#VariableString.urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString.urn" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableString.language_type"> |
| <em class="property">classmethod </em><code class="descname">language_type</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → type<a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableString.language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString.language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.VariableString.to_language_type"> |
| <code class="descname">to_language_type</code><span class="sig-paren">(</span><em>value: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/typehints/schemas.html#VariableString.to_language_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString.to_language_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.typehints.schemas.VariableString.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#VariableString.argument_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString.argument_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.typehints.schemas.VariableString.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#VariableString.argument"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.typehints.schemas.VariableString.argument" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.typehints.sharded_key_type.html" class="btn btn-neutral float-right" title="apache_beam.typehints.sharded_key_type module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.typehints.schema_registry.html" class="btn btn-neutral float-left" title="apache_beam.typehints.schema_registry 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> |
