blob: 5f5ea63ce29436f0fa108ed172c359892d9c77a4 [file] [log] [blame]
<!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.yaml_combine module &mdash; 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.yaml_io module" href="apache_beam.yaml.yaml_io.html" />
<link rel="prev" title="apache_beam.yaml.options module" href="apache_beam.yaml.options.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"><a class="reference internal" href="apache_beam.yaml.json_utils.html">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 current"><a class="current reference internal" href="#">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> &raquo;</li>
<li><a href="apache_beam.yaml.html">apache_beam.yaml package</a> &raquo;</li>
<li>apache_beam.yaml.yaml_combine module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.yaml.yaml_combine.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.yaml_combine">
<span id="apache-beam-yaml-yaml-combine-module"></span><h1>apache_beam.yaml.yaml_combine module<a class="headerlink" href="#module-apache_beam.yaml.yaml_combine" title="Permalink to this headline"></a></h1>
<p>This module defines the basic Combine operation.</p>
<dl class="function">
<dt id="apache_beam.yaml.yaml_combine.normalize_combine">
<code class="descclassname">apache_beam.yaml.yaml_combine.</code><code class="descname">normalize_combine</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_combine.html#normalize_combine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_combine.normalize_combine" title="Permalink to this definition"></a></dt>
<dd><p>Expands various shorthand specs for combine (which can otherwise be quite
verbose for simple cases.) We do this here so that it doesn’t need to be done
per language. The following are all equivalent:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">dest</span><span class="p">:</span> <span class="n">fn_type</span>
<span class="n">dest</span><span class="p">:</span>
<span class="n">value</span><span class="p">:</span> <span class="n">dest</span>
<span class="n">fn</span><span class="p">:</span> <span class="n">fn_type</span>
<span class="n">dest</span><span class="p">:</span>
<span class="n">value</span><span class="p">:</span> <span class="n">dest</span>
<span class="n">fn</span><span class="p">:</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">fn_type</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="apache_beam.yaml.yaml_combine.PyJsYamlCombine">
<em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_combine.</code><code class="descname">PyJsYamlCombine</code><span class="sig-paren">(</span><em>group_by: Iterable[str], combine: Mapping[str, Mapping[str, Any]], language: Optional[str] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_combine.html#PyJsYamlCombine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_combine.PyJsYamlCombine" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<dl class="method">
<dt id="apache_beam.yaml.yaml_combine.PyJsYamlCombine.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_combine.html#PyJsYamlCombine.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_combine.PyJsYamlCombine.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.yaml.yaml_combine.create_combine_providers">
<code class="descclassname">apache_beam.yaml.yaml_combine.</code><code class="descname">create_combine_providers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_combine.html#create_combine_providers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_combine.create_combine_providers" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.yaml.yaml_io.html" class="btn btn-neutral float-right" title="apache_beam.yaml.yaml_io module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.yaml.options.html" class="btn btn-neutral float-left" title="apache_beam.yaml.options module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; 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>