Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / pydoc / 2.15.0 / _modules / apache_beam / io / external / generate_sequence.html
blob: 5f4b4d0a9e1331d6e3ed53ea6cbbcfae026bc286 [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.io.external.generate_sequence &mdash; Apache Beam documentation</title>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="../../../../genindex.html"/>
<link rel="search" title="Search" href="../../../../search.html"/>
<link rel="top" title="Apache Beam documentation" href="../../../../index.html"/>
<link rel="up" title="Module code" href="../../../index.html"/>
<script src="../../../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../../../../index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.internal.html">apache_beam.internal package</a></li>
<li class="toctree-l1"><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.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.tools.html">apache_beam.tools package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../apache_beam.version.html">apache_beam.version module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" 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="../../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.io.external.generate_sequence</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.io.external.generate_sequence</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="k">import</span> <span class="n">ExternalTransform</span>
<span class="kn">from</span> <span class="nn">apache_beam</span> <span class="k">import</span> <span class="n">pvalue</span>
<span class="kn">from</span> <span class="nn">apache_beam.coders</span> <span class="k">import</span> <span class="n">VarIntCoder</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api.external_transforms_pb2</span> <span class="k">import</span> <span class="n">ConfigValue</span>
<span class="kn">from</span> <span class="nn">apache_beam.portability.api.external_transforms_pb2</span> <span class="k">import</span> <span class="n">ExternalConfigurationPayload</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms</span> <span class="k">import</span> <span class="n">ptransform</span>
<div class="viewcode-block" id="GenerateSequence"><a class="viewcode-back" href="../../../../apache_beam.io.external.generate_sequence.html#apache_beam.io.external.generate_sequence.GenerateSequence">[docs]</a><span class="k">class</span> <span class="nc">GenerateSequence</span><span class="p">(</span><span class="n">ptransform</span><span class="o">.</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> An external PTransform which provides a bounded or unbounded stream of</span>
<span class="sd"> integers.</span>
<span class="sd"> Note: To use this transform, you need to start the Java expansion service.</span>
<span class="sd"> Please refer to the portability documentation on how to do that. The</span>
<span class="sd"> expansion service address has to be provided when instantiating this</span>
<span class="sd"> transform. During pipeline translation this transform will be replaced by</span>
<span class="sd"> the Java SDK&#39;s GenerateSequence.</span>
<span class="sd"> If you start Flink&#39;s job server, the expansion service will be started on</span>
<span class="sd"> port 8097. This is also the configured default for this transform. For a</span>
<span class="sd"> different address, please set the expansion_service parameter.</span>
<span class="sd"> For more information see:</span>
<span class="sd"> - https://beam.apache.org/documentation/runners/flink/</span>
<span class="sd"> - https://beam.apache.org/roadmap/portability/</span>
<span class="sd"> Note: Runners need to support translating Read operations in order to use</span>
<span class="sd"> this source. At the moment only the Flink Runner supports this.</span>
<span class="sd"> Experimental; no backwards compatibility guarantees.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">elements_per_period</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">max_read_time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">expansion_service</span><span class="o">=</span><span class="s1">&#39;localhost:8097&#39;</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GenerateSequence</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_urn</span> <span class="o">=</span> <span class="s1">&#39;beam:external:java:generate_sequence:v1&#39;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span> <span class="o">=</span> <span class="n">start</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span> <span class="o">=</span> <span class="n">stop</span>
<span class="bp">self</span><span class="o">.</span><span class="n">elements_per_period</span> <span class="o">=</span> <span class="n">elements_per_period</span>
<span class="bp">self</span><span class="o">.</span><span class="n">max_read_time</span> <span class="o">=</span> <span class="n">max_read_time</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span> <span class="o">=</span> <span class="n">expansion_service</span>
<div class="viewcode-block" id="GenerateSequence.expand"><a class="viewcode-back" href="../../../../apache_beam.io.external.generate_sequence.html#apache_beam.io.external.generate_sequence.GenerateSequence.expand">[docs]</a> <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pbegin</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pbegin</span><span class="p">,</span> <span class="n">pvalue</span><span class="o">.</span><span class="n">PBegin</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;GenerateSequence must be a root transform&quot;</span><span class="p">)</span>
<span class="n">coder</span> <span class="o">=</span> <span class="n">VarIntCoder</span><span class="p">()</span>
<span class="n">coder_urn</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;beam:coder:varint:v1&#39;</span><span class="p">]</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;start&#39;</span><span class="p">:</span>
<span class="n">ConfigValue</span><span class="p">(</span>
<span class="n">coder_urn</span><span class="o">=</span><span class="n">coder_urn</span><span class="p">,</span>
<span class="n">payload</span><span class="o">=</span><span class="n">coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">))</span>
<span class="p">}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">:</span>
<span class="n">args</span><span class="p">[</span><span class="s1">&#39;stop&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ConfigValue</span><span class="p">(</span>
<span class="n">coder_urn</span><span class="o">=</span><span class="n">coder_urn</span><span class="p">,</span>
<span class="n">payload</span><span class="o">=</span><span class="n">coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">elements_per_period</span><span class="p">:</span>
<span class="n">args</span><span class="p">[</span><span class="s1">&#39;elements_per_period&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ConfigValue</span><span class="p">(</span>
<span class="n">coder_urn</span><span class="o">=</span><span class="n">coder_urn</span><span class="p">,</span>
<span class="n">payload</span><span class="o">=</span><span class="n">coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">elements_per_period</span><span class="p">))</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_read_time</span><span class="p">:</span>
<span class="n">args</span><span class="p">[</span><span class="s1">&#39;max_read_time&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">ConfigValue</span><span class="p">(</span>
<span class="n">coder_urn</span><span class="o">=</span><span class="n">coder_urn</span><span class="p">,</span>
<span class="n">payload</span><span class="o">=</span><span class="n">coder</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">max_read_time</span><span class="p">))</span>
<span class="n">payload</span> <span class="o">=</span> <span class="n">ExternalConfigurationPayload</span><span class="p">(</span><span class="n">configuration</span><span class="o">=</span><span class="n">args</span><span class="p">)</span>
<span class="k">return</span> <span class="n">pbegin</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span>
<span class="n">ExternalTransform</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_urn</span><span class="p">,</span>
<span class="n">payload</span><span class="o">.</span><span class="n">SerializeToString</span><span class="p">(),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span><span class="p">))</span></div></div>
</pre></div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<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/snide/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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../../',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>