blob: 6ad443dc253cf9ef6fe17307ed7f3f997a8252e0 [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.transforms.environments module &mdash; Apache Beam 2.37.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.transforms.external module" href="apache_beam.transforms.external.html" />
<link rel="prev" title="apache_beam.transforms.display module" href="apache_beam.transforms.display.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.37.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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.environments module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.resources.html">apache_beam.transforms.resources module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li>
</ul>
</li>
</ul>
</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>
</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.transforms.html">apache_beam.transforms package</a> &raquo;</li>
<li>apache_beam.transforms.environments module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.transforms.environments.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.transforms.environments">
<span id="apache-beam-transforms-environments-module"></span><h1>apache_beam.transforms.environments module<a class="headerlink" href="#module-apache_beam.transforms.environments" title="Permalink to this headline"></a></h1>
<p>Environments concepts.</p>
<p>For internal use only. No backwards compatibility guarantees.</p>
<dl class="class">
<dt id="apache_beam.transforms.environments.Environment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">Environment</code><span class="sig-paren">(</span><em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Abstract base class for environments.</p>
<p>Represents a type and configuration of environment.
Each type of Environment should have a unique urn.</p>
<p>For internal use only. No backwards compatibility guarantees.</p>
<dl class="method">
<dt id="apache_beam.transforms.environments.Environment.artifacts">
<code class="descname">artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.artifacts" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.environments.Environment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.environments.Environment.capabilities">
<code class="descname">capabilities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.capabilities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.capabilities" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.environments.Environment.resource_hints">
<code class="descname">resource_hints</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.resource_hints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.resource_hints" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.Environment.register_urn">
<em class="property">classmethod </em><code class="descname">register_urn</code><span class="sig-paren">(</span><em>urn</em>, <em>parameter_type</em>, <em>constructor=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.register_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.register_urn" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.Environment.get_env_cls_from_urn">
<em class="property">classmethod </em><code class="descname">get_env_cls_from_urn</code><span class="sig-paren">(</span><em>urn</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.get_env_cls_from_urn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.get_env_cls_from_urn" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.environments.Environment.to_runner_api">
<code class="descname">to_runner_api</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.to_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.to_runner_api" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.Environment.from_runner_api">
<em class="property">classmethod </em><code class="descname">from_runner_api</code><span class="sig-paren">(</span><em>proto</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.from_runner_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.from_runner_api" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.Environment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#Environment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.Environment.from_options" title="Permalink to this definition"></a></dt>
<dd><p>Creates an Environment object from PortableOptions.</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>options</strong> – The PortableOptions object.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.DefaultEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">DefaultEnvironment</code><span class="sig-paren">(</span><em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DefaultEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DefaultEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<p>Used as a stub when context is missing a default environment.</p>
<dl class="method">
<dt id="apache_beam.transforms.environments.DefaultEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DefaultEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DefaultEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.DefaultEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DefaultEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DefaultEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.DockerEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">DockerEnvironment</code><span class="sig-paren">(</span><em>container_image=None</em>, <em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.DockerEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.DockerEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.DockerEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.DockerEnvironment.from_container_image">
<em class="property">classmethod </em><code class="descname">from_container_image</code><span class="sig-paren">(</span><em>container_image</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment.from_container_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment.from_container_image" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.DockerEnvironment.default_docker_image">
<em class="property">static </em><code class="descname">default_docker_image</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#DockerEnvironment.default_docker_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.DockerEnvironment.default_docker_image" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.ProcessEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">ProcessEnvironment</code><span class="sig-paren">(</span><em>command</em>, <em>os=''</em>, <em>arch=''</em>, <em>env=None</em>, <em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ProcessEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ProcessEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.ProcessEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ProcessEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ProcessEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.ProcessEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ProcessEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ProcessEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.ProcessEnvironment.parse_environment_variables">
<em class="property">static </em><code class="descname">parse_environment_variables</code><span class="sig-paren">(</span><em>variables</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ProcessEnvironment.parse_environment_variables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ProcessEnvironment.parse_environment_variables" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.ProcessEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ProcessEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ProcessEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.ExternalEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">ExternalEnvironment</code><span class="sig-paren">(</span><em>url</em>, <em>params=None</em>, <em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ExternalEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ExternalEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.ExternalEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ExternalEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ExternalEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.ExternalEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ExternalEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ExternalEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.ExternalEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#ExternalEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.ExternalEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.EmbeddedPythonEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">EmbeddedPythonEnvironment</code><span class="sig-paren">(</span><em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.EmbeddedPythonEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>unused_payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonEnvironment.default">
<em class="property">classmethod </em><code class="descname">default</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonEnvironment.default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonEnvironment.default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">EmbeddedPythonGrpcEnvironment</code><span class="sig-paren">(</span><em>state_cache_size=None</em>, <em>data_buffer_time_limit_ms=None</em>, <em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.parse_config">
<em class="property">static </em><code class="descname">parse_config</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment.parse_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.parse_config" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.default">
<em class="property">classmethod </em><code class="descname">default</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#EmbeddedPythonGrpcEnvironment.default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.EmbeddedPythonGrpcEnvironment.default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.SubprocessSDKEnvironment">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">SubprocessSDKEnvironment</code><span class="sig-paren">(</span><em>command_string</em>, <em>capabilities=()</em>, <em>artifacts=()</em>, <em>resource_hints=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#SubprocessSDKEnvironment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.SubprocessSDKEnvironment" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.environments.Environment" title="apache_beam.transforms.environments.Environment"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.environments.Environment</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.environments.SubprocessSDKEnvironment.to_runner_api_parameter">
<code class="descname">to_runner_api_parameter</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#SubprocessSDKEnvironment.to_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.SubprocessSDKEnvironment.to_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.transforms.environments.SubprocessSDKEnvironment.from_runner_api_parameter">
<em class="property">static </em><code class="descname">from_runner_api_parameter</code><span class="sig-paren">(</span><em>payload</em>, <em>capabilities</em>, <em>artifacts</em>, <em>resource_hints</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#SubprocessSDKEnvironment.from_runner_api_parameter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.SubprocessSDKEnvironment.from_runner_api_parameter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.SubprocessSDKEnvironment.from_options">
<em class="property">classmethod </em><code class="descname">from_options</code><span class="sig-paren">(</span><em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#SubprocessSDKEnvironment.from_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.SubprocessSDKEnvironment.from_options" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.SubprocessSDKEnvironment.from_command_string">
<em class="property">classmethod </em><code class="descname">from_command_string</code><span class="sig-paren">(</span><em>command_string</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#SubprocessSDKEnvironment.from_command_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.SubprocessSDKEnvironment.from_command_string" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.environments.PyPIArtifactRegistry">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.environments.</code><code class="descname">PyPIArtifactRegistry</code><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#PyPIArtifactRegistry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.PyPIArtifactRegistry" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.PyPIArtifactRegistry.register_artifact">
<em class="property">classmethod </em><code class="descname">register_artifact</code><span class="sig-paren">(</span><em>name</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#PyPIArtifactRegistry.register_artifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.PyPIArtifactRegistry.register_artifact" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="classmethod">
<dt id="apache_beam.transforms.environments.PyPIArtifactRegistry.get_artifacts">
<em class="property">classmethod </em><code class="descname">get_artifacts</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/environments.html#PyPIArtifactRegistry.get_artifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.environments.PyPIArtifactRegistry.get_artifacts" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.transforms.external.html" class="btn btn-neutral float-right" title="apache_beam.transforms.external module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.transforms.display.html" class="btn btn-neutral float-left" title="apache_beam.transforms.display 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>