| |
| |
| <!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.interactive.recording_manager module — Apache Beam 2.36.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.runners.interactive.user_pipeline_tracker module" href="apache_beam.runners.interactive.user_pipeline_tracker.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.pipeline_instrument module" href="apache_beam.runners.interactive.pipeline_instrument.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.36.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 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.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 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li> |
| </ul> |
| </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.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> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.recording_manager module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.recording_manager.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.interactive.recording_manager"> |
| <span id="apache-beam-runners-interactive-recording-manager-module"></span><h1>apache_beam.runners.interactive.recording_manager module<a class="headerlink" href="#module-apache_beam.runners.interactive.recording_manager" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.recording_manager.</code><code class="descname">ElementStream</code><span class="sig-paren">(</span><em>pcoll</em>, <em>var</em>, <em>cache_key</em>, <em>max_n</em>, <em>max_duration_secs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#ElementStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream" 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>A stream of elements from a given PCollection.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.var"> |
| <code class="descname">var</code><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.var" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the variable named that defined this PCollection.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.pcoll"> |
| <code class="descname">pcoll</code><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.pcoll" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the PCollection that supplies this stream with data.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.cache_key"> |
| <code class="descname">cache_key</code><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.cache_key" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns the cache key for this stream.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.display_id"> |
| <code class="descname">display_id</code><span class="sig-paren">(</span><em>suffix</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#ElementStream.display_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.display_id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a unique id able to be displayed in a web browser.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.is_computed"> |
| <code class="descname">is_computed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#ElementStream.is_computed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.is_computed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if no more elements will be recorded.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.is_done"> |
| <code class="descname">is_done</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#ElementStream.is_done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.is_done" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if no more new elements will be yielded.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.ElementStream.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><em>tail=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#ElementStream.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.ElementStream.read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reads the elements currently recorded.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.recording_manager.</code><code class="descname">Recording</code><span class="sig-paren">(</span><em>user_pipeline</em>, <em>pcolls</em>, <em>result</em>, <em>max_n</em>, <em>max_duration_secs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording" 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>A group of PCollections from a given pipeline run.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.is_computed"> |
| <code class="descname">is_computed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.is_computed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.is_computed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if all PCollections are computed.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.stream"> |
| <code class="descname">stream</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.stream" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns an ElementStream for a given PCollection.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.computed"> |
| <code class="descname">computed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.computed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.computed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns all computed ElementStreams.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.uncomputed"> |
| <code class="descname">uncomputed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.uncomputed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.uncomputed" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns all uncomputed ElementStreams.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.cancel"> |
| <code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.cancel" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Cancels the recording.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.wait_until_finish"> |
| <code class="descname">wait_until_finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.wait_until_finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.wait_until_finish" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Waits until the pipeline is done and returns the final state.</p> |
| <p>This also marks any PCollections as computed right away if the pipeline is |
| successful.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.Recording.describe"> |
| <code class="descname">describe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#Recording.describe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.Recording.describe" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary describing the cache and recording.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.recording_manager.</code><code class="descname">RecordingManager</code><span class="sig-paren">(</span><em>user_pipeline</em>, <em>pipeline_var=None</em>, <em>test_limiters=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager" 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>Manages recordings of PCollections for a given pipeline.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.clear"> |
| <code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.clear" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Clears all cached PCollections for this RecordingManager.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.cancel"> |
| <code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.cancel" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Cancels the current background recording job.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.describe"> |
| <code class="descname">describe</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.describe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.describe" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns a dictionary describing the cache and recording.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.record_pipeline"> |
| <code class="descname">record_pipeline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.record_pipeline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.record_pipeline" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Starts a background caching job for this RecordingManager’s pipeline.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.record"> |
| <code class="descname">record</code><span class="sig-paren">(</span><em>pcolls</em>, <em>max_n</em>, <em>max_duration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.record" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Records the given PCollections.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.recording_manager.RecordingManager.read"> |
| <code class="descname">read</code><span class="sig-paren">(</span><em>pcoll_name</em>, <em>pcoll</em>, <em>max_n</em>, <em>max_duration_secs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/recording_manager.html#RecordingManager.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.recording_manager.RecordingManager.read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reads an ElementStream of a computed PCollection.</p> |
| <p>Returns None if an error occurs. The caller is responsible of validating if |
| the given pcoll_name and pcoll can identify a watched and computed |
| PCollection without ambiguity in the notebook.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.user_pipeline_tracker.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.user_pipeline_tracker module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.pipeline_instrument.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.pipeline_instrument 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> |
