| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.kafka.streams.query (kafka 3.5.0 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.streams.query"> |
| <meta name="generator" content="javadoc/PackageWriterImpl"> |
| <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="package-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-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 class="nav-bar-cell1-rev">Package</li> |
| <li>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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" 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"> |
| <div class="header"> |
| <h1 title="Package org.apache.kafka.streams.query" class="title">Package org.apache.kafka.streams.query</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.kafka.streams.query</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides a query API (aka Interactive Queries) over state stores, for extracting data from a stateful Kafka Streams application.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.kafka.streams</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides the Kafka Streams library for building streaming data applications.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../errors/package-summary.html">org.apache.kafka.streams.errors</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Provides common exception classes for Streams applications.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../kstream/package-summary.html">org.apache.kafka.streams.kstream</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides a high-level programming model (DSL) to express a (stateful) data flow computation over input <a href="../kstream/KStream.html" title="interface in org.apache.kafka.streams.kstream"><code>streams</code></a> and <a href="../kstream/KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>tables</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../processor/package-summary.html">org.apache.kafka.streams.processor</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Provides a low-level programming model (Processor API, aka, PAPI) to express a (stateful) data flow computation over input topics.</div> |
| </div> |
| <div class="col-first even-row-color"><a href="../state/package-summary.html">org.apache.kafka.streams.state</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides interfaces for managing the intermediate state of a stateful streams application.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="../test/package-summary.html">org.apache.kafka.streams.test</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Provides classes for testing Kafka Streams applications with mocked inputs.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab3"><a href="FailureReason.html" title="enum class in org.apache.kafka.streams.query">FailureReason</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab3"> |
| <div class="block">This enumeration type captures the various top-level reasons that a particular |
| partition of a store would fail to execute a query.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KeyQuery.html" title="class in org.apache.kafka.streams.query">KeyQuery</a><K,<wbr>V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Interactive query for retrieving a single record based on its key.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Position.html" title="class in org.apache.kafka.streams.query">Position</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A representation of a position vector with respect to a set of topic partitions.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PositionBound.html" title="class in org.apache.kafka.streams.query">PositionBound</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A class bounding the processing state <a href="Position.html" title="class in org.apache.kafka.streams.query"><code>Position</code></a> during queries.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="Query.html" title="interface in org.apache.kafka.streams.query">Query</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Marker interface that all interactive queries must implement (see <a href="../KafkaStreams.html#query(org.apache.kafka.streams.query.StateQueryRequest)"><code>KafkaStreams.query(StateQueryRequest)</code></a>).</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="QueryConfig.html" title="class in org.apache.kafka.streams.query">QueryConfig</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Runtime configuration parameters</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="QueryResult.html" title="interface in org.apache.kafka.streams.query">QueryResult</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Container for a single partition's result when executing a <a href="StateQueryRequest.html" title="class in org.apache.kafka.streams.query"><code>StateQueryRequest</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RangeQuery.html" title="class in org.apache.kafka.streams.query">RangeQuery</a><K,<wbr>V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Interactive query for issuing range queries and scans over KeyValue stores.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StateQueryRequest.html" title="class in org.apache.kafka.streams.query">StateQueryRequest</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The request object for Interactive Queries.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StateQueryRequest.InStore.html" title="class in org.apache.kafka.streams.query">StateQueryRequest.InStore</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A progressive builder interface for creating <code>StoreQueryRequest</code>s.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StateQueryResult.html" title="class in org.apache.kafka.streams.query">StateQueryResult</a><R></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The response object for interactive queries.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="WindowKeyQuery.html" title="class in org.apache.kafka.streams.query">WindowKeyQuery</a><K,<wbr>V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="WindowRangeQuery.html" title="class in org.apache.kafka.streams.query">WindowRangeQuery</a><K,<wbr>V></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
