| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Overview (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="package index"> |
| <meta name="generator" content="javadoc/PackageIndexWriter"> |
| <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-index-page"> |
| <script type="text/javascript">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 class="nav-bar-cell1-rev">Overview</li> |
| <li>Package</li> |
| <li>Class</li> |
| <li><a href="overview-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#overview">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <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 class="title">kafka 3.5.2 API</h1> |
| </div> |
| <div id="all-packages-table"> |
| <div class="caption"><span>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 all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/clients/admin/package-summary.html">org.apache.kafka.clients.admin</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a Kafka client for performing administrative operations (such as creating topics and configuring brokers) on a Kafka cluster.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/clients/consumer/package-summary.html">org.apache.kafka.clients.consumer</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a Kafka client for consuming records from topics and/or partitions in a Kafka cluster.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/clients/producer/package-summary.html">org.apache.kafka.clients.producer</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a Kafka client for producing records to topics and/or partitions in a Kafka cluster.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/package-summary.html">org.apache.kafka.common</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides shared functionality for Kafka clients and servers.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/acl/package-summary.html">org.apache.kafka.common.acl</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides classes representing Access Control Lists for authorization of clients</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/annotation/package-summary.html">org.apache.kafka.common.annotation</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides annotations used on Kafka APIs.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/config/package-summary.html">org.apache.kafka.common.config</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common mechanisms for defining, parsing, validating, and documenting user-configurable parameters.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/config/provider/package-summary.html">org.apache.kafka.common.config.provider</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a pluggable interface and some implementations for late-binding in configuration values.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/errors/package-summary.html">org.apache.kafka.common.errors</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common exception classes.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/header/package-summary.html">org.apache.kafka.common.header</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides API for application-defined metadata attached to Kafka records.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/metrics/package-summary.html">org.apache.kafka.common.metrics</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides the API used by Kafka clients to emit metrics which are then exposed using the * <a href="org/apache/kafka/common/metrics/MetricsReporter.html" title="interface in org.apache.kafka.common.metrics"><code>MetricsReporter</code></a> interface.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/metrics/stats/package-summary.html">org.apache.kafka.common.metrics.stats</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides methods of statistically aggregating metrics upon emission.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/quota/package-summary.html">org.apache.kafka.common.quota</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides mechanisms for enforcing resource quotas.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/resource/package-summary.html">org.apache.kafka.common.resource</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides client handles representing logical resources in a Kafka cluster.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/auth/package-summary.html">org.apache.kafka.common.security.auth</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interfaces for implementing Kafka authentication mechanisms.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/oauthbearer/package-summary.html">org.apache.kafka.common.security.oauthbearer</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/security/auth/spi/LoginModule.html" title="class or interface in javax.security.auth.spi" class="external-link"><code>LoginModule</code></a> for using OAuth Bearer Token authentication with Kafka clusters.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/oauthbearer/secured/package-summary.html">org.apache.kafka.common.security.oauthbearer.secured</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">This package is deprecated.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/plain/package-summary.html">org.apache.kafka.common.security.plain</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides implementation to use plaintext credentials authentication for securing Kafka clusters.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/scram/package-summary.html">org.apache.kafka.common.security.scram</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides adaptor to use the Salted Challenge Response Authentication Mechanism for securing Kafka clusters.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/security/token/delegation/package-summary.html">org.apache.kafka.common.security.token.delegation</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides mechanism for delegating authorization to a distinct Principal for securing Kafka clusters.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/common/serialization/package-summary.html">org.apache.kafka.common.serialization</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides interface and some implementations of serialization/deserialization routines for various objects.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/components/package-summary.html">org.apache.kafka.connect.components</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common interfaces used to describe pluggable components.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/connector/package-summary.html">org.apache.kafka.connect.connector</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides interfaces for Connector and Task implementations.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/connector/policy/package-summary.html">org.apache.kafka.connect.connector.policy</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interfaces for policies controlling how users can configure connectors.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/data/package-summary.html">org.apache.kafka.connect.data</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides classes for representing data and schemas handled by Connect.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/errors/package-summary.html">org.apache.kafka.connect.errors</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common exception classes for Connect, used by the framework and plugins to communicate failures.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/header/package-summary.html">org.apache.kafka.connect.header</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides an API for application-defined metadata attached to Connect records.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/health/package-summary.html">org.apache.kafka.connect.health</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides an API for describing the state of a running Connect cluster to |
| <a href="org/apache/kafka/connect/rest/ConnectRestExtension.html" title="interface in org.apache.kafka.connect.rest"><code>ConnectRestExtension</code></a> instances.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/mirror/package-summary.html">org.apache.kafka.connect.mirror</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/rest/package-summary.html">org.apache.kafka.connect.rest</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a pluggable interface for altering the behavior of the Connect REST API.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/sink/package-summary.html">org.apache.kafka.connect.sink</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides an API for implementing sink connectors which write Kafka records to external applications.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/source/package-summary.html">org.apache.kafka.connect.source</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides an API for implementing source connectors which read data from external applications into Kafka.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/storage/package-summary.html">org.apache.kafka.connect.storage</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interfaces and some implementations for (de)serializing data to and from Kafka</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/transforms/package-summary.html">org.apache.kafka.connect.transforms</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a pluggable interface for altering data which is being moved by Connect.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/transforms/predicates/package-summary.html">org.apache.kafka.connect.transforms.predicates</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a pluggable interface for describing when a <a href="org/apache/kafka/connect/transforms/Transformation.html" title="interface in org.apache.kafka.connect.transforms"><code>Transformation</code></a> should be applied to a record.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/connect/util/package-summary.html">org.apache.kafka.connect.util</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common utilities that can be used in component implementations.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/server/authorizer/package-summary.html">org.apache.kafka.server.authorizer</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interface for performing authorization on a Kafka server.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/server/log/remote/storage/package-summary.html">org.apache.kafka.server.log.remote.storage</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a pluggable API for defining remote storage and retrieval of Kafka log segments.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/server/policy/package-summary.html">org.apache.kafka.server.policy</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interfaces for expressing policies on topics and configs.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/server/quota/package-summary.html">org.apache.kafka.server.quota</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides pluggable interface for enforcing client quotas from a Kafka server.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/package-summary.html">org.apache.kafka.streams</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides the Kafka Streams library for building streaming data applications.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/errors/package-summary.html">org.apache.kafka.streams.errors</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides common exception classes for Streams applications.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/kstream/package-summary.html">org.apache.kafka.streams.kstream</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides a high-level programming model (DSL) to express a (stateful) data flow computation over input <a href="org/apache/kafka/streams/kstream/KStream.html" title="interface in org.apache.kafka.streams.kstream"><code>streams</code></a> and <a href="org/apache/kafka/streams/kstream/KTable.html" title="interface in org.apache.kafka.streams.kstream"><code>tables</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/processor/package-summary.html">org.apache.kafka.streams.processor</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <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 all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/processor/api/package-summary.html">org.apache.kafka.streams.processor.api</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <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 all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/query/package-summary.html">org.apache.kafka.streams.query</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <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 all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/state/package-summary.html">org.apache.kafka.streams.state</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides interfaces for managing the intermediate state of a stateful streams application.</div> |
| </div> |
| <div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/streams/test/package-summary.html">org.apache.kafka.streams.test</a></div> |
| <div class="col-last odd-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides classes for testing Kafka Streams applications with mocked inputs.</div> |
| </div> |
| <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="org/apache/kafka/tools/api/package-summary.html">org.apache.kafka.tools.api</a></div> |
| <div class="col-last even-row-color all-packages-table all-packages-table-tab1"> |
| <div class="block">Provides interfaces for writing plugins of kafka tools</div> |
| </div> |
| </div> |
| </div> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
