blob: 634afb7d4b949c7b914aebe680f6f2f2ef36b4df [file] [log] [blame]
<!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.interactive.caching package &mdash; Apache Beam 2.67.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=959b4fbe"></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.interactive.caching.cacheable module" href="apache_beam.runners.interactive.caching.cacheable.html" />
<link rel="prev" title="apache_beam.runners.interactive package" href="apache_beam.runners.interactive.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"><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.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.interactive.html">apache_beam.runners.interactive package</a></li>
<li class="breadcrumb-item active">apache_beam.runners.interactive.caching package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.interactive.caching.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.interactive.caching">
<span id="apache-beam-runners-interactive-caching-package"></span><h1>apache_beam.runners.interactive.caching package<a class="headerlink" href="#module-apache_beam.runners.interactive.caching" title="Link to this heading"></a></h1>
<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.interactive.caching.cacheable.html">apache_beam.runners.interactive.caching.cacheable module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable"><code class="docutils literal notranslate"><span class="pre">Cacheable</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.var"><code class="docutils literal notranslate"><span class="pre">Cacheable.var</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.version"><code class="docutils literal notranslate"><span class="pre">Cacheable.version</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.producer_version"><code class="docutils literal notranslate"><span class="pre">Cacheable.producer_version</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.pcoll"><code class="docutils literal notranslate"><span class="pre">Cacheable.pcoll</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.from_pcoll"><code class="docutils literal notranslate"><span class="pre">Cacheable.from_pcoll()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.Cacheable.to_key"><code class="docutils literal notranslate"><span class="pre">Cacheable.to_key()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey"><code class="docutils literal notranslate"><span class="pre">CacheKey</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.var"><code class="docutils literal notranslate"><span class="pre">CacheKey.var</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.version"><code class="docutils literal notranslate"><span class="pre">CacheKey.version</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.producer_version"><code class="docutils literal notranslate"><span class="pre">CacheKey.producer_version</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.pipeline_id"><code class="docutils literal notranslate"><span class="pre">CacheKey.pipeline_id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.from_str"><code class="docutils literal notranslate"><span class="pre">CacheKey.from_str()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.from_pcoll"><code class="docutils literal notranslate"><span class="pre">CacheKey.from_pcoll()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.cacheable.html#apache_beam.runners.interactive.caching.cacheable.CacheKey.to_str"><code class="docutils literal notranslate"><span class="pre">CacheKey.to_str()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.caching.expression_cache.html">apache_beam.runners.interactive.caching.expression_cache module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.expression_cache.html#apache_beam.runners.interactive.caching.expression_cache.ExpressionCache"><code class="docutils literal notranslate"><span class="pre">ExpressionCache</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.expression_cache.html#apache_beam.runners.interactive.caching.expression_cache.ExpressionCache.replace_with_cached"><code class="docutils literal notranslate"><span class="pre">ExpressionCache.replace_with_cached()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.caching.read_cache.html">apache_beam.runners.interactive.caching.read_cache module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.read_cache.html#apache_beam.runners.interactive.caching.read_cache.ReadCache"><code class="docutils literal notranslate"><span class="pre">ReadCache</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.read_cache.html#apache_beam.runners.interactive.caching.read_cache.ReadCache.read_cache"><code class="docutils literal notranslate"><span class="pre">ReadCache.read_cache()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html">apache_beam.runners.interactive.caching.reify module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.Reify"><code class="docutils literal notranslate"><span class="pre">Reify</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.Reify.process"><code class="docutils literal notranslate"><span class="pre">Reify.process()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.Unreify"><code class="docutils literal notranslate"><span class="pre">Unreify</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.Unreify.process"><code class="docutils literal notranslate"><span class="pre">Unreify.process()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.reify_to_cache"><code class="docutils literal notranslate"><span class="pre">reify_to_cache()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.reify.html#apache_beam.runners.interactive.caching.reify.unreify_from_cache"><code class="docutils literal notranslate"><span class="pre">unreify_from_cache()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html">apache_beam.runners.interactive.caching.streaming_cache module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSink"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSink</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSink.path"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSink.path</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSink.size_in_bytes"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSink.size_in_bytes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSink.expand"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSink.expand()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSource"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSource</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCacheSource.read"><code class="docutils literal notranslate"><span class="pre">StreamingCacheSource.read()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache"><code class="docutils literal notranslate"><span class="pre">StreamingCache</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.size"><code class="docutils literal notranslate"><span class="pre">StreamingCache.size()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.capture_size"><code class="docutils literal notranslate"><span class="pre">StreamingCache.capture_size</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.capture_paths"><code class="docutils literal notranslate"><span class="pre">StreamingCache.capture_paths</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.capture_keys"><code class="docutils literal notranslate"><span class="pre">StreamingCache.capture_keys</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.exists"><code class="docutils literal notranslate"><span class="pre">StreamingCache.exists()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.read"><code class="docutils literal notranslate"><span class="pre">StreamingCache.read()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.read_multiple"><code class="docutils literal notranslate"><span class="pre">StreamingCache.read_multiple()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.write"><code class="docutils literal notranslate"><span class="pre">StreamingCache.write()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.clear"><code class="docutils literal notranslate"><span class="pre">StreamingCache.clear()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.source"><code class="docutils literal notranslate"><span class="pre">StreamingCache.source()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.sink"><code class="docutils literal notranslate"><span class="pre">StreamingCache.sink()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.save_pcoder"><code class="docutils literal notranslate"><span class="pre">StreamingCache.save_pcoder()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.load_pcoder"><code class="docutils literal notranslate"><span class="pre">StreamingCache.load_pcoder()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.cleanup"><code class="docutils literal notranslate"><span class="pre">StreamingCache.cleanup()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.Reader"><code class="docutils literal notranslate"><span class="pre">StreamingCache.Reader</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.caching.streaming_cache.html#apache_beam.runners.interactive.caching.streaming_cache.StreamingCache.Reader.read"><code class="docutils literal notranslate"><span class="pre">StreamingCache.Reader.read()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.interactive.caching.write_cache.html">apache_beam.runners.interactive.caching.write_cache module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.interactive.caching.write_cache.html#apache_beam.runners.interactive.caching.write_cache.WriteCache"><code class="docutils literal notranslate"><span class="pre">WriteCache</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.caching.write_cache.html#apache_beam.runners.interactive.caching.write_cache.WriteCache.write_cache"><code class="docutils literal notranslate"><span class="pre">WriteCache.write_cache()</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.interactive.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="apache_beam.runners.interactive.caching.cacheable.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.caching.cacheable module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>