Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / javadoc / 2.15.0 / org / apache / beam / sdk / transforms / windowing / SlidingWindows.html
blob: 24624a59a82c2e6188a47c0f20b55c7a27c98444 [file] [log] [blame]
<!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 Wed Aug 14 17:37:13 PDT 2019 -->
<title>SlidingWindows (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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="SlidingWindows (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/transforms/windowing/Sessions.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" target="_top">Frames</a></li>
<li><a href="SlidingWindows.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.transforms.windowing</div>
<h2 title="Class SlidingWindows" class="title">Class SlidingWindows</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">org.apache.beam.sdk.transforms.windowing.WindowFn</a>&lt;T,W&gt;</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/NonMergingWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.transforms.windowing.SlidingWindows</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SlidingWindows</span>
extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/NonMergingWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">NonMergingWindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</pre>
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> that windows values into possibly overlapping fixed-size timestamp-based
windows.
<p>For example, in order to window data into 10 minute windows that update every minute:
<pre><code>
PCollection&lt;Integer&gt; items = ...;
PCollection&lt;Integer&gt; windowedItems = items.apply(
Window.&lt;Integer&gt;into(SlidingWindows.of(Duration.standardMinutes(10))));
</code></pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.transforms.windowing.SlidingWindows">Serialized Form</a></dd>
</dl>
</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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.beam.sdk.transforms.windowing.<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.AssignContext.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn.AssignContext</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.MergeContext.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn.MergeContext</a></code></li>
</ul>
</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#assignsToOneWindow--">assignsToOneWindow</a></span>()</code>
<div class="block">Returns true if this <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> always assigns an element to exactly one window.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#assignWindows-org.joda.time.Instant-">assignWindows</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;timestamp)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-">assignWindows</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.AssignContext.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn.AssignContext</a>&nbsp;c)</code>
<div class="block">Given a timestamp and element, returns the set of windows into which it should be placed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;object)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#every-org.joda.time.Duration-">every</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;period)</code>
<div class="block">Returns a new <code>SlidingWindows</code> with the original size, that assigns timestamps into
half-open intervals of the form [N * period, N * period + size), where 0 is the epoch.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowMappingFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowMappingFn</a>&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#getDefaultWindowMappingFn--">getDefaultWindowMappingFn</a></span>()</code>
<div class="block">Return a <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowMappingFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowMappingFn</code></a> that returns the earliest window that contains the end of the
main-input window.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#getOffset--">getOffset</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#getOutputTime-org.joda.time.Instant-org.apache.beam.sdk.transforms.windowing.IntervalWindow-">getOutputTime</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;inputTimestamp,
<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&nbsp;window)</code>
<div class="block">Ensures that later sliding windows have an output time that is past the end of earlier windows.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#getPeriod--">getPeriod</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#getSize--">getSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#isCompatible-org.apache.beam.sdk.transforms.windowing.WindowFn-">isCompatible</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;?,?&gt;&nbsp;other)</code>
<div class="block">Returns whether this performs the same merging as the given <code>WindowFn</code>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#of-org.joda.time.Duration-">of</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;size)</code>
<div class="block">Assigns timestamps into half-open intervals of the form [N * period, N * period + size), where
0 is the epoch.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</code>
<div class="block">Register display data for the given transform or component.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#verifyCompatibility-org.apache.beam.sdk.transforms.windowing.WindowFn-">verifyCompatibility</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;?,?&gt;&nbsp;other)</code>
<div class="block">Throw <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IncompatibleWindowException.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>IncompatibleWindowException</code></a> if this WindowFn does not perform the same merging as
the given $<code>WindowFn</code>.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#windowCoder--">windowCoder</a></span>()</code>
<div class="block">Returns the <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> used for serializing the windows used by this windowFn.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#withOffset-org.joda.time.Duration-">withOffset</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;offset)</code>
<div class="block">Assigns timestamps into half-open intervals of the form [N * period + offset, N * period +
offset + size).</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.windowing.NonMergingWindowFn">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.windowing.<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/NonMergingWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">NonMergingWindowFn</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/NonMergingWindowFn.html#isNonMerging--">isNonMerging</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/NonMergingWindowFn.html#mergeWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.MergeContext-">mergeWindows</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.beam.sdk.transforms.windowing.<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a></h3>
<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getWindowTypeDescriptor--">getWindowTypeDescriptor</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</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="of-org.joda.time.Duration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>of</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a>&nbsp;of(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;size)</pre>
<div class="block">Assigns timestamps into half-open intervals of the form [N * period, N * period + size), where
0 is the epoch.
<p>If <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html#every-org.joda.time.Duration-"><code>every(org.joda.time.Duration)</code></a> is not called, the period defaults to the largest time unit
smaller than the given duration. For example, specifying a size of 5 seconds will result in a
default period of 1 second.</div>
</li>
</ul>
<a name="every-org.joda.time.Duration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>every</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a>&nbsp;every(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;period)</pre>
<div class="block">Returns a new <code>SlidingWindows</code> with the original size, that assigns timestamps into
half-open intervals of the form [N * period, N * period + size), where 0 is the epoch.</div>
</li>
</ul>
<a name="withOffset-org.joda.time.Duration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withOffset</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">SlidingWindows</a>&nbsp;withOffset(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;offset)</pre>
<div class="block">Assigns timestamps into half-open intervals of the form [N * period + offset, N * period +
offset + size).</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if offset is not in [0, period)</dd>
</dl>
</li>
</ul>
<a name="windowCoder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowCoder</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a>&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;&nbsp;windowCoder()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#windowCoder--">WindowFn</a></code></span></div>
<div class="block">Returns the <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders"><code>Coder</code></a> used for serializing the windows used by this windowFn.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#windowCoder--">windowCoder</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignWindows</h4>
<pre>public&nbsp;java.util.Collection&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;&nbsp;assignWindows(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.AssignContext.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn.AssignContext</a>&nbsp;c)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-">WindowFn</a></code></span></div>
<div class="block">Given a timestamp and element, returns the set of windows into which it should be placed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-">assignWindows</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="assignWindows-org.joda.time.Instant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignWindows</h4>
<pre>public&nbsp;java.util.Collection&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;&nbsp;assignWindows(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;timestamp)</pre>
</li>
</ul>
<a name="getDefaultWindowMappingFn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultWindowMappingFn</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowMappingFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowMappingFn</a>&lt;<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;&nbsp;getDefaultWindowMappingFn()</pre>
<div class="block">Return a <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowMappingFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowMappingFn</code></a> that returns the earliest window that contains the end of the
main-input window.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getDefaultWindowMappingFn--">getDefaultWindowMappingFn</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="isCompatible-org.apache.beam.sdk.transforms.windowing.WindowFn-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCompatible</h4>
<pre>public&nbsp;boolean&nbsp;isCompatible(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;?,?&gt;&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#isCompatible-org.apache.beam.sdk.transforms.windowing.WindowFn-">WindowFn</a></code></span></div>
<div class="block">Returns whether this performs the same merging as the given <code>WindowFn</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#isCompatible-org.apache.beam.sdk.transforms.windowing.WindowFn-">isCompatible</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="assignsToOneWindow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assignsToOneWindow</h4>
<pre>public&nbsp;boolean&nbsp;assignsToOneWindow()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignsToOneWindow--">WindowFn</a></code></span></div>
<div class="block">Returns true if this <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a> always assigns an element to exactly one window.
<p>If this varies per-element, or cannot be determined, conservatively return false.
<p>By default, returns false.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#assignsToOneWindow--">assignsToOneWindow</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="verifyCompatibility-org.apache.beam.sdk.transforms.windowing.WindowFn-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyCompatibility</h4>
<pre>public&nbsp;void&nbsp;verifyCompatibility(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;?,?&gt;&nbsp;other)
throws <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IncompatibleWindowException.html" title="class in org.apache.beam.sdk.transforms.windowing">IncompatibleWindowException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#verifyCompatibility-org.apache.beam.sdk.transforms.windowing.WindowFn-">WindowFn</a></code></span></div>
<div class="block">Throw <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IncompatibleWindowException.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>IncompatibleWindowException</code></a> if this WindowFn does not perform the same merging as
the given $<code>WindowFn</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#verifyCompatibility-org.apache.beam.sdk.transforms.windowing.WindowFn-">verifyCompatibility</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IncompatibleWindowException.html" title="class in org.apache.beam.sdk.transforms.windowing">IncompatibleWindowException</a></code> - if compared WindowFns are not compatible.</dd>
</dl>
</li>
</ul>
<a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populateDisplayData</h4>
<pre>public&nbsp;void&nbsp;populateDisplayData(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">WindowFn</a></code></span></div>
<div class="block">Register display data for the given transform or component.
<p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect
display data via <a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call <code>super.populateDisplayData(builder)</code> in order to register display data in the current namespace,
but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use the namespace
of the subcomponent.
<p>By default, does not register any display data. Implementors may override this method to
provide their own display data.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - The builder to populate with display data.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></dd>
</dl>
</li>
</ul>
<a name="getPeriod--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPeriod</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;getPeriod()</pre>
</li>
</ul>
<a name="getSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;getSize()</pre>
</li>
</ul>
<a name="getOffset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOffset</h4>
<pre>public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;getOffset()</pre>
</li>
</ul>
<a name="getOutputTime-org.joda.time.Instant-org.apache.beam.sdk.transforms.windowing.IntervalWindow-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputTime</h4>
<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#OUTPUT_TIME">OUTPUT_TIME</a>)
public&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;getOutputTime(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;inputTimestamp,
<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&nbsp;window)</pre>
<div class="block">Ensures that later sliding windows have an output time that is past the end of earlier windows.
<p>If this is the earliest sliding window containing <code>inputTimestamp</code>, that's fine.
Otherwise, we pick the earliest time that doesn't overlap with earlier windows.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#getOutputTime-org.joda.time.Instant-W-">getOutputTime</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a>&lt;java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;object)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</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/transforms/windowing/Sessions.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/TimestampCombiner.html" title="enum in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/windowing/SlidingWindows.html" target="_top">Frames</a></li>
<li><a href="SlidingWindows.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>