| |
| |
| <!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.transforms.trigger 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.transforms.userstate module" href="apache_beam.transforms.userstate.html" /> |
| <link rel="prev" title="apache_beam.transforms.timeutil module" href="apache_beam.transforms.timeutil.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"><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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.transforms.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.async_dofn.html">apache_beam.transforms.async_dofn module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.enrichment.html">apache_beam.transforms.enrichment module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.error_handling.html">apache_beam.transforms.error_handling module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_transform_provider.html">apache_beam.transforms.external_transform_provider module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.managed.html">apache_beam.transforms.managed module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.resources.html">apache_beam.transforms.resources module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.trigger module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AccumulationMode"><code class="docutils literal notranslate"><span class="pre">AccumulationMode</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn"><code class="docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.DefaultTrigger"><code class="docutils literal notranslate"><span class="pre">DefaultTrigger</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterWatermark"><code class="docutils literal notranslate"><span class="pre">AfterWatermark</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterProcessingTime"><code class="docutils literal notranslate"><span class="pre">AfterProcessingTime</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterCount"><code class="docutils literal notranslate"><span class="pre">AfterCount</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.Repeatedly"><code class="docutils literal notranslate"><span class="pre">Repeatedly</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterAny"><code class="docutils literal notranslate"><span class="pre">AfterAny</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterAll"><code class="docutils literal notranslate"><span class="pre">AfterAll</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.AfterEach"><code class="docutils literal notranslate"><span class="pre">AfterEach</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.trigger.OrFinally"><code class="docutils literal notranslate"><span class="pre">OrFinally</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </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.transforms.html">apache_beam.transforms package</a></li> |
| <li class="breadcrumb-item active">apache_beam.transforms.trigger module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.transforms.trigger.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.transforms.trigger"> |
| <span id="apache-beam-transforms-trigger-module"></span><h1>apache_beam.transforms.trigger module<a class="headerlink" href="#module-apache_beam.transforms.trigger" title="Link to this heading"></a></h1> |
| <p>Support for Apache Beam triggers.</p> |
| <p>Triggers control when in processing time windows get emitted.</p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AccumulationMode"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AccumulationMode</span></span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AccumulationMode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AccumulationMode" 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>Controls what to do with data when a trigger fires multiple times.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AccumulationMode.DISCARDING"> |
| <span class="sig-name descname"><span class="pre">DISCARDING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AccumulationMode.DISCARDING" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AccumulationMode.ACCUMULATING"> |
| <span class="sig-name descname"><span class="pre">ACCUMULATING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AccumulationMode.ACCUMULATING" 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.transforms.trigger.TriggerFn"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">TriggerFn</span></span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn" 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 TriggerFn determines when window (panes) are emitted.</p> |
| <p>See <a class="reference external" href="https://beam.apache.org/documentation/programming-guide/#triggers">https://beam.apache.org/documentation/programming-guide/#triggers</a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.on_element"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.on_element" title="Link to this definition"></a></dt> |
| <dd><p>Called when a new element arrives in a window.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>element</strong> – the element being added</p></li> |
| <li><p><strong>window</strong> – the window to which the element is being added</p></li> |
| <li><p><strong>context</strong> – a context (e.g. a TriggerContext instance) for managing state |
| and setting timers</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.on_merge"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.on_merge" title="Link to this definition"></a></dt> |
| <dd><p>Called when multiple windows are merged.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>to_be_merged</strong> – the set of windows to be merged</p></li> |
| <li><p><strong>merge_result</strong> – the window into which the windows are being merged</p></li> |
| <li><p><strong>context</strong> – a context (e.g. a TriggerContext instance) for managing state |
| and setting timers</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.should_fire"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.should_fire" title="Link to this definition"></a></dt> |
| <dd><p>Whether this trigger should cause the window to fire.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>time_domain</strong> – WATERMARK for event-time timers and REAL_TIME for |
| processing-time timers.</p></li> |
| <li><p><strong>timestamp</strong> – for time_domain WATERMARK, it represents the |
| watermark: (a lower bound on) the watermark of the system |
| and for time_domain REAL_TIME, it represents the |
| trigger: timestamp of the processing-time timer.</p></li> |
| <li><p><strong>window</strong> – the window whose trigger is being considered</p></li> |
| <li><p><strong>context</strong> – a context (e.g. a TriggerContext instance) for managing state |
| and setting timers</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>whether this trigger should cause a firing</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.has_ontime_pane"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.has_ontime_pane" title="Link to this definition"></a></dt> |
| <dd><p>Whether this trigger creates an empty pane even if there are no elements.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>True if this trigger guarantees that there will always be an ON_TIME pane |
| even if there are no elements in that pane.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.on_fire"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.on_fire" title="Link to this definition"></a></dt> |
| <dd><p>Called when a trigger actually fires.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>watermark</strong> – (a lower bound on) the watermark of the system</p></li> |
| <li><p><strong>window</strong> – the window whose trigger is being fired</p></li> |
| <li><p><strong>context</strong> – a context (e.g. a TriggerContext instance) for managing state |
| and setting timers</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>whether this trigger is finished</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.reset"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.reset" title="Link to this definition"></a></dt> |
| <dd><p>Clear any state and timers used by this TriggerFn.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_windowing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.Windowing" title="apache_beam.transforms.core.Windowing"><span class="pre">Windowing</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataLossReason</span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>Returns whether or not this trigger could cause data loss.</p> |
| <p>A trigger can cause data loss in the following scenarios:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><p>The trigger has a chance to finish. For instance, AfterWatermark() |
| without a late trigger would cause all late data to be lost. This |
| scenario is only accounted for if the windowing strategy allows |
| late data. Otherwise, the trigger is not responsible for the data |
| loss.</p></li> |
| </ul> |
| </div></blockquote> |
| <p>Note that this only returns the potential for loss. It does not mean that |
| there will be data loss. It also only accounts for loss related to the |
| trigger, not other potential causes.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>windowing</strong> – The Windowing that this trigger belongs to. It does not need |
| to be the top-level trigger.</p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><dl class="simple"> |
| <dt>The DataLossReason. If there is no potential loss,</dt><dd><p>DataLossReason.NO_POTENTIAL_LOSS is returned. Otherwise, all the |
| potential reasons are returned as a single value.</p> |
| </dd> |
| </dl> |
| </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.TriggerFn.to_runner_api"> |
| <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#TriggerFn.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.TriggerFn.to_runner_api" 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.transforms.trigger.DefaultTrigger"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">DefaultTrigger</span></span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <p>Semantically Repeatedly(AfterWatermark()), but more optimized.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.may_lose_data" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.DefaultTrigger.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#DefaultTrigger.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.DefaultTrigger.has_ontime_pane" 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.transforms.trigger.AfterWatermark"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterWatermark</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">early</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">late</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/transforms/trigger.html#AfterWatermark"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <p>Fire exactly once when the watermark passes the end of the window.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>early</strong> – if not None, a speculative trigger to repeatedly evaluate before |
| the watermark passes the end of the window</p></li> |
| <li><p><strong>late</strong> – if not None, a speculative trigger to repeatedly evaluate after |
| the watermark passes the end of the window</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.LATE_TAG"> |
| <span class="sig-name descname"><span class="pre">LATE_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CombiningValueStateTag(is_late,</span> <span class="pre">CallableWrapperCombineFn(<built-in</span> <span class="pre">function</span> <span class="pre">any>))</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.LATE_TAG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.is_late"> |
| <span class="sig-name descname"><span class="pre">is_late</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.is_late"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.is_late" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>May cause data loss if lateness allowed and no late trigger set.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterWatermark.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterWatermark.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterWatermark.has_ontime_pane" 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.transforms.trigger.AfterProcessingTime"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterProcessingTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">delay</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <p>Fire exactly once after a specified delay from processing time.</p> |
| <p>Initialize a processing time trigger with a delay in seconds.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.STATE_TAG"> |
| <span class="sig-name descname"><span class="pre">STATE_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">SetStateTag(has_timer)</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.STATE_TAG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>AfterProcessingTime may finish.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterProcessingTime.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterProcessingTime.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterProcessingTime.has_ontime_pane" 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.transforms.trigger.AfterCount"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterCount</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">count</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <p>Fire when there are at least count elements in this window pane.</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.COUNT_TAG"> |
| <span class="sig-name descname"><span class="pre">COUNT_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CombiningValueStateTag(count,</span> <span class="pre"><apache_beam.transforms.combiners.CountCombineFn</span> <span class="pre">object>)</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.COUNT_TAG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>AfterCount may finish.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unused_context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterCount.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterCount.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterCount.has_ontime_pane" 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.transforms.trigger.Repeatedly"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">Repeatedly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">underlying</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <p>Repeatedly invoke the given trigger, never finishing.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>Repeatedly will run in a loop and pick up whatever is left at GC.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.Repeatedly.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#Repeatedly.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.Repeatedly.has_ontime_pane" 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.transforms.trigger.AfterAny"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterAny</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">triggers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterAny"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterAny" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_ParallelTriggerFn</span></code></p> |
| <p>Fires when any subtrigger fires.</p> |
| <p>Also finishes when any subtrigger finishes.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterAny.combine_op"> |
| <span class="sig-name descname"><span class="pre">combine_op</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.transforms.trigger.AfterAny.combine_op" title="Link to this definition"></a></dt> |
| <dd><p>Return True if bool(x) is True for any x in the iterable.</p> |
| <p>If the iterable is empty, return False.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterAll"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterAll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">triggers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterAll"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterAll" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_ParallelTriggerFn</span></code></p> |
| <p>Fires when all subtriggers have fired.</p> |
| <p>Also finishes when all subtriggers have finished.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterAll.combine_op"> |
| <span class="sig-name descname"><span class="pre">combine_op</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.transforms.trigger.AfterAll.combine_op" title="Link to this definition"></a></dt> |
| <dd><p>Return True if bool(x) is True for all values x in the iterable.</p> |
| <p>If the iterable is empty, return True.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">AfterEach</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">triggers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.TriggerFn" title="apache_beam.transforms.trigger.TriggerFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">TriggerFn</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.INDEX_TAG"> |
| <span class="sig-name descname"><span class="pre">INDEX_TAG</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">CombiningValueStateTag(index,</span> <span class="pre">CallableWrapperCombineFn(<function</span> <span class="pre">AfterEach.<lambda>>))</span></em><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.INDEX_TAG" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.on_element"> |
| <span class="sig-name descname"><span class="pre">on_element</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">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.on_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.on_element" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.on_merge"> |
| <span class="sig-name descname"><span class="pre">on_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to_be_merged</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_result</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.on_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.on_merge" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.should_fire"> |
| <span class="sig-name descname"><span class="pre">should_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_domain</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.should_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.should_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.on_fire"> |
| <span class="sig-name descname"><span class="pre">on_fire</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">watermark</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.on_fire"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.on_fire" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.reset"> |
| <span class="sig-name descname"><span class="pre">reset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">window</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.reset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.reset" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.may_lose_data"> |
| <span class="sig-name descname"><span class="pre">may_lose_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">windowing</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.may_lose_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.may_lose_data" title="Link to this definition"></a></dt> |
| <dd><p>If all sub-triggers may finish, this may finish.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.to_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.AfterEach.has_ontime_pane"> |
| <span class="sig-name descname"><span class="pre">has_ontime_pane</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#AfterEach.has_ontime_pane"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.AfterEach.has_ontime_pane" 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.transforms.trigger.OrFinally"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.trigger.</span></span><span class="sig-name descname"><span class="pre">OrFinally</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">triggers</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#OrFinally"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.OrFinally" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.trigger.AfterAny" title="apache_beam.transforms.trigger.AfterAny"><code class="xref py py-class docutils literal notranslate"><span class="pre">AfterAny</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.OrFinally.from_runner_api"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#OrFinally.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.OrFinally.from_runner_api" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.trigger.OrFinally.to_runner_api"> |
| <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/trigger.html#OrFinally.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.trigger.OrFinally.to_runner_api" 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.transforms.timeutil.html" class="btn btn-neutral float-left" title="apache_beam.transforms.timeutil module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.transforms.userstate.html" class="btn btn-neutral float-right" title="apache_beam.transforms.userstate 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> |
