blob: 95cdc92c7b233acd34884cbee91731934641e1c2 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.transforms.periodicsequence module &mdash; Apache Beam 2.37.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.transforms.ptransform module" href="apache_beam.transforms.ptransform.html" />
<link rel="prev" title="apache_beam.transforms.fully_qualified_named_transform module" href="apache_beam.transforms.fully_qualified_named_transform.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 class="version">
2.37.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners 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 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.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.environments.html">apache_beam.transforms.environments 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.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></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>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.transforms.html">apache_beam.transforms package</a> &raquo;</li>
<li>apache_beam.transforms.periodicsequence module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.transforms.periodicsequence.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.transforms.periodicsequence">
<span id="apache-beam-transforms-periodicsequence-module"></span><h1>apache_beam.transforms.periodicsequence module<a class="headerlink" href="#module-apache_beam.transforms.periodicsequence" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.periodicsequence.</code><code class="descname">ImpulseSeqGenRestrictionProvider</code><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenRestrictionProvider"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.RestrictionProvider" title="apache_beam.transforms.core.RestrictionProvider"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.core.RestrictionProvider</span></code></a></p>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.initial_restriction">
<code class="descname">initial_restriction</code><span class="sig-paren">(</span><em>element</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenRestrictionProvider.initial_restriction"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.initial_restriction" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.create_tracker">
<code class="descname">create_tracker</code><span class="sig-paren">(</span><em>restriction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenRestrictionProvider.create_tracker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.create_tracker" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.restriction_size">
<code class="descname">restriction_size</code><span class="sig-paren">(</span><em>unused_element</em>, <em>restriction</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenRestrictionProvider.restriction_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenRestrictionProvider.restriction_size" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenDoFn">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.periodicsequence.</code><code class="descname">ImpulseSeqGenDoFn</code><span class="sig-paren">(</span><em>*unused_args</em>, <em>**unused_kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenDoFn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenDoFn" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.core.DoFn</span></code></a></p>
<p>ImpulseSeqGenDoFn fn receives tuple elements with three parts:</p>
<ul class="simple">
<li>first_timestamp = first timestamp to output element for.</li>
<li>last_timestamp = last timestamp/time to output element for.</li>
<li>fire_interval = how often to fire an element.</li>
</ul>
<p>For each input element received, ImpulseSeqGenDoFn fn will start
generating output elements in following pattern:</p>
<ul class="simple">
<li>if element timestamp is less than current runtime then output element.</li>
<li>if element timestamp is greater than current runtime, wait until next
element timestamp.</li>
</ul>
<p>ImpulseSeqGenDoFn can’t guarantee that each element is output at exact time.
ImpulseSeqGenDoFn guarantees that elements would not be output prior to
given runtime timestamp.</p>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.ImpulseSeqGenDoFn.process">
<code class="descname">process</code><span class="sig-paren">(</span><em>element</em>, <em>restriction_tracker=RestrictionParam(ImpulseSeqGenRestrictionProvider)</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#ImpulseSeqGenDoFn.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.ImpulseSeqGenDoFn.process" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>element</strong> – (start_timestamp, end_timestamp, interval)</li>
<li><strong>restriction_tracker</strong></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">yields elements at processing real-time intervals with value of
target output timestamp for the element.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.periodicsequence.PeriodicSequence">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.periodicsequence.</code><code class="descname">PeriodicSequence</code><span class="sig-paren">(</span><em>label=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#PeriodicSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.PeriodicSequence" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>PeriodicSequence transform receives tuple elements with three parts:</p>
<ul class="simple">
<li>first_timestamp = first timestamp to output element for.</li>
<li>last_timestamp = last timestamp/time to output element for.</li>
<li>fire_interval = how often to fire an element.</li>
</ul>
<p>For each input element received, PeriodicSequence transform will start
generating output elements in following pattern:</p>
<ul class="simple">
<li>if element timestamp is less than current runtime then output element.</li>
<li>if element timestamp is greater than current runtime, wait until next
element timestamp.</li>
</ul>
<p>PeriodicSequence can’t guarantee that each element is output at exact time.
PeriodicSequence guarantees that elements would not be output prior to given
runtime timestamp.</p>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.PeriodicSequence.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pcoll</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#PeriodicSequence.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.PeriodicSequence.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.transforms.periodicsequence.PeriodicImpulse">
<em class="property">class </em><code class="descclassname">apache_beam.transforms.periodicsequence.</code><code class="descname">PeriodicImpulse</code><span class="sig-paren">(</span><em>start_timestamp=Timestamp(1646098142.664386)</em>, <em>stop_timestamp=Timestamp(9223372036854.775000)</em>, <em>fire_interval=360.0</em>, <em>apply_windowing=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#PeriodicImpulse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.PeriodicImpulse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>PeriodicImpulse transform generates an infinite sequence of elements with
given runtime interval.</p>
<p>PeriodicImpulse transform behaves same as <a class="reference external" href="mailto:{&#37;&#52;&#48;link">{<span>&#64;</span>link</a> PeriodicSequence} transform,
but can be used as first transform in pipeline.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>start_timestamp</strong> – Timestamp for first element.</li>
<li><strong>stop_timestamp</strong> – Timestamp after which no elements will be output.</li>
<li><strong>fire_interval</strong> – Interval at which to output elements.</li>
<li><strong>apply_windowing</strong> – Whether each element should be assigned to
individual window. If false, all elements will reside in global window.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="apache_beam.transforms.periodicsequence.PeriodicImpulse.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pbegin</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/periodicsequence.html#PeriodicImpulse.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.periodicsequence.PeriodicImpulse.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.transforms.ptransform.html" class="btn btn-neutral float-right" title="apache_beam.transforms.ptransform module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.transforms.fully_qualified_named_transform.html" class="btn btn-neutral float-left" title="apache_beam.transforms.fully_qualified_named_transform module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>