http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html b/10/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html new file mode 100644 index 0000000..c0e9512 --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html @@ -0,0 +1,758 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_152) on Wed Nov 01 13:25:42 GMT 2017 --> +<title>KafkaAdminClient (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KafkaAdminClient (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/KafkaAdminClient.html" target="_top">Frames</a></li> +<li><a href="KafkaAdminClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.admin</div> +<h2 title="Class KafkaAdminClient" class="title">Class KafkaAdminClient</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">org.apache.kafka.clients.admin.AdminClient</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.admin.KafkaAdminClient</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.AutoCloseable</dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@InterfaceStability.Evolving</a> +public class <span class="typeNameLabel">KafkaAdminClient</span> +extends <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></pre> +<div class="block">The default implementation of <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin"><code>AdminClient</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. + + The API of this class is evolving, see <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin"><code>AdminClient</code></a> for details.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#alterConfigs-java.util.Map-org.apache.kafka.clients.admin.AlterConfigsOptions-">alterConfigs</a></span>(java.util.Map<<a href="../../../../../org/apache/kafka/common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<a href="../../../../../org/apache/kafka/clients/admin/Config.html" title="class in org.apache.kafka.clients.admin">Config</a>> configs, + <a href="../../../../../org/apache/kafka/clients/admin/AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</code> +<div class="block">Update the configuration for the specified resources with the default options.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#alterReplicaLogDirs-java.util.Map-org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions-">alterReplicaLogDirs</a></span>(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,java.lang.String> replicaAssignment, + <a href="../../../../../org/apache/kafka/clients/admin/AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a> options)</code> +<div class="block">Change the log directory for the specified replicas.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#close-long-java.util.concurrent.TimeUnit-">close</a></span>(long duration, + java.util.concurrent.TimeUnit unit)</code> +<div class="block">Close the AdminClient and release all associated resources.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#createAcls-java.util.Collection-org.apache.kafka.clients.admin.CreateAclsOptions-">createAcls</a></span>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>> acls, + <a href="../../../../../org/apache/kafka/clients/admin/CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a> options)</code> +<div class="block">Creates access control lists (ACLs) which are bound to specific resources.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#createPartitions-java.util.Map-org.apache.kafka.clients.admin.CreatePartitionsOptions-">createPartitions</a></span>(java.util.Map<java.lang.String,<a href="../../../../../org/apache/kafka/clients/admin/NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>> newPartitions, + <a href="../../../../../org/apache/kafka/clients/admin/CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a> options)</code> +<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 id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#createTopics-java.util.Collection-org.apache.kafka.clients.admin.CreateTopicsOptions-">createTopics</a></span>(java.util.Collection<<a href="../../../../../org/apache/kafka/clients/admin/NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>> newTopics, + <a href="../../../../../org/apache/kafka/clients/admin/CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a> options)</code> +<div class="block">Create a batch of new topics.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#deleteAcls-java.util.Collection-org.apache.kafka.clients.admin.DeleteAclsOptions-">deleteAcls</a></span>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>> filters, + <a href="../../../../../org/apache/kafka/clients/admin/DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a> options)</code> +<div class="block">Deletes access control lists (ACLs) according to the supplied filters.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#deleteTopics-java.util.Collection-org.apache.kafka.clients.admin.DeleteTopicsOptions-">deleteTopics</a></span>(java.util.Collection<java.lang.String> topicNames, + <a href="../../../../../org/apache/kafka/clients/admin/DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a> options)</code> +<div class="block">Delete a batch of topics.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeAcls-org.apache.kafka.common.acl.AclBindingFilter-org.apache.kafka.clients.admin.DescribeAclsOptions-">describeAcls</a></span>(<a href="../../../../../org/apache/kafka/common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a> filter, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a> options)</code> +<div class="block">Lists access control lists (ACLs) according to the supplied filter.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeCluster-org.apache.kafka.clients.admin.DescribeClusterOptions-">describeCluster</a></span>(<a href="../../../../../org/apache/kafka/clients/admin/DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a> options)</code> +<div class="block">Get information about the nodes in the cluster.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeConfigs-java.util.Collection-org.apache.kafka.clients.admin.DescribeConfigsOptions-">describeConfigs</a></span>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>> configResources, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a> options)</code> +<div class="block">Get the configuration for the specified resources.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeLogDirsOptions-">describeLogDirs</a></span>(java.util.Collection<java.lang.Integer> brokers, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a> options)</code> +<div class="block">Query the information of all log directories on the given set of brokers + + This operation is supported by brokers with version 1.0.0 or higher.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeReplicaLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions-">describeReplicaLogDirs</a></span>(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>> replicas, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a> options)</code> +<div class="block">Query the replica log directory information for the specified replicas.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeTopics-java.util.Collection-org.apache.kafka.clients.admin.DescribeTopicsOptions-">describeTopics</a></span>(java.util.Collection<java.lang.String> topicNames, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a> options)</code> +<div class="block">Describe some topics in the cluster.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#listTopics-org.apache.kafka.clients.admin.ListTopicsOptions-">listTopics</a></span>(<a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> options)</code> +<div class="block">List the topics available in the cluster.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.kafka.clients.admin.AdminClient"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.clients.admin.<a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></h3> +<code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs-java.util.Map-">alterConfigs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterReplicaLogDirs-java.util.Map-">alterReplicaLogDirs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close--">close</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#create-java.util.Map-">create</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#create-java.util.Properties-">create</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createAcls-java.util.Collection-">createAcls</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createPartitions-java.util.Map-">createPartitions</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createTopics-java.util.Collection-">createTopics</a>, <a href="../../../../../org/apache/kafka/clients/ad min/AdminClient.html#deleteAcls-java.util.Collection-">deleteAcls</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteTopics-java.util.Collection-">deleteTopics</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls-org.apache.kafka.common.acl.AclBindingFilter-">describeAcls</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeCluster--">describeCluster</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs-java.util.Collection-">describeConfigs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeLogDirs-java.util.Collection-">describeLogDirs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeReplicaLogDirs-java.util.Collection-">describeReplicaLogDirs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics-java.util.Collection-">describeTopics</a> , <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics--">listTopics</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="close-long-java.util.concurrent.TimeUnit-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close(long duration, + java.util.concurrent.TimeUnit unit)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close-long-java.util.concurrent.TimeUnit-">AdminClient</a></code></span></div> +<div class="block">Close the AdminClient and release all associated resources. + + The close operation has a grace period during which current operations will be allowed to + complete, specified by the given duration and time unit. + 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 TimeoutException.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close-long-java.util.concurrent.TimeUnit-">close</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>duration</code> - The duration to use for the wait time.</dd> +<dd><code>unit</code> - The time unit to use for the wait time.</dd> +</dl> +</li> +</ul> +<a name="createTopics-java.util.Collection-org.apache.kafka.clients.admin.CreateTopicsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createTopics</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/CreateTopicsResult.html" title="class in org.apache.kafka.clients.admin">CreateTopicsResult</a> createTopics(java.util.Collection<<a href="../../../../../org/apache/kafka/clients/admin/NewTopic.html" title="class in org.apache.kafka.clients.admin">NewTopic</a>> newTopics, + <a href="../../../../../org/apache/kafka/clients/admin/CreateTopicsOptions.html" title="class in org.apache.kafka.clients.admin">CreateTopicsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createTopics-java.util.Collection-org.apache.kafka.clients.admin.CreateTopicsOptions-">AdminClient</a></code></span></div> +<div class="block">Create a batch of new topics. + + This operation is not transactional so it may succeed for some topics while fail for others. + + It may take several seconds after this method returns + success for all the brokers to become aware that the topics have been created. + During this time, <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics--"><code>AdminClient.listTopics()</code></a> and <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics-java.util.Collection-"><code>AdminClient.describeTopics(Collection)</code></a> + may not return information about the new topics. + + 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> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createTopics-java.util.Collection-org.apache.kafka.clients.admin.CreateTopicsOptions-">createTopics</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The CreateTopicsResult.</dd> +</dl> +</li> +</ul> +<a name="deleteTopics-java.util.Collection-org.apache.kafka.clients.admin.DeleteTopicsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTopics</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DeleteTopicsResult.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsResult</a> deleteTopics(java.util.Collection<java.lang.String> topicNames, + <a href="../../../../../org/apache/kafka/clients/admin/DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteTopics-java.util.Collection-org.apache.kafka.clients.admin.DeleteTopicsOptions-">AdminClient</a></code></span></div> +<div class="block">Delete a batch of topics. + + This operation is not transactional so it may succeed for some topics while fail for others. + + It may take several seconds after AdminClient#deleteTopics returns + success for all the brokers to become aware that the topics are gone. + During this time, AdminClient#listTopics and AdminClient#describeTopics + may continue to return information about the deleted topics. + + 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. + + This operation is supported by brokers with version 0.10.1.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteTopics-java.util.Collection-org.apache.kafka.clients.admin.DeleteTopicsOptions-">deleteTopics</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topicNames</code> - The topic names to delete.</dd> +<dd><code>options</code> - The options to use when deleting the topics.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The DeleteTopicsResult.</dd> +</dl> +</li> +</ul> +<a name="listTopics-org.apache.kafka.clients.admin.ListTopicsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listTopics</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html" title="class in org.apache.kafka.clients.admin">ListTopicsResult</a> listTopics(<a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics-org.apache.kafka.clients.admin.ListTopicsOptions-">AdminClient</a></code></span></div> +<div class="block">List the topics available in the cluster.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics-org.apache.kafka.clients.admin.ListTopicsOptions-">listTopics</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>options</code> - The options to use when listing the topics.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The ListTopicsResult.</dd> +</dl> +</li> +</ul> +<a name="describeTopics-java.util.Collection-org.apache.kafka.clients.admin.DescribeTopicsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeTopics</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsResult</a> describeTopics(java.util.Collection<java.lang.String> topicNames, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeTopicsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics-java.util.Collection-org.apache.kafka.clients.admin.DescribeTopicsOptions-">AdminClient</a></code></span></div> +<div class="block">Describe some topics in the cluster.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics-java.util.Collection-org.apache.kafka.clients.admin.DescribeTopicsOptions-">describeTopics</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The DescribeTopicsResult.</dd> +</dl> +</li> +</ul> +<a name="describeCluster-org.apache.kafka.clients.admin.DescribeClusterOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeCluster</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeClusterResult.html" title="class in org.apache.kafka.clients.admin">DescribeClusterResult</a> describeCluster(<a href="../../../../../org/apache/kafka/clients/admin/DescribeClusterOptions.html" title="class in org.apache.kafka.clients.admin">DescribeClusterOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeCluster-org.apache.kafka.clients.admin.DescribeClusterOptions-">AdminClient</a></code></span></div> +<div class="block">Get information about the nodes in the cluster.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeCluster-org.apache.kafka.clients.admin.DescribeClusterOptions-">describeCluster</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>options</code> - The options to use when getting information about the cluster.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The DescribeClusterResult.</dd> +</dl> +</li> +</ul> +<a name="describeAcls-org.apache.kafka.common.acl.AclBindingFilter-org.apache.kafka.clients.admin.DescribeAclsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeAcls</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeAclsResult.html" title="class in org.apache.kafka.clients.admin">DescribeAclsResult</a> describeAcls(<a href="../../../../../org/apache/kafka/common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a> filter, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeAclsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeAclsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls-org.apache.kafka.common.acl.AclBindingFilter-org.apache.kafka.clients.admin.DescribeAclsOptions-">AdminClient</a></code></span></div> +<div class="block">Lists access control lists (ACLs) according to the supplied filter. + + Note: it may take some time for changes made by createAcls or deleteAcls to be reflected + in the output of describeAcls. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls-org.apache.kafka.common.acl.AclBindingFilter-org.apache.kafka.clients.admin.DescribeAclsOptions-">describeAcls</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filter</code> - The filter to use.</dd> +<dd><code>options</code> - The options to use when listing the ACLs.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The DeleteAclsResult.</dd> +</dl> +</li> +</ul> +<a name="createAcls-java.util.Collection-org.apache.kafka.clients.admin.CreateAclsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAcls</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/CreateAclsResult.html" title="class in org.apache.kafka.clients.admin">CreateAclsResult</a> createAcls(java.util.Collection<<a href="../../../../../org/apache/kafka/common/acl/AclBinding.html" title="class in org.apache.kafka.common.acl">AclBinding</a>> acls, + <a href="../../../../../org/apache/kafka/clients/admin/CreateAclsOptions.html" title="class in org.apache.kafka.clients.admin">CreateAclsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createAcls-java.util.Collection-org.apache.kafka.clients.admin.CreateAclsOptions-">AdminClient</a></code></span></div> +<div class="block">Creates access control lists (ACLs) which are bound to specific resources. + + This operation is not transactional so it may succeed for some ACLs while fail for others. + + If you attempt to add an ACL that duplicates an existing ACL, no error will be raised, but + no changes will be made. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createAcls-java.util.Collection-org.apache.kafka.clients.admin.CreateAclsOptions-">createAcls</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>acls</code> - The ACLs to create</dd> +<dd><code>options</code> - The options to use when creating the ACLs.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The CreateAclsResult.</dd> +</dl> +</li> +</ul> +<a name="deleteAcls-java.util.Collection-org.apache.kafka.clients.admin.DeleteAclsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteAcls</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DeleteAclsResult.html" title="class in org.apache.kafka.clients.admin">DeleteAclsResult</a> deleteAcls(java.util.Collection<<a href="../../../../../org/apache/kafka/common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a>> filters, + <a href="../../../../../org/apache/kafka/clients/admin/DeleteAclsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteAclsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteAcls-java.util.Collection-org.apache.kafka.clients.admin.DeleteAclsOptions-">AdminClient</a></code></span></div> +<div class="block">Deletes access control lists (ACLs) according to the supplied filters. + + This operation is not transactional so it may succeed for some ACLs while fail for others. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteAcls-java.util.Collection-org.apache.kafka.clients.admin.DeleteAclsOptions-">deleteAcls</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>filters</code> - The filters to use.</dd> +<dd><code>options</code> - The options to use when deleting the ACLs.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The DeleteAclsResult.</dd> +</dl> +</li> +</ul> +<a name="describeConfigs-java.util.Collection-org.apache.kafka.clients.admin.DescribeConfigsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeConfigs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeConfigsResult.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsResult</a> describeConfigs(java.util.Collection<<a href="../../../../../org/apache/kafka/common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>> configResources, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs-java.util.Collection-org.apache.kafka.clients.admin.DescribeConfigsOptions-">AdminClient</a></code></span></div> +<div class="block">Get the configuration for the specified resources. + + The returned configuration includes default values and the isDefault() method can be used to distinguish them + from user supplied values. + + The value of config entries where isSensitive() is true is always <code>null</code> so that sensitive information + is not disclosed. + + Config entries where isReadOnly() is true cannot be updated. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs-java.util.Collection-org.apache.kafka.clients.admin.DescribeConfigsOptions-">describeConfigs</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The DescribeConfigsResult</dd> +</dl> +</li> +</ul> +<a name="alterConfigs-java.util.Map-org.apache.kafka.clients.admin.AlterConfigsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>alterConfigs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/AlterConfigsResult.html" title="class in org.apache.kafka.clients.admin">AlterConfigsResult</a> alterConfigs(java.util.Map<<a href="../../../../../org/apache/kafka/common/config/ConfigResource.html" title="class in org.apache.kafka.common.config">ConfigResource</a>,<a href="../../../../../org/apache/kafka/clients/admin/Config.html" title="class in org.apache.kafka.clients.admin">Config</a>> configs, + <a href="../../../../../org/apache/kafka/clients/admin/AlterConfigsOptions.html" title="class in org.apache.kafka.clients.admin">AlterConfigsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs-java.util.Map-org.apache.kafka.clients.admin.AlterConfigsOptions-">AdminClient</a></code></span></div> +<div class="block">Update the configuration for the specified resources with the default options. + + Updates are not transactional so they may succeed for some resources while fail for others. The configs for + a particular resource are updated atomically. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs-java.util.Map-org.apache.kafka.clients.admin.AlterConfigsOptions-">alterConfigs</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The AlterConfigsResult</dd> +</dl> +</li> +</ul> +<a name="alterReplicaLogDirs-java.util.Map-org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>alterReplicaLogDirs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/AlterReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsResult</a> alterReplicaLogDirs(java.util.Map<<a href="../../../../../org/apache/kafka/common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>,java.lang.String> replicaAssignment, + <a href="../../../../../org/apache/kafka/clients/admin/AlterReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">AlterReplicaLogDirsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterReplicaLogDirs-java.util.Map-org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions-">AdminClient</a></code></span></div> +<div class="block">Change the log directory for the specified replicas. This API is currently only useful if it is used + before the replica has been created on the broker. It will support moving replicas that have already been created after + KIP-113 is fully implemented. + + This operation is not transactional so it may succeed for some replicas while fail for others. + + This operation is supported by brokers with version 1.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterReplicaLogDirs-java.util.Map-org.apache.kafka.clients.admin.AlterReplicaLogDirsOptions-">alterReplicaLogDirs</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The AlterReplicaLogDirsResult</dd> +</dl> +</li> +</ul> +<a name="describeLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeLogDirsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeLogDirs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsResult</a> describeLogDirs(java.util.Collection<java.lang.Integer> brokers, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeLogDirsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeLogDirsOptions-">AdminClient</a></code></span></div> +<div class="block">Query the information of all log directories on the given set of brokers + + This operation is supported by brokers with version 1.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeLogDirsOptions-">describeLogDirs</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The DescribeLogDirsResult</dd> +</dl> +</li> +</ul> +<a name="describeReplicaLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>describeReplicaLogDirs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/DescribeReplicaLogDirsResult.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsResult</a> describeReplicaLogDirs(java.util.Collection<<a href="../../../../../org/apache/kafka/common/TopicPartitionReplica.html" title="class in org.apache.kafka.common">TopicPartitionReplica</a>> replicas, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeReplicaLogDirsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeReplicaLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions-">AdminClient</a></code></span></div> +<div class="block">Query the replica log directory information for the specified replicas. + + This operation is supported by brokers with version 1.0.0 or higher.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeReplicaLogDirs-java.util.Collection-org.apache.kafka.clients.admin.DescribeReplicaLogDirsOptions-">describeReplicaLogDirs</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> +<dd>The DescribeReplicaLogDirsResult</dd> +</dl> +</li> +</ul> +<a name="createPartitions-java.util.Map-org.apache.kafka.clients.admin.CreatePartitionsOptions-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createPartitions</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/CreatePartitionsResult.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsResult</a> createPartitions(java.util.Map<java.lang.String,<a href="../../../../../org/apache/kafka/clients/admin/NewPartitions.html" title="class in org.apache.kafka.clients.admin">NewPartitions</a>> newPartitions, + <a href="../../../../../org/apache/kafka/clients/admin/CreatePartitionsOptions.html" title="class in org.apache.kafka.clients.admin">CreatePartitionsOptions</a> options)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createPartitions-java.util.Map-org.apache.kafka.clients.admin.CreatePartitionsOptions-">AdminClient</a></code></span></div> +<div class="block"><p>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> + + <p>This operation is not transactional so it may succeed for some topics while fail for others.</p> + + <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="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics-java.util.Collection-"><code>AdminClient.describeTopics(Collection)</code></a> + may not return information about the new partitions.</p> + + <p>This operation is supported by brokers with version 1.0.0 or higher.</p> + + <p>The following exceptions can be anticipated when calling <code>get()</code> on the futures obtained from the + <a href="../../../../../org/apache/kafka/clients/admin/CreatePartitionsResult.html#values--"><code>values()</code></a> method of the returned <code>CreatePartitionsResult</code></p> + <ul> + <li><a href="../../../../../org/apache/kafka/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="../../../../../org/apache/kafka/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="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html#timeoutMs--"><code>AbstractOptions.timeoutMs()</code></a>.</li> + <li><a href="../../../../../org/apache/kafka/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="../../../../../org/apache/kafka/common/errors/BrokerNotAvailableException.html" title="class in org.apache.kafka.common.errors"><code>BrokerNotAvailableException</code></a> + if the requested <a href="../../../../../org/apache/kafka/clients/admin/NewPartitions.html#assignments--"><code>NewPartitions.assignments()</code></a> contain a broker that is currently unavailable.</li> + <li><a href="../../../../../org/apache/kafka/common/errors/InvalidReplicationFactorException.html" title="class in org.apache.kafka.common.errors"><code>InvalidReplicationFactorException</code></a> + if no <a href="../../../../../org/apache/kafka/clients/admin/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="../../../../../org/apache/kafka/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> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createPartitions-java.util.Map-org.apache.kafka.clients.admin.CreatePartitionsOptions-">createPartitions</a></code> in class <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></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 paritions.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The CreatePartitionsResult.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/KafkaAdminClient.html" target="_top">Frames</a></li> +<li><a href="KafkaAdminClient.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html b/10/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html new file mode 100644 index 0000000..ba6fe06 --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html @@ -0,0 +1,311 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_152) on Wed Nov 01 13:25:42 GMT 2017 --> +<title>ListTopicsOptions (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ListTopicsOptions (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/ListTopicsOptions.html" target="_top">Frames</a></li> +<li><a href="ListTopicsOptions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.admin</div> +<h2 title="Class ListTopicsOptions" class="title">Class ListTopicsOptions</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html" title="class in org.apache.kafka.clients.admin">org.apache.kafka.clients.admin.AbstractOptions</a><<a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.admin.ListTopicsOptions</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@InterfaceStability.Evolving</a> +public class <span class="typeNameLabel">ListTopicsOptions</span> +extends <a href="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html" title="class in org.apache.kafka.clients.admin">AbstractOptions</a><<a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a>></pre> +<div class="block">Options for <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics--"><code>AdminClient.listTopics()</code></a>. + + The API of this class is evolving, see <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin"><code>AdminClient</code></a> for details.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#ListTopicsOptions--">ListTopicsOptions</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#listInternal-boolean-">listInternal</a></span>(boolean listInternal)</code> +<div class="block">Set whether we should list internal topics.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#shouldListInternal--">shouldListInternal</a></span>()</code> +<div class="block">Return true if we should list internal topics.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.kafka.clients.admin.AbstractOptions"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.kafka.clients.admin.<a href="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html" title="class in org.apache.kafka.clients.admin">AbstractOptions</a></h3> +<code><a href="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html#timeoutMs--">timeoutMs</a>, <a href="../../../../../org/apache/kafka/clients/admin/AbstractOptions.html#timeoutMs-java.lang.Integer-">timeoutMs</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ListTopicsOptions--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ListTopicsOptions</h4> +<pre>public ListTopicsOptions()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="listInternal-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listInternal</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> listInternal(boolean listInternal)</pre> +<div class="block">Set whether we should list internal topics.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>listInternal</code> - Whether we should list internal topics. null means to use + the default.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This ListTopicsOptions object.</dd> +</dl> +</li> +</ul> +<a name="shouldListInternal--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>shouldListInternal</h4> +<pre>public boolean shouldListInternal()</pre> +<div class="block">Return true if we should list internal topics.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/ListTopicsOptions.html" target="_top">Frames</a></li> +<li><a href="ListTopicsOptions.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/kafka-site/blob/2e200cfc/10/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html ---------------------------------------------------------------------- diff --git a/10/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html b/10/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html new file mode 100644 index 0000000..867d703 --- /dev/null +++ b/10/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html @@ -0,0 +1,274 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_152) on Wed Nov 01 13:25:42 GMT 2017 --> +<title>ListTopicsResult (kafka 1.0.0 API)</title> +<meta name="date" content="2017-11-01"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ListTopicsResult (kafka 1.0.0 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/NewPartitions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/ListTopicsResult.html" target="_top">Frames</a></li> +<li><a href="ListTopicsResult.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.kafka.clients.admin</div> +<h2 title="Class ListTopicsResult" class="title">Class ListTopicsResult</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.admin.ListTopicsResult</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../../org/apache/kafka/common/annotation/InterfaceStability.Evolving.html" title="annotation in org.apache.kafka.common.annotation">@InterfaceStability.Evolving</a> +public class <span class="typeNameLabel">ListTopicsResult</span> +extends java.lang.Object</pre> +<div class="block">The result of the <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics--"><code>AdminClient.listTopics()</code></a> call. + + The API of this class is evolving, see <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin"><code>AdminClient</code></a> for details.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Collection<<a href="../../../../../org/apache/kafka/clients/admin/TopicListing.html" title="class in org.apache.kafka.clients.admin">TopicListing</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#listings--">listings</a></span>()</code> +<div class="block">Return a future which yields a collection of TopicListing objects.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Set<java.lang.String>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#names--">names</a></span>()</code> +<div class="block">Return a future which yields a collection of topic names.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Map<java.lang.String,<a href="../../../../../org/apache/kafka/clients/admin/TopicListing.html" title="class in org.apache.kafka.clients.admin">TopicListing</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#namesToListings--">namesToListings</a></span>()</code> +<div class="block">Return a future which yields a map of topic names to TopicListing objects.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="namesToListings--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>namesToListings</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Map<java.lang.String,<a href="../../../../../org/apache/kafka/clients/admin/TopicListing.html" title="class in org.apache.kafka.clients.admin">TopicListing</a>>> namesToListings()</pre> +<div class="block">Return a future which yields a map of topic names to TopicListing objects.</div> +</li> +</ul> +<a name="listings--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listings</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Collection<<a href="../../../../../org/apache/kafka/clients/admin/TopicListing.html" title="class in org.apache.kafka.clients.admin">TopicListing</a>>> listings()</pre> +<div class="block">Return a future which yields a collection of TopicListing objects.</div> +</li> +</ul> +<a name="names--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>names</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><java.util.Set<java.lang.String>> names()</pre> +<div class="block">Return a future which yields a collection of topic names.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">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="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/NewPartitions.html" title="class in org.apache.kafka.clients.admin"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/ListTopicsResult.html" target="_top">Frames</a></li> +<li><a href="ListTopicsResult.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
