| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.kafka.streams (kafka 3.5.2 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"> |
| <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" class="title">Package org.apache.kafka.streams</h1> |
| </div> |
| <hr> |
| <div class="package-signature">package <span class="element-name">org.apache.kafka.streams</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">Provides the Kafka Streams library for building streaming data applications.</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="errors/package-summary.html">org.apache.kafka.streams.errors</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Provides common exception classes for Streams applications.</div> |
| </div> |
| <div class="col-first odd-row-color"><a href="kstream/package-summary.html">org.apache.kafka.streams.kstream</a></div> |
| <div class="col-last odd-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 even-row-color"><a href="processor/package-summary.html">org.apache.kafka.streams.processor</a></div> |
| <div class="col-last even-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 odd-row-color"><a href="query/package-summary.html">org.apache.kafka.streams.query</a></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Provides a query API (aka Interactive Queries) over state stores, for extracting data from a stateful Kafka Streams application.</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-tab1"><a href="KafkaClientSupplier.html" title="interface in org.apache.kafka.streams">KafkaClientSupplier</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block"><code>KafkaClientSupplier</code> can be used to provide custom Kafka clients to a <a href="KafkaStreams.html" title="class in org.apache.kafka.streams"><code>KafkaStreams</code></a> instance.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KafkaStreams.html" title="class in org.apache.kafka.streams">KafkaStreams</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A Kafka client that allows for performing continuous computation on input coming from one or more input topics and |
| sends output to zero, one, or more output topics.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaStreams.CloseOptions.html" title="class in org.apache.kafka.streams">KafkaStreams.CloseOptions</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Class that handles options passed in case of <code>KafkaStreams</code> instance scale down</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="KafkaStreams.State.html" title="enum class in org.apache.kafka.streams">KafkaStreams.State</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Kafka Streams states are the possible state that a Kafka Streams instance can be in.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="KafkaStreams.StateListener.html" title="interface in org.apache.kafka.streams">KafkaStreams.StateListener</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Listen to <a href="KafkaStreams.State.html" title="enum class in org.apache.kafka.streams"><code>KafkaStreams.State</code></a> change events.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KeyQueryMetadata.html" title="class in org.apache.kafka.streams">KeyQueryMetadata</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Represents all the metadata related to a key, where a particular key resides in a <a href="KafkaStreams.html" title="class in org.apache.kafka.streams"><code>KafkaStreams</code></a> application.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="KeyValue.html" title="class in org.apache.kafka.streams">KeyValue</a><K,<wbr>V></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A key-value pair defined for a single Kafka Streams record.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LagInfo.html" title="class in org.apache.kafka.streams">LagInfo</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Encapsulates information about lag, at a store partition replica (active or standby).</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StoreQueryParameters.html" title="class in org.apache.kafka.streams">StoreQueryParameters</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>StoreQueryParameters</code> allows you to pass a variety of parameters when fetching a store for interactive query.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StreamsBuilder.html" title="class in org.apache.kafka.streams">StreamsBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>StreamsBuilder</code> provide the high-level Kafka Streams DSL to specify a Kafka Streams topology.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="StreamsConfig.html" title="class in org.apache.kafka.streams">StreamsConfig</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Configuration for a <a href="KafkaStreams.html" title="class in org.apache.kafka.streams"><code>KafkaStreams</code></a> instance.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StreamsConfig.InternalConfig.html" title="class in org.apache.kafka.streams">StreamsConfig.InternalConfig</a></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-tab1"><a href="StreamsMetadata.html" title="interface in org.apache.kafka.streams">StreamsMetadata</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Metadata of a Kafka Streams client.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="StreamsMetrics.html" title="interface in org.apache.kafka.streams">StreamsMetrics</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">The Kafka Streams metrics interface for adding metric sensors and collecting metric values.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TaskMetadata.html" title="interface in org.apache.kafka.streams">TaskMetadata</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Metadata of a task.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TestInputTopic.html" title="class in org.apache.kafka.streams">TestInputTopic</a><K,<wbr>V></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>TestInputTopic</code> is used to pipe records to topic in <a href="TopologyTestDriver.html" title="class in org.apache.kafka.streams"><code>TopologyTestDriver</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TestOutputTopic.html" title="class in org.apache.kafka.streams">TestOutputTopic</a><K,<wbr>V></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block"><code>TestOutputTopic</code> is used to read records from a topic in <a href="TopologyTestDriver.html" title="class in org.apache.kafka.streams"><code>TopologyTestDriver</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="ThreadMetadata.html" title="interface in org.apache.kafka.streams">ThreadMetadata</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Metadata of a stream thread.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Topology.html" title="class in org.apache.kafka.streams">Topology</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">A logical representation of a <code>ProcessorTopology</code>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Topology.AutoOffsetReset.html" title="enum class in org.apache.kafka.streams">Topology.AutoOffsetReset</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab3"> |
| <div class="block">Sets the <code>auto.offset.reset</code> configuration when |
| <a href="Topology.html#addSource(org.apache.kafka.streams.Topology.AutoOffsetReset,java.lang.String,java.lang.String...)"><code>adding a source processor</code></a> or when creating <a href="kstream/KStream.html" title="interface in org.apache.kafka.streams.kstream"><code>KStream</code></a> |
| or <a href="kstream/KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>KTable</code></a> via <a href="StreamsBuilder.html" title="class in org.apache.kafka.streams"><code>StreamsBuilder</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopologyConfig.html" title="class in org.apache.kafka.streams">TopologyConfig</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Streams configs that apply at the topology level.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopologyConfig.TaskConfig.html" title="class in org.apache.kafka.streams">TopologyConfig.TaskConfig</a></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-tab1"><a href="TopologyDescription.html" title="interface in org.apache.kafka.streams">TopologyDescription</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A meta representation of a <a href="Topology.html" title="class in org.apache.kafka.streams"><code>topology</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TopologyDescription.GlobalStore.html" title="interface in org.apache.kafka.streams">TopologyDescription.GlobalStore</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Represents a <a href="Topology.html#addGlobalStore(org.apache.kafka.streams.state.StoreBuilder,java.lang.String,org.apache.kafka.common.serialization.Deserializer,org.apache.kafka.common.serialization.Deserializer,java.lang.String,java.lang.String,org.apache.kafka.streams.processor.api.ProcessorSupplier)"><code>global store</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TopologyDescription.Node.html" title="interface in org.apache.kafka.streams">TopologyDescription.Node</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A node of a topology.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TopologyDescription.Processor.html" title="interface in org.apache.kafka.streams">TopologyDescription.Processor</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A processor node of a topology.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TopologyDescription.Sink.html" title="interface in org.apache.kafka.streams">TopologyDescription.Sink</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A sink node of a topology.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="TopologyDescription.Source.html" title="interface in org.apache.kafka.streams">TopologyDescription.Source</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">A source node of a topology.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TopologyDescription.Subtopology.html" title="interface in org.apache.kafka.streams">TopologyDescription.Subtopology</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">A connected sub-graph of a <a href="Topology.html" title="class in org.apache.kafka.streams"><code>Topology</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopologyTestDriver.html" title="class in org.apache.kafka.streams">TopologyTestDriver</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">This class makes it easier to write tests to verify the behavior of topologies created with <a href="Topology.html" title="class in org.apache.kafka.streams"><code>Topology</code></a> or |
| <a href="StreamsBuilder.html" title="class in org.apache.kafka.streams"><code>StreamsBuilder</code></a>.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
