| |
| |
| <!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_provider module — Apache Beam 2.56.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_transform module" href="apache_beam.yaml.yaml_transform.html" /> |
| <link rel="prev" title="apache_beam.yaml.yaml_mapping module" href="apache_beam.yaml.yaml_mapping.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.56.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.generate_yaml_docs.html">apache_beam.yaml.generate_yaml_docs 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"><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_join.html">apache_beam.yaml.yaml_join 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 current"><a class="current reference internal" href="#">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.yaml_provider module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.yaml.yaml_provider.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_provider"> |
| <span id="apache-beam-yaml-yaml-provider-module"></span><h1>apache_beam.yaml.yaml_provider module<a class="headerlink" href="#module-apache_beam.yaml.yaml_provider" title="Permalink to this headline">¶</a></h1> |
| <p>This module defines Providers usable from yaml, which is a specification |
| for where to find and how to invoke services that vend implementations of |
| various PTransforms.</p> |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">Provider</code><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider" 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.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Maps transform types names and args to concrete PTransform instances.</p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.available" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns whether this provider is available to use in this environment.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → Optional[Iterable[str]]<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → Iterable[str]<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a list of transform type names this provider can handle.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.config_schema"> |
| <code class="descname">config_schema</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.config_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.config_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.description"> |
| <code class="descname">description</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.description" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.requires_inputs"> |
| <code class="descname">requires_inputs</code><span class="sig-paren">(</span><em>typ: str, args: Mapping[str, Any]</em><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.requires_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.requires_inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns whether this transform requires inputs.</p> |
| <p>Specifically, if this returns True and inputs are not provided than an error |
| will be thrown.</p> |
| <p>This is best-effort, primarily for better and earlier error messages.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>typ: str, args: Mapping[str, Any], yaml_create_transform: Callable[[Mapping[str, Any], Iterable[apache_beam.pvalue.PCollection]], apache_beam.transforms.ptransform.PTransform]</em><span class="sig-paren">)</span> → apache_beam.transforms.ptransform.PTransform<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a PTransform instance for the given transform type and arguments.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.underlying_provider"> |
| <code class="descname">underlying_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.underlying_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.underlying_provider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>If this provider is simply a proxy to another provider, return the |
| provider that should actually be used for affinity checking.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.Provider.affinity"> |
| <code class="descname">affinity</code><span class="sig-paren">(</span><em>other: apache_beam.yaml.yaml_provider.Provider</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#Provider.affinity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.Provider.affinity" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a value approximating how good it would be for this provider |
| to be used immediately following a transform from the other provider |
| (e.g. to encourage fusion).</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.as_provider"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">as_provider</code><span class="sig-paren">(</span><em>name</em>, <em>provider_or_constructor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#as_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.as_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.as_provider_list"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">as_provider_list</code><span class="sig-paren">(</span><em>name</em>, <em>lst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#as_provider_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.as_provider_list" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">ExternalProvider</code><span class="sig-paren">(</span><em>urns</em>, <em>service</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.Provider" title="apache_beam.yaml.yaml_provider.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.Provider</span></code></a></p> |
| <p>A Provider implemented via the cross language transform service.</p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.schema_transforms"> |
| <code class="descname">schema_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.schema_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.schema_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.config_schema"> |
| <code class="descname">config_schema</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.config_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.config_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.description"> |
| <code class="descname">description</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.description" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.requires_inputs"> |
| <code class="descname">requires_inputs</code><span class="sig-paren">(</span><em>typ</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.requires_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.requires_inputs" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>type</em>, <em>args</em>, <em>yaml_create_transform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.create_external_transform"> |
| <code class="descname">create_external_transform</code><span class="sig-paren">(</span><em>urn</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.create_external_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.create_external_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.provider_from_spec"> |
| <em class="property">classmethod </em><code class="descname">provider_from_spec</code><span class="sig-paren">(</span><em>spec</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.provider_from_spec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.provider_from_spec" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalProvider.register_provider_type"> |
| <em class="property">classmethod </em><code class="descname">register_provider_type</code><span class="sig-paren">(</span><em>type_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalProvider.register_provider_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalProvider.register_provider_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.java_jar"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">java_jar</code><span class="sig-paren">(</span><em>urns</em>, <em>jar: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#java_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.java_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.maven_jar"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">maven_jar</code><span class="sig-paren">(</span><em>urns</em>, <em>*</em>, <em>artifact_id</em>, <em>group_id</em>, <em>version</em>, <em>repository='https://repo.maven.apache.org/maven2'</em>, <em>classifier=None</em>, <em>appendix=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#maven_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.maven_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.beam_jar"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">beam_jar</code><span class="sig-paren">(</span><em>urns</em>, <em>*</em>, <em>gradle_target</em>, <em>appendix=None</em>, <em>version='2.56.0'</em>, <em>artifact_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#beam_jar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.beam_jar" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.docker"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">docker</code><span class="sig-paren">(</span><em>urns</em>, <em>**config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#docker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.docker" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.RemoteProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">RemoteProvider</code><span class="sig-paren">(</span><em>urns</em>, <em>address: str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RemoteProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RemoteProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.ExternalProvider" title="apache_beam.yaml.yaml_provider.ExternalProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.ExternalProvider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RemoteProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RemoteProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RemoteProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RemoteProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RemoteProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RemoteProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalJavaProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">ExternalJavaProvider</code><span class="sig-paren">(</span><em>urns</em>, <em>jar_provider</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalJavaProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalJavaProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.ExternalProvider" title="apache_beam.yaml.yaml_provider.ExternalProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.ExternalProvider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalJavaProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalJavaProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalJavaProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalJavaProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalJavaProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalJavaProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.python"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">python</code><span class="sig-paren">(</span><em>urns</em>, <em>packages=()</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#python"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.python" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalPythonProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">ExternalPythonProvider</code><span class="sig-paren">(</span><em>urns</em>, <em>packages</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalPythonProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalPythonProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.ExternalProvider" title="apache_beam.yaml.yaml_provider.ExternalProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.ExternalProvider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalPythonProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalPythonProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalPythonProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalPythonProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalPythonProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalPythonProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.ExternalPythonProvider.create_external_transform"> |
| <code class="descname">create_external_transform</code><span class="sig-paren">(</span><em>urn</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#ExternalPythonProvider.create_external_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.ExternalPythonProvider.create_external_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.fix_pycallable"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">fix_pycallable</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#fix_pycallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.fix_pycallable" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">InlineProvider</code><span class="sig-paren">(</span><em>transform_factories</em>, <em>no_input_transforms=()</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.Provider" title="apache_beam.yaml.yaml_provider.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.Provider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.config_schema"> |
| <code class="descname">config_schema</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.config_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.config_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.description"> |
| <code class="descname">description</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.description" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.get_docs"> |
| <code class="descname">get_docs</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.get_docs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.get_docs" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>type</em>, <em>args</em>, <em>yaml_create_transform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.to_json"> |
| <code class="descname">to_json</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.to_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.to_json" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.InlineProvider.requires_inputs"> |
| <code class="descname">requires_inputs</code><span class="sig-paren">(</span><em>typ</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#InlineProvider.requires_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.InlineProvider.requires_inputs" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.MetaInlineProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">MetaInlineProvider</code><span class="sig-paren">(</span><em>transform_factories</em>, <em>no_input_transforms=()</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#MetaInlineProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.MetaInlineProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.InlineProvider" title="apache_beam.yaml.yaml_provider.InlineProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.InlineProvider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.MetaInlineProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>type</em>, <em>args</em>, <em>yaml_create_transform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#MetaInlineProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.MetaInlineProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">SqlBackedProvider</code><span class="sig-paren">(</span><em>transforms: Mapping[str, Callable[[...], apache_beam.transforms.ptransform.PTransform]], sql_provider: Optional[apache_beam.yaml.yaml_provider.Provider] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.Provider" title="apache_beam.yaml.yaml_provider.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.Provider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.sql_provider"> |
| <code class="descname">sql_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.sql_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.sql_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.underlying_provider"> |
| <code class="descname">underlying_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.underlying_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.underlying_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.to_json"> |
| <code class="descname">to_json</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.to_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.to_json" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.SqlBackedProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>typ: str, args: Mapping[str, Any], yaml_create_transform: Any</em><span class="sig-paren">)</span> → apache_beam.transforms.ptransform.PTransform<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#SqlBackedProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.SqlBackedProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.element_to_rows"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">element_to_rows</code><span class="sig-paren">(</span><em>e</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#element_to_rows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.element_to_rows" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.dicts_to_rows"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">dicts_to_rows</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#dicts_to_rows"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.dicts_to_rows" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">YamlProviders</code><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders" 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.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.AssertEqual"> |
| <em class="property">class </em><code class="descname">AssertEqual</code><span class="sig-paren">(</span><em>elements</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.AssertEqual"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.AssertEqual" 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_provider.YamlProviders.AssertEqual.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_provider.html#YamlProviders.AssertEqual.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.AssertEqual.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.create"> |
| <em class="property">static </em><code class="descname">create</code><span class="sig-paren">(</span><em>elements: Iterable[Any], reshuffle: Optional[bool] = True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.create" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a collection containing a specified set of elements.</p> |
| <p>This transform always produces schema’d data. For example:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">Create</span> |
| <span class="n">config</span><span class="p">:</span> |
| <span class="n">elements</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span> |
| </pre></div> |
| </div> |
| <p>will result in an output with three elements with a schema of |
| Row(element=int) whereas YAML/JSON-style mappings will be interpreted |
| directly as Beam rows, e.g.:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">Create</span> |
| <span class="n">config</span><span class="p">:</span> |
| <span class="n">elements</span><span class="p">:</span> |
| <span class="o">-</span> <span class="p">{</span><span class="n">first</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="n">second</span><span class="p">:</span> <span class="p">{</span><span class="nb">str</span><span class="p">:</span> <span class="s2">"foo"</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]}}</span> |
| <span class="o">-</span> <span class="p">{</span><span class="n">first</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="n">second</span><span class="p">:</span> <span class="p">{</span><span class="nb">str</span><span class="p">:</span> <span class="s2">"bar"</span><span class="p">,</span> <span class="n">values</span><span class="p">:</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]}}</span> |
| </pre></div> |
| </div> |
| <p>will result in a schema of the form (int, Row(string, List[int])).</p> |
| <p>This can also be expressed as YAML:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">Create</span> |
| <span class="n">config</span><span class="p">:</span> |
| <span class="n">elements</span><span class="p">:</span> |
| <span class="o">-</span> <span class="n">first</span><span class="p">:</span> <span class="mi">0</span> |
| <span class="n">second</span><span class="p">:</span> |
| <span class="nb">str</span><span class="p">:</span> <span class="s2">"foo"</span> |
| <span class="n">values</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span> |
| <span class="o">-</span> <span class="n">first</span><span class="p">:</span> <span class="mi">1</span> |
| <span class="n">second</span><span class="p">:</span> |
| <span class="nb">str</span><span class="p">:</span> <span class="s2">"bar"</span> |
| <span class="n">values</span><span class="p">:</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">6</span><span class="p">]</span> |
| </pre></div> |
| </div> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>elements</strong> – The set of elements that should belong to the PCollection. |
| YAML/JSON-style mappings will be interpreted as Beam rows. |
| Primitives will be mapped to rows with a single “element” field.</li> |
| <li><strong>reshuffle</strong> – (optional) Whether to introduce a reshuffle (to possibly |
| redistribute the work) if there is more than one element in the |
| collection. Defaults to True.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.fully_qualified_named_transform"> |
| <em class="property">static </em><code class="descname">fully_qualified_named_transform</code><span class="sig-paren">(</span><em>constructor: str</em>, <em>args: Optional[Iterable[Any]] = ()</em>, <em>kwargs: Optional[Mapping[str</em>, <em>Any]] = {}</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.fully_qualified_named_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.fully_qualified_named_transform" title="Permalink to this definition">¶</a></dt> |
| <dd><p>A Python PTransform identified by fully qualified name.</p> |
| <p>This allows one to import, construct, and apply any Beam Python transform. |
| This can be useful for using transforms that have not yet been exposed |
| via a YAML interface. Note, however, that conversion may be required if this |
| transform does not accept or produce Beam Rows.</p> |
| <p>For example:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">type</span><span class="p">:</span> <span class="n">PyTransform</span> |
| <span class="n">config</span><span class="p">:</span> |
| <span class="n">constructor</span><span class="p">:</span> <span class="n">apache_beam</span><span class="o">.</span><span class="n">pkg</span><span class="o">.</span><span class="n">mod</span><span class="o">.</span><span class="n">SomeClass</span> |
| <span class="n">args</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="s1">'foo'</span><span class="p">]</span> |
| <span class="n">kwargs</span><span class="p">:</span> |
| <span class="n">baz</span><span class="p">:</span> <span class="mi">3</span> |
| </pre></div> |
| </div> |
| <p>can be used to access the transform |
| <cite>apache_beam.pkg.mod.SomeClass(1, ‘foo’, baz=3)</cite>.</p> |
| <p>See also the documentation on |
| [Inlining |
| Python](<a class="reference external" href="https://beam.apache.org/documentation/sdks/yaml-inline-python/">https://beam.apache.org/documentation/sdks/yaml-inline-python/</a>).</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>constructor</strong> – Fully qualified name of a callable used to construct the |
| transform. Often this is a class such as |
| <cite>apache_beam.pkg.mod.SomeClass</cite> but it can also be a function or |
| any other callable that returns a PTransform.</li> |
| <li><strong>args</strong> – A list of parameters to pass to the callable as positional |
| arguments.</li> |
| <li><strong>kwargs</strong> – A list of parameters to pass to the callable as keyword |
| arguments.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.Flatten"> |
| <em class="property">class </em><code class="descname">Flatten</code><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.Flatten"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.Flatten" 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> |
| <p>Flattens multiple PCollections into a single PCollection.</p> |
| <p>The elements of the resulting PCollection will be the (disjoint) union of |
| all the elements of all the inputs.</p> |
| <p>Note that in YAML transforms can always take a list of inputs which will |
| be implicitly flattened.</p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.Flatten.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>pcolls</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.Flatten.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.Flatten.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.WindowInto"> |
| <em class="property">class </em><code class="descname">WindowInto</code><span class="sig-paren">(</span><em>windowing</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.WindowInto"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.WindowInto" 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> |
| <p>A window transform assigning windows to each element of a PCollection.</p> |
| <p>The assigned windows will affect all downstream aggregating operations, |
| which will aggregate by window as well as by key.</p> |
| <p>See [the Beam documentation on windowing](<a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#windowing">https://beam.apache.org/documentation/programming-guide/#windowing</a>) |
| for more details.</p> |
| <p>Sizes, offsets, periods and gaps (where applicable) must be defined using |
| a time unit suffix ‘ms’, ‘s’, ‘m’, ‘h’ or ‘d’ for milliseconds, seconds, |
| minutes, hours or days, respectively. If a time unit is not specified, it |
| will default to ‘s’.</p> |
| <p>For example:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">windowing</span><span class="p">:</span> |
| <span class="nb">type</span><span class="p">:</span> <span class="n">fixed</span> |
| <span class="n">size</span><span class="p">:</span> <span class="mi">30</span><span class="n">s</span> |
| </pre></div> |
| </div> |
| <p>Note that any Yaml transform can have a |
| [windowing parameter](<a class="reference external" href="https://github.com/apache/beam/blob/master/sdks/python/apache_beam/yaml/README.md#windowing">https://github.com/apache/beam/blob/master/sdks/python/apache_beam/yaml/README.md#windowing</a>), |
| which is applied to its inputs (if any) or outputs (if there are no inputs) |
| which means that explicit WindowInto operations are not typically needed.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>windowing</strong> – the type and parameters of the windowing to perform</td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.WindowInto.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_provider.html#YamlProviders.WindowInto.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.WindowInto.expand" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.log_for_testing"> |
| <em class="property">static </em><code class="descname">log_for_testing</code><span class="sig-paren">(</span><em>level: Optional[str] = 'INFO'</em>, <em>prefix: Optional[str] = ''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.log_for_testing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.log_for_testing" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Logs each element of its input PCollection.</p> |
| <p>The output of this transform is a copy of its input for ease of use in |
| chain-style pipelines.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>level</strong> – one of ERROR, INFO, or DEBUG, mapped to a corresponding |
| language-specific logging level</li> |
| <li><strong>prefix</strong> – an optional identifier that will get prepended to the element |
| being logged</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.YamlProviders.create_builtin_provider"> |
| <em class="property">static </em><code class="descname">create_builtin_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#YamlProviders.create_builtin_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.YamlProviders.create_builtin_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">TranslatingProvider</code><span class="sig-paren">(</span><em>transforms: Mapping[str, Callable[[...], apache_beam.transforms.ptransform.PTransform]], underlying_provider: apache_beam.yaml.yaml_provider.Provider</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.Provider" title="apache_beam.yaml.yaml_provider.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.Provider</span></code></a></p> |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.underlying_provider"> |
| <code class="descname">underlying_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.underlying_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.underlying_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.to_json"> |
| <code class="descname">to_json</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.to_json"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.to_json" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.TranslatingProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>typ: str, config: Mapping[str, Any], yaml_create_transform: Any</em><span class="sig-paren">)</span> → apache_beam.transforms.ptransform.PTransform<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#TranslatingProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.TranslatingProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.create_java_builtin_provider"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">create_java_builtin_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#create_java_builtin_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.create_java_builtin_provider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Exposes built-in transforms from Java as well as Python to maximize |
| opportunities for fusion.</p> |
| <p>This class holds those transforms that require pre-processing of the configs. |
| For those Java transforms that can consume the user-provided configs directly |
| (or only need a simple renaming of parameters) a direct or renaming provider |
| is the simpler choice.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.PypiExpansionService"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">PypiExpansionService</code><span class="sig-paren">(</span><em>packages</em>, <em>base_python='/home/runner/work/beam/beam/beam/sdks/python/target/.tox/py38-docs/bin/python'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#PypiExpansionService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.PypiExpansionService" 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.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Expands transforms by fully qualified name in a virtual environment |
| with the given dependencies.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.yaml.yaml_provider.PypiExpansionService.VENV_CACHE"> |
| <code class="descname">VENV_CACHE</code><em class="property"> = '/home/runner/.apache_beam/cache/venvs'</em><a class="headerlink" href="#apache_beam.yaml.yaml_provider.PypiExpansionService.VENV_CACHE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider"> |
| <em class="property">class </em><code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">RenamingProvider</code><span class="sig-paren">(</span><em>transforms</em>, <em>mappings</em>, <em>underlying_provider</em>, <em>defaults=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.yaml.yaml_provider.Provider" title="apache_beam.yaml.yaml_provider.Provider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.yaml.yaml_provider.Provider</span></code></a></p> |
| <dl class="staticmethod"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.expand_mappings"> |
| <em class="property">static </em><code class="descname">expand_mappings</code><span class="sig-paren">(</span><em>mappings</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.expand_mappings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.expand_mappings" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.available"> |
| <code class="descname">available</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → bool<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.available"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.available" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.provided_transforms"> |
| <code class="descname">provided_transforms</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → Iterable[str]<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.provided_transforms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.provided_transforms" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.config_schema"> |
| <code class="descname">config_schema</code><span class="sig-paren">(</span><em>type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.config_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.config_schema" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.description"> |
| <code class="descname">description</code><span class="sig-paren">(</span><em>typ</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.description"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.description" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.requires_inputs"> |
| <code class="descname">requires_inputs</code><span class="sig-paren">(</span><em>typ</em>, <em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.requires_inputs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.requires_inputs" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.create_transform"> |
| <code class="descname">create_transform</code><span class="sig-paren">(</span><em>typ: str, args: Mapping[str, Any], yaml_create_transform: Callable[[Mapping[str, Any], Iterable[apache_beam.pvalue.PCollection]], apache_beam.transforms.ptransform.PTransform]</em><span class="sig-paren">)</span> → apache_beam.transforms.ptransform.PTransform<a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.create_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.create_transform" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Creates a PTransform instance for the given transform type and arguments.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.underlying_provider"> |
| <code class="descname">underlying_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.underlying_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.underlying_provider" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.yaml.yaml_provider.RenamingProvider.cache_artifacts"> |
| <code class="descname">cache_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#RenamingProvider.cache_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.RenamingProvider.cache_artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.parse_providers"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">parse_providers</code><span class="sig-paren">(</span><em>provider_specs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#parse_providers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.parse_providers" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.merge_providers"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">merge_providers</code><span class="sig-paren">(</span><em>*provider_sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#merge_providers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.merge_providers" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.yaml.yaml_provider.standard_providers"> |
| <code class="descclassname">apache_beam.yaml.yaml_provider.</code><code class="descname">standard_providers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/yaml/yaml_provider.html#standard_providers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.yaml.yaml_provider.standard_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_transform.html" class="btn btn-neutral float-right" title="apache_beam.yaml.yaml_transform module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.yaml.yaml_mapping.html" class="btn btn-neutral float-left" title="apache_beam.yaml.yaml_mapping 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> |
