| |
| |
| <!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.io.watermark_estimators 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 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.metrics package" href="apache_beam.metrics.html" /> |
| <link rel="prev" title="apache_beam.io.vcfio module" href="apache_beam.io.vcfio.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.internal.html">apache_beam.internal package</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.vcfio.html">apache_beam.io.vcfio module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.watermark_estimators module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></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><a href="apache_beam.io.html">apache_beam.io package</a> »</li> |
| |
| <li>apache_beam.io.watermark_estimators module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.io.watermark_estimators.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.io.watermark_estimators"> |
| <span id="apache-beam-io-watermark-estimators-module"></span><h1>apache_beam.io.watermark_estimators module<a class="headerlink" href="#module-apache_beam.io.watermark_estimators" title="Permalink to this headline">¶</a></h1> |
| <p>A collection of WatermarkEstimator implementations that SplittableDoFns |
| can use.</p> |
| <dl class="class"> |
| <dt id="apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.watermark_estimators.</code><code class="descname">MonotonicWatermarkEstimator</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#MonotonicWatermarkEstimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.WatermarkEstimator" title="apache_beam.io.iobase.WatermarkEstimator"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.iobase.WatermarkEstimator</span></code></a></p> |
| <p>A WatermarkEstimator which assumes that timestamps of all ouput records |
| are increasing monotonically.</p> |
| <p>For a new <element, restriction> pair, the initial value is None. When |
| resuming processing, the initial timestamp will be the last reported |
| watermark.</p> |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.observe_timestamp"> |
| <code class="descname">observe_timestamp</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#MonotonicWatermarkEstimator.observe_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.observe_timestamp" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.current_watermark"> |
| <code class="descname">current_watermark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#MonotonicWatermarkEstimator.current_watermark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.current_watermark" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.get_estimator_state"> |
| <code class="descname">get_estimator_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#MonotonicWatermarkEstimator.get_estimator_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.get_estimator_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.default_provider"> |
| <em class="property">static </em><code class="descname">default_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#MonotonicWatermarkEstimator.default_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.MonotonicWatermarkEstimator.default_provider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Provide a default WatermarkEstimatorProvider for |
| MonotonicWatermarkEstimator.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.watermark_estimators.</code><code class="descname">WalltimeWatermarkEstimator</code><span class="sig-paren">(</span><em>timestamp=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#WalltimeWatermarkEstimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.WatermarkEstimator" title="apache_beam.io.iobase.WatermarkEstimator"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.iobase.WatermarkEstimator</span></code></a></p> |
| <p>A WatermarkEstimator which uses processing time as the estimated watermark.</p> |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.observe_timestamp"> |
| <code class="descname">observe_timestamp</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#WalltimeWatermarkEstimator.observe_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.observe_timestamp" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.current_watermark"> |
| <code class="descname">current_watermark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#WalltimeWatermarkEstimator.current_watermark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.current_watermark" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.get_estimator_state"> |
| <code class="descname">get_estimator_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#WalltimeWatermarkEstimator.get_estimator_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.get_estimator_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.default_provider"> |
| <em class="property">static </em><code class="descname">default_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#WalltimeWatermarkEstimator.default_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.WalltimeWatermarkEstimator.default_provider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Provide a default WatermarkEstimatorProvider for |
| WalltimeWatermarkEstimator.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.watermark_estimators.</code><code class="descname">ManualWatermarkEstimator</code><span class="sig-paren">(</span><em>watermark</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.WatermarkEstimator" title="apache_beam.io.iobase.WatermarkEstimator"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.iobase.WatermarkEstimator</span></code></a></p> |
| <p>A WatermarkEstimator which is controlled manually from within a DoFn.</p> |
| <p>The DoFn must invoke set_watermark to advance the watermark.</p> |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator.observe_timestamp"> |
| <code class="descname">observe_timestamp</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator.observe_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator.observe_timestamp" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator.current_watermark"> |
| <code class="descname">current_watermark</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator.current_watermark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator.current_watermark" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator.get_estimator_state"> |
| <code class="descname">get_estimator_state</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator.get_estimator_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator.get_estimator_state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator.set_watermark"> |
| <code class="descname">set_watermark</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator.set_watermark"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator.set_watermark" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sets a timestamp before or at the timestamps of all future elements |
| produced by the associated DoFn.</p> |
| <p>This can be approximate. If records are output that violate this guarantee, |
| they will be considered late, which will affect how they will be processed. |
| See <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#watermarks-and-late-data">https://beam.apache.org/documentation/programming-guide/#watermarks-and-late-data</a> |
| for more information on late data and how to handle it.</p> |
| <p>However, this value should be as late as possible. Downstream windows may |
| not be able to close until this watermark passes their end.</p> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.io.watermark_estimators.ManualWatermarkEstimator.default_provider"> |
| <em class="property">static </em><code class="descname">default_provider</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/watermark_estimators.html#ManualWatermarkEstimator.default_provider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.watermark_estimators.ManualWatermarkEstimator.default_provider" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Provide a default WatermarkEstimatorProvider for |
| WalltimeWatermarkEstimator.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.metrics.html" class="btn btn-neutral float-right" title="apache_beam.metrics package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.io.vcfio.html" class="btn btn-neutral float-left" title="apache_beam.io.vcfio 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> |
