| |
| <!DOCTYPE html> |
| |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <title>pyspark.streaming.kinesis — PySpark 3.5.5 documentation</title> |
| |
| <link href="../../../_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> |
| <link href="../../../_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet"> |
| |
| |
| <link rel="stylesheet" |
| href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> |
| <link rel="preload" as="font" type="font/woff2" crossorigin |
| href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/styles/pydata-sphinx-theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../../_static/css/pyspark.css" /> |
| |
| <link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"> |
| |
| <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script src="../../../_static/jquery.js"></script> |
| <script src="../../../_static/underscore.js"></script> |
| <script src="../../../_static/doctools.js"></script> |
| <script src="../../../_static/language_data.js"></script> |
| <script src="../../../_static/clipboard.min.js"></script> |
| <script src="../../../_static/copybutton.js"></script> |
| <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> |
| <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script> |
| <link rel="canonical" href="https://spark.apache.org/docs/latest/api/python/_modules/pyspark/streaming/kinesis.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="docsearch:language" content="None"> |
| |
| |
| <!-- Google Analytics --> |
| |
| </head> |
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80"> |
| |
| <div class="container-fluid" id="banner"></div> |
| |
| |
| <nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="container-xl"> |
| |
| <div id="navbar-start"> |
| |
| |
| |
| <a class="navbar-brand" href="../../../index.html"> |
| <img src="../../../_static/spark-logo-reverse.png" class="logo" alt="logo"> |
| </a> |
| |
| |
| |
| </div> |
| |
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| |
| <div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse"> |
| <div id="navbar-center" class="mr-auto"> |
| |
| <div class="navbar-center-item"> |
| <ul id="navbar-main-elements" class="navbar-nav"> |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../index.html"> |
| Overview |
| </a> |
| </li> |
| |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../getting_started/index.html"> |
| Getting Started |
| </a> |
| </li> |
| |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../user_guide/index.html"> |
| User Guides |
| </a> |
| </li> |
| |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../reference/index.html"> |
| API Reference |
| </a> |
| </li> |
| |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../development/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="toctree-l1 nav-item"> |
| <a class="reference internal nav-link" href="../../../migration_guide/index.html"> |
| Migration Guides |
| </a> |
| </li> |
| |
| |
| </ul> |
| </div> |
| |
| </div> |
| |
| <div id="navbar-end"> |
| |
| <div class="navbar-end-item"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <div id="version-button" class="dropdown"> |
| <button type="button" class="btn btn-secondary btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown"> |
| 3.5.5 |
| <span class="caret"></span> |
| </button> |
| <div id="version_switcher" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| |
| <script type="text/javascript"> |
| // Function to construct the target URL from the JSON components |
| function buildURL(entry) { |
| var template = "https://spark.apache.org/docs/{version}/api/python/index.html"; // supplied by jinja |
| template = template.replace("{version}", entry.version); |
| return template; |
| } |
| |
| // Function to check if corresponding page path exists in other version of docs |
| // and, if so, go there instead of the homepage of the other docs version |
| function checkPageExistsAndRedirect(event) { |
| const currentFilePath = "_modules/pyspark/streaming/kinesis.html", |
| otherDocsHomepage = event.target.getAttribute("href"); |
| let tryUrl = `${otherDocsHomepage}${currentFilePath}`; |
| $.ajax({ |
| type: 'HEAD', |
| url: tryUrl, |
| // if the page exists, go there |
| success: function() { |
| location.href = tryUrl; |
| } |
| }).fail(function() { |
| location.href = otherDocsHomepage; |
| }); |
| return false; |
| } |
| |
| // Function to populate the version switcher |
| (function () { |
| // get JSON config |
| $.getJSON("https://spark.apache.org/static/versions.json", function(data, textStatus, jqXHR) { |
| // create the nodes first (before AJAX calls) to ensure the order is |
| // correct (for now, links will go to doc version homepage) |
| $.each(data, function(index, entry) { |
| // if no custom name specified (e.g., "latest"), use version string |
| if (!("name" in entry)) { |
| entry.name = entry.version; |
| } |
| // construct the appropriate URL, and add it to the dropdown |
| entry.url = buildURL(entry); |
| const node = document.createElement("a"); |
| node.setAttribute("class", "list-group-item list-group-item-action py-1"); |
| node.setAttribute("href", `${entry.url}`); |
| node.textContent = `${entry.name}`; |
| node.onclick = checkPageExistsAndRedirect; |
| $("#version_switcher").append(node); |
| }); |
| }); |
| })(); |
| </script> |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <div class="container-xl"> |
| <div class="row"> |
| |
| |
| <!-- Only show if we have sidebars configured, else just a small margin --> |
| <div class="col-12 col-md-3 bd-sidebar"> |
| <div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get"> |
| <i class="icon fas fa-search"></i> |
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > |
| </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> |
| <div class="bd-toc-item active"> |
| |
| </div> |
| </nav> |
| </div> |
| <div class="sidebar-end-items"> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main"> |
| |
| <div> |
| |
| <h1>Source code for pyspark.streaming.kinesis</h1><div class="highlight"><pre> |
| <span></span><span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span> |
| <span class="c1"># contributor license agreements. See the NOTICE file distributed with</span> |
| <span class="c1"># this work for additional information regarding copyright ownership.</span> |
| <span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span> |
| <span class="c1"># (the "License"); you may not use this file except in compliance with</span> |
| <span class="c1"># the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> |
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="c1"># See the License for the specific language governing permissions and</span> |
| <span class="c1"># limitations under the License.</span> |
| <span class="c1">#</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">overload</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Union</span> |
| |
| <span class="kn">from</span><span class="w"> </span><span class="nn">pyspark.serializers</span><span class="w"> </span><span class="kn">import</span> <span class="n">NoOpSerializer</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">pyspark.storagelevel</span><span class="w"> </span><span class="kn">import</span> <span class="n">StorageLevel</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">pyspark.streaming</span><span class="w"> </span><span class="kn">import</span> <span class="n">DStream</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">pyspark.streaming.context</span><span class="w"> </span><span class="kn">import</span> <span class="n">StreamingContext</span> |
| <span class="kn">from</span><span class="w"> </span><span class="nn">pyspark.util</span><span class="w"> </span><span class="kn">import</span> <span class="n">_print_missing_jar</span> |
| |
| |
| <span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"KinesisUtils"</span><span class="p">,</span> <span class="s2">"InitialPositionInStream"</span><span class="p">,</span> <span class="s2">"MetricsLevel"</span><span class="p">,</span> <span class="s2">"utf8_decoder"</span><span class="p">]</span> |
| |
| |
| <span class="k">class</span><span class="w"> </span><span class="nc">InitialPositionInStream</span><span class="p">:</span> |
| <span class="n">LATEST</span><span class="p">,</span> <span class="n">TRIM_HORIZON</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span><span class="w"> </span><span class="nc">MetricsLevel</span><span class="p">:</span> |
| <span class="n">DETAILED</span><span class="p">,</span> <span class="n">SUMMARY</span><span class="p">,</span> <span class="n">NONE</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span> |
| |
| |
| <span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">"T"</span><span class="p">)</span> |
| |
| |
| <span class="k">def</span><span class="w"> </span><span class="nf">utf8_decoder</span><span class="p">(</span><span class="n">s</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">])</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| <span class="w"> </span><span class="sd">"""Decode the unicode as UTF-8"""</span> |
| <span class="k">if</span> <span class="n">s</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s2">"utf-8"</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span><span class="w"> </span><span class="nc">KinesisUtils</span><span class="p">:</span> |
| <span class="nd">@staticmethod</span> |
| <span class="nd">@overload</span> |
| <span class="k">def</span><span class="w"> </span><span class="nf">createStream</span><span class="p">(</span> |
| <span class="n">ssc</span><span class="p">:</span> <span class="n">StreamingContext</span><span class="p">,</span> |
| <span class="n">kinesisAppName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">streamName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">endpointUrl</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">regionName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">initialPositionInStream</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">checkpointInterval</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> |
| <span class="n">metricsLevel</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">MetricsLevel</span><span class="o">.</span><span class="n">DETAILED</span><span class="p">,</span> |
| <span class="n">storageLevel</span><span class="p">:</span> <span class="n">StorageLevel</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">awsAccessKeyId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">awsSecretKey</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="o">*</span><span class="p">,</span> |
| <span class="n">stsAssumeRoleArn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">stsSessionName</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">stsExternalId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="s2">"DStream[Optional[str]]"</span><span class="p">:</span> |
| <span class="o">...</span> |
| |
| <span class="nd">@staticmethod</span> |
| <span class="nd">@overload</span> |
| <span class="k">def</span><span class="w"> </span><span class="nf">createStream</span><span class="p">(</span> |
| <span class="n">ssc</span><span class="p">:</span> <span class="n">StreamingContext</span><span class="p">,</span> |
| <span class="n">kinesisAppName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">streamName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">endpointUrl</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">regionName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">initialPositionInStream</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">checkpointInterval</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> |
| <span class="n">metricsLevel</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">MetricsLevel</span><span class="o">.</span><span class="n">DETAILED</span><span class="p">,</span> |
| <span class="n">storageLevel</span><span class="p">:</span> <span class="n">StorageLevel</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">awsAccessKeyId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">awsSecretKey</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">decoder</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]],</span> <span class="n">T</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">stsAssumeRoleArn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">stsSessionName</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="n">stsExternalId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="s2">"DStream[T]"</span><span class="p">:</span> |
| <span class="o">...</span> |
| |
| <div class="viewcode-block" id="KinesisUtils.createStream"><a class="viewcode-back" href="../../../reference/api/pyspark.streaming.kinesis.KinesisUtils.createStream.html#pyspark.streaming.kinesis.KinesisUtils.createStream">[docs]</a> <span class="nd">@staticmethod</span> |
| <span class="k">def</span><span class="w"> </span><span class="nf">createStream</span><span class="p">(</span> |
| <span class="n">ssc</span><span class="p">:</span> <span class="n">StreamingContext</span><span class="p">,</span> |
| <span class="n">kinesisAppName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">streamName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">endpointUrl</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">regionName</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">initialPositionInStream</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> |
| <span class="n">checkpointInterval</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> |
| <span class="n">metricsLevel</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">MetricsLevel</span><span class="o">.</span><span class="n">DETAILED</span><span class="p">,</span> |
| <span class="n">storageLevel</span><span class="p">:</span> <span class="n">StorageLevel</span> <span class="o">=</span> <span class="n">StorageLevel</span><span class="o">.</span><span class="n">MEMORY_AND_DISK_2</span><span class="p">,</span> |
| <span class="n">awsAccessKeyId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">awsSecretKey</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">decoder</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span> |
| <span class="n">Callable</span><span class="p">[[</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]],</span> <span class="n">T</span><span class="p">],</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Optional</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]],</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> |
| <span class="p">]</span> <span class="o">=</span> <span class="n">utf8_decoder</span><span class="p">,</span> |
| <span class="n">stsAssumeRoleArn</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">stsSessionName</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="n">stsExternalId</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="s2">"DStream[Union[T, Optional[str]]]"</span><span class="p">,</span> <span class="s2">"DStream[T]"</span><span class="p">]:</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Create an input stream that pulls messages from a Kinesis stream. This uses the</span> |
| <span class="sd"> Kinesis Client Library (KCL) to pull messages from Kinesis.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> ssc : :class:`StreamingContext`</span> |
| <span class="sd"> StreamingContext object</span> |
| <span class="sd"> kinesisAppName : str</span> |
| <span class="sd"> Kinesis application name used by the Kinesis Client Library (KCL) to</span> |
| <span class="sd"> update DynamoDB</span> |
| <span class="sd"> streamName : str</span> |
| <span class="sd"> Kinesis stream name</span> |
| <span class="sd"> endpointUrl : str</span> |
| <span class="sd"> Url of Kinesis service (e.g., https://kinesis.us-east-1.amazonaws.com)</span> |
| <span class="sd"> regionName : str</span> |
| <span class="sd"> Name of region used by the Kinesis Client Library (KCL) to update</span> |
| <span class="sd"> DynamoDB (lease coordination and checkpointing) and CloudWatch (metrics)</span> |
| <span class="sd"> initialPositionInStream : int</span> |
| <span class="sd"> In the absence of Kinesis checkpoint info, this is the</span> |
| <span class="sd"> worker's initial starting position in the stream. The</span> |
| <span class="sd"> values are either the beginning of the stream per Kinesis'</span> |
| <span class="sd"> limit of 24 hours (InitialPositionInStream.TRIM_HORIZON) or</span> |
| <span class="sd"> the tip of the stream (InitialPositionInStream.LATEST).</span> |
| <span class="sd"> checkpointInterval : int</span> |
| <span class="sd"> Checkpoint interval(in seconds) for Kinesis checkpointing. See the Kinesis</span> |
| <span class="sd"> Spark Streaming documentation for more details on the different</span> |
| <span class="sd"> types of checkpoints.</span> |
| <span class="sd"> metricsLevel : int</span> |
| <span class="sd"> Level of CloudWatch PutMetrics.</span> |
| <span class="sd"> Can be set to either DETAILED, SUMMARY, or NONE. (default is DETAILED)</span> |
| <span class="sd"> storageLevel : :class:`pyspark.StorageLevel`, optional</span> |
| <span class="sd"> Storage level to use for storing the received objects (default is</span> |
| <span class="sd"> StorageLevel.MEMORY_AND_DISK_2)</span> |
| <span class="sd"> awsAccessKeyId : str, optional</span> |
| <span class="sd"> AWS AccessKeyId (default is None. If None, will use</span> |
| <span class="sd"> DefaultAWSCredentialsProviderChain)</span> |
| <span class="sd"> awsSecretKey : str, optional</span> |
| <span class="sd"> AWS SecretKey (default is None. If None, will use</span> |
| <span class="sd"> DefaultAWSCredentialsProviderChain)</span> |
| <span class="sd"> decoder : function, optional</span> |
| <span class="sd"> A function used to decode value (default is utf8_decoder)</span> |
| <span class="sd"> stsAssumeRoleArn : str, optional</span> |
| <span class="sd"> ARN of IAM role to assume when using STS sessions to read from</span> |
| <span class="sd"> the Kinesis stream (default is None).</span> |
| <span class="sd"> stsSessionName : str, optional</span> |
| <span class="sd"> Name to uniquely identify STS sessions used to read from Kinesis</span> |
| <span class="sd"> stream, if STS is being used (default is None).</span> |
| <span class="sd"> stsExternalId : str, optional</span> |
| <span class="sd"> External ID that can be used to validate against the assumed IAM</span> |
| <span class="sd"> role's trust policy, if STS is being used (default is None).</span> |
| |
| <span class="sd"> Returns</span> |
| <span class="sd"> -------</span> |
| <span class="sd"> A DStream object</span> |
| |
| <span class="sd"> Notes</span> |
| <span class="sd"> -----</span> |
| <span class="sd"> The given AWS credentials will get saved in DStream checkpoints if checkpointing</span> |
| <span class="sd"> is enabled. Make sure that your checkpoint directory is secure.</span> |
| <span class="sd"> """</span> |
| <span class="n">jlevel</span> <span class="o">=</span> <span class="n">ssc</span><span class="o">.</span><span class="n">_sc</span><span class="o">.</span><span class="n">_getJavaStorageLevel</span><span class="p">(</span><span class="n">storageLevel</span><span class="p">)</span> |
| <span class="n">jduration</span> <span class="o">=</span> <span class="n">ssc</span><span class="o">.</span><span class="n">_jduration</span><span class="p">(</span><span class="n">checkpointInterval</span><span class="p">)</span> |
| |
| <span class="n">jvm</span> <span class="o">=</span> <span class="n">ssc</span><span class="o">.</span><span class="n">_jvm</span> |
| <span class="k">assert</span> <span class="n">jvm</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">helper</span> <span class="o">=</span> <span class="n">jvm</span><span class="o">.</span><span class="n">org</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">spark</span><span class="o">.</span><span class="n">streaming</span><span class="o">.</span><span class="n">kinesis</span><span class="o">.</span><span class="n">KinesisUtilsPythonHelper</span><span class="p">()</span> |
| <span class="k">except</span> <span class="ne">TypeError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"'JavaPackage' object is not callable"</span><span class="p">:</span> |
| <span class="n">_print_missing_jar</span><span class="p">(</span> |
| <span class="s2">"Streaming's Kinesis"</span><span class="p">,</span> |
| <span class="s2">"streaming-kinesis-asl"</span><span class="p">,</span> |
| <span class="s2">"streaming-kinesis-asl-assembly"</span><span class="p">,</span> |
| <span class="n">ssc</span><span class="o">.</span><span class="n">sparkContext</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="k">raise</span> |
| <span class="n">jstream</span> <span class="o">=</span> <span class="n">helper</span><span class="o">.</span><span class="n">createStream</span><span class="p">(</span> |
| <span class="n">ssc</span><span class="o">.</span><span class="n">_jssc</span><span class="p">,</span> |
| <span class="n">kinesisAppName</span><span class="p">,</span> |
| <span class="n">streamName</span><span class="p">,</span> |
| <span class="n">endpointUrl</span><span class="p">,</span> |
| <span class="n">regionName</span><span class="p">,</span> |
| <span class="n">initialPositionInStream</span><span class="p">,</span> |
| <span class="n">jduration</span><span class="p">,</span> |
| <span class="n">metricsLevel</span><span class="p">,</span> |
| <span class="n">jlevel</span><span class="p">,</span> |
| <span class="n">awsAccessKeyId</span><span class="p">,</span> |
| <span class="n">awsSecretKey</span><span class="p">,</span> |
| <span class="n">stsAssumeRoleArn</span><span class="p">,</span> |
| <span class="n">stsSessionName</span><span class="p">,</span> |
| <span class="n">stsExternalId</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="n">stream</span><span class="p">:</span> <span class="n">DStream</span> <span class="o">=</span> <span class="n">DStream</span><span class="p">(</span><span class="n">jstream</span><span class="p">,</span> <span class="n">ssc</span><span class="p">,</span> <span class="n">NoOpSerializer</span><span class="p">())</span> |
| <span class="k">return</span> <span class="n">stream</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">v</span><span class="p">:</span> <span class="n">decoder</span><span class="p">(</span><span class="n">v</span><span class="p">))</span></div> |
| </pre></div> |
| |
| </div> |
| |
| |
| <!-- Previous / next buttons --> |
| <div class='prev-next-area'> |
| </div> |
| |
| </main> |
| |
| |
| </div> |
| </div> |
| |
| <script src="../../../_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script> |
| <footer class="footer mt-5 mt-md-0"> |
| <div class="container"> |
| |
| <div class="footer-item"> |
| <p class="copyright"> |
| © Copyright .<br> |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| <p class="sphinx-version"> |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br> |
| </p> |
| </div> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
