blob: 8704616f4879e815fa647c4335a877ce7a717e70 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>apache_beam.runners.dataflow.native_io package &#8212; Apache Beam documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.runners.direct package" href="apache_beam.runners.direct.html" />
<link rel="prev" title="apache_beam.runners.dataflow.internal package" href="apache_beam.runners.dataflow.internal.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="apache_beam.runners.direct.html" title="apache_beam.runners.direct package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="apache_beam.runners.dataflow.internal.html" title="apache_beam.runners.dataflow.internal package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Apache Beam documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="apache_beam.html" >apache_beam package</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="apache_beam.runners.html" >apache_beam.runners package</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="apache_beam.runners.dataflow.html" accesskey="U">apache_beam.runners.dataflow package</a> &#187;</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">apache_beam.runners.dataflow.native_io package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-apache_beam.runners.dataflow.native_io.iobase">apache_beam.runners.dataflow.native_io.iobase module</a></li>
<li><a class="reference internal" href="#module-apache_beam.runners.dataflow.native_io.streaming_create">apache_beam.runners.dataflow.native_io.streaming_create module</a></li>
<li><a class="reference internal" href="#module-apache_beam.runners.dataflow.native_io">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="apache_beam.runners.dataflow.internal.html"
title="previous chapter">apache_beam.runners.dataflow.internal package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="apache_beam.runners.direct.html"
title="next chapter">apache_beam.runners.direct package</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/apache_beam.runners.dataflow.native_io.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="apache-beam-runners-dataflow-native-io-package">
<h1>apache_beam.runners.dataflow.native_io package<a class="headerlink" href="#apache-beam-runners-dataflow-native-io-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-apache_beam.runners.dataflow.native_io.iobase">
<span id="apache-beam-runners-dataflow-native-io-iobase-module"></span><h2>apache_beam.runners.dataflow.native_io.iobase module<a class="headerlink" href="#module-apache_beam.runners.dataflow.native_io.iobase" title="Permalink to this headline"></a></h2>
<p>Dataflow native sources and sinks.</p>
<p>For internal use only; no backwards-compatibility guarantees.</p>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ConcatPosition">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">ConcatPosition</code><span class="sig-paren">(</span><em>index</em>, <em>position</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#ConcatPosition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ConcatPosition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A position that encapsulate an inner position and an index.</p>
<p>This is used to represent the position of a source that encapsulate several
other sources.</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.DynamicSplitRequest">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">DynamicSplitRequest</code><span class="sig-paren">(</span><em>progress</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#DynamicSplitRequest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.DynamicSplitRequest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Specifies how &#8216;NativeSourceReader.request_dynamic_split&#8217; should split.</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResult">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">DynamicSplitResult</code><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#DynamicSplitResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResult" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResultWithPosition">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">DynamicSplitResultWithPosition</code><span class="sig-paren">(</span><em>stop_position</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#DynamicSplitResultWithPosition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResultWithPosition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResult" title="apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResult"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.runners.dataflow.native_io.iobase.DynamicSplitResult</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSink">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">NativeSink</code><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSink" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.html#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.display.HasDisplayData</span></code></a></p>
<p>A sink implemented by Dataflow service.</p>
<p>This class is to be only inherited by sinks natively implemented by Cloud
Dataflow service, hence should not be sub-classed by users.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSink.writer">
<code class="descname">writer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSink.writer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSink.writer" title="Permalink to this definition"></a></dt>
<dd><p>Returns a SinkWriter for this source.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">NativeSinkWriter</code><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSinkWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A writer for a sink implemented by Dataflow service.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter.Write">
<code class="descname">Write</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSinkWriter.Write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter.Write" title="Permalink to this definition"></a></dt>
<dd><p>Writes a record to the sink associated with this writer.</p>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter.takes_windowed_values">
<code class="descname">takes_windowed_values</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSinkWriter.takes_windowed_values" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether this writer takes windowed values.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSource">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">NativeSource</code><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSource"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSource" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.html#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.display.HasDisplayData</span></code></a></p>
<p>A source implemented by Dataflow service.</p>
<p>This class is to be only inherited by sources natively implemented by Cloud
Dataflow service, hence should not be sub-classed by users.</p>
<p>This class is deprecated and should not be used to define new sources.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSource.reader">
<code class="descname">reader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSource.reader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSource.reader" title="Permalink to this definition"></a></dt>
<dd><p>Returns a NativeSourceReader instance associated with this source.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">NativeSourceReader</code><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSourceReader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A reader for a source implemented by Dataflow service.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.get_progress">
<code class="descname">get_progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSourceReader.get_progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.get_progress" title="Permalink to this definition"></a></dt>
<dd><p>Returns a representation of how far the reader has read.</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">Returns:</th><td class="field-body">A SourceReaderProgress object that gives the current progress of the
reader.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.request_dynamic_split">
<code class="descname">request_dynamic_split</code><span class="sig-paren">(</span><em>dynamic_split_request</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#NativeSourceReader.request_dynamic_split"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.request_dynamic_split" title="Permalink to this definition"></a></dt>
<dd><p>Attempts to split the input in two parts.</p>
<p>The two parts are named the &#8220;primary&#8221; part and the &#8220;residual&#8221; part. The
current &#8216;NativeSourceReader&#8217; keeps processing the primary part, while the
residual part will be processed elsewhere (e.g. perhaps on a different
worker).</p>
<p>The primary and residual parts, if concatenated, must represent the
same input as the current input of this &#8216;NativeSourceReader&#8217; before this
call.</p>
<p>The boundary between the primary part and the residual part is
specified in a framework-specific way using &#8216;DynamicSplitRequest&#8217; e.g.,
if the framework supports the notion of positions, it might be a
position at which the input is asked to split itself (which is not
necessarily the same position at which it <em>will</em> split itself); it
might be an approximate fraction of input, or something else.</p>
<p>This function returns a &#8216;DynamicSplitResult&#8217;, which encodes, in a
framework-specific way, the information sufficient to construct a
description of the resulting primary and residual inputs. For example, it
might, again, be a position demarcating these parts, or it might be a pair
of fully-specified input descriptions, or something else.</p>
<p>After a successful call to &#8216;request_dynamic_split()&#8217;, subsequent calls
should be interpreted relative to the new primary.</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"><strong>dynamic_split_request</strong> &#8211; A &#8216;DynamicSplitRequest&#8217; describing the split
request.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">&#8216;None&#8217; if the &#8216;DynamicSplitRequest&#8217; cannot be honored (in that
case the input represented by this &#8216;NativeSourceReader&#8217; stays the same),
or a &#8216;DynamicSplitResult&#8217; describing how the input was split into a
primary and residual part.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.returns_windowed_values">
<code class="descname">returns_windowed_values</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSourceReader.returns_windowed_values" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether this reader returns windowed values.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderPosition">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">ReaderPosition</code><span class="sig-paren">(</span><em>end=None</em>, <em>key=None</em>, <em>byte_offset=None</em>, <em>record_index=None</em>, <em>shuffle_position=None</em>, <em>concat_position=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#ReaderPosition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderPosition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A representation of position in an iteration of a &#8216;NativeSourceReader&#8217;.</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.iobase.</code><code class="descname">ReaderProgress</code><span class="sig-paren">(</span><em>position=None</em>, <em>percent_complete=None</em>, <em>remaining_time=None</em>, <em>consumed_split_points=None</em>, <em>remaining_split_points=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/iobase.html#ReaderProgress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A representation of how far a NativeSourceReader has read.</p>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.consumed_split_points">
<code class="descname">consumed_split_points</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.consumed_split_points" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.percent_complete">
<code class="descname">percent_complete</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.percent_complete" title="Permalink to this definition"></a></dt>
<dd><p>Returns progress, represented as a percentage of total work.</p>
<p>Progress range from 0.0 (beginning, nothing complete) to 1.0 (end of the
work range, entire WorkItem complete).</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">Returns:</th><td class="field-body">Progress represented as a percentage of total work.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.position">
<code class="descname">position</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.position" title="Permalink to this definition"></a></dt>
<dd><p>Returns progress, represented as a ReaderPosition object.</p>
</dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.remaining_split_points">
<code class="descname">remaining_split_points</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.remaining_split_points" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.remaining_time">
<code class="descname">remaining_time</code><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.ReaderProgress.remaining_time" title="Permalink to this definition"></a></dt>
<dd><p>Returns progress, represented as an estimated time remaining.</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-apache_beam.runners.dataflow.native_io.streaming_create">
<span id="apache-beam-runners-dataflow-native-io-streaming-create-module"></span><h2>apache_beam.runners.dataflow.native_io.streaming_create module<a class="headerlink" href="#module-apache_beam.runners.dataflow.native_io.streaming_create" title="Permalink to this headline"></a></h2>
<p>Create transform for streaming.</p>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate">
<em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.native_io.streaming_create.</code><code class="descname">StreamingCreate</code><span class="sig-paren">(</span><em>values</em>, <em>coder</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>A specialized implementation for <code class="docutils literal"><span class="pre">Create</span></code> transform in streaming mode.</p>
<p>Note: There is no unbounded source API in python to wrap the Create source,
so we map this to composite of Impulse primitive and an SDF.</p>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.DecodeAndEmitDoFn">
<em class="property">class </em><code class="descname">DecodeAndEmitDoFn</code><span class="sig-paren">(</span><em>encoded_values</em>, <em>coder</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate.DecodeAndEmitDoFn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.DecodeAndEmitDoFn" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.core.DoFn</span></code></a></p>
<p>A DoFn which stores encoded versions of elements.</p>
<p>It also stores a Coder to decode and emit those elements.
TODO: BEAM-2422 - Make this a SplittableDoFn.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.DecodeAndEmitDoFn.process">
<code class="descname">process</code><span class="sig-paren">(</span><em>unused_element</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate.DecodeAndEmitDoFn.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.DecodeAndEmitDoFn.process" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse">
<em class="property">class </em><code class="descname">Impulse</code><span class="sig-paren">(</span><em>label=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate.Impulse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>The Dataflow specific override for the impulse primitive.</p>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.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/runners/dataflow/native_io/streaming_create.html#StreamingCreate.Impulse.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.get_windowing">
<code class="descname">get_windowing</code><span class="sig-paren">(</span><em>inputs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate.Impulse.get_windowing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.get_windowing" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.infer_output_type">
<code class="descname">infer_output_type</code><span class="sig-paren">(</span><em>unused_input_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/native_io/streaming_create.html#StreamingCreate.Impulse.infer_output_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.Impulse.infer_output_type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.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/runners/dataflow/native_io/streaming_create.html#StreamingCreate.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.streaming_create.StreamingCreate.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-apache_beam.runners.dataflow.native_io">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-apache_beam.runners.dataflow.native_io" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="apache_beam.runners.direct.html" title="apache_beam.runners.direct package"
>next</a> |</li>
<li class="right" >
<a href="apache_beam.runners.dataflow.internal.html" title="apache_beam.runners.dataflow.internal package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Apache Beam documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="apache_beam.html" >apache_beam package</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="apache_beam.runners.html" >apache_beam.runners package</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="apache_beam.runners.dataflow.html" >apache_beam.runners.dataflow package</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
</div>
</body>
</html>