Google Git
Sign in
apache / beam-site / 2319bdc64590ef0568e12df9bd27c67faffa3ff7 / . / pydoc / 2.2.0 / apache_beam.runners.dataflow.native_io.iobase.html
blob: 9d1e3ac1b3b310b3e2472ef5dea4d14cf047dad0 [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.runners.dataflow.native_io.iobase module &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="apache_beam.runners.dataflow.native_io package" href="apache_beam.runners.dataflow.native_io.html"/>
<link rel="next" title="apache_beam.runners.dataflow.native_io.streaming_create module" href="apache_beam.runners.dataflow.native_io.streaming_create.html"/>
<link rel="prev" title="apache_beam.runners.dataflow.native_io package" href="apache_beam.runners.dataflow.native_io.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 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.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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.dataflow.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.dataflow.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.experimental.html">apache_beam.runners.experimental package</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</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="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>
<li><a href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a> &raquo;</li>
<li><a href="apache_beam.runners.dataflow.native_io.html">apache_beam.runners.dataflow.native_io package</a> &raquo;</li>
<li>apache_beam.runners.dataflow.native_io.iobase module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.runners.dataflow.native_io.iobase.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.runners.dataflow.native_io.iobase">
<span id="apache-beam-runners-dataflow-native-io-iobase-module"></span><h1>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></h1>
<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.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: <code class="xref py py-class docutils literal"><span class="pre">apache_beam.io.iobase.SourceBase</span></code></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>
<dl class="method">
<dt id="apache_beam.runners.dataflow.native_io.iobase.NativeSource.is_bounded">
<code class="descname">is_bounded</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.is_bounded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.native_io.iobase.NativeSource.is_bounded" title="Permalink to this definition"></a></dt>
<dd></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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>A reader for a source implemented by Dataflow service.</p>
<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>
<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>
</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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></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.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.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.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>
<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.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>
</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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>A representation of position in an iteration of a &#8216;NativeSourceReader&#8217;.</p>
<p>Initializes ReaderPosition.</p>
<p>A ReaderPosition may get instantiated for one of these position types. Only
one of these should be specified.</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>end</strong> &#8211; position is past all other positions. For example, this may be used
to represent the end position of an unbounded range.</li>
<li><strong>key</strong> &#8211; position is a string key.</li>
<li><strong>byte_offset</strong> &#8211; position is a byte offset.</li>
<li><strong>record_index</strong> &#8211; position is a record index</li>
<li><strong>shuffle_position</strong> &#8211; position is a base64 encoded shuffle position.</li>
<li><strong>concat_position</strong> &#8211; position is a &#8216;ConcatPosition&#8217;.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></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>
<p>Initializes ConcatPosition.</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>index</strong> &#8211; index of the source currently being read.</li>
<li><strong>position</strong> &#8211; inner position within the source currently being read.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></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.display.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: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>A writer for a sink implemented by Dataflow service.</p>
<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>
<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>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.runners.dataflow.native_io.streaming_create.html" class="btn btn-neutral float-right" title="apache_beam.runners.dataflow.native_io.streaming_create module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.runners.dataflow.native_io.html" class="btn btn-neutral" title="apache_beam.runners.dataflow.native_io package" 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/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>