blob: 4de728b061abe3d484b32303d64d24be8fe7e1b1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.kafka.common (kafka 3.6.1 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.common">
<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:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</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.common" class="title">Package org.apache.kafka.common</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.kafka.common</span></div>
<section class="package-description" id="package-description">
<div class="block">Provides shared functionality for Kafka clients and servers.</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="acl/package-summary.html">org.apache.kafka.common.acl</a></div>
<div class="col-last even-row-color">
<div class="block">Provides classes representing Access Control Lists for authorization of clients</div>
</div>
<div class="col-first odd-row-color"><a href="annotation/package-summary.html">org.apache.kafka.common.annotation</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides annotations used on Kafka APIs.</div>
</div>
<div class="col-first even-row-color"><a href="config/package-summary.html">org.apache.kafka.common.config</a></div>
<div class="col-last even-row-color">
<div class="block">Provides common mechanisms for defining, parsing, validating, and documenting user-configurable parameters.</div>
</div>
<div class="col-first odd-row-color"><a href="errors/package-summary.html">org.apache.kafka.common.errors</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides common exception classes.</div>
</div>
<div class="col-first even-row-color"><a href="header/package-summary.html">org.apache.kafka.common.header</a></div>
<div class="col-last even-row-color">
<div class="block">Provides API for application-defined metadata attached to Kafka records.</div>
</div>
<div class="col-first odd-row-color"><a href="metrics/package-summary.html">org.apache.kafka.common.metrics</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides the API used by Kafka clients to emit metrics which are then exposed using the * <a href="metrics/MetricsReporter.html" title="interface in org.apache.kafka.common.metrics"><code>MetricsReporter</code></a> interface.</div>
</div>
<div class="col-first even-row-color"><a href="quota/package-summary.html">org.apache.kafka.common.quota</a></div>
<div class="col-last even-row-color">
<div class="block">Provides mechanisms for enforcing resource quotas.</div>
</div>
<div class="col-first odd-row-color"><a href="resource/package-summary.html">org.apache.kafka.common.resource</a></div>
<div class="col-last odd-row-color">
<div class="block">Provides client handles representing logical resources in a Kafka cluster.</div>
</div>
<div class="col-first even-row-color"><a href="serialization/package-summary.html">org.apache.kafka.common.serialization</a></div>
<div class="col-last even-row-color">
<div class="block">Provides interface and some implementations of serialization/deserialization routines for various objects.</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><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</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-tab2"><a href="Cluster.html" title="class in org.apache.kafka.common">Cluster</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An immutable representation of a subset of the nodes, topics, and partitions in the Kafka cluster.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ClusterResource.html" title="class in org.apache.kafka.common">ClusterResource</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The <code>ClusterResource</code> class encapsulates metadata for a Kafka cluster.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ClusterResourceListener.html" title="interface in org.apache.kafka.common">ClusterResourceListener</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A callback interface that users can implement when they wish to get notified about changes in the Cluster metadata.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A Mix-in style interface for classes that are instantiated by reflection and need to take configuration parameters</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ConsumerGroupState.html" title="enum class in org.apache.kafka.common">ConsumerGroupState</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">The consumer group state.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ElectionType.html" title="enum class in org.apache.kafka.common">ElectionType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Options for <a href="../clients/admin/Admin.html#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)"><code>Admin.electLeaders(ElectionType, Set, org.apache.kafka.clients.admin.ElectLeadersOptions)</code></a>.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Endpoint.html" title="class in org.apache.kafka.common">Endpoint</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Represents a broker endpoint.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="InvalidRecordException.html" title="class in org.apache.kafka.common">InvalidRecordException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="IsolationLevel.html" title="enum class in org.apache.kafka.common">IsolationLevel</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="KafkaException.html" title="class in org.apache.kafka.common">KafkaException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">The base class of all other Kafka exceptions</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A flexible future which supports call chaining and other asynchronous programming patterns.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="KafkaFuture.BaseFunction.html" title="interface in org.apache.kafka.common">KafkaFuture.BaseFunction</a>&lt;A,<wbr>B&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A function which takes objects of type A and returns objects of type B.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="KafkaFuture.BiConsumer.html" title="interface in org.apache.kafka.common">KafkaFuture.BiConsumer</a>&lt;A,<wbr>B&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">A consumer of two different types of object.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="KafkaFuture.Function.html" title="class in org.apache.kafka.common">KafkaFuture.Function</a>&lt;A,<wbr>B&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab2">Deprecated.
<div class="deprecation-comment">Since Kafka 3.0.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="MessageFormatter.html" title="interface in org.apache.kafka.common">MessageFormatter</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">This interface allows to define Formatters that can be used to parse and format records read by a
Consumer instance for display.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="Metric.html" title="interface in org.apache.kafka.common">Metric</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">A metric tracked for monitoring purposes.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MetricName.html" title="class in org.apache.kafka.common">MetricName</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">The <code>MetricName</code> class encapsulates a metric's name, logical group and its related attributes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MetricNameTemplate.html" title="class in org.apache.kafka.common">MetricNameTemplate</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A template for a MetricName.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Node.html" title="class in org.apache.kafka.common">Node</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Information about a Kafka node</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PartitionInfo.html" title="class in org.apache.kafka.common">PartitionInfo</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This is used to describe per-partition state in the MetadataResponse.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Interface for reconfigurable classes that support dynamic configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A class used to represent a collection of topics.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopicCollection.TopicIdCollection.html" title="class in org.apache.kafka.common">TopicCollection.TopicIdCollection</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A class used to represent a collection of topics defined by their topic ID.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopicCollection.TopicNameCollection.html" title="class in org.apache.kafka.common">TopicCollection.TopicNameCollection</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A class used to represent a collection of topics defined by their topic name.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopicIdPartition.html" title="class in org.apache.kafka.common">TopicIdPartition</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This represents universally unique identifier with topic id for a topic partition.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A topic name and partition number</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TopicPartitionInfo.html" title="class in org.apache.kafka.common">TopicPartitionInfo</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A class containing leadership, replicas and ISR information for a topic partition.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The topic name, partition number and the brokerId of the replica</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Uuid.html" title="class in org.apache.kafka.common">Uuid</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This class defines an immutable universally unique identifier (UUID).</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
</div>
</div>
</body>
</html>