blob: 8b2713160da978ec12fcf5abcfa0515f93c209b7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (18) -->
<title>ForwardingAdmin (kafka 3.7.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.clients.admin, class: ForwardingAdmin">
<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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button>
<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#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</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>&nbsp;<a href="package-summary.html">org.apache.kafka.clients.admin</a></div>
<h1 title="Class ForwardingAdmin" class="title">Class ForwardingAdmin</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.kafka.clients.admin.ForwardingAdmin</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ForwardingAdmin</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></span></div>
<div class="block"><code>ForwardingAdmin</code> is the default value of <code>forwarding.admin.class</code> in MirrorMaker.
Users who wish to customize the MirrorMaker behaviour for the creation of topics and access control lists can extend this
class without needing to provide a whole implementation of <code>Admin</code>.
The class must have a constructor with signature <code>(Map&lt;String, Object&gt; config)</code> for configuring
a decorated <a href="KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin"><code>KafkaAdminClient</code></a> and any other clients needed for external resource management.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.Map)" class="member-name-link">ForwardingAdmin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;configs)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AbortTransactionResult.html" title="class in org.apache.kafka.clients.admin">AbortTransactionResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec,org.apache.kafka.clients.admin.AbortTransactionOptions)" class="member-name-link">abortTransaction</a><wbr>(<a href="AbortTransactionSpec.html" title="class in org.apache.kafka.clients.admin">AbortTransactionSpec</a>&nbsp;spec,
<a href="AbortTransactionOptions.html" title="class in org.apache.kafka.clients.admin">AbortTransactionOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Forcefully abort a transaction which is open on a topic partition.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#alterClientQuotas(java.util.Collection,org.apache.kafka.clients.admin.AlterClientQuotasOptions)" class="member-name-link">alterClientQuotas</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/quota/ClientQuotaAlteration.html" title="class in org.apache.kafka.common.quota">ClientQuotaAlteration</a>&gt;&nbsp;entries,
<a href="AlterClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Alters client quota configurations with the specified alterations.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#alterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)" class="member-name-link">alterConfigs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<wbr><a href="Config.html" title="class in org.apache.kafka.clients.admin">Config</a>&gt;&nbsp;configs,
<a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#alterConsumerGroupOffsets(java.lang.String,java.util.Map,org.apache.kafka.clients.admin.AlterConsumerGroupOffsetsOptions)" class="member-name-link">alterConsumerGroupOffsets</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="../consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>&gt;&nbsp;offsets,
<a href="AlterConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Alters offsets for the specified group.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#alterPartitionReassignments(java.util.Map,org.apache.kafka.clients.admin.AlterPartitionReassignmentsOptions)" class="member-name-link">alterPartitionReassignments</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="NewPartitionReassignment.html" title="class in org.apache.kafka.clients.admin">NewPartitionReassignment</a>&gt;&gt;&nbsp;reassignments,
<a href="AlterPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Change the reassignments for one or more partitions.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#alterReplicaLogDirs(java.util.Map,org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions)" class="member-name-link">alterReplicaLogDirs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;replicaAssignment,
<a href="AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Change the log directory for the specified replicas.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#alterUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.AlterUserScramCredentialsOptions)" class="member-name-link">alterUserScramCredentials</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="UserScramCredentialAlteration.html" title="class in org.apache.kafka.clients.admin">UserScramCredentialAlteration</a>&gt;&nbsp;alterations,
<a href="AlterUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Alter SASL/SCRAM credentials.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../common/Uuid.html" title="class in org.apache.kafka.common">Uuid</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clientInstanceId(java.time.Duration)" class="member-name-link">clientInstanceId</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;timeout)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Determines the client's unique client instance ID used for telemetry.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close(java.time.Duration)" class="member-name-link">close</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;timeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Close the Admin client and release all associated resources.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createAcls(java.util.Collection,org.apache.kafka.clients.admin.CreateAclsOptions)" class="member-name-link">createAcls</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>&gt;&nbsp;acls,
<a href="CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Creates access control lists (ACLs) which are bound to specific resources.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CreateDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createDelegationToken(org.apache.kafka.clients.admin.CreateDelegationTokenOptions)" class="member-name-link">createDelegationToken</a><wbr>(<a href="CreateDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create a Delegation Token.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createPartitions(java.util.Map,org.apache.kafka.clients.admin.CreatePartitionsOptions)" class="member-name-link">createPartitions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>&gt;&nbsp;newPartitions,
<a href="CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Increase the number of partitions of the topics given as the keys of <code>newPartitions</code>
according to the corresponding values.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createTopics(java.util.Collection,org.apache.kafka.clients.admin.CreateTopicsOptions)" class="member-name-link">createTopics</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>&gt;&nbsp;newTopics,
<a href="CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create a batch of new topics.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteAcls(java.util.Collection,org.apache.kafka.clients.admin.DeleteAclsOptions)" class="member-name-link">deleteAcls</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>&gt;&nbsp;filters,
<a href="DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Deletes access control lists (ACLs) according to the supplied filters.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeleteConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteConsumerGroupOffsets(java.lang.String,java.util.Set,org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions)" class="member-name-link">deleteConsumerGroupOffsets</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="DeleteConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Delete committed offsets for a set of partitions in a consumer group.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeleteConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions)" class="member-name-link">deleteConsumerGroups</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;groupIds,
<a href="DeleteConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Delete consumer groups from the cluster.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeleteRecordsResult.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteRecords(java.util.Map,org.apache.kafka.clients.admin.DeleteRecordsOptions)" class="member-name-link">deleteRecords</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="RecordsToDelete.html" title="class in org.apache.kafka.clients.admin">RecordsToDelete</a>&gt;&nbsp;recordsToDelete,
<a href="DeleteRecordsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Delete records whose offset is smaller than the given offset of the corresponding partition.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DeleteTopicsOptions)" class="member-name-link">deleteTopics</a><wbr>(<a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a>&nbsp;topics,
<a href="DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Delete a batch of topics.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,org.apache.kafka.clients.admin.DescribeAclsOptions)" class="member-name-link">describeAcls</a><wbr>(<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>&nbsp;filter,
<a href="DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Lists access control lists (ACLs) according to the supplied filter.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter,org.apache.kafka.clients.admin.DescribeClientQuotasOptions)" class="member-name-link">describeClientQuotas</a><wbr>(<a href="../../common/quota/ClientQuotaFilter.html" title="class in org.apache.kafka.common.quota">ClientQuotaFilter</a>&nbsp;filter,
<a href="DescribeClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describes all entities matching the provided filter that have at least one client quota configuration
value defined.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)" class="member-name-link">describeCluster</a><wbr>(<a href="DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get information about the nodes in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeConfigs(java.util.Collection,org.apache.kafka.clients.admin.DescribeConfigsOptions)" class="member-name-link">describeConfigs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>&gt;&nbsp;resources,
<a href="DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the configuration for the specified resources.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DescribeConsumerGroupsOptions)" class="member-name-link">describeConsumerGroups</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;groupIds,
<a href="DescribeConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe some group IDs in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeDelegationToken(org.apache.kafka.clients.admin.DescribeDelegationTokenOptions)" class="member-name-link">describeDelegationToken</a><wbr>(<a href="DescribeDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe the Delegation Tokens.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)" class="member-name-link">describeFeatures</a><wbr>(<a href="DescribeFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describes finalized as well as supported features.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeLogDirsOptions)" class="member-name-link">describeLogDirs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;brokers,
<a href="DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Query the information of all log directories on the given set of brokers</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeMetadataQuorumResult.html" title="class in org.apache.kafka.clients.admin">DescribeMetadataQuorumResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeMetadataQuorum(org.apache.kafka.clients.admin.DescribeMetadataQuorumOptions)" class="member-name-link">describeMetadataQuorum</a><wbr>(<a href="DescribeMetadataQuorumOptions.html" title="class in org.apache.kafka.clients.admin">DescribeMetadataQuorumOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describes the state of the metadata quorum.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeProducersResult.html" title="class in org.apache.kafka.clients.admin">DescribeProducersResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeProducers(java.util.Collection,org.apache.kafka.clients.admin.DescribeProducersOptions)" class="member-name-link">describeProducers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="DescribeProducersOptions.html" title="class in org.apache.kafka.clients.admin">DescribeProducersOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe active producer state on a set of topic partitions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeReplicaLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions)" class="member-name-link">describeReplicaLogDirs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>&gt;&nbsp;replicas,
<a href="DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Query the replica log directory information for the specified replicas.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DescribeTopicsOptions)" class="member-name-link">describeTopics</a><wbr>(<a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a>&nbsp;topics,
<a href="DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe some topics in the cluster.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeTransactionsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeTransactions(java.util.Collection,org.apache.kafka.clients.admin.DescribeTransactionsOptions)" class="member-name-link">describeTransactions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;transactionalIds,
<a href="DescribeTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe the state of a set of transactional IDs from the respective transaction coordinators,
which are dynamically discovered.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="DescribeUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describeUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.DescribeUserScramCredentialsOptions)" class="member-name-link">describeUserScramCredentials</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;users,
<a href="DescribeUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Describe SASL/SCRAM credentials.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ElectLeadersResult.html" title="class in org.apache.kafka.clients.admin">ElectLeadersResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)" class="member-name-link">electLeaders</a><wbr>(<a href="../../common/ElectionType.html" title="enum class in org.apache.kafka.common">ElectionType</a>&nbsp;electionType,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="ElectLeadersOptions.html" title="class in org.apache.kafka.clients.admin">ElectLeadersOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Elect a replica as leader for the given <code>partitions</code>, or for all partitions if the argument
to <code>partitions</code> is null.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ExpireDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expireDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.ExpireDelegationTokenOptions)" class="member-name-link">expireDelegationToken</a><wbr>(byte[]&nbsp;hmac,
<a href="ExpireDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Expire a Delegation Token.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="FenceProducersResult.html" title="class in org.apache.kafka.clients.admin">FenceProducersResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fenceProducers(java.util.Collection,org.apache.kafka.clients.admin.FenceProducersOptions)" class="member-name-link">fenceProducers</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;transactionalIds,
<a href="FenceProducersOptions.html" title="class in org.apache.kafka.clients.admin">FenceProducersOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Fence out all active producers that use any of the provided transactional IDs.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#incrementalAlterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)" class="member-name-link">incrementalAlterConfigs</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="AlterConfigOp.html" title="class in org.apache.kafka.clients.admin">AlterConfigOp</a>&gt;&gt;&nbsp;configs,
<a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Incrementally update the configuration for the specified resources.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListClientMetricsResourcesResult.html" title="class in org.apache.kafka.clients.admin">ListClientMetricsResourcesResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listClientMetricsResources(org.apache.kafka.clients.admin.ListClientMetricsResourcesOptions)" class="member-name-link">listClientMetricsResources</a><wbr>(<a href="ListClientMetricsResourcesOptions.html" title="class in org.apache.kafka.clients.admin">ListClientMetricsResourcesOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List the client metrics configuration resources available in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listConsumerGroupOffsets(java.util.Map,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)" class="member-name-link">listConsumerGroupOffsets</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ListConsumerGroupOffsetsSpec.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsSpec</a>&gt;&nbsp;groupSpecs,
<a href="ListConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List the consumer group offsets available in the cluster for the specified consumer groups.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listConsumerGroups(org.apache.kafka.clients.admin.ListConsumerGroupsOptions)" class="member-name-link">listConsumerGroups</a><wbr>(<a href="ListConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List the consumer groups available in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListOffsetsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listOffsets(java.util.Map,org.apache.kafka.clients.admin.ListOffsetsOptions)" class="member-name-link">listOffsets</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="OffsetSpec.html" title="class in org.apache.kafka.clients.admin">OffsetSpec</a>&gt;&nbsp;topicPartitionOffsets,
<a href="ListOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListOffsetsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List offset for the specified partitions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listPartitionReassignments(java.util.Optional,org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)" class="member-name-link">listPartitionReassignments</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&gt;&nbsp;partitions,
<a href="ListPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)" class="member-name-link">listTopics</a><wbr>(<a href="ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List the topics available in the cluster.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ListTransactionsResult.html" title="class in org.apache.kafka.clients.admin">ListTransactionsResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#listTransactions(org.apache.kafka.clients.admin.ListTransactionsOptions)" class="member-name-link">listTransactions</a><wbr>(<a href="ListTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">ListTransactionsOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">List active transactions in the cluster.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,<wbr>? extends <a href="../../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#metrics()" class="member-name-link">metrics</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the metrics kept by the adminClient</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RemoveMembersFromConsumerGroupResult.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeMembersFromConsumerGroup(java.lang.String,org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions)" class="member-name-link">removeMembersFromConsumerGroup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="RemoveMembersFromConsumerGroupOptions.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Remove members from the consumer group by given member identities.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RenewDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#renewDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.RenewDelegationTokenOptions)" class="member-name-link">renewDelegationToken</a><wbr>(byte[]&nbsp;hmac,
<a href="RenewDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Renew a Delegation Token.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerResult</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)" class="member-name-link">unregisterBroker</a><wbr>(int&nbsp;brokerId,
<a href="UnregisterBrokerOptions.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerOptions</a>&nbsp;options)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Unregister a broker.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesResult</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateFeatures(java.util.Map,org.apache.kafka.clients.admin.UpdateFeaturesOptions)" class="member-name-link">updateFeatures</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin">FeatureUpdate</a>&gt;&nbsp;featureUpdates,
<a href="UpdateFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesOptions</a>&nbsp;options)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Applies specified updates to finalized features.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.kafka.clients.admin.Admin">Methods inherited from interface&nbsp;org.apache.kafka.clients.admin.<a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></h3>
<code><a href="Admin.html#abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec)">abortTransaction</a>, <a href="Admin.html#alterClientQuotas(java.util.Collection)">alterClientQuotas</a>, <a href="Admin.html#alterConfigs(java.util.Map)">alterConfigs</a>, <a href="Admin.html#alterConsumerGroupOffsets(java.lang.String,java.util.Map)">alterConsumerGroupOffsets</a>, <a href="Admin.html#alterPartitionReassignments(java.util.Map)">alterPartitionReassignments</a>, <a href="Admin.html#alterReplicaLogDirs(java.util.Map)">alterReplicaLogDirs</a>, <a href="Admin.html#alterUserScramCredentials(java.util.List)">alterUserScramCredentials</a>, <a href="Admin.html#close()">close</a>, <a href="Admin.html#createAcls(java.util.Collection)">createAcls</a>, <a href="Admin.html#createDelegationToken()">createDelegationToken</a>, <a href="Admin.html#createPartitions(java.util.Map)">createPartitions</a>, <a href="Admin.html#createTopics(java.util.Collection)">createTopics</a>, <a href="Admin.html#deleteAcls(java.util.Collection)">deleteAcls</a>, <a href="Admin.html#deleteConsumerGroupOffsets(java.lang.String,java.util.Set)">deleteConsumerGroupOffsets</a>, <a href="Admin.html#deleteConsumerGroups(java.util.Collection)">deleteConsumerGroups</a>, <a href="Admin.html#deleteRecords(java.util.Map)">deleteRecords</a>, <a href="Admin.html#deleteTopics(java.util.Collection)">deleteTopics</a>, <a href="Admin.html#deleteTopics(java.util.Collection,org.apache.kafka.clients.admin.DeleteTopicsOptions)">deleteTopics</a>, <a href="Admin.html#deleteTopics(org.apache.kafka.common.TopicCollection)">deleteTopics</a>, <a href="Admin.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter)">describeAcls</a>, <a href="Admin.html#describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter)">describeClientQuotas</a>, <a href="Admin.html#describeCluster()">describeCluster</a>, <a href="Admin.html#describeConfigs(java.util.Collection)">describeConfigs</a>, <a href="Admin.html#describeConsumerGroups(java.util.Collection)">describeConsumerGroups</a>, <a href="Admin.html#describeDelegationToken()">describeDelegationToken</a>, <a href="Admin.html#describeFeatures()">describeFeatures</a>, <a href="Admin.html#describeLogDirs(java.util.Collection)">describeLogDirs</a>, <a href="Admin.html#describeMetadataQuorum()">describeMetadataQuorum</a>, <a href="Admin.html#describeProducers(java.util.Collection)">describeProducers</a>, <a href="Admin.html#describeReplicaLogDirs(java.util.Collection)">describeReplicaLogDirs</a>, <a href="Admin.html#describeTopics(java.util.Collection)">describeTopics</a>, <a href="Admin.html#describeTopics(java.util.Collection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">describeTopics</a>, <a href="Admin.html#describeTopics(org.apache.kafka.common.TopicCollection)">describeTopics</a>, <a href="Admin.html#describeTransactions(java.util.Collection)">describeTransactions</a>, <a href="Admin.html#describeUserScramCredentials()">describeUserScramCredentials</a>, <a href="Admin.html#describeUserScramCredentials(java.util.List)">describeUserScramCredentials</a>, <a href="Admin.html#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set)">electLeaders</a>, <a href="Admin.html#expireDelegationToken(byte%5B%5D)">expireDelegationToken</a>, <a href="Admin.html#fenceProducers(java.util.Collection)">fenceProducers</a>, <a href="Admin.html#incrementalAlterConfigs(java.util.Map)">incrementalAlterConfigs</a>, <a href="Admin.html#listClientMetricsResources()">listClientMetricsResources</a>, <a href="Admin.html#listConsumerGroupOffsets(java.lang.String)">listConsumerGroupOffsets</a>, <a href="Admin.html#listConsumerGroupOffsets(java.lang.String,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">listConsumerGroupOffsets</a>, <a href="Admin.html#listConsumerGroupOffsets(java.util.Map)">listConsumerGroupOffsets</a>, <a href="Admin.html#listConsumerGroups()">listConsumerGroups</a>, <a href="Admin.html#listOffsets(java.util.Map)">listOffsets</a>, <a href="Admin.html#listPartitionReassignments()">listPartitionReassignments</a>, <a href="Admin.html#listPartitionReassignments(java.util.Set)">listPartitionReassignments</a>, <a href="Admin.html#listPartitionReassignments(java.util.Set,org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)">listPartitionReassignments</a>, <a href="Admin.html#listPartitionReassignments(org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)">listPartitionReassignments</a>, <a href="Admin.html#listTopics()">listTopics</a>, <a href="Admin.html#listTransactions()">listTransactions</a>, <a href="Admin.html#renewDelegationToken(byte%5B%5D)">renewDelegationToken</a>, <a href="Admin.html#unregisterBroker(int)">unregisterBroker</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.util.Map)">
<h3>ForwardingAdmin</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ForwardingAdmin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;configs)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="close(java.time.Duration)">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">close</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;timeout)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#close(java.time.Duration)">Admin</a></code></span></div>
<div class="block">Close the Admin client and release all associated resources.
<p>
The close operation has a grace period during which current operations will be allowed to
complete, specified by the given duration.
New operations will not be accepted during the grace period. Once the grace period is over,
all operations that have not yet been completed will be aborted with a <a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#close(java.time.Duration)">close</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>timeout</code> - The time to use for the wait time.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createTopics(java.util.Collection,org.apache.kafka.clients.admin.CreateTopicsOptions)">
<h3>createTopics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a></span>&nbsp;<span class="element-name">createTopics</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>&gt;&nbsp;newTopics,
<a href="CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#createTopics(java.util.Collection,org.apache.kafka.clients.admin.CreateTopicsOptions)">Admin</a></code></span></div>
<div class="block">Create a batch of new topics.
<p>
This operation is not transactional so it may succeed for some topics while fail for others.
<p>
It may take several seconds after <a href="CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin"><code>CreateTopicsResult</code></a> returns
success for all the brokers to become aware that the topics have been created.
During this time, <a href="Admin.html#listTopics()"><code>Admin.listTopics()</code></a> and <a href="Admin.html#describeTopics(java.util.Collection)"><code>Admin.describeTopics(Collection)</code></a>
may not return information about the new topics.
<p>
This operation is supported by brokers with version 0.10.1.0 or higher. The validateOnly option is supported
from version 0.10.2.0.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#createTopics(java.util.Collection,org.apache.kafka.clients.admin.CreateTopicsOptions)">createTopics</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>newTopics</code> - The new topics to create.</dd>
<dd><code>options</code> - The options to use when creating the new topics.</dd>
<dt>Returns:</dt>
<dd>The CreateTopicsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DeleteTopicsOptions)">
<h3>deleteTopics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a></span>&nbsp;<span class="element-name">deleteTopics</span><wbr><span class="parameters">(<a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a>&nbsp;topics,
<a href="DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#deleteTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DeleteTopicsOptions)">Admin</a></code></span></div>
<div class="block">Delete a batch of topics.
<p>
This operation is not transactional so it may succeed for some topics while fail for others.
<p>
It may take several seconds after the <a href="DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin"><code>DeleteTopicsResult</code></a> returns
success for all the brokers to become aware that the topics are gone.
During this time, <a href="Admin.html#listTopics()"><code>Admin.listTopics()</code></a> and <a href="Admin.html#describeTopics(java.util.Collection)"><code>Admin.describeTopics(Collection)</code></a>
may continue to return information about the deleted topics.
<p>
If delete.topic.enable is false on the brokers, deleteTopics will mark
the topics for deletion, but not actually delete them. The futures will
return successfully in this case.
<p>
When using topic IDs, this operation is supported by brokers with inter-broker protocol 2.8 or higher.
When using topic names, this operation is supported by brokers with version 0.10.1.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#deleteTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DeleteTopicsOptions)">deleteTopics</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>topics</code> - The topics to delete.</dd>
<dd><code>options</code> - The options to use when deleting the topics.</dd>
<dt>Returns:</dt>
<dd>The DeleteTopicsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">
<h3>listTopics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a></span>&nbsp;<span class="element-name">listTopics</span><wbr><span class="parameters">(<a href="ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">Admin</a></code></span></div>
<div class="block">List the topics available in the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">listTopics</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when listing the topics.</dd>
<dt>Returns:</dt>
<dd>The ListTopicsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">
<h3>describeTopics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a></span>&nbsp;<span class="element-name">describeTopics</span><wbr><span class="parameters">(<a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a>&nbsp;topics,
<a href="DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">Admin</a></code></span></div>
<div class="block">Describe some topics in the cluster.
When using topic IDs, this operation is supported by brokers with version 3.1.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">describeTopics</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>topics</code> - The topics to describe.</dd>
<dd><code>options</code> - The options to use when describing the topics.</dd>
<dt>Returns:</dt>
<dd>The DescribeTopicsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">
<h3>describeCluster</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a></span>&nbsp;<span class="element-name">describeCluster</span><wbr><span class="parameters">(<a href="DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">Admin</a></code></span></div>
<div class="block">Get information about the nodes in the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">describeCluster</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when getting information about the cluster.</dd>
<dt>Returns:</dt>
<dd>The DescribeClusterResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeAcls(org.apache.kafka.common.acl.AclBindingFilter,org.apache.kafka.clients.admin.DescribeAclsOptions)">
<h3>describeAcls</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a></span>&nbsp;<span class="element-name">describeAcls</span><wbr><span class="parameters">(<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>&nbsp;filter,
<a href="DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,org.apache.kafka.clients.admin.DescribeAclsOptions)">Admin</a></code></span></div>
<div class="block">Lists access control lists (ACLs) according to the supplied filter.
<p>
Note: it may take some time for changes made by <code>createAcls</code> or <code>deleteAcls</code> to be reflected
in the output of <code>describeAcls</code>.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,org.apache.kafka.clients.admin.DescribeAclsOptions)">describeAcls</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>filter</code> - The filter to use.</dd>
<dd><code>options</code> - The options to use when listing the ACLs.</dd>
<dt>Returns:</dt>
<dd>The DescribeAclsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createAcls(java.util.Collection,org.apache.kafka.clients.admin.CreateAclsOptions)">
<h3>createAcls</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a></span>&nbsp;<span class="element-name">createAcls</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>&gt;&nbsp;acls,
<a href="CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#createAcls(java.util.Collection,org.apache.kafka.clients.admin.CreateAclsOptions)">Admin</a></code></span></div>
<div class="block">Creates access control lists (ACLs) which are bound to specific resources.
<p>
This operation is not transactional so it may succeed for some ACLs while fail for others.
<p>
If you attempt to add an ACL that duplicates an existing ACL, no error will be raised, but
no changes will be made.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#createAcls(java.util.Collection,org.apache.kafka.clients.admin.CreateAclsOptions)">createAcls</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>acls</code> - The ACLs to create</dd>
<dd><code>options</code> - The options to use when creating the ACLs.</dd>
<dt>Returns:</dt>
<dd>The CreateAclsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteAcls(java.util.Collection,org.apache.kafka.clients.admin.DeleteAclsOptions)">
<h3>deleteAcls</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a></span>&nbsp;<span class="element-name">deleteAcls</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>&gt;&nbsp;filters,
<a href="DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#deleteAcls(java.util.Collection,org.apache.kafka.clients.admin.DeleteAclsOptions)">Admin</a></code></span></div>
<div class="block">Deletes access control lists (ACLs) according to the supplied filters.
<p>
This operation is not transactional so it may succeed for some ACLs while fail for others.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#deleteAcls(java.util.Collection,org.apache.kafka.clients.admin.DeleteAclsOptions)">deleteAcls</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>filters</code> - The filters to use.</dd>
<dd><code>options</code> - The options to use when deleting the ACLs.</dd>
<dt>Returns:</dt>
<dd>The DeleteAclsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeConfigs(java.util.Collection,org.apache.kafka.clients.admin.DescribeConfigsOptions)">
<h3>describeConfigs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a></span>&nbsp;<span class="element-name">describeConfigs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>&gt;&nbsp;resources,
<a href="DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeConfigs(java.util.Collection,org.apache.kafka.clients.admin.DescribeConfigsOptions)">Admin</a></code></span></div>
<div class="block">Get the configuration for the specified resources.
<p>
The returned configuration includes default values and the isDefault() method can be used to distinguish them
from user supplied values.
<p>
The value of config entries where isSensitive() is true is always <code>null</code> so that sensitive information
is not disclosed.
<p>
Config entries where isReadOnly() is true cannot be updated.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeConfigs(java.util.Collection,org.apache.kafka.clients.admin.DescribeConfigsOptions)">describeConfigs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>resources</code> - The resources (topic and broker resource types are currently supported)</dd>
<dd><code>options</code> - The options to use when describing configs</dd>
<dt>Returns:</dt>
<dd>The DescribeConfigsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">
<h3>alterConfigs</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></span>&nbsp;<span class="element-name">alterConfigs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<wbr><a href="Config.html" title="class in org.apache.kafka.clients.admin">Config</a>&gt;&nbsp;configs,
<a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a>&nbsp;options)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">Admin</a></code></span></div>
<div class="block">Update the configuration for the specified resources with the default options.
<p>
Updates are not transactional so they may succeed for some resources while fail for others. The configs for
a particular resource are updated atomically.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">alterConfigs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>configs</code> - The resources with their configs (topic is the only resource type with configs that can
be updated currently)</dd>
<dd><code>options</code> - The options to use when describing configs</dd>
<dt>Returns:</dt>
<dd>The AlterConfigsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="incrementalAlterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">
<h3>incrementalAlterConfigs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></span>&nbsp;<span class="element-name">incrementalAlterConfigs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="AlterConfigOp.html" title="class in org.apache.kafka.clients.admin">AlterConfigOp</a>&gt;&gt;&nbsp;configs,
<a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#incrementalAlterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">Admin</a></code></span></div>
<div class="block">Incrementally update the configuration for the specified resources.
<p>
Updates are not transactional so they may succeed for some resources while fail for others. The configs for
a particular resource are updated atomically.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from
the returned <a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin"><code>AlterConfigsResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
if the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/TopicAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>TopicAuthorizationException</code></a>
if the authenticated user didn't have alter access to the Topic.</li>
<li><a href="../../common/errors/UnknownTopicOrPartitionException.html" title="class in org.apache.kafka.common.errors"><code>UnknownTopicOrPartitionException</code></a>
if the Topic doesn't exist.</li>
<li><a href="../../common/errors/InvalidRequestException.html" title="class in org.apache.kafka.common.errors"><code>InvalidRequestException</code></a>
if the request details are invalid. e.g., a configuration key was specified more than once for a resource</li>
</ul>
<p>
This operation is supported by brokers with version 2.3.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#incrementalAlterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">incrementalAlterConfigs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>configs</code> - The resources with their configs</dd>
<dd><code>options</code> - The options to use when altering configs</dd>
<dt>Returns:</dt>
<dd>The AlterConfigsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterReplicaLogDirs(java.util.Map,org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions)">
<h3>alterReplicaLogDirs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a></span>&nbsp;<span class="element-name">alterReplicaLogDirs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;replicaAssignment,
<a href="AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterReplicaLogDirs(java.util.Map,org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions)">Admin</a></code></span></div>
<div class="block">Change the log directory for the specified replicas. If the replica does not exist on the broker, the result
shows REPLICA_NOT_AVAILABLE for the given replica and the replica will be created in the given log directory on the
broker when it is created later. If the replica already exists on the broker, the replica will be moved to the given
log directory if it is not already there. For detailed result, inspect the returned <a href="AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin"><code>AlterReplicaLogDirsResult</code></a> instance.
<p>
This operation is not transactional so it may succeed for some replicas while fail for others.
<p>
This operation is supported by brokers with version 1.1.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterReplicaLogDirs(java.util.Map,org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions)">alterReplicaLogDirs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>replicaAssignment</code> - The replicas with their log directory absolute path</dd>
<dd><code>options</code> - The options to use when changing replica dir</dd>
<dt>Returns:</dt>
<dd>The AlterReplicaLogDirsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeLogDirsOptions)">
<h3>describeLogDirs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a></span>&nbsp;<span class="element-name">describeLogDirs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;brokers,
<a href="DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeLogDirsOptions)">Admin</a></code></span></div>
<div class="block">Query the information of all log directories on the given set of brokers
<p>
This operation is supported by brokers with version 1.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeLogDirsOptions)">describeLogDirs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>brokers</code> - A list of brokers</dd>
<dd><code>options</code> - The options to use when querying log dir info</dd>
<dt>Returns:</dt>
<dd>The DescribeLogDirsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeReplicaLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions)">
<h3>describeReplicaLogDirs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a></span>&nbsp;<span class="element-name">describeReplicaLogDirs</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>&gt;&nbsp;replicas,
<a href="DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeReplicaLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions)">Admin</a></code></span></div>
<div class="block">Query the replica log directory information for the specified replicas.
<p>
This operation is supported by brokers with version 1.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeReplicaLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions)">describeReplicaLogDirs</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>replicas</code> - The replicas to query</dd>
<dd><code>options</code> - The options to use when querying replica log dir info</dd>
<dt>Returns:</dt>
<dd>The DescribeReplicaLogDirsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createPartitions(java.util.Map,org.apache.kafka.clients.admin.CreatePartitionsOptions)">
<h3>createPartitions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a></span>&nbsp;<span class="element-name">createPartitions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>&gt;&nbsp;newPartitions,
<a href="CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#createPartitions(java.util.Map,org.apache.kafka.clients.admin.CreatePartitionsOptions)">Admin</a></code></span></div>
<div class="block">Increase the number of partitions of the topics given as the keys of <code>newPartitions</code>
according to the corresponding values. <strong>If partitions are increased for a topic that has a key,
the partition logic or ordering of the messages will be affected.</strong>
<p>
This operation is not transactional so it may succeed for some topics while fail for others.
<p>
It may take several seconds after this method returns
success for all the brokers to become aware that the partitions have been created.
During this time, <a href="Admin.html#describeTopics(java.util.Collection)"><code>Admin.describeTopics(Collection)</code></a>
may not return information about the new partitions.
<p>
This operation is supported by brokers with version 1.0.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the
<a href="CreatePartitionsResult.html#values()"><code>values()</code></a> method of the returned <a href="CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin"><code>CreatePartitionsResult</code></a>
<ul>
<li><a href="../../common/errors/AuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>AuthorizationException</code></a>
if the authenticated user is not authorized to alter the topic</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request was not completed in within the given <a href="AbstractOptions.html#timeoutMs()"><code>AbstractOptions.timeoutMs()</code></a>.</li>
<li><a href="../../common/errors/ReassignmentInProgressException.html" title="class in org.apache.kafka.common.errors"><code>ReassignmentInProgressException</code></a>
if a partition reassignment is currently in progress</li>
<li><a href="../../common/errors/BrokerNotAvailableException.html" title="class in org.apache.kafka.common.errors"><code>BrokerNotAvailableException</code></a>
if the requested <a href="NewPartitions.html#assignments()"><code>NewPartitions.assignments()</code></a> contain a broker that is currently unavailable.</li>
<li><a href="../../common/errors/InvalidReplicationFactorException.html" title="class in org.apache.kafka.common.errors"><code>InvalidReplicationFactorException</code></a>
if no <a href="NewPartitions.html#assignments()"><code>NewPartitions.assignments()</code></a> are given and it is impossible for the broker to assign
replicas with the topics replication factor.</li>
<li>Subclasses of <a href="../../common/KafkaException.html" title="class in org.apache.kafka.common"><code>KafkaException</code></a>
if the request is invalid in some way.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#createPartitions(java.util.Map,org.apache.kafka.clients.admin.CreatePartitionsOptions)">createPartitions</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>newPartitions</code> - The topics which should have new partitions created, and corresponding parameters
for the created partitions.</dd>
<dd><code>options</code> - The options to use when creating the new partitions.</dd>
<dt>Returns:</dt>
<dd>The CreatePartitionsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteRecords(java.util.Map,org.apache.kafka.clients.admin.DeleteRecordsOptions)">
<h3>deleteRecords</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeleteRecordsResult.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsResult</a></span>&nbsp;<span class="element-name">deleteRecords</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="RecordsToDelete.html" title="class in org.apache.kafka.clients.admin">RecordsToDelete</a>&gt;&nbsp;recordsToDelete,
<a href="DeleteRecordsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#deleteRecords(java.util.Map,org.apache.kafka.clients.admin.DeleteRecordsOptions)">Admin</a></code></span></div>
<div class="block">Delete records whose offset is smaller than the given offset of the corresponding partition.
<p>
This operation is supported by brokers with version 0.11.0.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#deleteRecords(java.util.Map,org.apache.kafka.clients.admin.DeleteRecordsOptions)">deleteRecords</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>recordsToDelete</code> - The topic partitions and related offsets from which records deletion starts.</dd>
<dd><code>options</code> - The options to use when deleting records.</dd>
<dt>Returns:</dt>
<dd>The DeleteRecordsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createDelegationToken(org.apache.kafka.clients.admin.CreateDelegationTokenOptions)">
<h3>createDelegationToken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="CreateDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenResult</a></span>&nbsp;<span class="element-name">createDelegationToken</span><wbr><span class="parameters">(<a href="CreateDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#createDelegationToken(org.apache.kafka.clients.admin.CreateDelegationTokenOptions)">Admin</a></code></span></div>
<div class="block">Create a Delegation Token.
<p>
This operation is supported by brokers with version 1.1.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the
<a href="CreateDelegationTokenResult.html#delegationToken()"><code>delegationToken()</code></a> method of the returned <a href="CreateDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin"><code>CreateDelegationTokenResult</code></a>
<ul>
<li><a href="../../common/errors/UnsupportedByAuthenticationException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedByAuthenticationException</code></a>
If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.</li>
<li><a href="../../common/errors/InvalidPrincipalTypeException.html" title="class in org.apache.kafka.common.errors"><code>InvalidPrincipalTypeException</code></a>
if the renewers principal type is not supported.</li>
<li><a href="../../common/errors/DelegationTokenDisabledException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenDisabledException</code></a>
if the delegation token feature is disabled.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request was not completed in within the given <a href="AbstractOptions.html#timeoutMs()"><code>AbstractOptions.timeoutMs()</code></a>.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#createDelegationToken(org.apache.kafka.clients.admin.CreateDelegationTokenOptions)">createDelegationToken</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when creating delegation token.</dd>
<dt>Returns:</dt>
<dd>The DeleteRecordsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="renewDelegationToken(byte[],org.apache.kafka.clients.admin.RenewDelegationTokenOptions)">
<h3>renewDelegationToken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RenewDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenResult</a></span>&nbsp;<span class="element-name">renewDelegationToken</span><wbr><span class="parameters">(byte[]&nbsp;hmac,
<a href="RenewDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#renewDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.RenewDelegationTokenOptions)">Admin</a></code></span></div>
<div class="block">Renew a Delegation Token.
<p>
This operation is supported by brokers with version 1.1.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the
<a href="RenewDelegationTokenResult.html#expiryTimestamp()"><code>expiryTimestamp()</code></a> method of the returned <a href="RenewDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin"><code>RenewDelegationTokenResult</code></a>
<ul>
<li><a href="../../common/errors/UnsupportedByAuthenticationException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedByAuthenticationException</code></a>
If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.</li>
<li><a href="../../common/errors/DelegationTokenDisabledException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenDisabledException</code></a>
if the delegation token feature is disabled.</li>
<li><a href="../../common/errors/DelegationTokenNotFoundException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenNotFoundException</code></a>
if the delegation token is not found on server.</li>
<li><a href="../../common/errors/DelegationTokenOwnerMismatchException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenOwnerMismatchException</code></a>
if the authenticated user is not owner/renewer of the token.</li>
<li><a href="../../common/errors/DelegationTokenExpiredException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenExpiredException</code></a>
if the delegation token is expired.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request was not completed in within the given <a href="AbstractOptions.html#timeoutMs()"><code>AbstractOptions.timeoutMs()</code></a>.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#renewDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.RenewDelegationTokenOptions)">renewDelegationToken</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>hmac</code> - HMAC of the Delegation token</dd>
<dd><code>options</code> - The options to use when renewing delegation token.</dd>
<dt>Returns:</dt>
<dd>The RenewDelegationTokenResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="expireDelegationToken(byte[],org.apache.kafka.clients.admin.ExpireDelegationTokenOptions)">
<h3>expireDelegationToken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ExpireDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenResult</a></span>&nbsp;<span class="element-name">expireDelegationToken</span><wbr><span class="parameters">(byte[]&nbsp;hmac,
<a href="ExpireDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#expireDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.ExpireDelegationTokenOptions)">Admin</a></code></span></div>
<div class="block">Expire a Delegation Token.
<p>
This operation is supported by brokers with version 1.1.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the
<a href="ExpireDelegationTokenResult.html#expiryTimestamp()"><code>expiryTimestamp()</code></a> method of the returned <a href="ExpireDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin"><code>ExpireDelegationTokenResult</code></a>
<ul>
<li><a href="../../common/errors/UnsupportedByAuthenticationException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedByAuthenticationException</code></a>
If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.</li>
<li><a href="../../common/errors/DelegationTokenDisabledException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenDisabledException</code></a>
if the delegation token feature is disabled.</li>
<li><a href="../../common/errors/DelegationTokenNotFoundException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenNotFoundException</code></a>
if the delegation token is not found on server.</li>
<li><a href="../../common/errors/DelegationTokenOwnerMismatchException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenOwnerMismatchException</code></a>
if the authenticated user is not owner/renewer of the requested token.</li>
<li><a href="../../common/errors/DelegationTokenExpiredException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenExpiredException</code></a>
if the delegation token is expired.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request was not completed in within the given <a href="AbstractOptions.html#timeoutMs()"><code>AbstractOptions.timeoutMs()</code></a>.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#expireDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.ExpireDelegationTokenOptions)">expireDelegationToken</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>hmac</code> - HMAC of the Delegation token</dd>
<dd><code>options</code> - The options to use when expiring delegation token.</dd>
<dt>Returns:</dt>
<dd>The ExpireDelegationTokenResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeDelegationToken(org.apache.kafka.clients.admin.DescribeDelegationTokenOptions)">
<h3>describeDelegationToken</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenResult</a></span>&nbsp;<span class="element-name">describeDelegationToken</span><wbr><span class="parameters">(<a href="DescribeDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeDelegationToken(org.apache.kafka.clients.admin.DescribeDelegationTokenOptions)">Admin</a></code></span></div>
<div class="block">Describe the Delegation Tokens.
<p>
This operation is supported by brokers with version 1.1.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the
<a href="DescribeDelegationTokenResult.html#delegationTokens()"><code>delegationTokens()</code></a> method of the returned <a href="DescribeDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeDelegationTokenResult</code></a>
<ul>
<li><a href="../../common/errors/UnsupportedByAuthenticationException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedByAuthenticationException</code></a>
If the request sent on PLAINTEXT/1-way SSL channels or delegation token authenticated channels.</li>
<li><a href="../../common/errors/DelegationTokenDisabledException.html" title="class in org.apache.kafka.common.errors"><code>DelegationTokenDisabledException</code></a>
if the delegation token feature is disabled.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request was not completed in within the given <a href="AbstractOptions.html#timeoutMs()"><code>AbstractOptions.timeoutMs()</code></a>.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeDelegationToken(org.apache.kafka.clients.admin.DescribeDelegationTokenOptions)">describeDelegationToken</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when describing delegation tokens.</dd>
<dt>Returns:</dt>
<dd>The DescribeDelegationTokenResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DescribeConsumerGroupsOptions)">
<h3>describeConsumerGroups</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsResult</a></span>&nbsp;<span class="element-name">describeConsumerGroups</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;groupIds,
<a href="DescribeConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DescribeConsumerGroupsOptions)">Admin</a></code></span></div>
<div class="block">Describe some group IDs in the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DescribeConsumerGroupsOptions)">describeConsumerGroups</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>groupIds</code> - The IDs of the groups to describe.</dd>
<dd><code>options</code> - The options to use when describing the groups.</dd>
<dt>Returns:</dt>
<dd>The DescribeConsumerGroupResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listConsumerGroups(org.apache.kafka.clients.admin.ListConsumerGroupsOptions)">
<h3>listConsumerGroups</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsResult</a></span>&nbsp;<span class="element-name">listConsumerGroups</span><wbr><span class="parameters">(<a href="ListConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listConsumerGroups(org.apache.kafka.clients.admin.ListConsumerGroupsOptions)">Admin</a></code></span></div>
<div class="block">List the consumer groups available in the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listConsumerGroups(org.apache.kafka.clients.admin.ListConsumerGroupsOptions)">listConsumerGroups</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when listing the consumer groups.</dd>
<dt>Returns:</dt>
<dd>The ListGroupsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listConsumerGroupOffsets(java.util.Map,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">
<h3>listConsumerGroupOffsets</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsResult</a></span>&nbsp;<span class="element-name">listConsumerGroupOffsets</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="ListConsumerGroupOffsetsSpec.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsSpec</a>&gt;&nbsp;groupSpecs,
<a href="ListConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listConsumerGroupOffsets(java.util.Map,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">Admin</a></code></span></div>
<div class="block">List the consumer group offsets available in the cluster for the specified consumer groups.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listConsumerGroupOffsets(java.util.Map,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">listConsumerGroupOffsets</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>groupSpecs</code> - Map of consumer group ids to a spec that specifies the topic partitions of the group to list offsets for.</dd>
<dd><code>options</code> - The options to use when listing the consumer group offsets.</dd>
<dt>Returns:</dt>
<dd>The ListConsumerGroupOffsetsResult</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions)">
<h3>deleteConsumerGroups</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeleteConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsResult</a></span>&nbsp;<span class="element-name">deleteConsumerGroups</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;groupIds,
<a href="DeleteConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#deleteConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions)">Admin</a></code></span></div>
<div class="block">Delete consumer groups from the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#deleteConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions)">deleteConsumerGroups</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dd><code>options</code> - The options to use when deleting a consumer group.</dd>
<dt>Returns:</dt>
<dd>The DeleteConsumerGroupsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="deleteConsumerGroupOffsets(java.lang.String,java.util.Set,org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions)">
<h3>deleteConsumerGroupOffsets</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DeleteConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsResult</a></span>&nbsp;<span class="element-name">deleteConsumerGroupOffsets</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="DeleteConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#deleteConsumerGroupOffsets(java.lang.String,java.util.Set,org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions)">Admin</a></code></span></div>
<div class="block">Delete committed offsets for a set of partitions in a consumer group. This will
succeed at the partition level only if the group is not actively subscribed
to the corresponding topic.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#deleteConsumerGroupOffsets(java.lang.String,java.util.Set,org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions)">deleteConsumerGroupOffsets</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dd><code>options</code> - The options to use when deleting offsets in a consumer group.</dd>
<dt>Returns:</dt>
<dd>The DeleteConsumerGroupOffsetsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)">
<h3>electLeaders</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ElectLeadersResult.html" title="class in org.apache.kafka.clients.admin">ElectLeadersResult</a></span>&nbsp;<span class="element-name">electLeaders</span><wbr><span class="parameters">(<a href="../../common/ElectionType.html" title="enum class in org.apache.kafka.common">ElectionType</a>&nbsp;electionType,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="ElectLeadersOptions.html" title="class in org.apache.kafka.clients.admin">ElectLeadersOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)">Admin</a></code></span></div>
<div class="block">Elect a replica as leader for the given <code>partitions</code>, or for all partitions if the argument
to <code>partitions</code> is null.
<p>
This operation is not transactional so it may succeed for some partitions while fail for others.
<p>
It may take several seconds after this method returns success for all the brokers in the cluster
to become aware that the partitions have new leaders. During this time,
<a href="Admin.html#describeTopics(java.util.Collection)"><code>Admin.describeTopics(Collection)</code></a> may not return information about the partitions'
new leaders.
<p>
This operation is supported by brokers with version 2.2.0 or later if preferred election is use;
otherwise the brokers most be 2.4.0 or higher.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the future obtained
from the returned <a href="ElectLeadersResult.html" title="class in org.apache.kafka.clients.admin"><code>ElectLeadersResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
if the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/UnknownTopicOrPartitionException.html" title="class in org.apache.kafka.common.errors"><code>UnknownTopicOrPartitionException</code></a>
if the topic or partition did not exist within the cluster.</li>
<li><a href="../../common/errors/InvalidTopicException.html" title="class in org.apache.kafka.common.errors"><code>InvalidTopicException</code></a>
if the topic was already queued for deletion.</li>
<li><a href="../../common/errors/NotControllerException.html" title="class in org.apache.kafka.common.errors"><code>NotControllerException</code></a>
if the request was sent to a broker that was not the controller for the cluster.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request timed out before the election was complete.</li>
<li><a href="../../common/errors/LeaderNotAvailableException.html" title="class in org.apache.kafka.common.errors"><code>LeaderNotAvailableException</code></a>
if the preferred leader was not alive or not in the ISR.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)">electLeaders</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>electionType</code> - The type of election to conduct.</dd>
<dd><code>partitions</code> - The topics and partitions for which to conduct elections.</dd>
<dd><code>options</code> - The options to use when electing the leaders.</dd>
<dt>Returns:</dt>
<dd>The ElectLeadersResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterPartitionReassignments(java.util.Map,org.apache.kafka.clients.admin.AlterPartitionReassignmentsOptions)">
<h3>alterPartitionReassignments</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsResult</a></span>&nbsp;<span class="element-name">alterPartitionReassignments</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="NewPartitionReassignment.html" title="class in org.apache.kafka.clients.admin">NewPartitionReassignment</a>&gt;&gt;&nbsp;reassignments,
<a href="AlterPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterPartitionReassignments(java.util.Map,org.apache.kafka.clients.admin.AlterPartitionReassignmentsOptions)">Admin</a></code></span></div>
<div class="block">Change the reassignments for one or more partitions.
Providing an empty Optional (e.g via <a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Optional.html#empty()" title="class or interface in java.util" class="external-link"><code>Optional.empty()</code></a>) will <bold>revert</bold> the reassignment for the associated partition.
<p>The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from
the returned <code>AlterPartitionReassignmentsResult</code>:</p>
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/UnknownTopicOrPartitionException.html" title="class in org.apache.kafka.common.errors"><code>UnknownTopicOrPartitionException</code></a>
If the topic or partition does not exist within the cluster.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
if the request timed out before the controller could record the new assignments.</li>
<li><a href="../../common/errors/InvalidReplicaAssignmentException.html" title="class in org.apache.kafka.common.errors"><code>InvalidReplicaAssignmentException</code></a>
If the specified assignment was not valid.</li>
<li><a href="../../common/errors/NoReassignmentInProgressException.html" title="class in org.apache.kafka.common.errors"><code>NoReassignmentInProgressException</code></a>
If there was an attempt to cancel a reassignment for a partition which was not being reassigned.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterPartitionReassignments(java.util.Map,org.apache.kafka.clients.admin.AlterPartitionReassignmentsOptions)">alterPartitionReassignments</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>reassignments</code> - The reassignments to add, modify, or remove. See <a href="NewPartitionReassignment.html" title="class in org.apache.kafka.clients.admin"><code>NewPartitionReassignment</code></a>.</dd>
<dd><code>options</code> - The options to use.</dd>
<dt>Returns:</dt>
<dd>The result.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listPartitionReassignments(java.util.Optional,org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)">
<h3>listPartitionReassignments</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsResult</a></span>&nbsp;<span class="element-name">listPartitionReassignments</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&gt;&nbsp;partitions,
<a href="ListPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsOptions</a>&nbsp;options)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listPartitionReassignments(java.util.Optional,org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)">listPartitionReassignments</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>partitions</code> - the partitions we want to get reassignment for, or an empty optional if we want to get the reassignments for all partitions in the cluster</dd>
<dd><code>options</code> - The options to use.</dd>
<dt>Returns:</dt>
<dd>The result.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removeMembersFromConsumerGroup(java.lang.String,org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions)">
<h3>removeMembersFromConsumerGroup</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RemoveMembersFromConsumerGroupResult.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupResult</a></span>&nbsp;<span class="element-name">removeMembersFromConsumerGroup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="RemoveMembersFromConsumerGroupOptions.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#removeMembersFromConsumerGroup(java.lang.String,org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions)">Admin</a></code></span></div>
<div class="block">Remove members from the consumer group by given member identities.
<p>
For possible error codes, refer to <code>LeaveGroupResponse</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#removeMembersFromConsumerGroup(java.lang.String,org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions)">removeMembersFromConsumerGroup</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>groupId</code> - The ID of the group to remove member from.</dd>
<dd><code>options</code> - The options to carry removing members' information.</dd>
<dt>Returns:</dt>
<dd>The MembershipChangeResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterConsumerGroupOffsets(java.lang.String,java.util.Map,org.apache.kafka.clients.admin.AlterConsumerGroupOffsetsOptions)">
<h3>alterConsumerGroupOffsets</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsResult</a></span>&nbsp;<span class="element-name">alterConsumerGroupOffsets</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;groupId,
<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="../consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>&gt;&nbsp;offsets,
<a href="AlterConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterConsumerGroupOffsets(java.lang.String,java.util.Map,org.apache.kafka.clients.admin.AlterConsumerGroupOffsetsOptions)">Admin</a></code></span></div>
<div class="block"><p>Alters offsets for the specified group. In order to succeed, the group must be empty.
<p>This operation is not transactional so it may succeed for some partitions while fail for others.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterConsumerGroupOffsets(java.lang.String,java.util.Map,org.apache.kafka.clients.admin.AlterConsumerGroupOffsetsOptions)">alterConsumerGroupOffsets</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>groupId</code> - The group for which to alter offsets.</dd>
<dd><code>offsets</code> - A map of offsets by partition with associated metadata. Partitions not specified in the map are ignored.</dd>
<dd><code>options</code> - The options to use when altering the offsets.</dd>
<dt>Returns:</dt>
<dd>The AlterOffsetsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listOffsets(java.util.Map,org.apache.kafka.clients.admin.ListOffsetsOptions)">
<h3>listOffsets</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListOffsetsResult</a></span>&nbsp;<span class="element-name">listOffsets</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,<wbr><a href="OffsetSpec.html" title="class in org.apache.kafka.clients.admin">OffsetSpec</a>&gt;&nbsp;topicPartitionOffsets,
<a href="ListOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListOffsetsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listOffsets(java.util.Map,org.apache.kafka.clients.admin.ListOffsetsOptions)">Admin</a></code></span></div>
<div class="block"><p>List offset for the specified partitions. This operation enables to find
the beginning offset, end offset as well as the offset matching a timestamp in partitions.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listOffsets(java.util.Map,org.apache.kafka.clients.admin.ListOffsetsOptions)">listOffsets</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>topicPartitionOffsets</code> - The mapping from partition to the OffsetSpec to look up.</dd>
<dd><code>options</code> - The options to use when retrieving the offsets</dd>
<dt>Returns:</dt>
<dd>The ListOffsetsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter,org.apache.kafka.clients.admin.DescribeClientQuotasOptions)">
<h3>describeClientQuotas</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasResult</a></span>&nbsp;<span class="element-name">describeClientQuotas</span><wbr><span class="parameters">(<a href="../../common/quota/ClientQuotaFilter.html" title="class in org.apache.kafka.common.quota">ClientQuotaFilter</a>&nbsp;filter,
<a href="DescribeClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter,org.apache.kafka.clients.admin.DescribeClientQuotasOptions)">Admin</a></code></span></div>
<div class="block">Describes all entities matching the provided filter that have at least one client quota configuration
value defined.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the future from the
returned <a href="DescribeClientQuotasResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeClientQuotasResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have describe access to the cluster.</li>
<li><a href="../../common/errors/InvalidRequestException.html" title="class in org.apache.kafka.common.errors"><code>InvalidRequestException</code></a>
If the request details are invalid. e.g., an invalid entity type was specified.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the describe could finish.</li>
</ul>
<p>
This operation is supported by brokers with version 2.6.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter,org.apache.kafka.clients.admin.DescribeClientQuotasOptions)">describeClientQuotas</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>filter</code> - the filter to apply to match entities</dd>
<dd><code>options</code> - the options to use</dd>
<dt>Returns:</dt>
<dd>the DescribeClientQuotasResult containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterClientQuotas(java.util.Collection,org.apache.kafka.clients.admin.AlterClientQuotasOptions)">
<h3>alterClientQuotas</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasResult</a></span>&nbsp;<span class="element-name">alterClientQuotas</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/quota/ClientQuotaAlteration.html" title="class in org.apache.kafka.common.quota">ClientQuotaAlteration</a>&gt;&nbsp;entries,
<a href="AlterClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterClientQuotas(java.util.Collection,org.apache.kafka.clients.admin.AlterClientQuotasOptions)">Admin</a></code></span></div>
<div class="block">Alters client quota configurations with the specified alterations.
<p>
Alterations for a single entity are atomic, but across entities is not guaranteed. The resulting
per-entity error code should be evaluated to resolve the success or failure of all updates.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from
the returned <a href="AlterClientQuotasResult.html" title="class in org.apache.kafka.clients.admin"><code>AlterClientQuotasResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/InvalidRequestException.html" title="class in org.apache.kafka.common.errors"><code>InvalidRequestException</code></a>
If the request details are invalid. e.g., a configuration key was specified more than once for an entity.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the alterations could finish. It cannot be guaranteed whether the update
succeed or not.</li>
</ul>
<p>
This operation is supported by brokers with version 2.6.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterClientQuotas(java.util.Collection,org.apache.kafka.clients.admin.AlterClientQuotasOptions)">alterClientQuotas</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>entries</code> - the alterations to perform</dd>
<dt>Returns:</dt>
<dd>the AlterClientQuotasResult containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.DescribeUserScramCredentialsOptions)">
<h3>describeUserScramCredentials</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsResult</a></span>&nbsp;<span class="element-name">describeUserScramCredentials</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;users,
<a href="DescribeUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.DescribeUserScramCredentialsOptions)">Admin</a></code></span></div>
<div class="block">Describe SASL/SCRAM credentials.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures from the
returned <a href="DescribeUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeUserScramCredentialsResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have describe access to the cluster.</li>
<li><a href="../../common/errors/ResourceNotFoundException.html" title="class in org.apache.kafka.common.errors"><code>ResourceNotFoundException</code></a>
If the user did not exist/had no SCRAM credentials.</li>
<li><a href="../../common/errors/DuplicateResourceException.html" title="class in org.apache.kafka.common.errors"><code>DuplicateResourceException</code></a>
If the user was requested to be described more than once in the original request.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the describe operation could finish.</li>
</ul>
<p>
This operation is supported by brokers with version 2.7.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.DescribeUserScramCredentialsOptions)">describeUserScramCredentials</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>users</code> - the users for which credentials are to be described; all users' credentials are described if null
or empty.</dd>
<dd><code>options</code> - The options to use when describing the credentials</dd>
<dt>Returns:</dt>
<dd>The DescribeUserScramCredentialsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="alterUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.AlterUserScramCredentialsOptions)">
<h3>alterUserScramCredentials</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AlterUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsResult</a></span>&nbsp;<span class="element-name">alterUserScramCredentials</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="UserScramCredentialAlteration.html" title="class in org.apache.kafka.clients.admin">UserScramCredentialAlteration</a>&gt;&nbsp;alterations,
<a href="AlterUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#alterUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.AlterUserScramCredentialsOptions)">Admin</a></code></span></div>
<div class="block">Alter SASL/SCRAM credentials.
<p>
The following exceptions can be anticipated when calling <code>get()</code> any of the futures from the
returned <a href="AlterUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin"><code>AlterUserScramCredentialsResult</code></a>:
<ul>
<li><a href="../../common/errors/NotControllerException.html" title="class in org.apache.kafka.common.errors"><code>NotControllerException</code></a>
If the request is not sent to the Controller broker.</li>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/UnsupportedByAuthenticationException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedByAuthenticationException</code></a>
If the user authenticated with a delegation token.</li>
<li><a href="../../common/errors/UnsupportedSaslMechanismException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedSaslMechanismException</code></a>
If the requested SCRAM mechanism is unrecognized or otherwise unsupported.</li>
<li><a href="../../common/errors/UnacceptableCredentialException.html" title="class in org.apache.kafka.common.errors"><code>UnacceptableCredentialException</code></a>
If the username is empty or the requested number of iterations is too small or too large.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the describe could finish.</li>
</ul>
<p>
This operation is supported by brokers with version 2.7.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#alterUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.AlterUserScramCredentialsOptions)">alterUserScramCredentials</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>alterations</code> - the alterations to be applied</dd>
<dd><code>options</code> - The options to use when altering the credentials</dd>
<dt>Returns:</dt>
<dd>The AlterUserScramCredentialsResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)">
<h3>describeFeatures</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesResult</a></span>&nbsp;<span class="element-name">describeFeatures</span><wbr><span class="parameters">(<a href="DescribeFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)">Admin</a></code></span></div>
<div class="block">Describes finalized as well as supported features. The request is issued to any random
broker.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the future from the
returned <a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeFeaturesResult</code></a>:
<ul>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the describe operation could finish.</li>
</ul>
<p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)">describeFeatures</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - the options to use</dd>
<dt>Returns:</dt>
<dd>the <a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeFeaturesResult</code></a> containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="updateFeatures(java.util.Map,org.apache.kafka.clients.admin.UpdateFeaturesOptions)">
<h3>updateFeatures</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesResult</a></span>&nbsp;<span class="element-name">updateFeatures</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin">FeatureUpdate</a>&gt;&nbsp;featureUpdates,
<a href="UpdateFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#updateFeatures(java.util.Map,org.apache.kafka.clients.admin.UpdateFeaturesOptions)">Admin</a></code></span></div>
<div class="block">Applies specified updates to finalized features. This operation is not transactional so some
updates may succeed while the rest may fail.
<p>
The API takes in a map of finalized feature names to <a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin"><code>FeatureUpdate</code></a> that needs to be
applied. Each entry in the map specifies the finalized feature to be added or updated or
deleted, along with the new max feature version level value. This request is issued only to
the controller since the API is only served by the controller. The return value contains an
error code for each supplied <a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin"><code>FeatureUpdate</code></a>, and the code indicates if the update
succeeded or failed in the controller.
<ul>
<li>Downgrade of feature version level is not a regular operation/intent. It is only allowed
in the controller if the <a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin"><code>FeatureUpdate</code></a> has the allowDowngrade flag set. Setting this
flag conveys user intent to attempt downgrade of a feature max version level. Note that
despite the allowDowngrade flag being set, certain downgrades may be rejected by the
controller if it is deemed impossible.</li>
<li>Deletion of a finalized feature version is not a regular operation/intent. It could be
done by setting the allowDowngrade flag to true in the <a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin"><code>FeatureUpdate</code></a>, and, setting
the max version level to a value less than 1.</li>
</ul>
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures
obtained from the returned <a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin"><code>UpdateFeaturesResult</code></a>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have alter access to the cluster.</li>
<li><a href="../../common/errors/InvalidRequestException.html" title="class in org.apache.kafka.common.errors"><code>InvalidRequestException</code></a>
If the request details are invalid. e.g., a non-existing finalized feature is attempted
to be deleted or downgraded.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the updates could finish. It cannot be guaranteed whether
the updates succeeded or not.</li>
<li><a href="../../common/errors/FeatureUpdateFailedException.html" title="class in org.apache.kafka.common.errors"><code>FeatureUpdateFailedException</code></a>
This means there was an unexpected error encountered when the update was applied on
the controller. There is no guarantee on whether the update succeeded or failed. The best
way to find out is to issue a <a href="Admin.html#describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)"><code>Admin.describeFeatures(DescribeFeaturesOptions)</code></a>
request.</li>
</ul>
<p>
This operation is supported by brokers with version 2.7.0 or higher.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#updateFeatures(java.util.Map,org.apache.kafka.clients.admin.UpdateFeaturesOptions)">updateFeatures</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>featureUpdates</code> - the map of finalized feature name to <a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin"><code>FeatureUpdate</code></a></dd>
<dd><code>options</code> - the options to use</dd>
<dt>Returns:</dt>
<dd>the <a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin"><code>UpdateFeaturesResult</code></a> containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeMetadataQuorum(org.apache.kafka.clients.admin.DescribeMetadataQuorumOptions)">
<h3>describeMetadataQuorum</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeMetadataQuorumResult.html" title="class in org.apache.kafka.clients.admin">DescribeMetadataQuorumResult</a></span>&nbsp;<span class="element-name">describeMetadataQuorum</span><wbr><span class="parameters">(<a href="DescribeMetadataQuorumOptions.html" title="class in org.apache.kafka.clients.admin">DescribeMetadataQuorumOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeMetadataQuorum(org.apache.kafka.clients.admin.DescribeMetadataQuorumOptions)">Admin</a></code></span></div>
<div class="block">Describes the state of the metadata quorum.
<p>
The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from
the returned <code>DescribeMetadataQuorumResult</code>:
<ul>
<li><a href="../../common/errors/ClusterAuthorizationException.html" title="class in org.apache.kafka.common.errors"><code>ClusterAuthorizationException</code></a>
If the authenticated user didn't have <code>DESCRIBE</code> access to the cluster.</li>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the controller could list the cluster links.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeMetadataQuorum(org.apache.kafka.clients.admin.DescribeMetadataQuorumOptions)">describeMetadataQuorum</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The <a href="DescribeMetadataQuorumOptions.html" title="class in org.apache.kafka.clients.admin"><code>DescribeMetadataQuorumOptions</code></a> to use when describing the quorum.</dd>
<dt>Returns:</dt>
<dd>the <a href="DescribeMetadataQuorumResult.html" title="class in org.apache.kafka.clients.admin"><code>DescribeMetadataQuorumResult</code></a> containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)">
<h3>unregisterBroker</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerResult</a></span>&nbsp;<span class="element-name">unregisterBroker</span><wbr><span class="parameters">(int&nbsp;brokerId,
<a href="UnregisterBrokerOptions.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)">Admin</a></code></span></div>
<div class="block">Unregister a broker.
<p>
This operation does not have any effect on partition assignments. It is supported
only on Kafka clusters which use Raft to store metadata, rather than ZooKeeper.
The following exceptions can be anticipated when calling <code>get()</code> on the future from the
returned <a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin"><code>UnregisterBrokerResult</code></a>:
<ul>
<li><a href="../../common/errors/TimeoutException.html" title="class in org.apache.kafka.common.errors"><code>TimeoutException</code></a>
If the request timed out before the describe operation could finish.</li>
<li><a href="../../common/errors/UnsupportedVersionException.html" title="class in org.apache.kafka.common.errors"><code>UnsupportedVersionException</code></a>
If the software is too old to support the unregistration API, or if the
cluster is not using Raft to store metadata.
</ul>
<p></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)">unregisterBroker</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>brokerId</code> - the broker id to unregister.</dd>
<dd><code>options</code> - the options to use.</dd>
<dt>Returns:</dt>
<dd>the <a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin"><code>UnregisterBrokerResult</code></a> containing the result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeProducers(java.util.Collection,org.apache.kafka.clients.admin.DescribeProducersOptions)">
<h3>describeProducers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeProducersResult.html" title="class in org.apache.kafka.clients.admin">DescribeProducersResult</a></span>&nbsp;<span class="element-name">describeProducers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>&gt;&nbsp;partitions,
<a href="DescribeProducersOptions.html" title="class in org.apache.kafka.clients.admin">DescribeProducersOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeProducers(java.util.Collection,org.apache.kafka.clients.admin.DescribeProducersOptions)">Admin</a></code></span></div>
<div class="block">Describe active producer state on a set of topic partitions. Unless a specific broker
is requested through <a href="DescribeProducersOptions.html#brokerId(int)"><code>DescribeProducersOptions.brokerId(int)</code></a>, this will
query the partition leader to find the producer state.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeProducers(java.util.Collection,org.apache.kafka.clients.admin.DescribeProducersOptions)">describeProducers</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>partitions</code> - The set of partitions to query</dd>
<dd><code>options</code> - Options to control the method behavior</dd>
<dt>Returns:</dt>
<dd>The result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="describeTransactions(java.util.Collection,org.apache.kafka.clients.admin.DescribeTransactionsOptions)">
<h3>describeTransactions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="DescribeTransactionsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsResult</a></span>&nbsp;<span class="element-name">describeTransactions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;transactionalIds,
<a href="DescribeTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#describeTransactions(java.util.Collection,org.apache.kafka.clients.admin.DescribeTransactionsOptions)">Admin</a></code></span></div>
<div class="block">Describe the state of a set of transactional IDs from the respective transaction coordinators,
which are dynamically discovered.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#describeTransactions(java.util.Collection,org.apache.kafka.clients.admin.DescribeTransactionsOptions)">describeTransactions</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>transactionalIds</code> - The set of transactional IDs to query</dd>
<dd><code>options</code> - Options to control the method behavior</dd>
<dt>Returns:</dt>
<dd>The result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec,org.apache.kafka.clients.admin.AbortTransactionOptions)">
<h3>abortTransaction</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="AbortTransactionResult.html" title="class in org.apache.kafka.clients.admin">AbortTransactionResult</a></span>&nbsp;<span class="element-name">abortTransaction</span><wbr><span class="parameters">(<a href="AbortTransactionSpec.html" title="class in org.apache.kafka.clients.admin">AbortTransactionSpec</a>&nbsp;spec,
<a href="AbortTransactionOptions.html" title="class in org.apache.kafka.clients.admin">AbortTransactionOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec,org.apache.kafka.clients.admin.AbortTransactionOptions)">Admin</a></code></span></div>
<div class="block">Forcefully abort a transaction which is open on a topic partition. This will
send a `WriteTxnMarkers` request to the partition leader in order to abort the
transaction. This requires administrative privileges.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec,org.apache.kafka.clients.admin.AbortTransactionOptions)">abortTransaction</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>spec</code> - The transaction specification including topic partition and producer details</dd>
<dd><code>options</code> - Options to control the method behavior (including filters)</dd>
<dt>Returns:</dt>
<dd>The result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listTransactions(org.apache.kafka.clients.admin.ListTransactionsOptions)">
<h3>listTransactions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListTransactionsResult.html" title="class in org.apache.kafka.clients.admin">ListTransactionsResult</a></span>&nbsp;<span class="element-name">listTransactions</span><wbr><span class="parameters">(<a href="ListTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">ListTransactionsOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listTransactions(org.apache.kafka.clients.admin.ListTransactionsOptions)">Admin</a></code></span></div>
<div class="block">List active transactions in the cluster. This will query all potential transaction
coordinators in the cluster and collect the state of all transactions. Users
should typically attempt to reduce the size of the result set using
<a href="ListTransactionsOptions.html#filterProducerIds(java.util.Collection)"><code>ListTransactionsOptions.filterProducerIds(Collection)</code></a> or
<a href="ListTransactionsOptions.html#filterStates(java.util.Collection)"><code>ListTransactionsOptions.filterStates(Collection)</code></a></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listTransactions(org.apache.kafka.clients.admin.ListTransactionsOptions)">listTransactions</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - Options to control the method behavior (including filters)</dd>
<dt>Returns:</dt>
<dd>The result</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fenceProducers(java.util.Collection,org.apache.kafka.clients.admin.FenceProducersOptions)">
<h3>fenceProducers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="FenceProducersResult.html" title="class in org.apache.kafka.clients.admin">FenceProducersResult</a></span>&nbsp;<span class="element-name">fenceProducers</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a>&lt;<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;transactionalIds,
<a href="FenceProducersOptions.html" title="class in org.apache.kafka.clients.admin">FenceProducersOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#fenceProducers(java.util.Collection,org.apache.kafka.clients.admin.FenceProducersOptions)">Admin</a></code></span></div>
<div class="block">Fence out all active producers that use any of the provided transactional IDs.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#fenceProducers(java.util.Collection,org.apache.kafka.clients.admin.FenceProducersOptions)">fenceProducers</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>transactionalIds</code> - The IDs of the producers to fence.</dd>
<dd><code>options</code> - The options to use when fencing the producers.</dd>
<dt>Returns:</dt>
<dd>The FenceProducersResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="listClientMetricsResources(org.apache.kafka.clients.admin.ListClientMetricsResourcesOptions)">
<h3>listClientMetricsResources</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="ListClientMetricsResourcesResult.html" title="class in org.apache.kafka.clients.admin">ListClientMetricsResourcesResult</a></span>&nbsp;<span class="element-name">listClientMetricsResources</span><wbr><span class="parameters">(<a href="ListClientMetricsResourcesOptions.html" title="class in org.apache.kafka.clients.admin">ListClientMetricsResourcesOptions</a>&nbsp;options)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#listClientMetricsResources(org.apache.kafka.clients.admin.ListClientMetricsResourcesOptions)">Admin</a></code></span></div>
<div class="block">List the client metrics configuration resources available in the cluster.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#listClientMetricsResources(org.apache.kafka.clients.admin.ListClientMetricsResourcesOptions)">listClientMetricsResources</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>options</code> - The options to use when listing the client metrics resources.</dd>
<dt>Returns:</dt>
<dd>The ListClientMetricsResourcesResult.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clientInstanceId(java.time.Duration)">
<h3>clientInstanceId</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../common/Uuid.html" title="class in org.apache.kafka.common">Uuid</a></span>&nbsp;<span class="element-name">clientInstanceId</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a>&nbsp;timeout)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#clientInstanceId(java.time.Duration)">Admin</a></code></span></div>
<div class="block">Determines the client's unique client instance ID used for telemetry. This ID is unique to
this specific client instance and will not change after it is initially generated.
The ID is useful for correlating client operations with telemetry sent to the broker and
to its eventual monitoring destinations.
<p>
If telemetry is enabled, this will first require a connection to the cluster to generate
the unique client instance ID. This method waits up to <code>timeout</code> for the admin
client to complete the request.
<p>
Client telemetry is controlled by the <a href="AdminClientConfig.html#ENABLE_METRICS_PUSH_CONFIG"><code>AdminClientConfig.ENABLE_METRICS_PUSH_CONFIG</code></a>
configuration option.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#clientInstanceId(java.time.Duration)">clientInstanceId</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
<dt>Parameters:</dt>
<dd><code>timeout</code> - The maximum time to wait for admin client to determine its client instance ID.
The value must be non-negative. Specifying a timeout of zero means do not
wait for the initial request to complete if it hasn't already.</dd>
<dt>Returns:</dt>
<dd>The client's assigned instance id used for metrics collection.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="metrics()">
<h3>metrics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,<wbr>? extends <a href="../../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>&gt;</span>&nbsp;<span class="element-name">metrics</span>()</div>
<div class="block"><span class="description-from-type-label">Description copied from interface:&nbsp;<code><a href="Admin.html#metrics()">Admin</a></code></span></div>
<div class="block">Get the metrics kept by the adminClient</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Admin.html#metrics()">metrics</a></code>&nbsp;in interface&nbsp;<code><a href="Admin.html" title="interface in org.apache.kafka.clients.admin">Admin</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>