| |
| |
| <!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.sdf_utils module — Apache Beam 2.68.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=2388e03a"></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.trivial_runner module" href="apache_beam.runners.trivial_runner.html" /> |
| <link rel="prev" title="apache_beam.runners.runner module" href="apache_beam.runners.runner.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"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a><ul class="current"> |
| <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.pipeline_utils.html">apache_beam.runners.pipeline_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.render.html">apache_beam.runners.render 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 current"><a class="current reference internal" href="#">apache_beam.runners.sdf_utils module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.SplitResultPrimary"><code class="docutils literal notranslate"><span class="pre">SplitResultPrimary</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.SplitResultResidual"><code class="docutils literal notranslate"><span class="pre">SplitResultResidual</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker"><code class="docutils literal notranslate"><span class="pre">ThreadsafeRestrictionTracker</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView"><code class="docutils literal notranslate"><span class="pre">RestrictionTrackerView</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator"><code class="docutils literal notranslate"><span class="pre">ThreadsafeWatermarkEstimator</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider"><code class="docutils literal notranslate"><span class="pre">NoOpWatermarkEstimatorProvider</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.trivial_runner.html">apache_beam.runners.trivial_runner 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.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 active">apache_beam.runners.sdf_utils module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.runners.sdf_utils.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.sdf_utils"> |
| <span id="apache-beam-runners-sdf-utils-module"></span><h1>apache_beam.runners.sdf_utils module<a class="headerlink" href="#module-apache_beam.runners.sdf_utils" title="Link to this heading"></a></h1> |
| <p>Common utility class to help SDK harness to execute an SDF.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultPrimary"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">SplitResultPrimary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">primary_value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultPrimary" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of SplitResultPrimary(primary_value,)</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultPrimary.primary_value"> |
| <span class="sig-name descname"><span class="pre">primary_value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">WindowedValue</span></em><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultPrimary.primary_value" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultResidual"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">SplitResultResidual</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">residual_value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">current_watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deferred_timestamp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of SplitResultResidual(residual_value, current_watermark, deferred_timestamp)</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultResidual.current_watermark"> |
| <span class="sig-name descname"><span class="pre">current_watermark</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></em><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.current_watermark" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultResidual.deferred_timestamp"> |
| <span class="sig-name descname"><span class="pre">deferred_timestamp</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Duration" title="apache_beam.utils.timestamp.Duration"><span class="pre">Duration</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.deferred_timestamp" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 2</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.SplitResultResidual.residual_value"> |
| <span class="sig-name descname"><span class="pre">residual_value</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">WindowedValue</span></em><a class="headerlink" href="#apache_beam.runners.sdf_utils.SplitResultResidual.residual_value" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">ThreadsafeRestrictionTracker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">restriction_tracker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.RestrictionTracker" title="apache_beam.io.iobase.RestrictionTracker"><span class="pre">RestrictionTracker</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A thread-safe wrapper which wraps a <cite>RestrictionTracker</cite>.</p> |
| <p>This wrapper guarantees synchronization of modifying restrictions across |
| multi-thread.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_restriction"> |
| <span class="sig-name descname"><span class="pre">current_restriction</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.current_restriction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_restriction" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_claim"> |
| <span class="sig-name descname"><span class="pre">try_claim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.try_claim"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_claim" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.defer_remainder"> |
| <span class="sig-name descname"><span class="pre">defer_remainder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deferred_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.defer_remainder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.defer_remainder" title="Link to this definition"></a></dt> |
| <dd><p>Performs self-checkpoint on current processing restriction with an |
| expected resuming time.</p> |
| <p>Self-checkpoint could happen during processing elements. When executing an |
| DoFn.process(), you may want to stop processing an element and resuming |
| later if current element has been processed quit a long time or you also |
| want to have some outputs from other elements. <code class="docutils literal notranslate"><span class="pre">defer_remainder()</span></code> can be |
| called on per element if needed.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>deferred_time</strong> – A relative <code class="docutils literal notranslate"><span class="pre">Duration</span></code> that indicates the ideal time gap |
| between now and resuming, or an absolute <code class="docutils literal notranslate"><span class="pre">Timestamp</span></code> for resuming |
| execution time. If the time_delay is None, the deferred work will be |
| executed as soon as possible.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.check_done"> |
| <span class="sig-name descname"><span class="pre">check_done</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.check_done"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.check_done" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_progress"> |
| <span class="sig-name descname"><span class="pre">current_progress</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.RestrictionProgress" title="apache_beam.io.iobase.RestrictionProgress"><span class="pre">RestrictionProgress</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.current_progress"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.current_progress" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_split"> |
| <span class="sig-name descname"><span class="pre">try_split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fraction_of_remainder</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.try_split"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.try_split" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.deferred_status"> |
| <span class="sig-name descname"><span class="pre">deferred_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Tuple" title="(in Python v3.13)"><span class="pre">Tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Duration" title="apache_beam.utils.timestamp.Duration"><span class="pre">Duration</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.deferred_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.deferred_status" title="Link to this definition"></a></dt> |
| <dd><p>Returns deferred work which is produced by <code class="docutils literal notranslate"><span class="pre">defer_remainder()</span></code>.</p> |
| <p>When there is a self-checkpoint performed, the system needs to fulfill the |
| DelayedBundleApplication with deferred_work for a ProcessBundleResponse. |
| The system calls this API to get deferred_residual with watermark together |
| to help the runner to schedule a future work.</p> |
| <p>Returns: (deferred_residual, time_delay) if having any residual, else None.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.is_bounded"> |
| <span class="sig-name descname"><span class="pre">is_bounded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeRestrictionTracker.is_bounded"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker.is_bounded" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.RestrictionTrackerView"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">RestrictionTrackerView</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">threadsafe_restriction_tracker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker" title="apache_beam.runners.sdf_utils.ThreadsafeRestrictionTracker"><span class="pre">ThreadsafeRestrictionTracker</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A DoFn view of thread-safe RestrictionTracker.</p> |
| <p>The RestrictionTrackerView wraps a ThreadsafeRestrictionTracker and only |
| exposes APIs that will be called by a <code class="docutils literal notranslate"><span class="pre">DoFn.process()</span></code>. During execution |
| time, the RestrictionTrackerView will be fed into the <code class="docutils literal notranslate"><span class="pre">DoFn.process</span></code> as a |
| restriction_tracker.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.RestrictionTrackerView.current_restriction"> |
| <span class="sig-name descname"><span class="pre">current_restriction</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.current_restriction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.current_restriction" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.RestrictionTrackerView.try_claim"> |
| <span class="sig-name descname"><span class="pre">try_claim</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.try_claim"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.try_claim" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.RestrictionTrackerView.defer_remainder"> |
| <span class="sig-name descname"><span class="pre">defer_remainder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deferred_time</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.defer_remainder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.defer_remainder" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.RestrictionTrackerView.is_bounded"> |
| <span class="sig-name descname"><span class="pre">is_bounded</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#RestrictionTrackerView.is_bounded"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.RestrictionTrackerView.is_bounded" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">ThreadsafeWatermarkEstimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark_estimator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.io.iobase.html#apache_beam.io.iobase.WatermarkEstimator" title="apache_beam.io.iobase.WatermarkEstimator"><span class="pre">WatermarkEstimator</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>A threadsafe wrapper which wraps a WatermarkEstimator with locking |
| mechanism to guarantee multi-thread safety.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.get_estimator_state"> |
| <span class="sig-name descname"><span class="pre">get_estimator_state</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.get_estimator_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.get_estimator_state" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.current_watermark"> |
| <span class="sig-name descname"><span class="pre">current_watermark</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.current_watermark"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.current_watermark" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.observe_timestamp"> |
| <span class="sig-name descname"><span class="pre">observe_timestamp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.utils.timestamp.html#apache_beam.utils.timestamp.Timestamp" title="apache_beam.utils.timestamp.Timestamp"><span class="pre">Timestamp</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#ThreadsafeWatermarkEstimator.observe_timestamp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.ThreadsafeWatermarkEstimator.observe_timestamp" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.runners.sdf_utils.</span></span><span class="sig-name descname"><span class="pre">NoOpWatermarkEstimatorProvider</span></span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.WatermarkEstimatorProvider" title="apache_beam.transforms.core.WatermarkEstimatorProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">WatermarkEstimatorProvider</span></code></a></p> |
| <p>A WatermarkEstimatorProvider which creates NoOpWatermarkEstimator for the |
| framework.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.initial_estimator_state"> |
| <span class="sig-name descname"><span class="pre">initial_estimator_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">restriction</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider.initial_estimator_state"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.initial_estimator_state" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.create_watermark_estimator"> |
| <span class="sig-name descname"><span class="pre">create_watermark_estimator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">estimator_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/sdf_utils.html#NoOpWatermarkEstimatorProvider.create_watermark_estimator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.runners.sdf_utils.NoOpWatermarkEstimatorProvider.create_watermark_estimator" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.runners.runner.html" class="btn btn-neutral float-left" title="apache_beam.runners.runner module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.runners.trivial_runner.html" class="btn btn-neutral float-right" title="apache_beam.runners.trivial_runner module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© 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> |
