blob: 95fc23cd318efda411b2db0ec860d547f3a2add9 [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.kinesis module &mdash; Apache Beam 2.36.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.io.localfilesystem module" href="apache_beam.io.localfilesystem.html" />
<link rel="prev" title="apache_beam.io.kafka module" href="apache_beam.io.kafka.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Apache Beam
</a>
<div class="version">
2.36.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.kinesis module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>
<li>apache_beam.io.kinesis module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.kinesis.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.io.kinesis">
<span id="apache-beam-io-kinesis-module"></span><h1>apache_beam.io.kinesis module<a class="headerlink" href="#module-apache_beam.io.kinesis" title="Permalink to this headline"></a></h1>
<p>PTransforms for supporting Kinesis streaming in Python pipelines.</p>
<p>These transforms are currently supported by Beam Flink and Spark portable
runners.</p>
<p><strong>Setup</strong></p>
<p>Transforms provided in this module are cross-language transforms
implemented in the Beam Java SDK. During the pipeline construction, Python SDK
will connect to a Java expansion service to expand these transforms.
To facilitate this, a small amount of setup is needed before using these
transforms in a Beam Python pipeline.</p>
<p>There are several ways to setup cross-language Kinesis transforms.</p>
<ul class="simple">
<li>Option 1: use the default expansion service</li>
<li>Option 2: specify a custom expansion service</li>
</ul>
<p>See below for details regarding each of these options.</p>
<p><em>Option 1: Use the default expansion service</em></p>
<p>This is the recommended and easiest setup option for using Python Kinesis
transforms. This option is only available for Beam 2.25.0 and later.</p>
<p>This option requires following pre-requisites before running the Beam
pipeline.</p>
<ul class="simple">
<li>Install Java runtime in the computer from where the pipeline is constructed
and make sure that ‘java’ command is available.</li>
</ul>
<p>In this option, Python SDK will either download (for released Beam version) or
build (when running from a Beam Git clone) a expansion service jar and use
that to expand transforms. Currently Kinesis transforms use the
‘beam-sdks-java-io-kinesis-expansion-service’ jar for this purpose.</p>
<p><em>Option 2: specify a custom expansion service</em></p>
<p>In this option, you startup your own expansion service and provide that as
a parameter when using the transforms provided in this module.</p>
<p>This option requires following pre-requisites before running the Beam
pipeline.</p>
<ul class="simple">
<li>Startup your own expansion service.</li>
<li>Update your pipeline to provide the expansion service address when
initiating Kinesis transforms provided in this module.</li>
</ul>
<p>Flink Users can use the built-in Expansion Service of the Flink Runner’s
Job Server. If you start Flink’s Job Server, the expansion service will be
started on port 8097. For a different address, please set the
expansion_service parameter.</p>
<p><strong>More information</strong></p>
<p>For more information regarding cross-language transforms see:
- <a class="reference external" href="https://beam.apache.org/roadmap/portability/">https://beam.apache.org/roadmap/portability/</a></p>
<p>For more information specific to Flink runner see:
- <a class="reference external" href="https://beam.apache.org/documentation/runners/flink/">https://beam.apache.org/documentation/runners/flink/</a></p>
<dl class="class">
<dt id="apache_beam.io.kinesis.WriteToKinesis">
<em class="property">class </em><code class="descclassname">apache_beam.io.kinesis.</code><code class="descname">WriteToKinesis</code><span class="sig-paren">(</span><em>stream_name</em>, <em>aws_access_key</em>, <em>aws_secret_key</em>, <em>region</em>, <em>partition_key</em>, <em>service_endpoint=None</em>, <em>verify_certificate=None</em>, <em>producer_properties=None</em>, <em>expansion_service=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#WriteToKinesis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.WriteToKinesis" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.external.html#apache_beam.transforms.external.ExternalTransform" title="apache_beam.transforms.external.ExternalTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.ExternalTransform</span></code></a></p>
<p>An external PTransform which writes byte array stream to Amazon Kinesis.</p>
<p>Experimental; no backwards compatibility guarantees.</p>
<p>Initializes a write operation to Kinesis.</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>stream_name</strong> – Kinesis stream name.</li>
<li><strong>aws_access_key</strong> – Kinesis access key.</li>
<li><strong>aws_secret_key</strong> – Kinesis access key secret.</li>
<li><strong>region</strong> – AWS region. Example: ‘us-east-1’.</li>
<li><strong>service_endpoint</strong> – Kinesis service endpoint</li>
<li><strong>verify_certificate</strong> – Enable or disable certificate verification.
Never set to False on production. True by default.</li>
<li><strong>partition_key</strong> – Specify default partition key.</li>
<li><strong>producer_properties</strong> – Specify the configuration properties for Kinesis
Producer Library (KPL) as dictionary.
Example: {‘CollectionMaxCount’: ‘1000’, ‘ConnectTimeout’: ‘10000’}</li>
<li><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.WriteToKinesis.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:kinesis_write:v1'</em><a class="headerlink" href="#apache_beam.io.kinesis.WriteToKinesis.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.kinesis.ReadDataFromKinesis">
<em class="property">class </em><code class="descclassname">apache_beam.io.kinesis.</code><code class="descname">ReadDataFromKinesis</code><span class="sig-paren">(</span><em>stream_name</em>, <em>aws_access_key</em>, <em>aws_secret_key</em>, <em>region</em>, <em>service_endpoint=None</em>, <em>verify_certificate=None</em>, <em>max_num_records=None</em>, <em>max_read_time=None</em>, <em>initial_position_in_stream=None</em>, <em>initial_timestamp_in_stream=None</em>, <em>request_records_limit=None</em>, <em>up_to_date_threshold=None</em>, <em>max_capacity_per_shard=None</em>, <em>watermark_policy=None</em>, <em>watermark_idle_duration_threshold=None</em>, <em>rate_limit=None</em>, <em>expansion_service=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#ReadDataFromKinesis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.ReadDataFromKinesis" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.external.html#apache_beam.transforms.external.ExternalTransform" title="apache_beam.transforms.external.ExternalTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.ExternalTransform</span></code></a></p>
<p>An external PTransform which reads byte array stream from Amazon Kinesis.</p>
<p>Experimental; no backwards compatibility guarantees.</p>
<p>Initializes a read operation from Kinesis.</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>stream_name</strong> – Kinesis stream name.</li>
<li><strong>aws_access_key</strong> – Kinesis access key.</li>
<li><strong>aws_secret_key</strong> – Kinesis access key secret.</li>
<li><strong>region</strong> – AWS region. Example: ‘us-east-1’.</li>
<li><strong>service_endpoint</strong> – Kinesis service endpoint</li>
<li><strong>verify_certificate</strong> – Enable or disable certificate verification.
Never set to False on production. True by default.</li>
<li><strong>max_num_records</strong> – Specifies to read at most a given number of records.
Must be greater than 0.</li>
<li><strong>max_read_time</strong> – Specifies to read records during x milliseconds.</li>
<li><strong>initial_timestamp_in_stream</strong> – Specify reading beginning at the given
timestamp in milliseconds. Must be in the past.</li>
<li><strong>initial_position_in_stream</strong> – Specify reading from some initial
position in stream. Possible values:
LATEST - Start after the most recent data record (fetch new data).
TRIM_HORIZON - Start from the oldest available data record.
AT_TIMESTAMP - Start from the record at or after the specified
server-side timestamp.</li>
<li><strong>request_records_limit</strong> – Specifies the maximum number of records in
GetRecordsResult returned by GetRecords call which is limited by 10K
records. If should be adjusted according to average size of data record
to prevent shard overloading. More at:
docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html</li>
<li><strong>up_to_date_threshold</strong> – Specifies how late in milliseconds records
consumed by this source can be to still be considered on time. Defaults
to zero.</li>
<li><strong>max_capacity_per_shard</strong> – Specifies the maximum number of messages per
one shard. Defaults to 10’000.</li>
<li><strong>watermark_policy</strong> – Specifies the watermark policy. Possible values:
PROCESSING_TYPE, ARRIVAL_TIME. Defaults to ARRIVAL_TIME.</li>
<li><strong>watermark_idle_duration_threshold</strong> – Use only when watermark policy is
ARRIVAL_TIME. Denotes the duration for which the watermark can be idle.
Passed in milliseconds.</li>
<li><strong>rate_limit</strong> – Sets fixed rate policy for given milliseconds value. By
default there is no rate limit.</li>
<li><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.ReadDataFromKinesis.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:kinesis_read:v1'</em><a class="headerlink" href="#apache_beam.io.kinesis.ReadDataFromKinesis.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.kinesis.InitialPositionInStream">
<em class="property">class </em><code class="descclassname">apache_beam.io.kinesis.</code><code class="descname">InitialPositionInStream</code><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#InitialPositionInStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.InitialPositionInStream" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.InitialPositionInStream.LATEST">
<code class="descname">LATEST</code><em class="property"> = 'LATEST'</em><a class="headerlink" href="#apache_beam.io.kinesis.InitialPositionInStream.LATEST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.InitialPositionInStream.TRIM_HORIZON">
<code class="descname">TRIM_HORIZON</code><em class="property"> = 'TRIM_HORIZON'</em><a class="headerlink" href="#apache_beam.io.kinesis.InitialPositionInStream.TRIM_HORIZON" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.InitialPositionInStream.AT_TIMESTAMP">
<code class="descname">AT_TIMESTAMP</code><em class="property"> = 'AT_TIMESTAMP'</em><a class="headerlink" href="#apache_beam.io.kinesis.InitialPositionInStream.AT_TIMESTAMP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.io.kinesis.InitialPositionInStream.validate_param">
<em class="property">static </em><code class="descname">validate_param</code><span class="sig-paren">(</span><em>param</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#InitialPositionInStream.validate_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.InitialPositionInStream.validate_param" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.kinesis.WatermarkPolicy">
<em class="property">class </em><code class="descclassname">apache_beam.io.kinesis.</code><code class="descname">WatermarkPolicy</code><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#WatermarkPolicy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.WatermarkPolicy" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.WatermarkPolicy.PROCESSING_TYPE">
<code class="descname">PROCESSING_TYPE</code><em class="property"> = 'PROCESSING_TYPE'</em><a class="headerlink" href="#apache_beam.io.kinesis.WatermarkPolicy.PROCESSING_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.kinesis.WatermarkPolicy.ARRIVAL_TIME">
<code class="descname">ARRIVAL_TIME</code><em class="property"> = 'ARRIVAL_TIME'</em><a class="headerlink" href="#apache_beam.io.kinesis.WatermarkPolicy.ARRIVAL_TIME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.io.kinesis.WatermarkPolicy.validate_param">
<em class="property">static </em><code class="descname">validate_param</code><span class="sig-paren">(</span><em>param</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/kinesis.html#WatermarkPolicy.validate_param"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.kinesis.WatermarkPolicy.validate_param" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.localfilesystem.html" class="btn btn-neutral float-right" title="apache_beam.io.localfilesystem module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.kafka.html" class="btn btn-neutral float-left" title="apache_beam.io.kafka module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>