| |
| |
| <!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 package — 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.dataflow_exercise_metrics_pipeline module" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html" /> |
| <link rel="prev" title="apache_beam.runners.dask.overrides module" href="apache_beam.runners.dask.overrides.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="current reference internal" href="#">apache_beam.runners.dataflow package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#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 active">apache_beam.runners.dataflow package</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.runners.dataflow.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"> |
| <span id="apache-beam-runners-dataflow-package"></span><h1>apache_beam.runners.dataflow package<a class="headerlink" href="#module-apache_beam.runners.dataflow" title="Link to this heading"></a></h1> |
| <p>The DataflowRunner executes pipelines on Google Cloud Dataflow.</p> |
| <p>Anything in this package not imported here is an internal implementation detail |
| with no backwards-compatibility guarantees.</p> |
| <section id="submodules"> |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html">apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.metric_matchers"><code class="docutils literal notranslate"><span class="pre">metric_matchers()</span></code></a></li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.UserMetricsDoFn"><code class="docutils literal notranslate"><span class="pre">UserMetricsDoFn</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.UserMetricsDoFn.start_bundle"><code class="docutils literal notranslate"><span class="pre">UserMetricsDoFn.start_bundle()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.UserMetricsDoFn.process"><code class="docutils literal notranslate"><span class="pre">UserMetricsDoFn.process()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.UserMetricsDoFn.finish_bundle"><code class="docutils literal notranslate"><span class="pre">UserMetricsDoFn.finish_bundle()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.apply_and_run"><code class="docutils literal notranslate"><span class="pre">apply_and_run()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html">apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.StreamingUserMetricsDoFn"><code class="docutils literal notranslate"><span class="pre">StreamingUserMetricsDoFn</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.StreamingUserMetricsDoFn.start_bundle"><code class="docutils literal notranslate"><span class="pre">StreamingUserMetricsDoFn.start_bundle()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.StreamingUserMetricsDoFn.process"><code class="docutils literal notranslate"><span class="pre">StreamingUserMetricsDoFn.process()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.StreamingUserMetricsDoFn.finish_bundle"><code class="docutils literal notranslate"><span class="pre">StreamingUserMetricsDoFn.finish_bundle()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.html#apache_beam.runners.dataflow.dataflow_exercise_streaming_metrics_pipeline.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_job_service.html">apache_beam.runners.dataflow.dataflow_job_service module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_job_service.html#apache_beam.runners.dataflow.dataflow_job_service.DataflowBeamJob"><code class="docutils literal notranslate"><span class="pre">DataflowBeamJob</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_job_service.html#apache_beam.runners.dataflow.dataflow_job_service.DataflowBeamJob.cancel"><code class="docutils literal notranslate"><span class="pre">DataflowBeamJob.cancel()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_job_service.html#apache_beam.runners.dataflow.dataflow_job_service.run"><code class="docutils literal notranslate"><span class="pre">run()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html">apache_beam.runners.dataflow.dataflow_metrics module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html#apache_beam.runners.dataflow.dataflow_metrics.DataflowMetrics"><code class="docutils literal notranslate"><span class="pre">DataflowMetrics</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html#apache_beam.runners.dataflow.dataflow_metrics.DataflowMetrics.all_metrics"><code class="docutils literal notranslate"><span class="pre">DataflowMetrics.all_metrics()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html#apache_beam.runners.dataflow.dataflow_metrics.DataflowMetrics.query"><code class="docutils literal notranslate"><span class="pre">DataflowMetrics.query()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html#apache_beam.runners.dataflow.dataflow_metrics.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html">apache_beam.runners.dataflow.dataflow_runner module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner"><code class="docutils literal notranslate"><span class="pre">DataflowRunner</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.NativeReadPTransformOverride</span></code></a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.get_replacement_transform"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.NativeReadPTransformOverride.get_replacement_transform()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.matches"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.NativeReadPTransformOverride.matches()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.default_pickle_library_override"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.default_pickle_library_override()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.is_fnapi_compatible"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.is_fnapi_compatible()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.poll_for_job_completion"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.poll_for_job_completion()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.side_input_visitor"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.side_input_visitor()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.flatten_input_visitor"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.flatten_input_visitor()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.combinefn_visitor"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.combinefn_visitor()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_pipeline"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.run_pipeline()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.get_default_gcp_region"><code class="docutils literal notranslate"><span class="pre">DataflowRunner.get_default_gcp_region()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.ptransform_overrides.html">apache_beam.runners.dataflow.ptransform_overrides module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.ptransform_overrides.html#apache_beam.runners.dataflow.ptransform_overrides.NativeReadPTransformOverride"><code class="docutils literal notranslate"><span class="pre">NativeReadPTransformOverride</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.ptransform_overrides.html#apache_beam.runners.dataflow.ptransform_overrides.NativeReadPTransformOverride.matches"><code class="docutils literal notranslate"><span class="pre">NativeReadPTransformOverride.matches()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.ptransform_overrides.html#apache_beam.runners.dataflow.ptransform_overrides.NativeReadPTransformOverride.get_replacement_transform"><code class="docutils literal notranslate"><span class="pre">NativeReadPTransformOverride.get_replacement_transform()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.test_dataflow_runner.html">apache_beam.runners.dataflow.test_dataflow_runner module</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.test_dataflow_runner.html#apache_beam.runners.dataflow.test_dataflow_runner.TestDataflowRunner"><code class="docutils literal notranslate"><span class="pre">TestDataflowRunner</span></code></a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.test_dataflow_runner.html#apache_beam.runners.dataflow.test_dataflow_runner.TestDataflowRunner.run_pipeline"><code class="docutils literal notranslate"><span class="pre">TestDataflowRunner.run_pipeline()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.test_dataflow_runner.html#apache_beam.runners.dataflow.test_dataflow_runner.TestDataflowRunner.build_console_url"><code class="docutils literal notranslate"><span class="pre">TestDataflowRunner.build_console_url()</span></code></a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.test_dataflow_runner.html#apache_beam.runners.dataflow.test_dataflow_runner.TestDataflowRunner.wait_until_in_state"><code class="docutils literal notranslate"><span class="pre">TestDataflowRunner.wait_until_in_state()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.runners.dask.overrides.html" class="btn btn-neutral float-left" title="apache_beam.runners.dask.overrides module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline.html" class="btn btn-neutral float-right" title="apache_beam.runners.dataflow.dataflow_exercise_metrics_pipeline 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> |
