http://git-wip-us.apache.org/repos/asf/kafka-site/blob/6699e22d/0110/javadoc/org/apache/kafka/clients/admin/DescribeTopicsResult.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/org/apache/kafka/clients/admin/DescribeTopicsResult.html b/0110/javadoc/org/apache/kafka/clients/admin/DescribeTopicsResult.html new file mode 100644 index 0000000..c947568 --- /dev/null +++ b/0110/javadoc/org/apache/kafka/clients/admin/DescribeTopicsResult.html @@ -0,0 +1,245 @@ +<!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 (version 1.7.0_80) on Thu Jun 22 23:10:08 BST 2017 --> +<title>DescribeTopicsResult (kafka 0.11.0.0 API)</title> +<meta name="date" content="2017-06-22"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DescribeTopicsResult (kafka 0.11.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/DescribeTopicsResult.html" target="_top">Frames</a></li> +<li><a href="DescribeTopicsResult.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 DescribeTopicsResult" class="title">Class DescribeTopicsResult</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.admin.DescribeTopicsResult</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="strong">DescribeTopicsResult</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">The result of the <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics(java.util.Collection)"><code>AdminClient.describeTopics(Collection)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/kafka/clients/admin/TopicDescription.html" title="class in org.apache.kafka.clients.admin">TopicDescription</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html#all()">all</a></strong>()</code> +<div class="block">Return a future which succeeds only if all the topic descriptions succeed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="../../../../../org/apache/kafka/clients/admin/TopicDescription.html" title="class in org.apache.kafka.clients.admin">TopicDescription</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/DescribeTopicsResult.html#values()">values</a></strong>()</code> +<div class="block">Return a map from topic names to futures which can be used to check the status of + individual topics.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="../../../../../org/apache/kafka/clients/admin/TopicDescription.html" title="class in org.apache.kafka.clients.admin">TopicDescription</a>>> values()</pre> +<div class="block">Return a map from topic names to futures which can be used to check the status of + individual topics.</div> +</li> +</ul> +<a name="all()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>all</h4> +<pre>public <a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/kafka/clients/admin/TopicDescription.html" title="class in org.apache.kafka.clients.admin">TopicDescription</a>>> all()</pre> +<div class="block">Return a future which succeeds only if all the topic descriptions succeed.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/DescribeTopicsOptions.html" title="class in org.apache.kafka.clients.admin"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/kafka/clients/admin/DescribeTopicsResult.html" target="_top">Frames</a></li> +<li><a href="DescribeTopicsResult.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/6699e22d/0110/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html b/0110/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html new file mode 100644 index 0000000..4b8989b --- /dev/null +++ b/0110/javadoc/org/apache/kafka/clients/admin/KafkaAdminClient.html @@ -0,0 +1,539 @@ +<!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 (version 1.7.0_80) on Thu Jun 22 23:10:08 BST 2017 --> +<title>KafkaAdminClient (kafka 0.11.0.0 API)</title> +<meta name="date" content="2017-06-22"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KafkaAdminClient (kafka 0.11.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></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="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#alterConfigs(java.util.Map,%20org.apache.kafka.clients.admin.AlterConfigsOptions)">alterConfigs</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#close(long,%20java.util.concurrent.TimeUnit)">close</a></strong>(long duration, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> +<div class="block">Close the AdminClient and release all associated resources.</div> +</td> +</tr> +<tr class="altColor"> +<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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#createAcls(java.util.Collection,%20org.apache.kafka.clients.admin.CreateAclsOptions)">createAcls</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#createTopics(java.util.Collection,%20org.apache.kafka.clients.admin.CreateTopicsOptions)">createTopics</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#deleteAcls(java.util.Collection,%20org.apache.kafka.clients.admin.DeleteAclsOptions)">deleteAcls</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#deleteTopics(java.util.Collection,%20org.apache.kafka.clients.admin.DeleteTopicsOptions)">deleteTopics</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> 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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,%20org.apache.kafka.clients.admin.DescribeAclsOptions)">describeAcls</a></strong>(<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">describeCluster</a></strong>(<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeConfigs(java.util.Collection,%20org.apache.kafka.clients.admin.DescribeConfigsOptions)">describeConfigs</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#describeTopics(java.util.Collection,%20org.apache.kafka.clients.admin.DescribeTopicsOptions)">describeTopics</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> 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 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><strong><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">listTopics</a></strong>(<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#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#createTopics(java.util.Collection)">createTopics</a>, <a href="../../../../../org/apache/kafka/clients/admin/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/AdminCli ent.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#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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true"; title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close(long,%20java.util.concurrent.TimeUnit)">AdminClient</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close(long,%20java.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="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createTopics(java.util.Collection,%20org.apache.kafka.clients.admin.CreateTopicsOptions)">AdminClient</a></code></strong></div> +<div class="block">Create a batch of new topics. + + It may take several seconds after AdminClient#createTopics returns + success for all the brokers to become aware that the topics have been created. + During this time, AdminClient#listTopics and AdminClient#describeTopics + 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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createTopics(java.util.Collection,%20org.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="strong">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="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> 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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteTopics(java.util.Collection,%20org.apache.kafka.clients.admin.DeleteTopicsOptions)">AdminClient</a></code></strong></div> +<div class="block">Delete a batch of topics. + + 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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteTopics(java.util.Collection,%20org.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="strong">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="strong">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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#listTopics(org.apache.kafka.clients.admin.ListTopicsOptions)">AdminClient</a></code></strong></div> +<div class="block">List the topics available in the cluster.</div> +<dl> +<dt><strong>Specified by:</strong></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="strong">Parameters:</span></dt><dd><code>options</code> - The options to use when listing the topics.</dd> +<dt><span class="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>> 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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics(java.util.Collection,%20org.apache.kafka.clients.admin.DescribeTopicsOptions)">AdminClient</a></code></strong></div> +<div class="block">Describe some topics in the cluster.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeTopics(java.util.Collection,%20org.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="strong">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="strong">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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeCluster(org.apache.kafka.clients.admin.DescribeClusterOptions)">AdminClient</a></code></strong></div> +<div class="block">Get information about the nodes in the cluster.</div> +<dl> +<dt><strong>Specified by:</strong></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="strong">Parameters:</span></dt><dd><code>options</code> - The options to use when getting information about the cluster.</dd> +<dt><span class="strong">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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,%20org.apache.kafka.clients.admin.DescribeAclsOptions)">AdminClient</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,%20org.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="strong">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="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createAcls(java.util.Collection,%20org.apache.kafka.clients.admin.CreateAclsOptions)">AdminClient</a></code></strong></div> +<div class="block">Creates access control lists (ACLs) which are bound to specific resources. + + 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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#createAcls(java.util.Collection,%20org.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="strong">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="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteAcls(java.util.Collection,%20org.apache.kafka.clients.admin.DeleteAclsOptions)">AdminClient</a></code></strong></div> +<div class="block">Deletes access control lists (ACLs) according to the supplied filters. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#deleteAcls(java.util.Collection,%20org.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="strong">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="strong">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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs(java.util.Collection,%20org.apache.kafka.clients.admin.DescribeConfigsOptions)">AdminClient</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs(java.util.Collection,%20org.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="strong">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="strong">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="blockListLast"> +<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(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<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"><strong>Description copied from class: <code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs(java.util.Map,%20org.apache.kafka.clients.admin.AlterConfigsOptions)">AdminClient</a></code></strong></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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs(java.util.Map,%20org.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="strong">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="strong">Returns:</span></dt><dd>The AlterConfigsResult</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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/6699e22d/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html b/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html new file mode 100644 index 0000000..0b71b06 --- /dev/null +++ b/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsOptions.html @@ -0,0 +1,316 @@ +<!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 (version 1.7.0_80) on Thu Jun 22 23:10:08 BST 2017 --> +<title>ListTopicsOptions (kafka 0.11.0.0 API)</title> +<meta name="date" content="2017-06-22"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ListTopicsOptions (kafka 0.11.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">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="strong">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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.kafka.clients.admin.ListTopicsOptions</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="strong">ListTopicsOptions</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</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="overviewSummary" 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><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#ListTopicsOptions()">ListTopicsOptions</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr 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><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#listInternal(boolean)">listInternal</a></strong>(boolean listInternal)</code> +<div class="block">Set whether we should list internal topics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#shouldListInternal()">shouldListInternal</a></strong>()</code> +<div class="block">Return true if we should list internal topics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#timeoutMs()">timeoutMs</a></strong>()</code> +<div class="block">The request timeout in milliseconds for this operation or <code>null</code> if the default request timeout for the + AdminClient should be used.</div> +</td> +</tr> +<tr class="rowColor"> +<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><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html#timeoutMs(java.lang.Integer)">timeoutMs</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> timeoutMs)</code> +<div class="block">Set the request timeout in milliseconds for this operation or <code>null</code> if the default request timeout for the + AdminClient should be used.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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="timeoutMs(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timeoutMs</h4> +<pre>public <a href="../../../../../org/apache/kafka/clients/admin/ListTopicsOptions.html" title="class in org.apache.kafka.clients.admin">ListTopicsOptions</a> timeoutMs(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> timeoutMs)</pre> +<div class="block">Set the request timeout in milliseconds for this operation or <code>null</code> if the default request timeout for the + AdminClient should be used.</div> +</li> +</ul> +<a name="timeoutMs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>timeoutMs</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> timeoutMs()</pre> +<div class="block">The request timeout in milliseconds for this operation or <code>null</code> if the default request timeout for the + AdminClient should be used.</div> +</li> +</ul> +<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="strong">Parameters:</span></dt><dd><code>listInternal</code> - Whether we should list internal topics. null means to use + the default.</dd> +<dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">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="strong">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/6699e22d/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html b/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html new file mode 100644 index 0000000..62ab6ce --- /dev/null +++ b/0110/javadoc/org/apache/kafka/clients/admin/ListTopicsResult.html @@ -0,0 +1,259 @@ +<!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 (version 1.7.0_80) on Thu Jun 22 23:10:08 BST 2017 --> +<title>ListTopicsResult (kafka 0.11.0.0 API)</title> +<meta name="date" content="2017-06-22"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ListTopicsResult (kafka 0.11.0.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/NewTopic.html" title="class in org.apache.kafka.clients.admin"><span class="strong">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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></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="strong">ListTopicsResult</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#listings()">listings</a></strong>()</code> +<div class="block">Return a future which yields a collection of TopicListing objects.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#names()">names</a></strong>()</code> +<div class="block">Return a future which yields a collection of topic names.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/kafka/common/KafkaFuture.html" title="class in org.apache.kafka.common">KafkaFuture</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<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><strong><a href="../../../../../org/apache/kafka/clients/admin/ListTopicsResult.html#namesToListings()">namesToListings</a></strong>()</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></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><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<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><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>>> 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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/kafka/clients/admin/NewTopic.html" title="class in org.apache.kafka.clients.admin"><span class="strong">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>
