| |
| |
| <!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.yaml.json_utils module — Apache Beam 2.52.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.yaml.main module" href="apache_beam.yaml.main.html" /> |
| <link rel="prev" title="apache_beam.yaml.cache_provider_artifacts module" href="apache_beam.yaml.cache_provider_artifacts.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.52.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"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.yaml.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.cache_provider_artifacts.html">apache_beam.yaml.cache_provider_artifacts module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.yaml.json_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.main.html">apache_beam.yaml.main module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.options.html">apache_beam.yaml.options module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_combine.html">apache_beam.yaml.yaml_combine module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_io.html">apache_beam.yaml.yaml_io module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_mapping.html">apache_beam.yaml.yaml_mapping module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_provider.html">apache_beam.yaml.yaml_provider module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.yaml.yaml_transform.html">apache_beam.yaml.yaml_transform module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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.yaml.html">apache_beam.yaml package</a> »</li> |
| |
| <li>apache_beam.yaml.json_utils module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.yaml.json_utils.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.yaml.json_utils"> |
| <span id="apache-beam-yaml-json-utils-module"></span><h1>apache_beam.yaml.json_utils module<a class="headerlink" href="#module-apache_beam.yaml.json_utils" title="Permalink to this headline">¶</a></h1> |
| <p>Utilities for converting between JSON and Beam Schema’d data.</p> |
| <p>For internal use, no backward compatibility guarantees.</p> |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.json_schema_to_beam_schema"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">json_schema_to_beam_schema</code><span class="sig-paren">(</span><em>json_schema: Dict[str, Any]</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.Schema<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#json_schema_to_beam_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.json_schema_to_beam_schema" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a Beam schema equivalent for the given Json schema.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.json_type_to_beam_type"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">json_type_to_beam_type</code><span class="sig-paren">(</span><em>json_type: Dict[str, Any]</em><span class="sig-paren">)</span> → org.apache.beam.model.pipeline.v1.schema_pb2.FieldType<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#json_type_to_beam_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.json_type_to_beam_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a Beam schema type for the given Json (schema) type.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.json_to_row"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">json_to_row</code><span class="sig-paren">(</span><em>beam_type: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em><span class="sig-paren">)</span> → Callable[[Any], Any]<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#json_to_row"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.json_to_row" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a callable converting Json objects to Beam rows of the given type.</p> |
| <p>The input to the returned callable is expected to conform to the Json schema |
| corresponding to this Beam type.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.json_parser"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">json_parser</code><span class="sig-paren">(</span><em>beam_schema: org.apache.beam.model.pipeline.v1.schema_pb2.Schema</em>, <em>json_schema: Optional[Dict[str</em>, <em>Any]] = None</em><span class="sig-paren">)</span> → Callable[[bytes], apache_beam.pvalue.Row]<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#json_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.json_parser" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a callable converting Json strings to Beam rows of the given type.</p> |
| <p>The input to the returned callable is expected to conform to the Json schema |
| corresponding to this Beam type.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.row_to_json"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">row_to_json</code><span class="sig-paren">(</span><em>beam_type: org.apache.beam.model.pipeline.v1.schema_pb2.FieldType</em><span class="sig-paren">)</span> → Callable[[Any], Any]<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#row_to_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.row_to_json" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a callable converting rows of the given type to Json objects.</p> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.json_utils.json_formater"> |
| <code class="descclassname">apache_beam.yaml.json_utils.</code><code class="descname">json_formater</code><span class="sig-paren">(</span><em>beam_schema: org.apache.beam.model.pipeline.v1.schema_pb2.Schema</em><span class="sig-paren">)</span> → Callable[[apache_beam.pvalue.Row], bytes]<a class="reference internal" href="_modules/apache_beam/yaml/json_utils.html#json_formater"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.json_utils.json_formater" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a callable converting rows of the given schema to Json strings.</p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.yaml.main.html" class="btn btn-neutral float-right" title="apache_beam.yaml.main module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.yaml.cache_provider_artifacts.html" class="btn btn-neutral float-left" title="apache_beam.yaml.cache_provider_artifacts 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> |
