| <!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:30 PST 2020 --> |
| <title>WatermarkPolicyFactory (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="WatermarkPolicyFactory (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":17,"i2":17,"i3":17,"i4":17}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/kinesis/WatermarkPolicy.html" title="interface in org.apache.beam.sdk.io.kinesis"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" target="_top">Frames</a></li> |
| <li><a href="WatermarkPolicyFactory.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.kinesis</div> |
| <h2 title="Interface WatermarkPolicyFactory" class="title">Interface WatermarkPolicyFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.io.Serializable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">WatermarkPolicyFactory</span> |
| extends java.io.Serializable</pre> |
| <div class="block">Implement this interface to create a <code>WatermarkPolicy</code>. Used by the <code>ShardRecordsIterator</code> to create a watermark policy for every shard.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.CustomWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.CustomWatermarkPolicy</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ProcessingTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory.ProcessingTimeWatermarkPolicy</a></span></code> |
| <div class="block">Watermark policy where the processing time is used as the event time.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicy.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html#createWatermarkPolicy--">createWatermarkPolicy</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html#withArrivalTimePolicy--">withArrivalTimePolicy</a></span>()</code> |
| <div class="block">Returns an ArrivalTimeWatermarkPolicy.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html#withArrivalTimePolicy-org.joda.time.Duration-">withArrivalTimePolicy</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> watermarkIdleDurationThreshold)</code> |
| <div class="block">Returns an ArrivalTimeWatermarkPolicy.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html#withCustomWatermarkPolicy-org.apache.beam.sdk.io.kinesis.WatermarkParameters-">withCustomWatermarkPolicy</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkParameters.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkParameters</a> watermarkParameters)</code> |
| <div class="block">Returns an custom WatermarkPolicyFactory.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html#withProcessingTimePolicy--">withProcessingTimePolicy</a></span>()</code> |
| <div class="block">Returns an ProcessingTimeWatermarkPolicy.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createWatermarkPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWatermarkPolicy</h4> |
| <pre><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicy.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicy</a> createWatermarkPolicy()</pre> |
| </li> |
| </ul> |
| <a name="withArrivalTimePolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArrivalTimePolicy</h4> |
| <pre>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a> withArrivalTimePolicy()</pre> |
| <div class="block">Returns an ArrivalTimeWatermarkPolicy.</div> |
| </li> |
| </ul> |
| <a name="withArrivalTimePolicy-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArrivalTimePolicy</h4> |
| <pre>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a> withArrivalTimePolicy(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> watermarkIdleDurationThreshold)</pre> |
| <div class="block">Returns an ArrivalTimeWatermarkPolicy.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watermarkIdleDurationThreshold</code> - watermark idle duration threshold.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withProcessingTimePolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withProcessingTimePolicy</h4> |
| <pre>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a> withProcessingTimePolicy()</pre> |
| <div class="block">Returns an ProcessingTimeWatermarkPolicy.</div> |
| </li> |
| </ul> |
| <a name="withCustomWatermarkPolicy-org.apache.beam.sdk.io.kinesis.WatermarkParameters-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>withCustomWatermarkPolicy</h4> |
| <pre>static <a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" title="interface in org.apache.beam.sdk.io.kinesis">WatermarkPolicyFactory</a> withCustomWatermarkPolicy(<a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkParameters.html" title="class in org.apache.beam.sdk.io.kinesis">WatermarkParameters</a> watermarkParameters)</pre> |
| <div class="block">Returns an custom WatermarkPolicyFactory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>watermarkParameters</code> - Watermark parameters (timestamp extractor, watermark lag) for the |
| policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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/kinesis/WatermarkPolicy.html" title="interface in org.apache.beam.sdk.io.kinesis"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.ArrivalTimeWatermarkPolicy.html" title="class in org.apache.beam.sdk.io.kinesis"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/kinesis/WatermarkPolicyFactory.html" target="_top">Frames</a></li> |
| <li><a href="WatermarkPolicyFactory.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |