| |
| |
| <!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.runners package — Apache Beam 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 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.runners.dataflow package" href="apache_beam.runners.dataflow.html" /> |
| <link rel="prev" title="apache_beam.portability.utils module" href="apache_beam.portability.utils.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" /> |
| <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.internal.html">apache_beam.internal 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="current reference internal" href="#">apache_beam.runners package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></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.internal.html">apache_beam.runners.internal 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="#submodules">Submodules</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.pipeline_context.html">apache_beam.runners.pipeline_context module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.runner.html">apache_beam.runners.runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.sdf_utils.html">apache_beam.runners.sdf_utils module</a></li> |
| </ul> |
| </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.tools.html">apache_beam.tools 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> |
| </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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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>apache_beam.runners package</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.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.runners"> |
| <span id="apache-beam-runners-package"></span><h1>apache_beam.runners package<a class="headerlink" href="#module-apache_beam.runners" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Runner objects execute a Pipeline.</p> |
| <p>This package defines runners, which are used to execute a pipeline.</p> |
| <div class="section" id="subpackages"> |
| <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">ΒΆ</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.html#subpackages">Subpackages</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.native_io.html">apache_beam.runners.dataflow.native_io package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.dataflow.native_io.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.dataflow.native_io.iobase.html">apache_beam.runners.dataflow.native_io.iobase module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.dataflow.html#submodules">Submodules</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 module</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 module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_metrics.html">apache_beam.runners.dataflow.dataflow_metrics module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.dataflow_runner.html">apache_beam.runners.dataflow.dataflow_runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.ptransform_overrides.html">apache_beam.runners.dataflow.ptransform_overrides module</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 module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.direct.html#submodules">Submodules</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.bundle_factory.html">apache_beam.runners.direct.bundle_factory module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.clock.html">apache_beam.runners.direct.clock module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.consumer_tracking_pipeline_visitor.html">apache_beam.runners.direct.consumer_tracking_pipeline_visitor module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.direct_metrics.html">apache_beam.runners.direct.direct_metrics module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.direct_runner.html">apache_beam.runners.direct.direct_runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.direct_userstate.html">apache_beam.runners.direct.direct_userstate module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.evaluation_context.html">apache_beam.runners.direct.evaluation_context module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.executor.html">apache_beam.runners.direct.executor module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.helper_transforms.html">apache_beam.runners.direct.helper_transforms module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.sdf_direct_runner.html">apache_beam.runners.direct.sdf_direct_runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.test_direct_runner.html">apache_beam.runners.direct.test_direct_runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.test_stream_impl.html">apache_beam.runners.direct.test_stream_impl module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.transform_evaluator.html">apache_beam.runners.direct.transform_evaluator module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.util.html">apache_beam.runners.direct.util module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.watermark_manager.html">apache_beam.runners.direct.watermark_manager module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.html">apache_beam.runners.interactive.caching package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.caching.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html">apache_beam.runners.interactive.caching.streaming_cache module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.display.html">apache_beam.runners.interactive.display package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.display.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.display.display_manager.html">apache_beam.runners.interactive.display.display_manager module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.display.interactive_pipeline_graph.html">apache_beam.runners.interactive.display.interactive_pipeline_graph module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.display.pcoll_visualization.html">apache_beam.runners.interactive.display.pcoll_visualization module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph.html">apache_beam.runners.interactive.display.pipeline_graph module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.display.pipeline_graph_renderer.html">apache_beam.runners.interactive.display.pipeline_graph_renderer module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.messaging.html">apache_beam.runners.interactive.messaging package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.messaging.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.messaging.interactive_environment_inspector.html">apache_beam.runners.interactive.messaging.interactive_environment_inspector module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.options.html">apache_beam.runners.interactive.options package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.options.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.options.capture_control.html">apache_beam.runners.interactive.options.capture_control module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.options.capture_limiters.html">apache_beam.runners.interactive.options.capture_limiters module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.options.interactive_options.html">apache_beam.runners.interactive.options.interactive_options module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.testing.html">apache_beam.runners.interactive.testing package</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.testing.html#subpackages">Subpackages</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.testing.integration.html">apache_beam.runners.interactive.testing.integration package</a><ul> |
| <li class="toctree-l6"><a class="reference internal" href="apache_beam.runners.interactive.testing.integration.html#submodules">Submodules</a><ul> |
| <li class="toctree-l7"><a class="reference internal" href="apache_beam.runners.interactive.testing.integration.notebook_executor.html">apache_beam.runners.interactive.testing.integration.notebook_executor module</a></li> |
| <li class="toctree-l7"><a class="reference internal" href="apache_beam.runners.interactive.testing.integration.screen_diff.html">apache_beam.runners.interactive.testing.integration.screen_diff module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.testing.html#submodules">Submodules</a><ul> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.testing.mock_ipython.html">apache_beam.runners.interactive.testing.mock_ipython module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.testing.pipeline_assertion.html">apache_beam.runners.interactive.testing.pipeline_assertion module</a></li> |
| <li class="toctree-l5"><a class="reference internal" href="apache_beam.runners.interactive.testing.test_cache_manager.html">apache_beam.runners.interactive.testing.test_cache_manager module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.background_caching_job.html">apache_beam.runners.interactive.background_caching_job module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.cache_manager.html">apache_beam.runners.interactive.cache_manager module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.interactive_beam.html">apache_beam.runners.interactive.interactive_beam module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.interactive_environment.html">apache_beam.runners.interactive.interactive_environment module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.interactive_runner.html">apache_beam.runners.interactive.interactive_runner module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.pipeline_analyzer.html">apache_beam.runners.interactive.pipeline_analyzer module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.pipeline_fragment.html">apache_beam.runners.interactive.pipeline_fragment module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.pipeline_instrument.html">apache_beam.runners.interactive.pipeline_instrument module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.utils.html">apache_beam.runners.interactive.utils module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.internal.html">apache_beam.runners.internal package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.internal.html#submodules">Submodules</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.internal.names.html">apache_beam.runners.internal.names module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.job.html#submodules">Submodules</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.manager.html">apache_beam.runners.job.manager module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.utils.html">apache_beam.runners.job.utils module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="submodules"> |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">ΒΆ</a></h2> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.pipeline_context.html">apache_beam.runners.pipeline_context module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.runner.html">apache_beam.runners.runner module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.sdf_utils.html">apache_beam.runners.sdf_utils module</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.dataflow.html" class="btn btn-neutral float-right" title="apache_beam.runners.dataflow package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.portability.utils.html" class="btn btn-neutral float-left" title="apache_beam.portability.utils 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> |