| <!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_161-google-v7) on Thu Oct 18 16:14:34 PDT 2018 --> |
| <title>WindowFnTestUtils (Apache Beam 2.8.0-SNAPSHOT)</title> |
| <meta name="date" content="2018-10-18"> |
| <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="WindowFnTestUtils (Apache Beam 2.8.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/testing/ValidatesRunner.html" title="interface in org.apache.beam.sdk.testing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/testing/WindowFnTestUtils.html" target="_top">Frames</a></li> |
| <li><a href="WindowFnTestUtils.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.testing</div> |
| <h2 title="Class WindowFnTestUtils" class="title">Class WindowFnTestUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.testing.WindowFnTestUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WindowFnTestUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">A utility class for testing <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a>s.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#WindowFnTestUtils--">WindowFnTestUtils</a></span>()</code> </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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>java.util.Collection<W></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#assignedWindows-org.apache.beam.sdk.transforms.windowing.WindowFn-long-">assignedWindows</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp)</code> |
| <div class="block">runs <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-"><code>WindowFn.assignWindows(WindowFn.AssignContext)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>java.util.Collection<W></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#assignedWindowsWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-">assignedWindowsWithValue</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue)</code> |
| <div class="block">runs <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-"><code>WindowFn.assignWindows(WindowFn.AssignContext)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>java.util.Map<W,java.util.Set<java.lang.String>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#runWindowFn-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-">runWindowFn</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| java.util.List<java.lang.Long> timestamps)</code> |
| <div class="block">Runs the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> over the provided input, returning a map of windows to the timestamps |
| in those windows.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>java.util.Map<W,java.util.Set<java.lang.String>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#runWindowFnWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-">runWindowFnWithValue</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T>> timestampedValues)</code> |
| <div class="block">Runs the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> over the provided input, returning a map of windows to the timestamps |
| in those windows.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#set-long...-">set</a></span>(long... timestamps)</code> |
| <div class="block">Creates a Set of elements to be used as expected output in <a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#runWindowFn-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-"><code>runWindowFn(org.apache.beam.sdk.transforms.windowing.WindowFn<T, W>, java.util.List<java.lang.Long>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateGetOutputTimestamp-org.apache.beam.sdk.transforms.windowing.WindowFn-long-">validateGetOutputTimestamp</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp)</code> |
| <div class="block">Assigns the given <code>timestamp</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getOutputTime-org.joda.time.Instant-W-"><code>windowFn.getOutputTime</code></a> for later windows |
| (as defined by <code>maxTimestamp</code> won't prevent the watermark from passing the end of earlier |
| windows.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateGetOutputTimestamps-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-java.util.List-">validateGetOutputTimestamps</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner, |
| java.util.List<java.util.List<java.lang.Long>> timestampsPerWindow)</code> |
| <div class="block">Verifies that later-ending merged windows from any of the timestamps hold up output of |
| earlier-ending windows, using the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateGetOutputTimestampsWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-java.util.List-">validateGetOutputTimestampsWithValue</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner, |
| java.util.List<java.util.List<<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T>>> timestampValuesPerWindow)</code> |
| <div class="block">Verifies that later-ending merged windows from any of the timestampValues hold up output of |
| earlier-ending windows, using the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateGetOutputTimestampWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-">validateGetOutputTimestampWithValue</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue)</code> |
| <div class="block">Assigns the given <code>timestampedValue</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getOutputTime-org.joda.time.Instant-W-"><code>windowFn.getOutputTime</code></a> for later windows |
| (as defined by <code>maxTimestamp</code> won't prevent the watermark from passing the end of earlier |
| windows.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateNonInterferingOutputTimes-org.apache.beam.sdk.transforms.windowing.WindowFn-long-">validateNonInterferingOutputTimes</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp)</code> |
| <div class="block">Assigns the given <code>timestamp</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <code>windowFn.getOutputTimestamp</code> for each window is within the |
| proper bound.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>><br>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#validateNonInterferingOutputTimesWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-">validateNonInterferingOutputTimesWithValue</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue)</code> |
| <div class="block">Assigns the given <code>timestampedValue</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <code>windowFn.getOutputTimestamp</code> for each window is within the |
| proper bound.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WindowFnTestUtils--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WindowFnTestUtils</h4> |
| <pre>public WindowFnTestUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="set-long...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public static java.util.Set<java.lang.String> set(long... timestamps)</pre> |
| <div class="block">Creates a Set of elements to be used as expected output in <a href="../../../../../org/apache/beam/sdk/testing/WindowFnTestUtils.html#runWindowFn-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-"><code>runWindowFn(org.apache.beam.sdk.transforms.windowing.WindowFn<T, W>, java.util.List<java.lang.Long>)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="runWindowFn-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>runWindowFn</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> java.util.Map<W,java.util.Set<java.lang.String>> runWindowFn(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| java.util.List<java.lang.Long> timestamps) |
| throws java.lang.Exception</pre> |
| <div class="block">Runs the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> over the provided input, returning a map of windows to the timestamps |
| in those windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="runWindowFnWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>runWindowFnWithValue</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> java.util.Map<W,java.util.Set<java.lang.String>> runWindowFnWithValue(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| java.util.List<<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T>> timestampedValues) |
| throws java.lang.Exception</pre> |
| <div class="block">Runs the <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> over the provided input, returning a map of windows to the timestamps |
| in those windows. This version allows to pass a list of <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values"><code>TimestampedValue</code></a> in case the |
| values are used to assign windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assignedWindows-org.apache.beam.sdk.transforms.windowing.WindowFn-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignedWindows</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> java.util.Collection<W> assignedWindows(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp) |
| throws java.lang.Exception</pre> |
| <div class="block">runs <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-"><code>WindowFn.assignWindows(WindowFn.AssignContext)</code></a>.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="assignedWindowsWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignedWindowsWithValue</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> java.util.Collection<W> assignedWindowsWithValue(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue) |
| throws java.lang.Exception</pre> |
| <div class="block">runs <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-"><code>WindowFn.assignWindows(WindowFn.AssignContext)</code></a>. This version allows passing a |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values"><code>TimestampedValue</code></a> in case the value is needed to assign windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateNonInterferingOutputTimes-org.apache.beam.sdk.transforms.windowing.WindowFn-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateNonInterferingOutputTimes</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> void validateNonInterferingOutputTimes(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp) |
| throws java.lang.Exception</pre> |
| <div class="block">Assigns the given <code>timestamp</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <code>windowFn.getOutputTimestamp</code> for each window is within the |
| proper bound.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateNonInterferingOutputTimesWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateNonInterferingOutputTimesWithValue</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> void validateNonInterferingOutputTimesWithValue(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue) |
| throws java.lang.Exception</pre> |
| <div class="block">Assigns the given <code>timestampedValue</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <code>windowFn.getOutputTimestamp</code> for each window is within the |
| proper bound. This version allows passing a <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values"><code>TimestampedValue</code></a> in case the value is |
| needed to assign windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateGetOutputTimestamp-org.apache.beam.sdk.transforms.windowing.WindowFn-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateGetOutputTimestamp</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> void validateGetOutputTimestamp(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| long timestamp) |
| throws java.lang.Exception</pre> |
| <div class="block">Assigns the given <code>timestamp</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getOutputTime-org.joda.time.Instant-W-"><code>windowFn.getOutputTime</code></a> for later windows |
| (as defined by <code>maxTimestamp</code> won't prevent the watermark from passing the end of earlier |
| windows. |
| |
| <p>This verifies that overlapping windows don't interfere at all. Depending on the <code>windowFn</code> this may be stricter than desired.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateGetOutputTimestampWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.values.TimestampedValue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateGetOutputTimestampWithValue</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> void validateGetOutputTimestampWithValue(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T> timestampedValue) |
| throws java.lang.Exception</pre> |
| <div class="block">Assigns the given <code>timestampedValue</code> to windows using the specified <code>windowFn</code>, and |
| verifies that result of <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getOutputTime-org.joda.time.Instant-W-"><code>windowFn.getOutputTime</code></a> for later windows |
| (as defined by <code>maxTimestamp</code> won't prevent the watermark from passing the end of earlier |
| windows. |
| |
| <p>This verifies that overlapping windows don't interfere at all. Depending on the <code>windowFn</code> this may be stricter than desired. This version allows passing a <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values"><code>TimestampedValue</code></a> in case the value is needed to assign windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateGetOutputTimestamps-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateGetOutputTimestamps</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>> void validateGetOutputTimestamps(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner, |
| java.util.List<java.util.List<java.lang.Long>> timestampsPerWindow) |
| throws java.lang.Exception</pre> |
| <div class="block">Verifies that later-ending merged windows from any of the timestamps hold up output of |
| earlier-ending windows, using the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>. |
| |
| <p>Given a list of lists of timestamps, where each list is expected to merge into a single |
| window with end times in ascending order, assigns and merges windows for each list (as though |
| each were a separate key/user session). Then combines each timestamp in the list according to |
| the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>. |
| |
| <p>Verifies that a overlapping windows do not hold each other up via the watermark.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="validateGetOutputTimestampsWithValue-org.apache.beam.sdk.transforms.windowing.WindowFn-org.apache.beam.sdk.transforms.windowing.TimestampCombiner-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validateGetOutputTimestampsWithValue</h4> |
| <pre>public static <T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>> void validateGetOutputTimestampsWithValue(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><T,W> windowFn, |
| <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing">TimestampCombiner</a> timestampCombiner, |
| java.util.List<java.util.List<<a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values">TimestampedValue</a><T>>> timestampValuesPerWindow) |
| throws java.lang.Exception</pre> |
| <div class="block">Verifies that later-ending merged windows from any of the timestampValues hold up output of |
| earlier-ending windows, using the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> and <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>. |
| |
| <p>Given a list of lists of timestampValues, where each list is expected to merge into a single |
| window with end times in ascending order, assigns and merges windows for each list (as though |
| each were a separate key/user session). Then combines each timestamp in the list according to |
| the provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><code>TimestampCombiner</code></a>. |
| |
| <p>Verifies that a overlapping windows do not hold each other up via the watermark. This |
| version allows passing <a href="../../../../../org/apache/beam/sdk/values/TimestampedValue.html" title="class in org.apache.beam.sdk.values"><code>TimestampedValue</code></a> in case the value is needed to assign windows.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></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/testing/ValidatesRunner.html" title="interface in org.apache.beam.sdk.testing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/sdk/testing/WindowFnTestUtils.html" target="_top">Frames</a></li> |
| <li><a href="WindowFnTestUtils.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>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
