| <!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>CalendarWindows.YearsWindows (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="CalendarWindows.YearsWindows (Apache Beam 2.20.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":10}; |
| var tabs = {65535:["t0","All 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/CalendarWindows.MonthsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/DefaultTrigger.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" target="_top">Frames</a></li> |
| <li><a href="CalendarWindows.YearsWindows.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.classes.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">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.transforms.windowing</div> |
| <h2 title="Class CalendarWindows.YearsWindows" class="title">Class CalendarWindows.YearsWindows</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><T,W></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><T,W></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">org.apache.beam.sdk.transforms.windowing.PartitioningWindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.transforms.windowing.CalendarWindows.YearsWindows</li> |
| </ul> |
| </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> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <span class="typeNameLabel">CalendarWindows.YearsWindows</span> |
| extends <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">PartitioningWindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></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 elements into periods measured by years. |
| |
| <p>By default, periods of multiple years are measured starting at the epoch. This can be |
| overridden with <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#withStartingYear-int-"><code>withStartingYear(int)</code></a>. |
| |
| <p>Years start on the first day of each calendar year, unless overridden by <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#beginningOnDay-int-int-"><code>beginningOnDay(int, int)</code></a>. |
| |
| <p>The time zone used to determine calendar boundaries is UTC, unless this is overridden with |
| the <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#withTimeZone-org.joda.time.DateTimeZone-"><code>withTimeZone(org.joda.time.DateTimeZone)</code></a> method.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.transforms.windowing.CalendarWindows.YearsWindows">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 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#assignWindow-org.joda.time.Instant-">assignWindow</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp)</code> |
| <div class="block">Returns the single window to which elements with this timestamp belong.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#beginningOnDay-int-int-">beginningOnDay</a></span>(int monthOfYear, |
| int dayOfMonth)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#getDayOfMonth--">getDayOfMonth</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#getMonthOfYear--">getMonthOfYear</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#getNumber--">getNumber</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTime.html?is-external=true" title="class or interface in org.joda.time">DateTime</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#getStartDate--">getStartDate</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTimeZone.html?is-external=true" title="class or interface in org.joda.time">DateTimeZone</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#getTimeZone--">getTimeZone</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.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><?,?> other)</code> |
| <div class="block">Returns whether this performs the same merging as the given <code>WindowFn</code>.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.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> builder)</code> |
| <div class="block">Register display data for the given transform or component.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.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><?,?> 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="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.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="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#withStartingYear-int-">withStartingYear</a></span>(int year)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html#withTimeZone-org.joda.time.DateTimeZone-">withTimeZone</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTimeZone.html?is-external=true" title="class or interface in org.joda.time">DateTimeZone</a> timeZone)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.windowing.PartitioningWindowFn"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.windowing.<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">PartitioningWindowFn</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#assignsToOneWindow--">assignsToOneWindow</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#assignWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.AssignContext-">assignWindows</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#getDefaultWindowMappingFn--">getDefaultWindowMappingFn</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#getOutputTime-org.joda.time.Instant-W-">getOutputTime</a></code></li> |
| </ul> |
| <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 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 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 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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="beginningOnDay-int-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beginningOnDay</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a> beginningOnDay(int monthOfYear, |
| int dayOfMonth)</pre> |
| </li> |
| </ul> |
| <a name="withStartingYear-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStartingYear</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a> withStartingYear(int year)</pre> |
| </li> |
| </ul> |
| <a name="withTimeZone-org.joda.time.DateTimeZone-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTimeZone</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing">CalendarWindows.YearsWindows</a> withTimeZone(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTimeZone.html?is-external=true" title="class or interface in org.joda.time">DateTimeZone</a> timeZone)</pre> |
| </li> |
| </ul> |
| <a name="assignWindow-org.joda.time.Instant-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>assignWindow</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a> assignWindow(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a> timestamp)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#assignWindow-org.joda.time.Instant-">PartitioningWindowFn</a></code></span></div> |
| <div class="block">Returns the single window to which elements with this timestamp belong.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html#assignWindow-org.joda.time.Instant-">assignWindow</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/PartitioningWindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">PartitioningWindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="windowCoder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>windowCoder</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/coders/Coder.html" title="class in org.apache.beam.sdk.coders">Coder</a><<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>> windowCoder()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></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 boolean isCompatible(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><?,?> other)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></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 void verifyCompatibility(<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><?,?> 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: <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> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></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 void populateDisplayData(<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in interface <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> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><java.lang.Object,<a href="../../../../../../org/apache/beam/sdk/transforms/windowing/IntervalWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">IntervalWindow</a>></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="getTimeZone--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeZone</h4> |
| <pre>public <a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTimeZone.html?is-external=true" title="class or interface in org.joda.time">DateTimeZone</a> getTimeZone()</pre> |
| </li> |
| </ul> |
| <a name="getStartDate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStartDate</h4> |
| <pre>public <a href="https://static.javadoc.io/joda-time/joda-time/2.10.3/org/joda/time/DateTime.html?is-external=true" title="class or interface in org.joda.time">DateTime</a> getStartDate()</pre> |
| </li> |
| </ul> |
| <a name="getDayOfMonth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDayOfMonth</h4> |
| <pre>public int getDayOfMonth()</pre> |
| </li> |
| </ul> |
| <a name="getMonthOfYear--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMonthOfYear</h4> |
| <pre>public int getMonthOfYear()</pre> |
| </li> |
| </ul> |
| <a name="getNumber--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNumber</h4> |
| <pre>public int getNumber()</pre> |
| </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/CalendarWindows.MonthsWindows.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/windowing/DefaultTrigger.html" title="class in org.apache.beam.sdk.transforms.windowing"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/transforms/windowing/CalendarWindows.YearsWindows.html" target="_top">Frames</a></li> |
| <li><a href="CalendarWindows.YearsWindows.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.classes.inherited.from.class.org.apache.beam.sdk.transforms.windowing.WindowFn">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> |
