| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:35 PST 2020 --> |
| <title>org.apache.beam.sdk.io.kinesis (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.beam.sdk.io.kinesis (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kafka/serialization/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/mongodb/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kinesis/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.beam.sdk.io.kinesis</h1> |
| <div class="docSummary"> |
| <div class="block">Transforms for reading and writing from Amazon Kinesis.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/AWSClientsProvider.html" title="interface in org.apache.beam.sdk.io.kinesis">AWSClientsProvider</a></td> |
| <td class="colLast"> |
| <div class="block">Provides instances of AWS clients.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisPartitioner.html" title="interface in org.apache.beam.sdk.io.kinesis">KinesisPartitioner</a></td> |
| <td class="colLast"> |
| <div class="block">Kinesis interface for custom partitioner.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicy.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">Implement this interface to define a custom watermark calculation heuristic.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Implement this interface to create a <code>WatermarkPolicy</code>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisIO.html" title="class in org.apache.beam.sdk.io.kinesis">KinesisIO</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>s for reading from and writing to <a |
| href="https://aws.amazon.com/kinesis/">Kinesis</a> streams.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisIO.Read.html" title="class in org.apache.beam.sdk.io.kinesis">KinesisIO.Read</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisIO.html#read--"><code>KinesisIO.read()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisIO.Write.html" title="class in org.apache.beam.sdk.io.kinesis">KinesisIO.Write</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisIO.html#write--"><code>KinesisIO.write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/KinesisRecord.html" title="class in org.apache.beam.sdk.io.kinesis">KinesisRecord</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="https://static.javadoc.io/com.amazonaws/aws-java-sdk-kinesis/1.11.519/com/amazonaws/services/kinesis/clientlibrary.types.UserRecord.html?is-external=true" title="class or interface in com.amazonaws.services.kinesis"><code>UserRecord</code></a> enhanced with utility methods.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkParameters.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkParameters</a></td> |
| <td class="colLast"> |
| <div class="block"><code>WatermarkParameters</code> contains the parameters used for watermark computation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">ArrivalTimeWatermarkPolicy uses <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.CustomWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis"><code>WatermarkPolicyFactory.CustomWatermarkPolicy</code></a> for watermark computation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.CustomWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.CustomWatermarkPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">CustomWatermarkPolicy uses parameters defined in <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkParameters.html" title="class in org.apache.beam.sdk.io.kinesis"><code>WatermarkParameters</code></a> to compute |
| watermarks.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ProcessingTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.ProcessingTimeWatermarkPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">Watermark policy where the processing time is used as the event time.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.beam.sdk.io.kinesis Description">Package org.apache.beam.sdk.io.kinesis Description</h2> |
| <div class="block">Transforms for reading and writing from Amazon Kinesis.</div> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kafka/serialization/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/mongodb/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kinesis/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
