| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>KafkaAdminClient (kafka 3.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.kafka.clients.admin, class: KafkaAdminClient"> |
| <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 data = {"i0":10,"i1":10,"i2":42,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><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">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.kafka.clients.admin</a></div> |
| <h1 title="Class KafkaAdminClient" class="title">Class KafkaAdminClient</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/15/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"><a href="AdminClient.html" title="class in org.apache.kafka.clients.admin">org.apache.kafka.clients.admin.AdminClient</a> |
| <div class="inheritance">org.apache.kafka.clients.admin.KafkaAdminClient</div> |
| </div> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/15/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> |
| <pre><a href="../../common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@Evolving</a> |
| public class <span class="type-name-label">KafkaAdminClient</span> |
| extends <a href="AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></pre> |
| <div class="block">The default implementation of <a href="Admin.html" title="interface in org.apache.kafka.clients.admin"><code>Admin</code></a>. An instance of this class is created by invoking one of the |
| <code>create()</code> methods in <code>AdminClient</code>. Users should not refer to this class directly. |
| |
| <p> |
| This class is thread-safe. |
| </p> |
| The API of this class is evolving, see <a href="Admin.html" title="interface in org.apache.kafka.clients.admin"><code>Admin</code></a> for details.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="table-tab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="table-tab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code><a href="AbortTransactionResult.html" title="class in org.apache.kafka.clients.admin">AbortTransactionResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#abortTransaction(org.apache.kafka.clients.admin.AbortTransactionSpec,org.apache.kafka.clients.admin.AbortTransactionOptions)">abortTransaction</a></span>​(<a href="AbortTransactionSpec.html" title="class in org.apache.kafka.clients.admin">AbortTransactionSpec</a> spec, |
| <a href="AbortTransactionOptions.html" title="class in org.apache.kafka.clients.admin">AbortTransactionOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Forcefully abort a transaction which is open on a topic partition.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code><a href="AlterClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterClientQuotas(java.util.Collection,org.apache.kafka.clients.admin.AlterClientQuotasOptions)">alterClientQuotas</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/quota/ClientQuotaAlteration.html" title="class in org.apache.kafka.common.quota">ClientQuotaAlteration</a>> entries, |
| <a href="AlterClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Alters client quota configurations with the specified alterations.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">alterConfigs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,​<a href="Config.html" title="class in org.apache.kafka.clients.admin">Config</a>> configs, |
| <a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code><a href="AlterConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterConsumerGroupOffsets(java.lang.String,java.util.Map,org.apache.kafka.clients.admin.AlterConsumerGroupOffsetsOptions)">alterConsumerGroupOffsets</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="../consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets, |
| <a href="AlterConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Alters offsets for the specified group.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code><a href="AlterPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterPartitionReassignments(java.util.Map,org.apache.kafka.clients.admin.AlterPartitionReassignmentsOptions)">alterPartitionReassignments</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="NewPartitionReassignment.html" title="class in org.apache.kafka.clients.admin">NewPartitionReassignment</a>>> reassignments, |
| <a href="AlterPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Change the reassignments for one or more partitions.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i5"> |
| <td class="col-first"><code><a href="AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterReplicaLogDirs(java.util.Map,org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions)">alterReplicaLogDirs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> replicaAssignment, |
| <a href="AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Change the log directory for the specified replicas.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i6"> |
| <td class="col-first"><code><a href="AlterUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#alterUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.AlterUserScramCredentialsOptions)">alterUserScramCredentials</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="UserScramCredentialAlteration.html" title="class in org.apache.kafka.clients.admin">UserScramCredentialAlteration</a>> alterations, |
| <a href="AlterUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Alter SASL/SCRAM credentials.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i7"> |
| <td class="col-first"><code>void</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#close(java.time.Duration)">close</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> timeout)</code></th> |
| <td class="col-last"> |
| <div class="block">Close the Admin client and release all associated resources.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i8"> |
| <td class="col-first"><code><a href="CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#createAcls(java.util.Collection,org.apache.kafka.clients.admin.CreateAclsOptions)">createAcls</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>> acls, |
| <a href="CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Creates access control lists (ACLs) which are bound to specific resources.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i9"> |
| <td class="col-first"><code><a href="CreateDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#createDelegationToken(org.apache.kafka.clients.admin.CreateDelegationTokenOptions)">createDelegationToken</a></span>​(<a href="CreateDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Create a Delegation Token.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i10"> |
| <td class="col-first"><code><a href="CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#createPartitions(java.util.Map,org.apache.kafka.clients.admin.CreatePartitionsOptions)">createPartitions</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​<a href="NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>> newPartitions, |
| <a href="CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <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> |
| </td> |
| </tr> |
| <tr class="row-color" id="i11"> |
| <td class="col-first"><code><a href="CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#createTopics(java.util.Collection,org.apache.kafka.clients.admin.CreateTopicsOptions)">createTopics</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>> newTopics, |
| <a href="CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Create a batch of new topics.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i12"> |
| <td class="col-first"><code><a href="DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#deleteAcls(java.util.Collection,org.apache.kafka.clients.admin.DeleteAclsOptions)">deleteAcls</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>> filters, |
| <a href="DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Deletes access control lists (ACLs) according to the supplied filters.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i13"> |
| <td class="col-first"><code><a href="DeleteConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#deleteConsumerGroupOffsets(java.lang.String,java.util.Set,org.apache.kafka.clients.admin.DeleteConsumerGroupOffsetsOptions)">deleteConsumerGroupOffsets</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions, |
| <a href="DeleteConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Delete committed offsets for a set of partitions in a consumer group.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i14"> |
| <td class="col-first"><code><a href="DeleteConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#deleteConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DeleteConsumerGroupsOptions)">deleteConsumerGroups</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> groupIds, |
| <a href="DeleteConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Delete consumer groups from the cluster.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i15"> |
| <td class="col-first"><code><a href="DeleteRecordsResult.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#deleteRecords(java.util.Map,org.apache.kafka.clients.admin.DeleteRecordsOptions)">deleteRecords</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="RecordsToDelete.html" title="class in org.apache.kafka.clients.admin">RecordsToDelete</a>> recordsToDelete, |
| <a href="DeleteRecordsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Delete records whose offset is smaller than the given offset of the corresponding partition.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i16"> |
| <td class="col-first"><code><a href="DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#deleteTopics(org.apache.kafka.common.TopicCollection,org.apache.kafka.clients.admin.DeleteTopicsOptions)">deleteTopics</a></span>​(<a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a> topics, |
| <a href="DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Delete a batch of topics.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i17"> |
| <td class="col-first"><code><a href="DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,org.apache.kafka.clients.admin.DescribeAclsOptions)">describeAcls</a></span>​(<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a> filter, |
| <a href="DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Lists access control lists (ACLs) according to the supplied filter.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i18"> |
| <td class="col-first"><code><a href="DescribeClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeClientQuotas(org.apache.kafka.common.quota.ClientQuotaFilter,org.apache.kafka.clients.admin.DescribeClientQuotasOptions)">describeClientQuotas</a></span>​(<a href="../../common/quota/ClientQuotaFilter.html" title="class in org.apache.kafka.common.quota">ClientQuotaFilter</a> filter, |
| <a href="DescribeClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describes all entities matching the provided filter that have at least one client quota configuration |
| value defined.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i19"> |
| <td class="col-first"><code><a href="DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">describeCluster</a></span>​(<a href="DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Get information about the nodes in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i20"> |
| <td class="col-first"><code><a href="DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeConfigs(java.util.Collection,org.apache.kafka.clients.admin.DescribeConfigsOptions)">describeConfigs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>> configResources, |
| <a href="DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Get the configuration for the specified resources.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i21"> |
| <td class="col-first"><code><a href="DescribeConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeConsumerGroups(java.util.Collection,org.apache.kafka.clients.admin.DescribeConsumerGroupsOptions)">describeConsumerGroups</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> groupIds, |
| <a href="DescribeConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe some group IDs in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i22"> |
| <td class="col-first"><code><a href="DescribeDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeDelegationToken(org.apache.kafka.clients.admin.DescribeDelegationTokenOptions)">describeDelegationToken</a></span>​(<a href="DescribeDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe the Delegation Tokens.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i23"> |
| <td class="col-first"><code><a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeFeatures(org.apache.kafka.clients.admin.DescribeFeaturesOptions)">describeFeatures</a></span>​(<a href="DescribeFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describes finalized as well as supported features.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i24"> |
| <td class="col-first"><code><a href="DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeLogDirsOptions)">describeLogDirs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> brokers, |
| <a href="DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Query the information of all log directories on the given set of brokers</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i25"> |
| <td class="col-first"><code><a href="DescribeProducersResult.html" title="class in org.apache.kafka.clients.admin">DescribeProducersResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeProducers(java.util.Collection,org.apache.kafka.clients.admin.DescribeProducersOptions)">describeProducers</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> topicPartitions, |
| <a href="DescribeProducersOptions.html" title="class in org.apache.kafka.clients.admin">DescribeProducersOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe active producer state on a set of topic partitions.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i26"> |
| <td class="col-first"><code><a href="DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeReplicaLogDirs(java.util.Collection,org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions)">describeReplicaLogDirs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>> replicas, |
| <a href="DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Query the replica log directory information for the specified replicas.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i27"> |
| <td class="col-first"><code><a href="DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeTopics(java.util.Collection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">describeTopics</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topicNames, |
| <a href="DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe some topics in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i28"> |
| <td class="col-first"><code><a href="DescribeTransactionsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeTransactions(java.util.Collection,org.apache.kafka.clients.admin.DescribeTransactionsOptions)">describeTransactions</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> transactionalIds, |
| <a href="DescribeTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe the state of a set of transactional IDs from the respective transaction coordinators, |
| which are dynamically discovered.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i29"> |
| <td class="col-first"><code><a href="DescribeUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#describeUserScramCredentials(java.util.List,org.apache.kafka.clients.admin.DescribeUserScramCredentialsOptions)">describeUserScramCredentials</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> users, |
| <a href="DescribeUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Describe SASL/SCRAM credentials.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i30"> |
| <td class="col-first"><code><a href="ElectLeadersResult.html" title="class in org.apache.kafka.clients.admin">ElectLeadersResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#electLeaders(org.apache.kafka.common.ElectionType,java.util.Set,org.apache.kafka.clients.admin.ElectLeadersOptions)">electLeaders</a></span>​(<a href="../../common/ElectionType.html" title="enum in org.apache.kafka.common">ElectionType</a> electionType, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> topicPartitions, |
| <a href="ElectLeadersOptions.html" title="class in org.apache.kafka.clients.admin">ElectLeadersOptions</a> options)</code></th> |
| <td class="col-last"> |
| <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> |
| </td> |
| </tr> |
| <tr class="row-color" id="i31"> |
| <td class="col-first"><code><a href="ExpireDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#expireDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.ExpireDelegationTokenOptions)">expireDelegationToken</a></span>​(byte[] hmac, |
| <a href="ExpireDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Expire a Delegation Token.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i32"> |
| <td class="col-first"><code><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#incrementalAlterConfigs(java.util.Map,org.apache.kafka.clients.admin.AlterConfigsOptions)">incrementalAlterConfigs</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="AlterConfigOp.html" title="class in org.apache.kafka.clients.admin">AlterConfigOp</a>>> configs, |
| <a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Incrementally update the configuration for the specified resources.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i33"> |
| <td class="col-first"><code><a href="ListConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listConsumerGroupOffsets(java.lang.String,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">listConsumerGroupOffsets</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="ListConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">List the consumer group offsets available in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i34"> |
| <td class="col-first"><code><a href="ListConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listConsumerGroups(org.apache.kafka.clients.admin.ListConsumerGroupsOptions)">listConsumerGroups</a></span>​(<a href="ListConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">List the consumer groups available in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i35"> |
| <td class="col-first"><code><a href="ListOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListOffsetsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listOffsets(java.util.Map,org.apache.kafka.clients.admin.ListOffsetsOptions)">listOffsets</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="OffsetSpec.html" title="class in org.apache.kafka.clients.admin">OffsetSpec</a>> topicPartitionOffsets, |
| <a href="ListOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListOffsetsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">List offset for the specified partitions.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i36"> |
| <td class="col-first"><code><a href="ListPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listPartitionReassignments(java.util.Optional,org.apache.kafka.clients.admin.ListPartitionReassignmentsOptions)">listPartitionReassignments</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>> partitions, |
| <a href="ListPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsOptions</a> options)</code></th> |
| <td class="col-last"> </td> |
| </tr> |
| <tr class="row-color" id="i37"> |
| <td class="col-first"><code><a href="ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">listTopics</a></span>​(<a href="ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">List the topics available in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i38"> |
| <td class="col-first"><code><a href="ListTransactionsResult.html" title="class in org.apache.kafka.clients.admin">ListTransactionsResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#listTransactions(org.apache.kafka.clients.admin.ListTransactionsOptions)">listTransactions</a></span>​(<a href="ListTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">ListTransactionsOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">List active transactions in the cluster.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i39"> |
| <td class="col-first"><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,​? extends <a href="../../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#metrics()">metrics</a></span>()</code></th> |
| <td class="col-last"> |
| <div class="block">Get the metrics kept by the adminClient</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i40"> |
| <td class="col-first"><code><a href="RemoveMembersFromConsumerGroupResult.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#removeMembersFromConsumerGroup(java.lang.String,org.apache.kafka.clients.admin.RemoveMembersFromConsumerGroupOptions)">removeMembersFromConsumerGroup</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="RemoveMembersFromConsumerGroupOptions.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Remove members from the consumer group by given member identities.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i41"> |
| <td class="col-first"><code><a href="RenewDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#renewDelegationToken(byte%5B%5D,org.apache.kafka.clients.admin.RenewDelegationTokenOptions)">renewDelegationToken</a></span>​(byte[] hmac, |
| <a href="RenewDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Renew a Delegation Token.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i42"> |
| <td class="col-first"><code><a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)">unregisterBroker</a></span>​(int brokerId, |
| <a href="UnregisterBrokerOptions.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Unregister a broker.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i43"> |
| <td class="col-first"><code><a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesResult</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#updateFeatures(java.util.Map,org.apache.kafka.clients.admin.UpdateFeaturesOptions)">updateFeatures</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​<a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin">FeatureUpdate</a>> featureUpdates, |
| <a href="UpdateFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesOptions</a> options)</code></th> |
| <td class="col-last"> |
| <div class="block">Applies specified updates to finalized features.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.org.apache.kafka.clients.admin.AdminClient">Methods inherited from class org.apache.kafka.clients.admin.<a href="AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></h3> |
| <code><a href="AdminClient.html#create(java.util.Map)">create</a>, <a href="AdminClient.html#create(java.util.Properties)">create</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/15/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/15/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/15/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/15/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/15/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/15/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/15/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/15/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/15/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/15/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/15/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/15/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 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#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#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#incrementalAlterConfigs(java.util.Map)">incrementalAlterConfigs</a>, <a href="Admin.html#listConsumerGroupOffsets(java.lang.String)">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"> |
| <!-- ============ 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> <span class="return-type">void</span> <span class="member-name">close</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/time/Duration.html" title="class or interface in java.time" class="external-link">Duration</a> timeout)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a></span> <span class="member-name">createTopics</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>> newTopics, |
| <a href="CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a></span> <span class="member-name">deleteTopics</span>​(<span class="parameters"><a href="../../common/TopicCollection.html" title="class in org.apache.kafka.common">TopicCollection</a> topics, |
| <a href="DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a></span> <span class="member-name">listTopics</span>​(<span class="parameters"><a href="ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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(java.util.Collection,org.apache.kafka.clients.admin.DescribeTopicsOptions)"> |
| <h3>describeTopics</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a></span> <span class="member-name">describeTopics</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> topicNames, |
| <a href="DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Admin.html#describeTopics(java.util.Collection,org.apache.kafka.clients.admin.DescribeTopicsOptions)">Admin</a></code></span></div> |
| <div class="block">Describe some topics in the cluster.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>topicNames</code> - The names of the topics to describe.</dd> |
| <dd><code>options</code> - The options to use when describing the topic.</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> <span class="return-type"><a href="DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a></span> <span class="member-name">describeCluster</span>​(<span class="parameters"><a href="DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a></span> <span class="member-name">describeAcls</span>​(<span class="parameters"><a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a> filter, |
| <a href="DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a></span> <span class="member-name">createAcls</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>> acls, |
| <a href="CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a></span> <span class="member-name">deleteAcls</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>> filters, |
| <a href="DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a></span> <span class="member-name">describeConfigs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>> configResources, |
| <a href="DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>Parameters:</dt> |
| <dd><code>configResources</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/15/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> <span class="return-type"><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></span> <span class="member-name">alterConfigs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,​<a href="Config.html" title="class in org.apache.kafka.clients.admin">Config</a>> configs, |
| <a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></span> <span class="member-name">incrementalAlterConfigs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="AlterConfigOp.html" title="class in org.apache.kafka.clients.admin">AlterConfigOp</a>>> configs, |
| <a href="AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a></span> <span class="member-name">alterReplicaLogDirs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> replicaAssignment, |
| <a href="AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a></span> <span class="member-name">describeLogDirs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> brokers, |
| <a href="DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a></span> <span class="member-name">describeReplicaLogDirs</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>> replicas, |
| <a href="DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a></span> <span class="member-name">createPartitions</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​<a href="NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>> newPartitions, |
| <a href="CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DeleteRecordsResult.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsResult</a></span> <span class="member-name">deleteRecords</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="RecordsToDelete.html" title="class in org.apache.kafka.clients.admin">RecordsToDelete</a>> recordsToDelete, |
| <a href="DeleteRecordsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteRecordsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="CreateDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenResult</a></span> <span class="member-name">createDelegationToken</span>​(<span class="parameters"><a href="CreateDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">CreateDelegationTokenOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="RenewDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenResult</a></span> <span class="member-name">renewDelegationToken</span>​(<span class="parameters">byte[] hmac, |
| <a href="RenewDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">RenewDelegationTokenOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="ExpireDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenResult</a></span> <span class="member-name">expireDelegationToken</span>​(<span class="parameters">byte[] hmac, |
| <a href="ExpireDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">ExpireDelegationTokenOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeDelegationTokenResult.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenResult</a></span> <span class="member-name">describeDelegationToken</span>​(<span class="parameters"><a href="DescribeDelegationTokenOptions.html" title="class in org.apache.kafka.clients.admin">DescribeDelegationTokenOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsResult</a></span> <span class="member-name">describeConsumerGroups</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> groupIds, |
| <a href="DescribeConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConsumerGroupsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="ListConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsResult</a></span> <span class="member-name">listConsumerGroups</span>​(<span class="parameters"><a href="ListConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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.lang.String,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)"> |
| <h3>listConsumerGroupOffsets</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ListConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsResult</a></span> <span class="member-name">listConsumerGroupOffsets</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="ListConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListConsumerGroupOffsetsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Admin.html#listConsumerGroupOffsets(java.lang.String,org.apache.kafka.clients.admin.ListConsumerGroupOffsetsOptions)">Admin</a></code></span></div> |
| <div class="block">List the consumer group offsets available in the cluster.</div> |
| <dl class="notes"> |
| <dd><code>options</code> - The options to use when listing the consumer group offsets.</dd> |
| <dt>Returns:</dt> |
| <dd>The ListGroupOffsetsResult</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> <span class="return-type"><a href="DeleteConsumerGroupsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsResult</a></span> <span class="member-name">deleteConsumerGroups</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> groupIds, |
| <a href="DeleteConsumerGroupsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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"> |
| <dd><code>options</code> - The options to use when deleting a consumer group.</dd> |
| <dt>Returns:</dt> |
| <dd>The DeletConsumerGroupResult.</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> <span class="return-type"><a href="DeleteConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsResult</a></span> <span class="member-name">deleteConsumerGroupOffsets</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> partitions, |
| <a href="DeleteConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteConsumerGroupOffsetsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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"> |
| <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="metrics()"> |
| <h3>metrics</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,​? extends <a href="../../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>></span> <span class="member-name">metrics</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Admin.html#metrics()">Admin</a></code></span></div> |
| <div class="block">Get the metrics kept by the adminClient</div> |
| </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> <span class="return-type"><a href="ElectLeadersResult.html" title="class in org.apache.kafka.clients.admin">ElectLeadersResult</a></span> <span class="member-name">electLeaders</span>​(<span class="parameters"><a href="../../common/ElectionType.html" title="enum in org.apache.kafka.common">ElectionType</a> electionType, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> topicPartitions, |
| <a href="ElectLeadersOptions.html" title="class in org.apache.kafka.clients.admin">ElectLeadersOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>Parameters:</dt> |
| <dd><code>electionType</code> - The type of election to conduct.</dd> |
| <dd><code>topicPartitions</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> <span class="return-type"><a href="AlterPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsResult</a></span> <span class="member-name">alterPartitionReassignments</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="NewPartitionReassignment.html" title="class in org.apache.kafka.clients.admin">NewPartitionReassignment</a>>> reassignments, |
| <a href="AlterPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">AlterPartitionReassignmentsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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/15/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>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> <span class="return-type"><a href="ListPartitionReassignmentsResult.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsResult</a></span> <span class="member-name">listPartitionReassignments</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>>> partitions, |
| <a href="ListPartitionReassignmentsOptions.html" title="class in org.apache.kafka.clients.admin">ListPartitionReassignmentsOptions</a> options)</span></div> |
| <dl class="notes"> |
| <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> <span class="return-type"><a href="RemoveMembersFromConsumerGroupResult.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupResult</a></span> <span class="member-name">removeMembersFromConsumerGroup</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="RemoveMembersFromConsumerGroupOptions.html" title="class in org.apache.kafka.clients.admin">RemoveMembersFromConsumerGroupOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AlterConsumerGroupOffsetsResult.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsResult</a></span> <span class="member-name">alterConsumerGroupOffsets</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> groupId, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="../consumer/OffsetAndMetadata.html" title="class in org.apache.kafka.clients.consumer">OffsetAndMetadata</a>> offsets, |
| <a href="AlterConsumerGroupOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConsumerGroupOffsetsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="ListOffsetsResult.html" title="class in org.apache.kafka.clients.admin">ListOffsetsResult</a></span> <span class="member-name">listOffsets</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>,​<a href="OffsetSpec.html" title="class in org.apache.kafka.clients.admin">OffsetSpec</a>> topicPartitionOffsets, |
| <a href="ListOffsetsOptions.html" title="class in org.apache.kafka.clients.admin">ListOffsetsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasResult</a></span> <span class="member-name">describeClientQuotas</span>​(<span class="parameters"><a href="../../common/quota/ClientQuotaFilter.html" title="class in org.apache.kafka.common.quota">ClientQuotaFilter</a> filter, |
| <a href="DescribeClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClientQuotasOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AlterClientQuotasResult.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasResult</a></span> <span class="member-name">alterClientQuotas</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/quota/ClientQuotaAlteration.html" title="class in org.apache.kafka.common.quota">ClientQuotaAlteration</a>> entries, |
| <a href="AlterClientQuotasOptions.html" title="class in org.apache.kafka.clients.admin">AlterClientQuotasOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsResult</a></span> <span class="member-name">describeUserScramCredentials</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> users, |
| <a href="DescribeUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeUserScramCredentialsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AlterUserScramCredentialsResult.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsResult</a></span> <span class="member-name">alterUserScramCredentials</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="UserScramCredentialAlteration.html" title="class in org.apache.kafka.clients.admin">UserScramCredentialAlteration</a>> alterations, |
| <a href="AlterUserScramCredentialsOptions.html" title="class in org.apache.kafka.clients.admin">AlterUserScramCredentialsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeFeaturesResult.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesResult</a></span> <span class="member-name">describeFeatures</span>​(<span class="parameters"><a href="DescribeFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">DescribeFeaturesOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="UpdateFeaturesResult.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesResult</a></span> <span class="member-name">updateFeatures</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,​<a href="FeatureUpdate.html" title="class in org.apache.kafka.clients.admin">FeatureUpdate</a>> featureUpdates, |
| <a href="UpdateFeaturesOptions.html" title="class in org.apache.kafka.clients.admin">UpdateFeaturesOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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="unregisterBroker(int,org.apache.kafka.clients.admin.UnregisterBrokerOptions)"> |
| <h3>unregisterBroker</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="UnregisterBrokerResult.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerResult</a></span> <span class="member-name">unregisterBroker</span>​(<span class="parameters">int brokerId, |
| <a href="UnregisterBrokerOptions.html" title="class in org.apache.kafka.clients.admin">UnregisterBrokerOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="DescribeProducersResult.html" title="class in org.apache.kafka.clients.admin">DescribeProducersResult</a></span> <span class="member-name">describeProducers</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="../../common/TopicPartition.html" title="class in org.apache.kafka.common">TopicPartition</a>> topicPartitions, |
| <a href="DescribeProducersOptions.html" title="class in org.apache.kafka.clients.admin">DescribeProducersOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>Parameters:</dt> |
| <dd><code>topicPartitions</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> <span class="return-type"><a href="DescribeTransactionsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsResult</a></span> <span class="member-name">describeTransactions</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> transactionalIds, |
| <a href="DescribeTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTransactionsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="AbortTransactionResult.html" title="class in org.apache.kafka.clients.admin">AbortTransactionResult</a></span> <span class="member-name">abortTransaction</span>​(<span class="parameters"><a href="AbortTransactionSpec.html" title="class in org.apache.kafka.clients.admin">AbortTransactionSpec</a> spec, |
| <a href="AbortTransactionOptions.html" title="class in org.apache.kafka.clients.admin">AbortTransactionOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> <span class="return-type"><a href="ListTransactionsResult.html" title="class in org.apache.kafka.clients.admin">ListTransactionsResult</a></span> <span class="member-name">listTransactions</span>​(<span class="parameters"><a href="ListTransactionsOptions.html" title="class in org.apache.kafka.clients.admin">ListTransactionsOptions</a> options)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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>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> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
