| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.runners.dataflow.dataflow_runner module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.runners.dataflow.ptransform_overrides module" href="apache_beam.runners.dataflow.ptransform_overrides.html" /> |
| <link rel="prev" title="apache_beam.runners.dataflow.dataflow_metrics module" href="apache_beam.runners.dataflow.dataflow_metrics.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 role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> |
| <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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dask.html">apache_beam.runners.dask package</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.dataflow.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li> |
| </ul> |
| </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"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></li> |
| <li class="breadcrumb-item active">apache_beam.runners.dataflow.dataflow_runner module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.runners.dataflow.dataflow_runner.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"> |
| |
| <section id="module-apache_beam.runners.dataflow.dataflow_runner"> |
| <span id="apache-beam-runners-dataflow-dataflow-runner-module"></span><h1>apache_beam.runners.dataflow.dataflow_runner module<a class="headerlink" href="#module-apache_beam.runners.dataflow.dataflow_runner" title="Link to this heading"></a></h1> |
| <p>A runner implementation that submits a job for remote execution.</p> |
| <p>The runner will create a JSON description of the job graph and then submit it |
| to the Dataflow Service for remote execution by a worker.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.dataflow.dataflow_runner.</span></span><span class="sig-name descname"><span class="pre">DataflowRunner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cache</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineRunner" title="apache_beam.runners.runner.PipelineRunner"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineRunner</span></code></a></p> |
| <p>A runner that creates job graphs and submits them for remote execution.</p> |
| <p>Every execution of the run() method will submit an independent job for |
| remote execution that consists of the nodes reachable from the passed-in |
| node argument or entire graph if the node is None. The run() method returns |
| after the service creates the job, and the job status is reported as RUNNING.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">NativeReadPTransformOverride</span></span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PTransformOverride</span></code></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">Read</span></code> using native sources.</p> |
| <p>The DataflowRunner expects that the Read PTransform using native sources act |
| as a primitive. So this override replaces the Read with a primitive.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.get_replacement_transform"> |
| <span class="sig-name descname"><span class="pre">get_replacement_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ptransform</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.get_replacement_transform" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.matches"> |
| <span class="sig-name descname"><span class="pre">matches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">applied_ptransform</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.matches" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.default_pickle_library_override"> |
| <span class="sig-name descname"><span class="pre">default_pickle_library_override</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.default_pickle_library_override"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.default_pickle_library_override" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.is_fnapi_compatible"> |
| <span class="sig-name descname"><span class="pre">is_fnapi_compatible</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.is_fnapi_compatible"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.is_fnapi_compatible" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.poll_for_job_completion"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">poll_for_job_completion</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">runner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state_update_callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.poll_for_job_completion"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.poll_for_job_completion" title="Link to this definition"></a></dt> |
| <dd><p>Polls for the specified job to finish running (successfully or not).</p> |
| <p>Updates the result with the new job information before returning.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>runner</strong> – DataflowRunner instance to use for polling job state.</p></li> |
| <li><p><strong>result</strong> – DataflowPipelineResult instance used for job information.</p></li> |
| <li><p><strong>duration</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – The time to wait (in milliseconds) for job to finish. |
| If it is set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a>, it will wait indefinitely until the job |
| is finished.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.side_input_visitor"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">side_input_visitor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deterministic_key_coders</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.side_input_visitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.side_input_visitor" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.flatten_input_visitor"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flatten_input_visitor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.flatten_input_visitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.flatten_input_visitor" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.combinefn_visitor"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">combinefn_visitor</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.combinefn_visitor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.combinefn_visitor" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_pipeline"> |
| <span class="sig-name descname"><span class="pre">run_pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pipeline_proto</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_pipeline"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_pipeline" title="Link to this definition"></a></dt> |
| <dd><p>Remotely executes entire pipeline or parts reachable from node.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.get_default_gcp_region"> |
| <span class="sig-name descname"><span class="pre">get_default_gcp_region</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.get_default_gcp_region"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.get_default_gcp_region" title="Link to this definition"></a></dt> |
| <dd><p>Get a default value for Google Cloud region according to |
| <a class="reference external" href="https://cloud.google.com/compute/docs/gcloud-compute/#default-properties">https://cloud.google.com/compute/docs/gcloud-compute/#default-properties</a>. |
| If no default can be found, returns None.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.runners.dataflow.dataflow_metrics.html" class="btn btn-neutral float-left" title="apache_beam.runners.dataflow.dataflow_metrics module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.runners.dataflow.ptransform_overrides.html" class="btn btn-neutral float-right" title="apache_beam.runners.dataflow.ptransform_overrides module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
