| <!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 (version 1.7.0_80) on Thu Aug 04 13:19:29 BST 2016 --> |
| <title>WindowStore (kafka 0.10.0.1 API)</title> |
| <meta name="date" content="2016-08-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WindowStore (kafka 0.10.0.1 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/kafka/streams/state/Stores.ValueFactory.html" title="class in org.apache.kafka.streams.state"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/streams/state/WindowStoreIterator.html" title="interface in org.apache.kafka.streams.state"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/streams/state/WindowStore.html" target="_top">Frames</a></li> |
| <li><a href="WindowStore.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>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.kafka.streams.state</div> |
| <h2 title="Interface WindowStore" class="title">Interface WindowStore<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - Type of keys</dd><dd><code>V</code> - Type of values</dd></dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceStability.Unstable |
| public interface <span class="strong">WindowStore<K,V></span> |
| extends <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></pre> |
| <div class="block">A windowed store interface extending <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor"><code>StateStore</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/kafka/streams/state/WindowStoreIterator.html" title="interface in org.apache.kafka.streams.state">WindowStoreIterator</a><<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/WindowStore.html#fetch(K,%20long,%20long)">fetch</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| long timeFrom, |
| long timeTo)</code> |
| <div class="block">Get all the key-value pairs with the given key and the time range from all |
| the existing windows.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/WindowStore.html#put(K,%20V)">put</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| <a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a> value)</code> |
| <div class="block">Put a key-value pair with the current wall-clock time as the timestamp |
| into the corresponding window</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/streams/state/WindowStore.html#put(K,%20V,%20long)">put</a></strong>(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| <a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a> value, |
| long timestamp)</code> |
| <div class="block">Put a key-value pair with the given timestamp into the corresponding window</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.kafka.streams.processor.StateStore"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.kafka.streams.processor.<a href="../../../../../org/apache/kafka/streams/processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></h3> |
| <code><a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#close()">close</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#flush()">flush</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#init(org.apache.kafka.streams.processor.ProcessorContext,%20org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#name()">name</a>, <a href="../../../../../org/apache/kafka/streams/processor/StateStore.html#persistent()">persistent</a></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="put(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a name="put(K, V)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>void put(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| <a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a> value)</pre> |
| <div class="block">Put a key-value pair with the current wall-clock time as the timestamp |
| into the corresponding window</div> |
| </li> |
| </ul> |
| <a name="put(java.lang.Object,java.lang.Object,long)"> |
| <!-- --> |
| </a><a name="put(K, V, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>void put(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| <a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a> value, |
| long timestamp)</pre> |
| <div class="block">Put a key-value pair with the given timestamp into the corresponding window</div> |
| </li> |
| </ul> |
| <a name="fetch(java.lang.Object,long,long)"> |
| <!-- --> |
| </a><a name="fetch(K, long, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fetch</h4> |
| <pre><a href="../../../../../org/apache/kafka/streams/state/WindowStoreIterator.html" title="interface in org.apache.kafka.streams.state">WindowStoreIterator</a><<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">V</a>> fetch(<a href="../../../../../org/apache/kafka/streams/state/WindowStore.html" title="type parameter in WindowStore">K</a> key, |
| long timeFrom, |
| long timeTo)</pre> |
| <div class="block">Get all the key-value pairs with the given key and the time range from all |
| the existing windows.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>an iterator over key-value pairs <code><timestamp, value></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/kafka/streams/state/Stores.ValueFactory.html" title="class in org.apache.kafka.streams.state"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/kafka/streams/state/WindowStoreIterator.html" title="interface in org.apache.kafka.streams.state"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/kafka/streams/state/WindowStore.html" target="_top">Frames</a></li> |
| <li><a href="WindowStore.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>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> |
