blob: 7057ea0307757a7aaf4cea724f1f67906a3ad7c7 [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 &#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" />
</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="nav-item nav-item-0"><a href="index.html">Apache Beam documentation</a> &#187;</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/modules.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">
<h1>apache_beam<a class="headerlink" href="#apache-beam" title="Permalink to this headline">ΒΆ</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.html">apache_beam package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.coder_impl">apache_beam.coders.coder_impl module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.coders">apache_beam.coders.coders module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.coders_test_common">apache_beam.coders.coders_test_common module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.observable">apache_beam.coders.observable module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.proto2_coder_test_messages_pb2">apache_beam.coders.proto2_coder_test_messages_pb2 module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.slow_stream">apache_beam.coders.slow_stream module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#apache-beam-coders-stream-module">apache_beam.coders.stream module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders.typecoders">apache_beam.coders.typecoders module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.coders.html#module-apache_beam.coders">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.internal.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.internal.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.internal.html#module-apache_beam.internal.pickler">apache_beam.internal.pickler module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.internal.html#module-apache_beam.internal.util">apache_beam.internal.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.internal.html#module-apache_beam.internal">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.avroio">apache_beam.io.avroio module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.concat_source">apache_beam.io.concat_source module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.filebasedsink">apache_beam.io.filebasedsink module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.filebasedsource">apache_beam.io.filebasedsource module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.filesystem">apache_beam.io.filesystem module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.filesystems">apache_beam.io.filesystems module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.iobase">apache_beam.io.iobase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.localfilesystem">apache_beam.io.localfilesystem module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.range_trackers">apache_beam.io.range_trackers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.source_test_utils">apache_beam.io.source_test_utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.textio">apache_beam.io.textio module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io.tfrecordio">apache_beam.io.tfrecordio module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.html#module-apache_beam.io">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#module-apache_beam.metrics.cells">apache_beam.metrics.cells module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#module-apache_beam.metrics.execution">apache_beam.metrics.execution module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#module-apache_beam.metrics.metric">apache_beam.metrics.metric module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#module-apache_beam.metrics.metricbase">apache_beam.metrics.metricbase module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.metrics.html#module-apache_beam.metrics">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.options.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.options.html#module-apache_beam.options.pipeline_options">apache_beam.options.pipeline_options module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.options.html#module-apache_beam.options.pipeline_options_validator">apache_beam.options.pipeline_options_validator module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.options.html#module-apache_beam.options.value_provider">apache_beam.options.value_provider module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.options.html#module-apache_beam.options">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.portability.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.portability.html#module-apache_beam.portability">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#module-apache_beam.runners.common">apache_beam.runners.common module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#module-apache_beam.runners.pipeline_context">apache_beam.runners.pipeline_context module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#module-apache_beam.runners.runner">apache_beam.runners.runner module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.html#module-apache_beam.runners">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing.pipeline_verifiers">apache_beam.testing.pipeline_verifiers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing.test_pipeline">apache_beam.testing.test_pipeline module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing.test_stream">apache_beam.testing.test_stream module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing.test_utils">apache_beam.testing.test_utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing.util">apache_beam.testing.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.testing.html#module-apache_beam.testing">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.combiners">apache_beam.transforms.combiners module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.core">apache_beam.transforms.core module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.cy_combiners">apache_beam.transforms.cy_combiners module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.display">apache_beam.transforms.display module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.ptransform">apache_beam.transforms.ptransform module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.sideinputs">apache_beam.transforms.sideinputs module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.timeutil">apache_beam.transforms.timeutil module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.trigger">apache_beam.transforms.trigger module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.util">apache_beam.transforms.util module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms.window">apache_beam.transforms.window module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.transforms.html#module-apache_beam.transforms">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints.decorators">apache_beam.typehints.decorators module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints.opcodes">apache_beam.typehints.opcodes module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints.trivial_inference">apache_beam.typehints.trivial_inference module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints.typecheck">apache_beam.typehints.typecheck module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints.typehints">apache_beam.typehints.typehints module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.typehints.html#module-apache_beam.typehints">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.annotations">apache_beam.utils.annotations module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.counters">apache_beam.utils.counters module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.plugin">apache_beam.utils.plugin module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.processes">apache_beam.utils.processes module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.profiler">apache_beam.utils.profiler module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.proto_utils">apache_beam.utils.proto_utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.retry">apache_beam.utils.retry module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.timestamp">apache_beam.utils.timestamp module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.urns">apache_beam.utils.urns module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils.windowed_value">apache_beam.utils.windowed_value module</a></li>
<li class="toctree-l4"><a class="reference internal" href="apache_beam.utils.html#module-apache_beam.utils">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#module-apache_beam.error">apache_beam.error module</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#module-apache_beam.pipeline">apache_beam.pipeline module</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#module-apache_beam.pvalue">apache_beam.pvalue module</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#module-apache_beam.version">apache_beam.version module</a></li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.html#module-apache_beam">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.html#status">Status</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.html#typical-usage">Typical usage</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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="nav-item nav-item-0"><a href="index.html">Apache Beam documentation</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>