| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CogroupedKStream (kafka 3.0.1 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.streams.kstream, interface: CogroupedKStream"> |
| <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":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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.kstream</a></div> |
| <h1 title="Interface CogroupedKStream" class="title">Interface CogroupedKStream<K,​VOut></h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>K</code> - Type of keys</dd> |
| <dd><code>VOut</code> - Type of values after agg</dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="type-name-label">CogroupedKStream<K,​VOut></span></pre> |
| <div class="block"><code>CogroupedKStream</code> is an abstraction of multiple <i>grouped</i> record streams of <a href="../KeyValue.html" title="class in org.apache.kafka.streams"><code>KeyValue</code></a> pairs. |
| <p> |
| It is an intermediate representation after a grouping of <a href="KStream.html" title="interface in org.apache.kafka.streams.kstream"><code>KStream</code></a>s, before the |
| aggregations are applied to the new partitions resulting in a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a>. |
| <p> |
| A <code>CogroupedKStream</code> must be obtained from a <a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream"><code>KGroupedStream</code></a> via |
| <a href="KGroupedStream.html#cogroup(org.apache.kafka.streams.kstream.Aggregator)"><code>cogroup(...)</code></a>.</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></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><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#aggregate(org.apache.kafka.streams.kstream.Initializer)">aggregate</a></span>​(<a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer)</code></th> |
| <td class="col-last"> |
| <div class="block">Aggregate the values of records in these streams by the grouped key.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Materialized)">aggregate</a></span>​(<a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream">Materialized</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>,​<a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state">KeyValueStore</a><org.apache.kafka.common.utils.Bytes,​byte[]>> materialized)</code></th> |
| <td class="col-last"> |
| <div class="block">Aggregate the values of records in these streams by the grouped key.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Named)">aggregate</a></span>​(<a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Named.html" title="class in org.apache.kafka.streams.kstream">Named</a> named)</code></th> |
| <td class="col-last"> |
| <div class="block">Aggregate the values of records in these streams by the grouped key.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Named,org.apache.kafka.streams.kstream.Materialized)">aggregate</a></span>​(<a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Named.html" title="class in org.apache.kafka.streams.kstream">Named</a> named, |
| <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream">Materialized</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>,​<a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state">KeyValueStore</a><org.apache.kafka.common.utils.Bytes,​byte[]>> materialized)</code></th> |
| <td class="col-last"> |
| <div class="block">Aggregate the values of records in these streams by the grouped key.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code><VIn> <a href="CogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">CogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)">cogroup</a></span>​(<a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream">KGroupedStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​VIn> groupedStream, |
| <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream">Aggregator</a><? super <a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​? super VIn,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> aggregator)</code></th> |
| <td class="col-last"> |
| <div class="block">Add an already <a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream"><code>grouped KStream</code></a> to this <code>CogroupedKStream</code>.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i5"> |
| <td class="col-first"><code><a href="SessionWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">SessionWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#windowedBy(org.apache.kafka.streams.kstream.SessionWindows)">windowedBy</a></span>​(<a href="SessionWindows.html" title="class in org.apache.kafka.streams.kstream">SessionWindows</a> windows)</code></th> |
| <td class="col-last"> |
| <div class="block">Create a new <a href="SessionWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>SessionWindowedCogroupedKStream</code></a> instance that can be used to perform session |
| windowed aggregations.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i6"> |
| <td class="col-first"><code><a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">TimeWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#windowedBy(org.apache.kafka.streams.kstream.SlidingWindows)">windowedBy</a></span>​(<a href="SlidingWindows.html" title="class in org.apache.kafka.streams.kstream">SlidingWindows</a> windows)</code></th> |
| <td class="col-last"> |
| <div class="block">Create a new <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a> instance that can be used to perform sliding |
| windowed aggregations.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i7"> |
| <td class="col-first"><code><W extends <a href="Window.html" title="class in org.apache.kafka.streams.kstream">Window</a>><br><a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">TimeWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#windowedBy(org.apache.kafka.streams.kstream.Windows)">windowedBy</a></span>​(<a href="Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><W> windows)</code></th> |
| <td class="col-last"> |
| <div class="block">Create a new <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a> instance that can be used to perform windowed |
| aggregations.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </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="cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)"> |
| <h3>cogroup</h3> |
| <div class="member-signature"><span class="type-parameters"><VIn></span> <span class="return-type"><a href="CogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">CogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">cogroup</span>​(<span class="parameters"><a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream">KGroupedStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​VIn> groupedStream, |
| <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream">Aggregator</a><? super <a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​? super VIn,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> aggregator)</span></div> |
| <div class="block">Add an already <a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream"><code>grouped KStream</code></a> to this <code>CogroupedKStream</code>. |
| <p> |
| The added <a href="KGroupedStream.html" title="interface in org.apache.kafka.streams.kstream"><code>grouped KStream</code></a> must have the same number of partitions as all existing |
| streams of this <code>CogroupedKStream</code>. |
| If this is not the case, you would need to call <a href="KStream.html#repartition(org.apache.kafka.streams.kstream.Repartitioned)"><code>KStream.repartition(Repartitioned)</code></a> before |
| <a href="KStream.html#groupByKey()"><code>grouping</code></a> the <a href="KStream.html" title="interface in org.apache.kafka.streams.kstream"><code>KStream</code></a> and specify the "correct" number of |
| partitions via <a href="Repartitioned.html" title="class in org.apache.kafka.streams.kstream"><code>Repartitioned</code></a> parameter. |
| <p> |
| The specified <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> is applied in the actual <a href="#aggregate(org.apache.kafka.streams.kstream.Initializer)"><code>aggregation</code></a> step for |
| each input record and computes a new aggregate using the current aggregate (or for the very first record per key |
| using the initial intermediate aggregation result provided via the <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> that is passed into |
| <a href="#aggregate(org.apache.kafka.streams.kstream.Initializer)"><code>aggregate(Initializer)</code></a>) and the record's value.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>VIn</code> - Type of input values</dd> |
| <dt>Parameters:</dt> |
| <dd><code>groupedStream</code> - a group stream</dd> |
| <dd><code>aggregator</code> - an <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> that computes a new aggregate result</dd> |
| <dt>Returns:</dt> |
| <dd>a <code>CogroupedKStream</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aggregate(org.apache.kafka.streams.kstream.Initializer)"> |
| <h3>aggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">aggregate</span>​(<span class="parameters"><a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer)</span></div> |
| <div class="block">Aggregate the values of records in these streams by the grouped key. |
| Records with <code>null</code> key or value are ignored. |
| The result is written into a local <a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>KeyValueStore</code></a> (which is basically an ever-updating materialized view) |
| that can be queried by the given store name in <code>materialized</code>. |
| Furthermore, updates to the store are sent downstream into a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> changelog stream. |
| <p> |
| To compute the aggregation the corresponding <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> as specified in |
| <a href="#cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)"><code>cogroup(...)</code></a> is used per input stream. |
| The specified <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> is applied once per key, directly before the first input record per key is |
| processed to provide an initial intermediate aggregation result that is used to process the first record. |
| <p> |
| Not all updates might get sent downstream, as an internal cache is used to deduplicate consecutive updates to the |
| same key. |
| The rate of propagated updates depends on your input data rate, the number of distinct keys, the number of |
| parallel running Kafka Streams instances, and the <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>configuration</code></a> parameters for |
| <a href="../StreamsConfig.html#CACHE_MAX_BYTES_BUFFERING_CONFIG"><code>cache size</code></a>, and |
| <a href="../StreamsConfig.html#COMMIT_INTERVAL_MS_CONFIG"><code>commit interval</code></a>. |
| <p> |
| To query the local <a href="../state/ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>ReadOnlyKeyValueStore</code></a> it must be obtained via |
| <a href="../KafkaStreams.html#store(org.apache.kafka.streams.StoreQueryParameters)"><code>KafkaStreams#store(...)</code></a>: |
| <pre><code> |
| KafkaStreams streams = ... // some aggregation on value type double |
| String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance |
| ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore()); |
| K key = "some-key"; |
| ValueAndTimestamp<VOut> aggForKey = localStore.get(key); // key must be local (application state is shared over all running Kafka Streams instances) |
| </code></pre> |
| For non-local keys, a custom RPC mechanism must be implemented using <a href="../KafkaStreams.html#metadataForAllStreamsClients()"><code>KafkaStreams.metadataForAllStreamsClients()</code></a> to query |
| the value of the key on a parallel running instance of your Kafka Streams application. |
| <p> |
| For failure and recovery the store (which always will be of type <a href="../state/TimestampedKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>TimestampedKeyValueStore</code></a>) will be backed by |
| an internal changelog topic that will be created in Kafka. |
| Therefore, the store name defined by the Materialized instance must be a valid Kafka topic name and cannot |
| contain characters other than ASCII alphanumerics, '.', '_' and '-'. |
| The changelog topic will be named "${applicationId}-${storeName}-changelog", where "applicationId" is |
| user-specified in <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>StreamsConfig</code></a> via parameter |
| <a href="../StreamsConfig.html#APPLICATION_ID_CONFIG"><code>APPLICATION_ID_CONFIG</code></a>, "storeName" is a generated value, and |
| "-changelog" is a fixed suffix. |
| <p> |
| You can retrieve all generated internal topic names via <a href="../Topology.html#describe()"><code>Topology.describe()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>initializer</code> - an <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> that computes an initial intermediate aggregation |
| result. Cannot be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> that contains "update" records with unmodified keys, and values that |
| represent the latest (rolling) aggregate for each key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Named)"> |
| <h3>aggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">aggregate</span>​(<span class="parameters"><a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Named.html" title="class in org.apache.kafka.streams.kstream">Named</a> named)</span></div> |
| <div class="block">Aggregate the values of records in these streams by the grouped key. |
| Records with <code>null</code> key or value are ignored. |
| The result is written into a local <a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>KeyValueStore</code></a> (which is basically an ever-updating materialized view) |
| that can be queried by the given store name in <code>materialized</code>. |
| Furthermore, updates to the store are sent downstream into a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> changelog stream. |
| <p> |
| To compute the aggregation the corresponding <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> as specified in |
| <a href="#cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)"><code>cogroup(...)</code></a> is used per input stream. |
| The specified <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> is applied once per key, directly before the first input record per key is |
| processed to provide an initial intermediate aggregation result that is used to process the first record. |
| The specified <a href="Named.html" title="class in org.apache.kafka.streams.kstream"><code>Named</code></a> is applied once to the processor combining the grouped streams. |
| <p> |
| Not all updates might get sent downstream, as an internal cache is used to deduplicate consecutive updates to the |
| same key. |
| The rate of propagated updates depends on your input data rate, the number of distinct keys, the number of |
| parallel running Kafka Streams instances, and the <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>configuration</code></a> parameters for |
| <a href="../StreamsConfig.html#CACHE_MAX_BYTES_BUFFERING_CONFIG"><code>cache size</code></a>, and |
| <a href="../StreamsConfig.html#COMMIT_INTERVAL_MS_CONFIG"><code>commit interval</code></a>. |
| <p> |
| To query the local <a href="../state/ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>ReadOnlyKeyValueStore</code></a> it must be obtained via |
| <a href="../KafkaStreams.html#store(org.apache.kafka.streams.StoreQueryParameters)"><code>KafkaStreams#store(...)</code></a>: |
| <pre><code> |
| KafkaStreams streams = ... // some aggregation on value type double |
| String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance |
| ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore()); |
| K key = "some-key"; |
| ValueAndTimestamp<VOut> aggForKey = localStore.get(key); // key must be local (application state is shared over all running Kafka Streams instances) |
| </code></pre> |
| For non-local keys, a custom RPC mechanism must be implemented using <a href="../KafkaStreams.html#metadataForAllStreamsClients()"><code>KafkaStreams.metadataForAllStreamsClients()</code></a> to query |
| the value of the key on a parallel running instance of your Kafka Streams application. |
| <p> |
| For failure and recovery the store (which always will be of type <a href="../state/TimestampedKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>TimestampedKeyValueStore</code></a>) will be backed by |
| an internal changelog topic that will be created in Kafka. |
| Therefore, the store name defined by the Materialized instance must be a valid Kafka topic name and cannot |
| contain characters other than ASCII alphanumerics, '.', '_' and '-'. |
| The changelog topic will be named "${applicationId}-${storeName}-changelog", where "applicationId" is |
| user-specified in <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>StreamsConfig</code></a> via parameter |
| <a href="../StreamsConfig.html#APPLICATION_ID_CONFIG"><code>APPLICATION_ID_CONFIG</code></a>, "storeName" is the provide store name defined |
| in <code>Materialized</code>, and "-changelog" is a fixed suffix. |
| <p> |
| You can retrieve all generated internal topic names via <a href="../Topology.html#describe()"><code>Topology.describe()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>initializer</code> - an <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> that computes an initial intermediate aggregation |
| result. Cannot be <code>null</code>.</dd> |
| <dd><code>named</code> - name the processor. Cannot be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> that contains "update" records with unmodified keys, and values that |
| represent the latest (rolling) aggregate for each key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Materialized)"> |
| <h3>aggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">aggregate</span>​(<span class="parameters"><a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream">Materialized</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>,​<a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state">KeyValueStore</a><org.apache.kafka.common.utils.Bytes,​byte[]>> materialized)</span></div> |
| <div class="block">Aggregate the values of records in these streams by the grouped key. |
| Records with <code>null</code> key or value are ignored. |
| The result is written into a local <a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>KeyValueStore</code></a> (which is basically an ever-updating materialized view) |
| that can be queried by the given store name in <code>materialized</code>. |
| Furthermore, updates to the store are sent downstream into a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> changelog stream. |
| <p> |
| To compute the aggregation the corresponding <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> as specified in |
| <a href="#cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)"><code>cogroup(...)</code></a> is used per input stream. |
| The specified <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> is applied once per key, directly before the first input record per key is |
| processed to provide an initial intermediate aggregation result that is used to process the first record. |
| <p> |
| Not all updates might get sent downstream, as an internal cache is used to deduplicate consecutive updates to the |
| same key. |
| The rate of propagated updates depends on your input data rate, the number of distinct keys, the number of |
| parallel running Kafka Streams instances, and the <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>configuration</code></a> parameters for |
| <a href="../StreamsConfig.html#CACHE_MAX_BYTES_BUFFERING_CONFIG"><code>cache size</code></a>, and |
| <a href="../StreamsConfig.html#COMMIT_INTERVAL_MS_CONFIG"><code>commit interval</code></a>. |
| <p> |
| To query the local <a href="../state/ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>ReadOnlyKeyValueStore</code></a> it must be obtained via |
| <a href="../KafkaStreams.html#store(org.apache.kafka.streams.StoreQueryParameters)"><code>KafkaStreams#store(...)</code></a>: |
| <pre><code> |
| KafkaStreams streams = ... // some aggregation on value type double |
| String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance |
| ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore()); |
| K key = "some-key"; |
| ValueAndTimestamp<VOut> aggForKey = localStore.get(key); // key must be local (application state is shared over all running Kafka Streams instances) |
| </code></pre> |
| For non-local keys, a custom RPC mechanism must be implemented using <a href="../KafkaStreams.html#metadataForAllStreamsClients()"><code>KafkaStreams.metadataForAllStreamsClients()</code></a> to query |
| the value of the key on a parallel running instance of your Kafka Streams application. |
| <p> |
| For failure and recovery the store (which always will be of type <a href="../state/TimestampedKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>TimestampedKeyValueStore</code></a> -- regardless of what |
| is specified in the parameter <code>materialized</code>) will be backed by an internal changelog topic that will be created in Kafka. |
| Therefore, the store name defined by the Materialized instance must be a valid Kafka topic name and cannot |
| contain characters other than ASCII alphanumerics, '.', '_' and '-'. |
| The changelog topic will be named "${applicationId}-${storeName}-changelog", where "applicationId" is |
| user-specified in <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>StreamsConfig</code></a> via parameter |
| <a href="../StreamsConfig.html#APPLICATION_ID_CONFIG"><code>APPLICATION_ID_CONFIG</code></a>, "storeName" is the provide store name defined |
| in <code>Materialized</code>, and "-changelog" is a fixed suffix. |
| <p> |
| You can retrieve all generated internal topic names via <a href="../Topology.html#describe()"><code>Topology.describe()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>initializer</code> - an <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> that computes an initial intermediate aggregation |
| result. Cannot be <code>null</code>.</dd> |
| <dd><code>materialized</code> - an instance of <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream"><code>Materialized</code></a> used to materialize a state store. |
| Cannot be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> that contains "update" records with unmodified keys, and values that |
| represent the latest (rolling) aggregate for each key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="aggregate(org.apache.kafka.streams.kstream.Initializer,org.apache.kafka.streams.kstream.Named,org.apache.kafka.streams.kstream.Materialized)"> |
| <h3>aggregate</h3> |
| <div class="member-signature"><span class="return-type"><a href="KTable.html" title="interface in org.apache.kafka.streams.kstream">KTable</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">aggregate</span>​(<span class="parameters"><a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream">Initializer</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>> initializer, |
| <a href="Named.html" title="class in org.apache.kafka.streams.kstream">Named</a> named, |
| <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream">Materialized</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>,​<a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state">KeyValueStore</a><org.apache.kafka.common.utils.Bytes,​byte[]>> materialized)</span></div> |
| <div class="block">Aggregate the values of records in these streams by the grouped key. |
| Records with <code>null</code> key or value are ignored. |
| The result is written into a local <a href="../state/KeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>KeyValueStore</code></a> (which is basically an ever-updating materialized view) |
| that can be queried by the given store name in <code>materialized</code>. |
| Furthermore, updates to the store are sent downstream into a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> changelog stream. |
| <p> |
| To compute the aggregation the corresponding <a href="Aggregator.html" title="interface in org.apache.kafka.streams.kstream"><code>Aggregator</code></a> as specified in |
| <a href="#cogroup(org.apache.kafka.streams.kstream.KGroupedStream,org.apache.kafka.streams.kstream.Aggregator)"><code>cogroup(...)</code></a> is used per input stream. |
| The specified <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> is applied once per key, directly before the first input record per key is |
| processed to provide an initial intermediate aggregation result that is used to process the first record. |
| The specified <a href="Named.html" title="class in org.apache.kafka.streams.kstream"><code>Named</code></a> is used to name the processor combining the grouped streams. |
| <p> |
| Not all updates might get sent downstream, as an internal cache is used to deduplicate consecutive updates to the |
| same key. |
| The rate of propagated updates depends on your input data rate, the number of distinct keys, the number of |
| parallel running Kafka Streams instances, and the <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>configuration</code></a> parameters for |
| <a href="../StreamsConfig.html#CACHE_MAX_BYTES_BUFFERING_CONFIG"><code>cache size</code></a>, and |
| <a href="../StreamsConfig.html#COMMIT_INTERVAL_MS_CONFIG"><code>commit interval</code></a>. |
| <p> |
| To query the local <a href="../state/ReadOnlyKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>ReadOnlyKeyValueStore</code></a> it must be obtained via |
| <a href="../KafkaStreams.html#store(org.apache.kafka.streams.StoreQueryParameters)"><code>KafkaStreams#store(...)</code></a>: |
| <pre><code> |
| KafkaStreams streams = ... // some aggregation on value type double |
| String queryableStoreName = "storeName" // the store name should be the name of the store as defined by the Materialized instance |
| ReadOnlyKeyValueStore<K, ValueAndTimestamp<VOut>> localStore = streams.store(queryableStoreName, QueryableStoreTypes.<K, ValueAndTimestamp<VOut>> timestampedKeyValueStore()); |
| K key = "some-key"; |
| ValueAndTimestamp<VOut> aggForKey = localStore.get(key); // key must be local (application state is shared over all running Kafka Streams instances) |
| </code></pre> |
| For non-local keys, a custom RPC mechanism must be implemented using <a href="../KafkaStreams.html#metadataForAllStreamsClients()"><code>KafkaStreams.metadataForAllStreamsClients()</code></a> to query |
| the value of the key on a parallel running instance of your Kafka Streams application. |
| <p> |
| For failure and recovery the store (which always will be of type <a href="../state/TimestampedKeyValueStore.html" title="interface in org.apache.kafka.streams.state"><code>TimestampedKeyValueStore</code></a> -- regardless of what |
| is specified in the parameter <code>materialized</code>) will be backed by an internal changelog topic that will be created in Kafka. |
| Therefore, the store name defined by the Materialized instance must be a valid Kafka topic name and cannot |
| contain characters other than ASCII alphanumerics, '.', '_' and '-'. |
| The changelog topic will be named "${applicationId}-${storeName}-changelog", where "applicationId" is |
| user-specified in <a href="../StreamsConfig.html" title="class in org.apache.kafka.streams"><code>StreamsConfig</code></a> via parameter |
| <a href="../StreamsConfig.html#APPLICATION_ID_CONFIG"><code>APPLICATION_ID_CONFIG</code></a>, "storeName" is the provide store name defined |
| in <code>Materialized</code>, and "-changelog" is a fixed suffix. |
| <p> |
| You can retrieve all generated internal topic names via <a href="../Topology.html#describe()"><code>Topology.describe()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>initializer</code> - an <a href="Initializer.html" title="interface in org.apache.kafka.streams.kstream"><code>Initializer</code></a> that computes an initial intermediate aggregation |
| result. Cannot be <code>null</code>.</dd> |
| <dd><code>materialized</code> - an instance of <a href="Materialized.html" title="class in org.apache.kafka.streams.kstream"><code>Materialized</code></a> used to materialize a state store. |
| Cannot be <code>null</code>.</dd> |
| <dd><code>named</code> - name the processors. Cannot be <code>null</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>a <a href="KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> that contains "update" records with unmodified keys, and values that |
| represent the latest (rolling) aggregate for each key</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="windowedBy(org.apache.kafka.streams.kstream.Windows)"> |
| <h3>windowedBy</h3> |
| <div class="member-signature"><span class="type-parameters"><W extends <a href="Window.html" title="class in org.apache.kafka.streams.kstream">Window</a>></span> |
| <span class="return-type"><a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">TimeWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">windowedBy</span>​(<span class="parameters"><a href="Windows.html" title="class in org.apache.kafka.streams.kstream">Windows</a><W> windows)</span></div> |
| <div class="block">Create a new <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a> instance that can be used to perform windowed |
| aggregations.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>W</code> - the window type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>windows</code> - the specification of the aggregation <a href="Windows.html" title="class in org.apache.kafka.streams.kstream"><code>Windows</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="windowedBy(org.apache.kafka.streams.kstream.SlidingWindows)"> |
| <h3>windowedBy</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">TimeWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">windowedBy</span>​(<span class="parameters"><a href="SlidingWindows.html" title="class in org.apache.kafka.streams.kstream">SlidingWindows</a> windows)</span></div> |
| <div class="block">Create a new <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a> instance that can be used to perform sliding |
| windowed aggregations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windows</code> - the specification of the aggregation <a href="SlidingWindows.html" title="class in org.apache.kafka.streams.kstream"><code>SlidingWindows</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <a href="TimeWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>TimeWindowedCogroupedKStream</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="windowedBy(org.apache.kafka.streams.kstream.SessionWindows)"> |
| <h3>windowedBy</h3> |
| <div class="member-signature"><span class="return-type"><a href="SessionWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream">SessionWindowedCogroupedKStream</a><<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">K</a>,​<a href="CogroupedKStream.html" title="type parameter in CogroupedKStream">VOut</a>></span> <span class="member-name">windowedBy</span>​(<span class="parameters"><a href="SessionWindows.html" title="class in org.apache.kafka.streams.kstream">SessionWindows</a> windows)</span></div> |
| <div class="block">Create a new <a href="SessionWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>SessionWindowedCogroupedKStream</code></a> instance that can be used to perform session |
| windowed aggregations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windows</code> - the specification of the aggregation <a href="SessionWindows.html" title="class in org.apache.kafka.streams.kstream"><code>SessionWindows</code></a></dd> |
| <dt>Returns:</dt> |
| <dd>an instance of <a href="SessionWindowedCogroupedKStream.html" title="interface in org.apache.kafka.streams.kstream"><code>SessionWindowedCogroupedKStream</code></a></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> |
