http://git-wip-us.apache.org/repos/asf/kafka-site/blob/6699e22d/0110/javadoc/index.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/index.html b/0110/javadoc/index.html new file mode 100644 index 0000000..6457a1f --- /dev/null +++ b/0110/javadoc/index.html @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc on Thu Jun 22 23:10:09 BST 2017 --> +<title>kafka 0.11.0.0 API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
http://git-wip-us.apache.org/repos/asf/kafka-site/blob/6699e22d/0110/javadoc/org/apache/kafka/clients/admin/AdminClient.html ---------------------------------------------------------------------- diff --git a/0110/javadoc/org/apache/kafka/clients/admin/AdminClient.html b/0110/javadoc/org/apache/kafka/clients/admin/AdminClient.html new file mode 100644 index 0000000..c3c11ad --- /dev/null +++ b/0110/javadoc/org/apache/kafka/clients/admin/AdminClient.html @@ -0,0 +1,791 @@ +<!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:07 BST 2017 --> +<title>AdminClient (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="AdminClient (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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/clients/admin/AdminClientConfig.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/AdminClient.html" target="_top">Frames</a></li> +<li><a href="AdminClient.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 AdminClient" class="title">Class AdminClient</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.AdminClient</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/kafka/clients/admin/KafkaAdminClient.html" title="class in org.apache.kafka.clients.admin">KafkaAdminClient</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 abstract class <span class="strong">AdminClient</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> +implements <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></pre> +<div class="block">The administrative client for Kafka, which supports managing and inspecting topics, brokers, configurations and ACLs. + + The minimum broker version required is 0.10.0.0. Methods with stricter requirements will specify the minimum broker + version required. + + This client was introduced in 0.11.0.0 and the API is still evolving. We will try to evolve the API in a compatible + manner, but we reserve the right to make breaking changes in minor releases, if necessary. We will update the + <code>InterfaceStability</code> annotation and this notice once the API is considered stable.</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/AdminClient.html#AdminClient()">AdminClient</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/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/AdminClient.html#alterConfigs(java.util.Map)">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)</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>abstract <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/AdminClient.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="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close()">close</a></strong>()</code> +<div class="block">Close the AdminClient and release all associated resources.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.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>static <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#create(java.util.Map)">create</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="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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> conf)</code> +<div class="block">Create a new AdminClient with the given configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#create(java.util.Properties)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> props)</code> +<div class="block">Create a new AdminClient with the given configuration.</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/AdminClient.html#createAcls(java.util.Collection)">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)</code> +<div class="block">Similar to #<code>AdminClient#createAcls(Collection<AclBinding>, CreateAclsOptions)</code>, + but uses the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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="altColor"> +<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/AdminClient.html#createTopics(java.util.Collection)">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)</code> +<div class="block">Create a batch of new topics with the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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/AdminClient.html#deleteAcls(java.util.Collection)">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)</code> +<div class="block">Similar to #<code>AdminClient#deleteAcls(Collection<AclBinding>, DeleteAclsOptions)</code>, + but uses the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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="altColor"> +<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/AdminClient.html#deleteTopics(java.util.Collection)">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>> topics)</code> +<div class="block">Similar to #<code>AdminClient#deleteTopics(Collection<String>, DeleteTopicsOptions)</code>, + but uses the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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>> topics, + <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/AdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter)">describeAcls</a></strong>(<a href="../../../../../org/apache/kafka/common/acl/AclBindingFilter.html" title="class in org.apache.kafka.common.acl">AclBindingFilter</a> filter)</code> +<div class="block">Similar to #<a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,%20org.apache.kafka.clients.admin.DescribeAclsOptions)"><code>describeAcls(AclBindingFilter, DescribeAclsOptions)</code></a>, + but uses the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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="altColor"> +<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/AdminClient.html#describeCluster()">describeCluster</a></strong>()</code> +<div class="block">Get information about the nodes in the cluster, using the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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/AdminClient.html#describeConfigs(java.util.Collection)">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>> resources)</code> +<div class="block">Get the configuration for the specified resources with the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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>> resources, + <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="altColor"> +<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/AdminClient.html#describeTopics(java.util.Collection)">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)</code> +<div class="block">Describe some topics in the cluster, with the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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/AdminClient.html#listTopics()">listTopics</a></strong>()</code> +<div class="block">List the topics available in the cluster with the default options.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <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/AdminClient.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_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="AdminClient()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AdminClient</h4> +<pre>public AdminClient()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create(java.util.Properties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html?is-external=true"; title="class or interface in java.util">Properties</a> props)</pre> +<div class="block">Create a new AdminClient with the given configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>props</code> - The configuration.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The new KafkaAdminClient.</dd></dl> +</li> +</ul> +<a name="create(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html" title="class in org.apache.kafka.clients.admin">AdminClient</a> create(<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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> conf)</pre> +<div class="block">Create a new AdminClient with the given configuration.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conf</code> - The configuration.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The new KafkaAdminClient.</dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close()</pre> +<div class="block">Close the AdminClient and release all associated resources. + + See <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#close(long,%20java.util.concurrent.TimeUnit)"><code>close(long, TimeUnit)</code></a></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang">close</a></code> in interface <code><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></code></dd> +</dl> +</li> +</ul> +<a name="close(long, java.util.concurrent.TimeUnit)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public abstract 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">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="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)"> +<!-- --> +</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)</pre> +<div class="block">Create a batch of new topics with the default options. + + This operation is supported by brokers with version 0.10.1.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newTopics</code> - The new topics to create.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The CreateTopicsResult.</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 abstract <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">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><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)"> +<!-- --> +</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>> topics)</pre> +<div class="block">Similar to #<code>AdminClient#deleteTopics(Collection<String>, DeleteTopicsOptions)</code>, + but uses the default options. + + This operation is supported by brokers with version 0.10.1.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topics</code> - The topic names to delete.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DeleteTopicsResult.</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 abstract <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>> topics, + <a href="../../../../../org/apache/kafka/clients/admin/DeleteTopicsOptions.html" title="class in org.apache.kafka.clients.admin">DeleteTopicsOptions</a> options)</pre> +<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><span class="strong">Parameters:</span></dt><dd><code>topics</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()"> +<!-- --> +</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()</pre> +<div class="block">List the topics available in the cluster with the default options.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The ListTopicsResult.</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 abstract <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">List the topics available in the cluster.</div> +<dl><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)"> +<!-- --> +</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)</pre> +<div class="block">Describe some topics in the cluster, with the default options. + + See <code>AdminClient#describeTopics(Collection<String>, DescribeTopicsOptions)</code></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>topicNames</code> - The names of the topics to describe.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DescribeTopicsResult.</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 abstract <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">Describe some topics in the cluster.</div> +<dl><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()"> +<!-- --> +</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()</pre> +<div class="block">Get information about the nodes in the cluster, using the default options.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The DescribeClusterResult.</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 abstract <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">Get information about the nodes in the cluster.</div> +<dl><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)"> +<!-- --> +</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)</pre> +<div class="block">Similar to #<a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeAcls(org.apache.kafka.common.acl.AclBindingFilter,%20org.apache.kafka.clients.admin.DescribeAclsOptions)"><code>describeAcls(AclBindingFilter, DescribeAclsOptions)</code></a>, + but uses the default options. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filter</code> - The filter to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DeleteAclsResult.</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 abstract <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">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="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)"> +<!-- --> +</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)</pre> +<div class="block">Similar to #<code>AdminClient#createAcls(Collection<AclBinding>, CreateAclsOptions)</code>, + but uses the default options. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>acls</code> - The ACLs to create</dd> +<dt><span class="strong">Returns:</span></dt><dd>The CreateAclsResult.</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 abstract <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">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><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)"> +<!-- --> +</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)</pre> +<div class="block">Similar to #<code>AdminClient#deleteAcls(Collection<AclBinding>, DeleteAclsOptions)</code>, + but uses the default options. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filters</code> - The filters to use.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DeleteAclsResult.</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 abstract <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">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><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)"> +<!-- --> +</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>> resources)</pre> +<div class="block">Get the configuration for the specified resources with the default options. + + See <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#describeConfigs(java.util.Collection,%20org.apache.kafka.clients.admin.DescribeConfigsOptions)"><code>describeConfigs(Collection, DescribeConfigsOptions)</code></a> for more details. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>resources</code> - The resources (topic and broker resource types are currently supported)</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DescribeConfigsResult</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 abstract <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>> resources, + <a href="../../../../../org/apache/kafka/clients/admin/DescribeConfigsOptions.html" title="class in org.apache.kafka.clients.admin">DescribeConfigsOptions</a> options)</pre> +<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="strong">Parameters:</span></dt><dd><code>resources</code> - The resources (topic and broker resource types are currently supported)</dd><dd><code>options</code> - The options to use when describing configs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The DescribeConfigsResult</dd></dl> +</li> +</ul> +<a name="alterConfigs(java.util.Map)"> +<!-- --> +</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(<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)</pre> +<div class="block">Update the configuration for the specified resources with the default options. + + See <a href="../../../../../org/apache/kafka/clients/admin/AdminClient.html#alterConfigs(java.util.Map,%20org.apache.kafka.clients.admin.AlterConfigsOptions)"><code>alterConfigs(Map, AlterConfigsOptions)</code></a> for more details. + + This operation is supported by brokers with version 0.11.0.0 or higher.</div> +<dl><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> +<dt><span class="strong">Returns:</span></dt><dd>The AlterConfigsResult</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 abstract <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">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="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>Prev Class</li> +<li><a href="../../../../../org/apache/kafka/clients/admin/AdminClientConfig.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/AdminClient.html" target="_top">Frames</a></li> +<li><a href="AdminClient.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>
