| |
| |
| <!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.caching.reify module — 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 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.caching.streaming_cache module" href="apache_beam.runners.interactive.caching.streaming_cache.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.caching.read_cache module" href="apache_beam.runners.interactive.caching.read_cache.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.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 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4"><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><a href="apache_beam.runners.interactive.caching.html">apache_beam.runners.interactive.caching package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.caching.reify module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.caching.reify.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.caching.reify"> |
| <span id="apache-beam-runners-interactive-caching-reify-module"></span><h1>apache_beam.runners.interactive.caching.reify module<a class="headerlink" href="#module-apache_beam.runners.interactive.caching.reify" title="Permalink to this headline">¶</a></h1> |
| <p>Module for transforms that reifies and unreifies PCollection values with |
| window info.</p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.caching.reify.Reify"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.caching.reify.</code><code class="descname">Reify</code><span class="sig-paren">(</span><em>*unused_args</em>, <em>**unused_kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#Reify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.Reify" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.core.DoFn</span></code></a></p> |
| <p>Reifies elements with window info into windowed values.</p> |
| <p>Internally used to capture window info with each element into cache for |
| replayability.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.caching.reify.Reify.process"> |
| <code class="descname">process</code><span class="sig-paren">(</span><em>e</em>, <em>w=WindowParam</em>, <em>p=PaneInfoParam</em>, <em>t=TimestampParam</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#Reify.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.Reify.process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.caching.reify.Unreify"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.caching.reify.</code><code class="descname">Unreify</code><span class="sig-paren">(</span><em>*unused_args</em>, <em>**unused_kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#Unreify"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.Unreify" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.core.DoFn</span></code></a></p> |
| <p>Unreifies elements from windowed values.</p> |
| <p>Cached values are elements with window info. This unpacks the elements.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.caching.reify.Unreify.process"> |
| <code class="descname">process</code><span class="sig-paren">(</span><em>e</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#Unreify.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.Unreify.process" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.caching.reify.reify_to_cache"> |
| <code class="descclassname">apache_beam.runners.interactive.caching.reify.</code><code class="descname">reify_to_cache</code><span class="sig-paren">(</span><em>pcoll: apache_beam.pvalue.PCollection</em>, <em>cache_key: str</em>, <em>cache_manager: apache_beam.runners.interactive.cache_manager.CacheManager</em>, <em>reify_label: Optional[str] = None</em>, <em>write_cache_label: Optional[str] = None</em>, <em>is_capture: bool = False</em><span class="sig-paren">)</span> → apache_beam.pvalue.PValue<a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#reify_to_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.reify_to_cache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reifies elements into windowed values and write to cache.</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"><ul class="first last simple"> |
| <li><strong>pcoll</strong> – The PCollection to be cached.</li> |
| <li><strong>cache_key</strong> – The key of the cache.</li> |
| <li><strong>cache_manager</strong> – The cache manager to manage the cache.</li> |
| <li><strong>reify_label</strong> – (optional) A transform label for the Reify transform.</li> |
| <li><strong>write_cache_label</strong> – (optional) A transform label for the cache-writing |
| transform.</li> |
| <li><strong>is_capture</strong> – Whether the cache is capturing a record of recordable sources.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="function"> |
| <dt id="apache_beam.runners.interactive.caching.reify.unreify_from_cache"> |
| <code class="descclassname">apache_beam.runners.interactive.caching.reify.</code><code class="descname">unreify_from_cache</code><span class="sig-paren">(</span><em>pipeline: apache_beam.pipeline.Pipeline</em>, <em>cache_key: str</em>, <em>cache_manager: apache_beam.runners.interactive.cache_manager.CacheManager</em>, <em>element_type: Optional[type] = None</em>, <em>source_label: Optional[str] = None</em>, <em>unreify_label: Optional[str] = None</em><span class="sig-paren">)</span> → apache_beam.pvalue.PCollection<a class="reference internal" href="_modules/apache_beam/runners/interactive/caching/reify.html#unreify_from_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.caching.reify.unreify_from_cache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reads from cache and unreifies elements from windowed values.</p> |
| <p>pipeline: The pipeline that’s reading from the cache. |
| cache_key: The key of the cache. |
| cache_manager: The cache manager to manage the cache. |
| element_type: (optional) The element type of the PCollection’s elements. |
| source_label: (optional) A transform label for the cache-reading transform. |
| unreify_label: (optional) A transform label for the Unreify transform.</p> |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.caching.streaming_cache.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.caching.streaming_cache module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.caching.read_cache.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.caching.read_cache 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> |
