| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SessionStore (kafka 3.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.streams.state, interface: SessionStore"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var data = {"i0":18,"i1":18,"i2":18,"i3":18,"i4":18,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.streams.state</a></div> |
| <h1 title="Interface SessionStore" class="title">Interface SessionStore<K,​AGG></h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - type of the record keys</dd> |
| <dd><code>AGG</code> - type of the aggregated values</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><K,​AGG></code>, <code><a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="type-name-label">SessionStore<K,​AGG></span> |
| extends <a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a>, <a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><K,​AGG></pre> |
| <div class="block">Interface for storing the aggregated values of sessions. |
| <p> |
| The key is internally represented as <a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream"><code>Windowed<K></code></a> that comprises the plain |
| key and the <a href="../kstream/Window.html" title="class in org.apache.kafka.streams.kstream"><code>Window</code></a> that represents window start- and end-timestamp. |
| <p> |
| If two sessions are merged, a new session with new start- and end-timestamp must be inserted into |
| the store while the two old sessions must be deleted.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="table-tab" onclick="show(16);">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code>default <a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#backwardFindSessions(K,java.time.Instant,java.time.Instant)">backwardFindSessions</a></span>​(<a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</code></th> |
| <td class="col-last"> |
| <div class="block">Fetch any sessions with the matching key and the sessions end is ≥ earliestSessionEndTime |
| and the sessions start is ≤ latestSessionStartTime iterating from latest to earliest.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code>default <a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#backwardFindSessions(K,K,java.time.Instant,java.time.Instant)">backwardFindSessions</a></span>​(<a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyFrom, |
| <a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyTo, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</code></th> |
| <td class="col-last"> |
| <div class="block">Fetch any sessions in the given range of keys and the sessions end is ≥ |
| earliestSessionEndTime and the sessions start is ≤ latestSessionStartTime iterating from |
| latest to earliest.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code>default <a href="SessionStore.html" title="type parameter in SessionStore">AGG</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#fetchSession(K,java.time.Instant,java.time.Instant)">fetchSession</a></span>​(<a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</code></th> |
| <td class="col-last"> |
| <div class="block">Get the value of key from a single session.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code>default <a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#findSessions(K,java.time.Instant,java.time.Instant)">findSessions</a></span>​(<a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</code></th> |
| <td class="col-last"> |
| <div class="block">Fetch any sessions with the matching key and the sessions end is ≥ earliestSessionEndTime |
| and the sessions start is ≤ latestSessionStartTime iterating from earliest to latest.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code>default <a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#findSessions(K,K,java.time.Instant,java.time.Instant)">findSessions</a></span>​(<a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyFrom, |
| <a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyTo, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</code></th> |
| <td class="col-last"> |
| <div class="block">Fetch any sessions in the given range of keys and the sessions end is ≥ |
| earliestSessionEndTime and the sessions start is ≤ latestSessionStartTime iterating from |
| earliest to latest.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i5"> |
| <td class="col-first"><code>void</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#put(org.apache.kafka.streams.kstream.Windowed,AGG)">put</a></span>​(<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>> sessionKey, |
| <a href="SessionStore.html" title="type parameter in SessionStore">AGG</a> aggregate)</code></th> |
| <td class="col-last"> |
| <div class="block">Write the aggregated value for the provided key to the store</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i6"> |
| <td class="col-first"><code>void</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#remove(org.apache.kafka.streams.kstream.Windowed)">remove</a></span>​(<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>> sessionKey)</code></th> |
| <td class="col-last"> |
| <div class="block">Remove the session aggregated with provided <a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream"><code>Windowed</code></a> key from the store</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.kafka.streams.state.ReadOnlySessionStore">Methods inherited from interface org.apache.kafka.streams.state.<a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a></h3> |
| <code><a href="ReadOnlySessionStore.html#backwardFetch(K)">backwardFetch</a>, <a href="ReadOnlySessionStore.html#backwardFetch(K,K)">backwardFetch</a>, <a href="ReadOnlySessionStore.html#backwardFindSessions(K,long,long)">backwardFindSessions</a>, <a href="ReadOnlySessionStore.html#backwardFindSessions(K,K,long,long)">backwardFindSessions</a>, <a href="ReadOnlySessionStore.html#fetch(K)">fetch</a>, <a href="ReadOnlySessionStore.html#fetch(K,K)">fetch</a>, <a href="ReadOnlySessionStore.html#fetchSession(K,long,long)">fetchSession</a>, <a href="ReadOnlySessionStore.html#findSessions(K,long,long)">findSessions</a>, <a href="ReadOnlySessionStore.html#findSessions(K,K,long,long)">findSessions</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.kafka.streams.processor.StateStore">Methods inherited from interface org.apache.kafka.streams.processor.<a href="../processor/StateStore.html" title="interface in org.apache.kafka.streams.processor">StateStore</a></h3> |
| <code><a href="../processor/StateStore.html#close()">close</a>, <a href="../processor/StateStore.html#flush()">flush</a>, <a href="../processor/StateStore.html#init(org.apache.kafka.streams.processor.ProcessorContext,org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../processor/StateStore.html#init(org.apache.kafka.streams.processor.StateStoreContext,org.apache.kafka.streams.processor.StateStore)">init</a>, <a href="../processor/StateStore.html#isOpen()">isOpen</a>, <a href="../processor/StateStore.html#name()">name</a>, <a href="../processor/StateStore.html#persistent()">persistent</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="findSessions(K,java.time.Instant,java.time.Instant)"> |
| <h3 id="findSessions(java.lang.Object,java.time.Instant,java.time.Instant)">findSessions</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></span> <span class="member-name">findSessions</span>​(<span class="parameters"><a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReadOnlySessionStore.html#findSessions(K,java.time.Instant,java.time.Instant)">ReadOnlySessionStore</a></code></span></div> |
| <div class="block">Fetch any sessions with the matching key and the sessions end is ≥ earliestSessionEndTime |
| and the sessions start is ≤ latestSessionStartTime iterating from earliest to latest. |
| <p> |
| This iterator must be closed after use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html#findSessions(K,java.time.Instant,java.time.Instant)">findSessions</a></code> in interface <code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key to return sessions for</dd> |
| <dd><code>earliestSessionEndTime</code> - the end timestamp of the earliest session to search for, where |
| iteration starts.</dd> |
| <dd><code>latestSessionStartTime</code> - the end timestamp of the latest session to search for, where |
| iteration ends.</dd> |
| <dt>Returns:</dt> |
| <dd>iterator of sessions with the matching key and aggregated values, from earliest to |
| latest session time.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backwardFindSessions(K,java.time.Instant,java.time.Instant)"> |
| <h3 id="backwardFindSessions(java.lang.Object,java.time.Instant,java.time.Instant)">backwardFindSessions</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></span> <span class="member-name">backwardFindSessions</span>​(<span class="parameters"><a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReadOnlySessionStore.html#backwardFindSessions(K,java.time.Instant,java.time.Instant)">ReadOnlySessionStore</a></code></span></div> |
| <div class="block">Fetch any sessions with the matching key and the sessions end is ≥ earliestSessionEndTime |
| and the sessions start is ≤ latestSessionStartTime iterating from latest to earliest. |
| <p> |
| This iterator must be closed after use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html#backwardFindSessions(K,java.time.Instant,java.time.Instant)">backwardFindSessions</a></code> in interface <code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key to return sessions for</dd> |
| <dd><code>earliestSessionEndTime</code> - the end timestamp of the earliest session to search for, where |
| iteration ends.</dd> |
| <dd><code>latestSessionStartTime</code> - the end timestamp of the latest session to search for, where |
| iteration starts.</dd> |
| <dt>Returns:</dt> |
| <dd>backward iterator of sessions with the matching key and aggregated values, from |
| latest to earliest session time.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="findSessions(K,K,java.time.Instant,java.time.Instant)"> |
| <h3 id="findSessions(java.lang.Object,java.lang.Object,java.time.Instant,java.time.Instant)">findSessions</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></span> <span class="member-name">findSessions</span>​(<span class="parameters"><a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyFrom, |
| <a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyTo, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReadOnlySessionStore.html#findSessions(K,K,java.time.Instant,java.time.Instant)">ReadOnlySessionStore</a></code></span></div> |
| <div class="block">Fetch any sessions in the given range of keys and the sessions end is ≥ |
| earliestSessionEndTime and the sessions start is ≤ latestSessionStartTime iterating from |
| earliest to latest. |
| <p> |
| This iterator must be closed after use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html#findSessions(K,K,java.time.Instant,java.time.Instant)">findSessions</a></code> in interface <code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>keyFrom</code> - The first key that could be in the range</dd> |
| <dd><code>keyTo</code> - The last key that could be in the range</dd> |
| <dd><code>earliestSessionEndTime</code> - the end timestamp of the earliest session to search for, where |
| iteration starts.</dd> |
| <dd><code>latestSessionStartTime</code> - the end timestamp of the latest session to search for, where |
| iteration ends.</dd> |
| <dt>Returns:</dt> |
| <dd>iterator of sessions with the matching keys and aggregated values, from earliest to |
| latest session time.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="backwardFindSessions(K,K,java.time.Instant,java.time.Instant)"> |
| <h3 id="backwardFindSessions(java.lang.Object,java.lang.Object,java.time.Instant,java.time.Instant)">backwardFindSessions</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="KeyValueIterator.html" title="interface in org.apache.kafka.streams.state">KeyValueIterator</a><<a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></span> <span class="member-name">backwardFindSessions</span>​(<span class="parameters"><a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyFrom, |
| <a href="SessionStore.html" title="type parameter in SessionStore">K</a> keyTo, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReadOnlySessionStore.html#backwardFindSessions(K,K,java.time.Instant,java.time.Instant)">ReadOnlySessionStore</a></code></span></div> |
| <div class="block">Fetch any sessions in the given range of keys and the sessions end is ≥ |
| earliestSessionEndTime and the sessions start is ≤ latestSessionStartTime iterating from |
| latest to earliest. |
| <p> |
| This iterator must be closed after use.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html#backwardFindSessions(K,K,java.time.Instant,java.time.Instant)">backwardFindSessions</a></code> in interface <code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>keyFrom</code> - The first key that could be in the range</dd> |
| <dd><code>keyTo</code> - The last key that could be in the range</dd> |
| <dd><code>earliestSessionEndTime</code> - the end timestamp of the earliest session to search for, where |
| iteration ends.</dd> |
| <dd><code>latestSessionStartTime</code> - the end timestamp of the latest session to search for, where |
| iteration starts.</dd> |
| <dt>Returns:</dt> |
| <dd>backward iterator of sessions with the matching keys and aggregated values, from |
| latest to earliest session time.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fetchSession(K,java.time.Instant,java.time.Instant)"> |
| <h3 id="fetchSession(java.lang.Object,java.time.Instant,java.time.Instant)">fetchSession</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="SessionStore.html" title="type parameter in SessionStore">AGG</a></span> <span class="member-name">fetchSession</span>​(<span class="parameters"><a href="SessionStore.html" title="type parameter in SessionStore">K</a> key, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> earliestSessionEndTime, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Instant.html" title="class or interface in java.time" class="external-link">Instant</a> latestSessionStartTime)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ReadOnlySessionStore.html#fetchSession(K,java.time.Instant,java.time.Instant)">ReadOnlySessionStore</a></code></span></div> |
| <div class="block">Get the value of key from a single session.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ReadOnlySessionStore.html#fetchSession(K,java.time.Instant,java.time.Instant)">fetchSession</a></code> in interface <code><a href="ReadOnlySessionStore.html" title="interface in org.apache.kafka.streams.state">ReadOnlySessionStore</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>,​<a href="SessionStore.html" title="type parameter in SessionStore">AGG</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key to fetch</dd> |
| <dd><code>earliestSessionEndTime</code> - start timestamp of the session</dd> |
| <dd><code>latestSessionStartTime</code> - end timestamp of the session</dd> |
| <dt>Returns:</dt> |
| <dd>The value or <code>null</code> if no session associated with the key can be found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(org.apache.kafka.streams.kstream.Windowed)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="member-name">remove</span>​(<span class="parameters"><a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>> sessionKey)</span></div> |
| <div class="block">Remove the session aggregated with provided <a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream"><code>Windowed</code></a> key from the store</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sessionKey</code> - key of the session to remove</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If null is used for sessionKey.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(org.apache.kafka.streams.kstream.Windowed,AGG)"> |
| <h3 id="put(org.apache.kafka.streams.kstream.Windowed,java.lang.Object)">put</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="member-name">put</span>​(<span class="parameters"><a href="../kstream/Windowed.html" title="class in org.apache.kafka.streams.kstream">Windowed</a><<a href="SessionStore.html" title="type parameter in SessionStore">K</a>> sessionKey, |
| <a href="SessionStore.html" title="type parameter in SessionStore">AGG</a> aggregate)</span></div> |
| <div class="block">Write the aggregated value for the provided key to the store</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sessionKey</code> - key of the session to write</dd> |
| <dd><code>aggregate</code> - the aggregated value for the session, it can be null; if the serialized |
| bytes are also null it is interpreted as deletes</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - If null is used for sessionKey.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
