This is an automated email from the ASF dual-hosted git repository. mmerli pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/incubator-pulsar.git
The following commit(s) were added to refs/heads/asf-site by this push: new 3a13786 Updated site at revision e626e2a 3a13786 is described below commit 3a1378627618b93170f898455c99b312b694c027 Author: jenkins <bui...@apache.org> AuthorDate: Mon Apr 16 08:22:22 2018 +0000 Updated site at revision e626e2a --- content/api/admin/allclasses-frame.html | 3 +- content/api/admin/allclasses-noframe.html | 3 +- content/api/admin/deprecated-list.html | 28 +- content/api/admin/index-all.html | 69 ++++- .../org/apache/pulsar/client/admin/Namespaces.html | 50 +-- .../pulsar/client/admin/PersistentTopics.html | 8 +- .../org/apache/pulsar/client/admin/Properties.html | 44 ++- .../apache/pulsar/client/admin/PulsarAdmin.html | 35 ++- .../apache/pulsar/client/admin/ResourceQuotas.html | 4 +- .../client/admin/{Properties.html => Tenants.html} | 142 +++++---- .../apache/pulsar/client/admin/package-frame.html | 1 + .../pulsar/client/admin/package-summary.html | 10 +- .../apache/pulsar/client/admin/package-tree.html | 1 + .../pulsar/common/policies/data/Policies.html | 4 +- .../common/policies/data/PublisherStats.html | 4 +- .../common/policies/data/SubscriptionStats.html | 4 +- .../pulsar/common/policies/data/TenantInfo.html | 338 +++++++++++++++++++++ .../pulsar/common/policies/data/package-frame.html | 2 +- .../common/policies/data/package-summary.html | 16 +- .../pulsar/common/policies/data/package-tree.html | 2 +- content/api/admin/overview-tree.html | 3 +- content/api/client/index-all.html | 7 +- .../apache/pulsar/client/api/ProducerBuilder.html | 17 +- .../pulsar/client/api/ProducerConfiguration.html | 27 +- 24 files changed, 645 insertions(+), 177 deletions(-) diff --git a/content/api/admin/allclasses-frame.html b/content/api/admin/allclasses-frame.html index 4d4bbf7..64a0634 100644 --- a/content/api/admin/allclasses-frame.html +++ b/content/api/admin/allclasses-frame.html @@ -57,7 +57,6 @@ <li><a href="org/apache/pulsar/common/policies/data/PersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PersistentTopicStats</a></li> <li><a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">Policies</a></li> <li><a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Properties</span></a></li> -<li><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PropertyAdmin</a></li> <li><a href="org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PublisherStats</a></li> <li><a href="org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin" target="classFrame">PulsarAdmin</a></li> <li><a href="org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">PulsarAdminBuilder</span></a></li> @@ -77,6 +76,8 @@ <li><a href="org/apache/pulsar/common/policies/data/RetentionPolicies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">RetentionPolicies</a></li> <li><a href="org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html" title="enum in org.apache.pulsar.common.policies.data" target="classFrame">SubscriptionAuthMode</a></li> <li><a href="org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">SubscriptionStats</a></li> +<li><a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">TenantInfo</a></li> +<li><a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Tenants</span></a></li> </ul> </div> </body> diff --git a/content/api/admin/allclasses-noframe.html b/content/api/admin/allclasses-noframe.html index 5f19f3c..9729b7c 100644 --- a/content/api/admin/allclasses-noframe.html +++ b/content/api/admin/allclasses-noframe.html @@ -57,7 +57,6 @@ <li><a href="org/apache/pulsar/common/policies/data/PersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicStats</a></li> <li><a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data">Policies</a></li> <li><a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">Properties</span></a></li> -<li><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></li> <li><a href="org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data">PublisherStats</a></li> <li><a href="org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin">PulsarAdmin</a></li> <li><a href="org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">PulsarAdminBuilder</span></a></li> @@ -77,6 +76,8 @@ <li><a href="org/apache/pulsar/common/policies/data/RetentionPolicies.html" title="class in org.apache.pulsar.common.policies.data">RetentionPolicies</a></li> <li><a href="org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html" title="enum in org.apache.pulsar.common.policies.data">SubscriptionAuthMode</a></li> <li><a href="org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data">SubscriptionStats</a></li> +<li><a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></li> +<li><a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="interfaceName">Tenants</span></a></li> </ul> </div> </body> diff --git a/content/api/admin/deprecated-list.html b/content/api/admin/deprecated-list.html index 559ebe3..c4cf7c9 100644 --- a/content/api/admin/deprecated-list.html +++ b/content/api/admin/deprecated-list.html @@ -71,11 +71,32 @@ <h1 title="Deprecated API" class="title">Deprecated API</h1> <h2 title="Contents">Contents</h2> <ul> +<li><a href="#interface">Deprecated Interfaces</a></li> <li><a href="#method">Deprecated Methods</a></li> <li><a href="#constructor">Deprecated Constructors</a></li> </ul> </div> -<div class="contentContainer"><a name="method"> +<div class="contentContainer"><a name="interface"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Interfaces table, listing deprecated interfaces, and an explanation"> +<caption><span>Deprecated Interfaces</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">org.apache.pulsar.client.admin.Properties</a> +<div class="block"><span class="deprecationComment">see <a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><code>Tenants</code></a> from <a href="org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="method"> <!-- --> </a> <ul class="blockList"> @@ -89,6 +110,11 @@ <tr class="altColor"> <td class="colOne"><a href="org/apache/pulsar/client/admin/Namespaces.html#getNamespaces-java.lang.String-java.lang.String-">org.apache.pulsar.client.admin.Namespaces.getNamespaces(String, String)</a></td> </tr> +<tr class="rowColor"> +<td class="colOne"><a href="org/apache/pulsar/client/admin/PulsarAdmin.html#properties--">org.apache.pulsar.client.admin.PulsarAdmin.properties()</a> +<div class="block"><span class="deprecationComment">since 2.0. See <a href="org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> +</td> +</tr> </tbody> </table> </li> diff --git a/content/api/admin/index-all.html b/content/api/admin/index-all.html index 39268a9..acfdf4f 100644 --- a/content/api/admin/index-all.html +++ b/content/api/admin/index-all.html @@ -368,8 +368,9 @@ <dd> <div class="block">Create a partitioned topic asynchronously.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#createProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">createProperty(String, PropertyAdmin)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#createProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">createProperty(String, TenantInfo)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Create a new property.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PersistentTopics.html#createSubscription-java.lang.String-java.lang.String-MessageId-">createSubscription(String, String, MessageId)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">PersistentTopics</a></dt> @@ -380,6 +381,10 @@ <dd> <div class="block">Create a new subscription on a topic</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Tenants.html#createTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">createTenant(String, TenantInfo)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></dt> +<dd> +<div class="block">Create a new tenant.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html#currentLedgerEntries">currentLedgerEntries</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html#currentLedgerSize">currentLedgerSize</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats</a></dt> @@ -470,6 +475,7 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#deleteProperty-java.lang.String-">deleteProperty(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Delete an existing property.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PersistentTopics.html#deleteSubscription-java.lang.String-java.lang.String-">deleteSubscription(String, String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">PersistentTopics</a></dt> @@ -480,6 +486,10 @@ <dd> <div class="block">Delete a subscription asynchronously.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Tenants.html#deleteTenant-java.lang.String-">deleteTenant(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></dt> +<dd> +<div class="block">Delete an existing tenant.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/AuthPolicies.html#destination_auth">destination_auth</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/AuthPolicies.html" title="class in org.apache.pulsar.common.policies.data">AuthPolicies</a></dt> <dd> </dd> <dt><a href="org/apache/pulsar/common/policies/data/DispatchRate.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">DispatchRate</span></a> - Class in <a href="org/apache/pulsar/common/policies/data/package-summary.html">org.apache.pulsar.common.policies.data</a></dt> @@ -530,12 +540,12 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/Policies.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data">Policies</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/ResourceQuota.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/ResourceQuota.html" title="class in org.apache.pulsar.common.policies.data">ResourceQuota</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/RetentionPolicies.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/RetentionPolicies.html" title="class in org.apache.pulsar.common.policies.data">RetentionPolicies</a></dt> <dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> +<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.impl.<a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html" title="class in org.apache.pulsar.common.policies.impl">MinAvailablePolicy</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/impl/NamespaceIsolationPolicyImpl.html#equals-java.lang.Object-">equals(Object)</a></span> - Method in class org.apache.pulsar.common.policies.impl.<a href="org/apache/pulsar/common/policies/impl/NamespaceIsolationPolicyImpl.html" title="class in org.apache.pulsar.common.policies.impl">NamespaceIsolationPolicyImpl</a></dt> @@ -610,7 +620,7 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PublisherStats.html#getAddress--">getAddress()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data">PublisherStats</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#getAdminRoles--">getAdminRoles()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#getAdminRoles--">getAdminRoles()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Brokers.html#getAllDynamicConfigurations--">getAllDynamicConfigurations()</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Brokers.html" title="interface in org.apache.pulsar.client.admin">Brokers</a></dt> <dd> @@ -618,7 +628,7 @@ </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/BrokerStats.html#getAllocatorStats-java.lang.String-">getAllocatorStats(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/BrokerStats.html" title="interface in org.apache.pulsar.client.admin">BrokerStats</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#getAllowedClusters--">getAllowedClusters()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#getAllowedClusters--">getAllowedClusters()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Namespaces.html#getAntiAffinityNamespaces-java.lang.String-java.lang.String-java.lang.String-">getAntiAffinityNamespaces(String, String, String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin">Namespaces</a></dt> <dd> @@ -930,10 +940,12 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#getProperties--">getProperties()</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Get the list of properties.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#getPropertyAdmin-java.lang.String-">getPropertyAdmin(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Get the config of the property.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html#getPublishers--">getPublishers()</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data">NonPersistentTopicStats</a></dt> @@ -996,6 +1008,14 @@ <dd> <div class="block">Get the list of subscriptions asynchronously.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Tenants.html#getTenantInfo-java.lang.String-">getTenantInfo(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></dt> +<dd> +<div class="block">Get the config of the tenant.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Tenants.html#getTenants--">getTenants()</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></dt> +<dd> +<div class="block">Get the list of tenants.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html#GettingAuthenticationDataException-java.lang.Throwable-">GettingAuthenticationDataException(Throwable)</a></span> - Constructor for exception org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.GettingAuthent [...] <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html#GettingAuthenticationDataException-java.lang.String-">GettingAuthenticationDataException(String)</a></span> - Constructor for exception org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdminException.GettingAuthenticationDataException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.GettingAuthenticatio [...] @@ -1433,18 +1453,18 @@ </dd> <dt><a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Properties</span></a> - Interface in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt> <dd> -<div class="block">Admin interface for properties management</div> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">see <a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><code>Tenants</code></a> from <a href="org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> +</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdmin.html#properties--">properties()</a></span> - Method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin">PulsarAdmin</a></dt> -<dd> </dd> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0. See <a href="org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> +</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.CursorStats.html#properties">properties</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PersistentTopicInternalStats.CursorStats.html" title="class in org.apache.pulsar.common.policies.data">PersistentTopicInternalStats.CursorStats</a></dt> <dd> </dd> -<dt><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">PropertyAdmin</span></a> - Class in <a href="org/apache/pulsar/common/policies/data/package-summary.html">org.apache.pulsar.common.policies.data</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#PropertyAdmin--">PropertyAdmin()</a></span> - Constructor for class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> -<dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#PropertyAdmin-java.util.Set-java.util.Set-">PropertyAdmin(Set<String>, Set<String>)</a></span> - Constructor for class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> -<dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html#publishers">publishers</a></span> - Variable in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NonPersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data">NonPersistentTopicStats</a></dt> <dd> <div class="block">List of connected publishers on this topic w/ their stats</div> @@ -1639,9 +1659,9 @@ <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PublisherStats.html#setAddress-java.lang.String-">setAddress(String)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data">PublisherStats</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#setAdminRoles-java.util.Set-">setAdminRoles(Set<String>)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#setAdminRoles-java.util.Set-">setAdminRoles(Set<String>)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> <dd> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html#setAllowedClusters-java.util.Set-">setAllowedClusters(Set<String>)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#setAllowedClusters-java.util.Set-">setAllowedClusters(Set<String>)</a></span> - Method in class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> <dd> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Namespaces.html#setBacklogQuota-java.lang.String-org.apache.pulsar.common.policies.data.BacklogQuota-">setBacklogQuota(String, BacklogQuota)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Namespaces.html" title="interface in org.apache.pulsar.client.admin">Namespaces</a></dt> <dd> @@ -1867,6 +1887,18 @@ </a> <h2 class="title">T</h2> <dl> +<dt><a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">TenantInfo</span></a> - Class in <a href="org/apache/pulsar/common/policies/data/package-summary.html">org.apache.pulsar.common.policies.data</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#TenantInfo--">TenantInfo()</a></span> - Constructor for class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/data/TenantInfo.html#TenantInfo-java.util.Set-java.util.Set-">TenantInfo(Set<String>, Set<String>)</a></span> - Constructor for class org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--">tenants()</a></span> - Method in class org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin">PulsarAdmin</a></dt> +<dd> </dd> +<dt><a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Tenants</span></a> - Interface in <a href="org/apache/pulsar/client/admin/package-summary.html">org.apache.pulsar.client.admin</a></dt> +<dd> +<div class="block">Admin interface for tenants management</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/PersistentTopics.html#terminateTopicAsync-java.lang.String-">terminateTopicAsync(String)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin">PersistentTopics</a></dt> <dd> <div class="block">Terminate the topic and prevent any more messages being published on it.</div> @@ -2011,10 +2043,15 @@ <dd> <div class="block">Update peer cluster names.</div> </dd> -<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">updateProperty(String, PropertyAdmin)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Properties.html#updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">updateProperty(String, TenantInfo)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></dt> <dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> <div class="block">Update the admins for a property.</div> </dd> +<dt><span class="memberNameLink"><a href="org/apache/pulsar/client/admin/Tenants.html#updateTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">updateTenant(String, TenantInfo)</a></span> - Method in interface org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></dt> +<dd> +<div class="block">Update the admins for a tenant.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html#usage_threshold">usage_threshold</a></span> - Variable in class org.apache.pulsar.common.policies.impl.<a href="org/apache/pulsar/common/policies/impl/MinAvailablePolicy.html" title="class in org.apache.pulsar.common.policies.impl">MinAvailablePolicy</a></dt> <dd> </dd> </dl> diff --git a/content/api/admin/org/apache/pulsar/client/admin/Namespaces.html b/content/api/admin/org/apache/pulsar/client/admin/Namespaces.html index bc7ff88..24bfbef 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/Namespaces.html +++ b/content/api/admin/org/apache/pulsar/client/admin/Namespaces.html @@ -195,7 +195,7 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>List<String></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getAntiAffinityNamespaces-java.lang.String-java.lang.String-java.lang.String-">getAntiAffinityNamespaces</a></span>(String property, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getAntiAffinityNamespaces-java.lang.String-java.lang.String-java.lang.String-">getAntiAffinityNamespaces</a></span>(String tenant, String cluster, String namespaceAntiAffinityGroup)</code> <div class="block">Get all namespaces that grouped with given anti-affinity group</div> @@ -251,13 +251,13 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code>List<String></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getNamespaces-java.lang.String-">getNamespaces</a></span>(String property)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getNamespaces-java.lang.String-">getNamespaces</a></span>(String tenant)</code> <div class="block">Get the list of namespaces.</div> </td> </tr> <tr id="i21" class="rowColor"> <td class="colFirst"><code>List<String></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getNamespaces-java.lang.String-java.lang.String-">getNamespaces</a></span>(String property, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Namespaces.html#getNamespaces-java.lang.String-java.lang.String-">getNamespaces</a></span>(String tenant, String cluster)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> </td> @@ -480,25 +480,25 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getNamespaces</h4> -<pre>List<String> getNamespaces(String property) +<pre>List<String> getNamespaces(String tenant) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> <div class="block">Get the list of namespaces. <p> - Get the list of all the namespaces for a certain property. + Get the list of all the namespaces for a certain tenant. <p> Response Example: <pre> - <code>["my-property/c1/namespace1", - "my-property/global/namespace2", - "my-property/c2/namespace3"]</code> + <code>["my-tenant/c1/namespace1", + "my-tenant/global/namespace2", + "my-tenant/c2/namespace3"]</code> </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> @@ -510,26 +510,26 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <h4>getNamespaces</h4> <pre>@Deprecated -List<String> getNamespaces(String property, +List<String> getNamespaces(String tenant, String cluster) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Get the list of namespaces. <p> - Get the list of all the namespaces for a certain property on single cluster. + Get the list of all the namespaces for a certain tenant on single cluster. <p> Response Example: <pre> - <code>["my-property/use/namespace1", "my-property/use/namespace2"]</code> + <code>["my-tenant/use/namespace1", "my-tenant/use/namespace2"]</code> </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dd><code>cluster</code> - Cluster name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property or cluster does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant or cluster does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> @@ -549,8 +549,8 @@ List<String> getNamespaces(String property, Response Example: <pre> - <code>["persistent://my-property/use/namespace1/my-topic-1", - "persistent://my-property/use/namespace1/my-topic-2"]</code> + <code>["persistent://my-tenant/use/namespace1/my-topic-1", + "persistent://my-tenant/use/namespace1/my-topic-2"]</code> </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -623,7 +623,7 @@ List<String> getNamespaces(String property, <dd><code>numBundles</code> - Number of bundles</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - You don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property or cluster does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant or cluster does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Namespace already exists</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> @@ -647,7 +647,7 @@ List<String> getNamespaces(String property, <dd><code>bundlesData</code> - Bundles Data</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - You don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property or cluster does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant or cluster does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Namespace already exists</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> @@ -669,7 +669,7 @@ List<String> getNamespaces(String property, <dd><code>namespace</code> - Namespace name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - You don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property or cluster does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant or cluster does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Namespace already exists</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> @@ -694,7 +694,7 @@ List<String> getNamespaces(String property, across clusters will be enabled.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - You don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property or cluster does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant or cluster does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Namespace already exists</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> @@ -967,14 +967,14 @@ List<String> getNamespaces(String property, <ul class="blockList"> <li class="blockList"> <h4>getAntiAffinityNamespaces</h4> -<pre>List<String> getAntiAffinityNamespaces(String property, +<pre>List<String> getAntiAffinityNamespaces(String tenant, String cluster, String namespaceAntiAffinityGroup) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> <div class="block">Get all namespaces that grouped with given anti-affinity group</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - property is only used for authorization. Client has to be admin of any of the property to access this +<dd><code>tenant</code> - tenant is only used for authorization. Client has to be admin of any of the tenant to access this api api.</dd> <dd><code>cluster</code> - cluster name</dd> <dd><code>namespaceAntiAffinityGroup</code> - Anti-affinity group name</dd> @@ -1184,7 +1184,7 @@ List<String> getNamespaces(String property, </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dd><code>cluster</code> - Cluster name</dd> <dd><code>namespace</code> - Namespace name</dd> <dd><code>persistence</code> - Persistence policies object</dd> @@ -1224,7 +1224,7 @@ List<String> getNamespaces(String property, </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dd><code>cluster</code> - Cluster name</dd> <dd><code>namespace</code> - Namespace name</dd> <dt><span class="throwsLabel">Throws:</span></dt> diff --git a/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html b/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html index e4e5189..ce1d5d1 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html +++ b/content/api/admin/org/apache/pulsar/client/admin/PersistentTopics.html @@ -475,8 +475,8 @@ var activeTableTab = "activeTableTab"; Response example: <pre> - <code>["topic://my-property/use/my-namespace/topic-1", - "topic://my-property/use/my-namespace/topic-2"]</code> + <code>["topic://my-tenant/use/my-namespace/topic-1", + "topic://my-tenant/use/my-namespace/topic-2"]</code> </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -503,8 +503,8 @@ var activeTableTab = "activeTableTab"; Response example: <pre> - <code>["persistent://my-property/use/my-namespace/topic-1", - "persistent://my-property/use/my-namespace/topic-2"]</code> + <code>["persistent://my-tenant/use/my-namespace/topic-1", + "persistent://my-tenant/use/my-namespace/topic-2"]</code> </pre></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> diff --git a/content/api/admin/org/apache/pulsar/client/admin/Properties.html b/content/api/admin/org/apache/pulsar/client/admin/Properties.html index 9b0fcf9..3ee9057 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/Properties.html +++ b/content/api/admin/org/apache/pulsar/client/admin/Properties.html @@ -17,8 +17,8 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -98,8 +98,12 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">see <a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><code>Tenants</code></a> from <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> +</div> <br> -<pre>public interface <span class="typeNameLabel">Properties</span></pre> +<pre>@Deprecated +public interface <span class="typeNameLabel">Properties</span></pre> <div class="block">Admin interface for properties management</div> </li> </ul> @@ -114,40 +118,45 @@ var activeTableTab = "activeTableTab"; </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="t [...] <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#createProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">createProperty</a></span>(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#createProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">createProperty</a></span>(String property, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create a new property.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#deleteProperty-java.lang.String-">deleteProperty</a></span>(String property)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Delete an existing property.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>List<String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#getProperties--">getProperties</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Get the list of properties.</div> </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></code></td> +<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#getPropertyAdmin-java.lang.String-">getPropertyAdmin</a></span>(String property)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Get the config of the property.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">updateProperty</a></span>(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">updateProperty</a></span>(String property, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Update the admins for a property.</div> </td> </tr> @@ -174,6 +183,7 @@ var activeTableTab = "activeTableTab"; <h4>getProperties</h4> <pre>List<String> getProperties() throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Get the list of properties. <p> Get the list of all the properties. @@ -198,8 +208,9 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getPropertyAdmin</h4> -<pre><a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> getPropertyAdmin(String property) - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<pre><a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> getPropertyAdmin(String property) + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Get the config of the property. <p> Get the admin configuration for a given property.</div> @@ -215,15 +226,16 @@ var activeTableTab = "activeTableTab"; </dl> </li> </ul> -<a name="createProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-"> +<a name="createProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>createProperty</h4> <pre>void createProperty(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config) + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Create a new property. <p> Provisions a new property. This operation requires Pulsar super-user privileges.</div> @@ -239,15 +251,16 @@ var activeTableTab = "activeTableTab"; </dl> </li> </ul> -<a name="updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-"> +<a name="updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>updateProperty</h4> <pre>void updateProperty(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config) + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Update the admins for a property. <p> This operation requires Pulsar super-user privileges.</div> @@ -270,6 +283,7 @@ var activeTableTab = "activeTableTab"; <h4>deleteProperty</h4> <pre>void deleteProperty(String property) throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> <div class="block">Delete an existing property. <p> Delete a property and all namespaces and topics under it.</div> diff --git a/content/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html b/content/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html index 847c644..cfed1b1 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html +++ b/content/api/admin/org/apache/pulsar/client/admin/PulsarAdmin.html @@ -17,8 +17,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":42,"i13":10,"i14":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -203,7 +203,7 @@ implements Closeable</pre> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd [...] +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd [...] <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> @@ -262,12 +262,20 @@ implements Closeable</pre> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#properties--">properties</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#properties--">properties</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 2.0. See <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>tenants()</code></a></span></div> +</div> +</td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin">ResourceQuotas</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#resourceQuotas--">resourceQuotas</a></span>()</code> </td> </tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--">tenants</a></span>()</code> </td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.Object"> @@ -471,19 +479,30 @@ public PulsarAdmin(URL serviceUrl, </dl> </li> </ul> -<a name="properties--"> +<a name="tenants--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>properties</h4> -<pre>public <a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a> properties()</pre> +<h4>tenants</h4> +<pre>public <a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a> tenants()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>the properties management object</dd> +<dd>the tenants management object</dd> </dl> </li> </ul> +<a name="properties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>properties</h4> +<pre>@Deprecated +public <a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a> properties()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">since 2.0. See <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>tenants()</code></a></span></div> +</li> +</ul> <a name="namespaces--"> <!-- --> </a> diff --git a/content/api/admin/org/apache/pulsar/client/admin/ResourceQuotas.html b/content/api/admin/org/apache/pulsar/client/admin/ResourceQuotas.html index b14872a..d08ef8b 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/ResourceQuotas.html +++ b/content/api/admin/org/apache/pulsar/client/admin/ResourceQuotas.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/pulsar/client/admin/ResourceQuotas.html" target="_top">Frames</a></li> @@ -390,7 +390,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ServerSideErrorException.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/pulsar/client/admin/ResourceQuotas.html" target="_top">Frames</a></li> diff --git a/content/api/admin/org/apache/pulsar/client/admin/Properties.html b/content/api/admin/org/apache/pulsar/client/admin/Tenants.html similarity index 64% copy from content/api/admin/org/apache/pulsar/client/admin/Properties.html copy to content/api/admin/org/apache/pulsar/client/admin/Tenants.html index 9b0fcf9..0b4e67f 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/Properties.html +++ b/content/api/admin/org/apache/pulsar/client/admin/Tenants.html @@ -3,7 +3,7 @@ <html lang="en"> <head> <!-- Generated by javadoc --> -<title>Properties (Pulsar Admin Java API)</title> +<title>Tenants (Pulsar Admin Java API)</title> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -11,7 +11,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Properties (Pulsar Admin Java API)"; + parent.document.title="Tenants (Pulsar Admin Java API)"; } } catch(err) { @@ -47,12 +47,12 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> </ul> <ul class="navList"> -<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Properties.html" target="_top">Frames</a></li> -<li><a href="Properties.html" target="_top">No Frames</a></li> +<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Tenants.html" target="_top">Frames</a></li> +<li><a href="Tenants.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> @@ -91,7 +91,7 @@ var activeTableTab = "activeTableTab"; <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">org.apache.pulsar.client.admin</div> -<h2 title="Interface Properties" class="title">Interface Properties</h2> +<h2 title="Interface Tenants" class="title">Interface Tenants</h2> </div> <div class="contentContainer"> <div class="description"> @@ -99,8 +99,8 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public interface <span class="typeNameLabel">Properties</span></pre> -<div class="block">Admin interface for properties management</div> +<pre>public interface <span class="typeNameLabel">Tenants</span></pre> +<div class="block">Admin interface for tenants management</div> </li> </ul> </div> @@ -121,34 +121,34 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#createProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">createProperty</a></span>(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config)</code> -<div class="block">Create a new property.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html#createTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">createTenant</a></span>(String tenant, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config)</code> +<div class="block">Create a new tenant.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#deleteProperty-java.lang.String-">deleteProperty</a></span>(String property)</code> -<div class="block">Delete an existing property.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html#deleteTenant-java.lang.String-">deleteTenant</a></span>(String tenant)</code> +<div class="block">Delete an existing tenant.</div> </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code>List<String></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#getProperties--">getProperties</a></span>()</code> -<div class="block">Get the list of properties.</div> +<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html#getTenantInfo-java.lang.String-">getTenantInfo</a></span>(String tenant)</code> +<div class="block">Get the config of the tenant.</div> </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#getPropertyAdmin-java.lang.String-">getPropertyAdmin</a></span>(String property)</code> -<div class="block">Get the config of the property.</div> +<td class="colFirst"><code>List<String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html#getTenants--">getTenants</a></span>()</code> +<div class="block">Get the list of tenants.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html#updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-">updateProperty</a></span>(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config)</code> -<div class="block">Update the admins for a property.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html#updateTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-">updateTenant</a></span>(String tenant, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config)</code> +<div class="block">Update the admins for a tenant.</div> </td> </tr> </table> @@ -166,120 +166,118 @@ var activeTableTab = "activeTableTab"; <!-- --> </a> <h3>Method Detail</h3> -<a name="getProperties--"> +<a name="getTenants--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getProperties</h4> -<pre>List<String> getProperties() - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> -<div class="block">Get the list of properties. - <p> - Get the list of all the properties. +<h4>getTenants</h4> +<pre>List<String> getTenants() + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block">Get the list of tenants. <p> Response Example: <pre> - <code>["my-property", "other-property", "third-property"]</code> + <code>["my-tenant", "other-tenant", "third-tenant"]</code> </pre></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>the list of Pulsar tenants properties</dd> +<dd>the list of Pulsar tenants</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> </ul> -<a name="getPropertyAdmin-java.lang.String-"> +<a name="getTenantInfo-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getPropertyAdmin</h4> -<pre><a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> getPropertyAdmin(String property) - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> -<div class="block">Get the config of the property. +<h4>getTenantInfo</h4> +<pre><a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> getTenantInfo(String tenant) + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block">Get the config of the tenant. <p> - Get the admin configuration for a given property.</div> + Get the admin configuration for a given tenant.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>the property configuration</dd> +<dd>the tenant configuration</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> </ul> -<a name="createProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-"> +<a name="createTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>createProperty</h4> -<pre>void createProperty(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config) - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> -<div class="block">Create a new property. +<h4>createTenant</h4> +<pre>void createTenant(String tenant, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config) + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block">Create a new tenant. <p> - Provisions a new property. This operation requires Pulsar super-user privileges.</div> + Provisions a new tenant. This operation requires Pulsar super-user privileges.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dd><code>config</code> - Config data</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Property already exists</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.PreconditionFailedException</a></code> - Property name is not valid</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - Tenant already exists</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.PreconditionFailedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.PreconditionFailedException</a></code> - Tenant name is not valid</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> </ul> -<a name="updateProperty-java.lang.String-org.apache.pulsar.common.policies.data.PropertyAdmin-"> +<a name="updateTenant-java.lang.String-org.apache.pulsar.common.policies.data.TenantInfo-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>updateProperty</h4> -<pre>void updateProperty(String property, - <a href="../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a> config) - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> -<div class="block">Update the admins for a property. +<h4>updateTenant</h4> +<pre>void updateTenant(String tenant, + <a href="../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a> config) + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block">Update the admins for a tenant. <p> This operation requires Pulsar super-user privileges.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dd><code>config</code> - Config data</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Property does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - Tenant does not exist</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> </ul> -<a name="deleteProperty-java.lang.String-"> +<a name="deleteTenant-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> -<h4>deleteProperty</h4> -<pre>void deleteProperty(String property) - throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> -<div class="block">Delete an existing property. +<h4>deleteTenant</h4> +<pre>void deleteTenant(String tenant) + throws <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></pre> +<div class="block">Delete an existing tenant. <p> - Delete a property and all namespaces and topics under it.</div> + Delete a tenant and all namespaces and topics under it.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>property</code> - Property name</dd> +<dd><code>tenant</code> - Tenant name</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotAuthorizedException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotAuthorizedException</a></code> - Don't have admin permission</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - The property does not exist</dd> -<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - The property still has active namespaces</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.NotFoundException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.NotFoundException</a></code> - The tenant does not exist</dd> +<dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.ConflictException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException.ConflictException</a></code> - The tenant still has active namespaces</dd> <dd><code><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminException.html" title="class in org.apache.pulsar.client.admin">PulsarAdminException</a></code> - Unexpected error</dd> </dl> </li> @@ -311,12 +309,12 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../org/apache/pulsar/client/admin/PersistentTopics.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html" title="class in org.apache.pulsar.client.admin"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> </ul> <ul class="navList"> -<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Properties.html" target="_top">Frames</a></li> -<li><a href="Properties.html" target="_top">No Frames</a></li> +<li><a href="../../../../../index.html?org/apache/pulsar/client/admin/Tenants.html" target="_top">Frames</a></li> +<li><a href="Tenants.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> diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-frame.html b/content/api/admin/org/apache/pulsar/client/admin/package-frame.html index 9ef1f26..108f530 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/package-frame.html +++ b/content/api/admin/org/apache/pulsar/client/admin/package-frame.html @@ -23,6 +23,7 @@ <li><a href="Properties.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Properties</span></a></li> <li><a href="PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">PulsarAdminBuilder</span></a></li> <li><a href="ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">ResourceQuotas</span></a></li> +<li><a href="Tenants.html" title="interface in org.apache.pulsar.client.admin" target="classFrame"><span class="interfaceName">Tenants</span></a></li> </ul> <h2 title="Classes">Classes</h2> <ul title="Classes"> diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-summary.html b/content/api/admin/org/apache/pulsar/client/admin/package-summary.html index 70d2785..eb595b1 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/package-summary.html +++ b/content/api/admin/org/apache/pulsar/client/admin/package-summary.html @@ -126,8 +126,8 @@ </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin">Properties</a></td> -<td class="colLast"> -<div class="block">Admin interface for properties management</div> +<td class="colLast">Deprecated +<div class="block"><span class="deprecationComment">see <a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><code>Tenants</code></a> from <a href="../../../../../org/apache/pulsar/client/admin/PulsarAdmin.html#tenants--"><code>PulsarAdmin.tenants()</code></a></span></div> </td> </tr> <tr class="rowColor"> @@ -140,6 +140,12 @@ <td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin">ResourceQuotas</a></td> <td class="colLast"> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin">Tenants</a></td> +<td class="colLast"> +<div class="block">Admin interface for tenants management</div> +</td> +</tr> </tbody> </table> </li> diff --git a/content/api/admin/org/apache/pulsar/client/admin/package-tree.html b/content/api/admin/org/apache/pulsar/client/admin/package-tree.html index 0e8c098..68745ac 100644 --- a/content/api/admin/org/apache/pulsar/client/admin/package-tree.html +++ b/content/api/admin/org/apache/pulsar/client/admin/package-tree.html @@ -117,6 +117,7 @@ <li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Properties</span></a></li> <li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">PulsarAdminBuilder</span></a></li> <li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">ResourceQuotas</span></a></li> +<li type="circle">org.apache.pulsar.client.admin.<a href="../../../../../org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Tenants</span></a></li> </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/Policies.html b/content/api/admin/org/apache/pulsar/common/policies/data/Policies.html index 5587e9a..63d3c07 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/Policies.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/Policies.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/PersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/Policies.html" target="_top">Frames</a></li> @@ -549,7 +549,7 @@ extends Object</pre> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/PersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/Policies.html" target="_top">Frames</a></li> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/PublisherStats.html b/content/api/admin/org/apache/pulsar/common/policies/data/PublisherStats.html index ae253a8..d853a22 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/PublisherStats.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/PublisherStats.html @@ -47,7 +47,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/ReplicatorStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -434,7 +434,7 @@ extends Object</pre> </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/ReplicatorStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/SubscriptionStats.html b/content/api/admin/org/apache/pulsar/common/policies/data/SubscriptionStats.html index 7a782d2..f333e4a 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/SubscriptionStats.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/SubscriptionStats.html @@ -48,7 +48,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/SubscriptionStats.html" target="_top">Frames</a></li> @@ -408,7 +408,7 @@ extends Object</pre> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../../org/apache/pulsar/common/policies/data/SubscriptionAuthMode.html" title="enum in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> -<li>Next Class</li> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/SubscriptionStats.html" target="_top">Frames</a></li> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/TenantInfo.html b/content/api/admin/org/apache/pulsar/common/policies/data/TenantInfo.html new file mode 100644 index 0000000..31384ed --- /dev/null +++ b/content/api/admin/org/apache/pulsar/common/policies/data/TenantInfo.html @@ -0,0 +1,338 @@ +<!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 --> +<title>TenantInfo (Pulsar Admin Java API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TenantInfo (Pulsar Admin Java API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/TenantInfo.html" target="_top">Frames</a></li> +<li><a href="TenantInfo.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.pulsar.common.policies.data</div> +<h2 title="Class TenantInfo" class="title">Class TenantInfo</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.pulsar.common.policies.data.TenantInfo</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">TenantInfo</span> +extends Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#TenantInfo--">TenantInfo</a></span>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#TenantInfo-java.util.Set-java.util.Set-">TenantInfo</a></span>(Set<String> adminRoles, + Set<String> allowedClusters)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#equals-java.lang.Object-">equals</a></span>(Object obj)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>Set<String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#getAdminRoles--">getAdminRoles</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>Set<String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#getAllowedClusters--">getAllowedClusters</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#setAdminRoles-java.util.Set-">setAdminRoles</a></span>(Set<String> adminRoles)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html#setAllowedClusters-java.util.Set-">setAllowedClusters</a></span>(Set<String> allowedClusters)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TenantInfo--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TenantInfo</h4> +<pre>public TenantInfo()</pre> +</li> +</ul> +<a name="TenantInfo-java.util.Set-java.util.Set-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TenantInfo</h4> +<pre>public TenantInfo(Set<String> adminRoles, + Set<String> allowedClusters)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAdminRoles--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdminRoles</h4> +<pre>public Set<String> getAdminRoles()</pre> +</li> +</ul> +<a name="setAdminRoles-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAdminRoles</h4> +<pre>public void setAdminRoles(Set<String> adminRoles)</pre> +</li> +</ul> +<a name="getAllowedClusters--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowedClusters</h4> +<pre>public Set<String> getAllowedClusters()</pre> +</li> +</ul> +<a name="setAllowedClusters-java.util.Set-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllowedClusters</h4> +<pre>public void setAllowedClusters(Set<String> allowedClusters)</pre> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/pulsar/common/policies/data/TenantInfo.html" target="_top">Frames</a></li> +<li><a href="TenantInfo.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> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/package-frame.html b/content/api/admin/org/apache/pulsar/common/policies/data/package-frame.html index 0cd5768..277305d 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/package-frame.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/package-frame.html @@ -38,12 +38,12 @@ <li><a href="PersistentTopicInternalStats.LedgerInfo.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PersistentTopicInternalStats.LedgerInfo</a></li> <li><a href="PersistentTopicStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PersistentTopicStats</a></li> <li><a href="Policies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">Policies</a></li> -<li><a href="PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PropertyAdmin</a></li> <li><a href="PublisherStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">PublisherStats</a></li> <li><a href="ReplicatorStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">ReplicatorStats</a></li> <li><a href="ResourceQuota.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">ResourceQuota</a></li> <li><a href="RetentionPolicies.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">RetentionPolicies</a></li> <li><a href="SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">SubscriptionStats</a></li> +<li><a href="TenantInfo.html" title="class in org.apache.pulsar.common.policies.data" target="classFrame">TenantInfo</a></li> </ul> <h2 title="Enums">Enums</h2> <ul title="Enums"> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/package-summary.html b/content/api/admin/org/apache/pulsar/common/policies/data/package-summary.html index 21d1a6e..81da55f 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/package-summary.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/package-summary.html @@ -189,31 +189,31 @@ <td class="colLast"> </td> </tr> <tr class="altColor"> -<td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data">PropertyAdmin</a></td> -<td class="colLast"> </td> -</tr> -<tr class="rowColor"> <td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data">PublisherStats</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/ReplicatorStats.html" title="class in org.apache.pulsar.common.policies.data">ReplicatorStats</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/ResourceQuota.html" title="class in org.apache.pulsar.common.policies.data">ResourceQuota</a></td> <td class="colLast"> <div class="block">Resource quota for a namespace or namespace bundle.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/RetentionPolicies.html" title="class in org.apache.pulsar.common.policies.data">RetentionPolicies</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/SubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data">SubscriptionStats</a></td> <td class="colLast"> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data">TenantInfo</a></td> +<td class="colLast"> </td> +</tr> </tbody> </table> </li> diff --git a/content/api/admin/org/apache/pulsar/common/policies/data/package-tree.html b/content/api/admin/org/apache/pulsar/common/policies/data/package-tree.html index 8393141..a97facf 100644 --- a/content/api/admin/org/apache/pulsar/common/policies/data/package-tree.html +++ b/content/api/admin/org/apache/pulsar/common/policies/data/package-tree.html @@ -107,7 +107,6 @@ </ul> </li> <li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Policies</span></a></li> -<li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">PropertyAdmin</span></a></li> <li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">PublisherStats</span></a> <ul> <li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">NonPersistentPublisherStats</span></a></li> @@ -125,6 +124,7 @@ <li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">NonPersistentSubscriptionStats</span></a></li> </ul> </li> +<li type="circle">org.apache.pulsar.common.policies.data.<a href="../../../../../../org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">TenantInfo</span></a></li> </ul> </li> </ul> diff --git a/content/api/admin/overview-tree.html b/content/api/admin/overview-tree.html index bfbac5b..8665f69 100644 --- a/content/api/admin/overview-tree.html +++ b/content/api/admin/overview-tree.html @@ -118,7 +118,6 @@ </ul> </li> <li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/Policies.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">Policies</span></a></li> -<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PropertyAdmin.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">PropertyAdmin</span></a></li> <li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/PublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">PublisherStats</span></a> <ul> <li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NonPersistentPublisherStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">NonPersistentPublisherStats</span></a></li> @@ -137,6 +136,7 @@ <li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/NonPersistentSubscriptionStats.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">NonPersistentSubscriptionStats</span></a></li> </ul> </li> +<li type="circle">org.apache.pulsar.common.policies.data.<a href="org/apache/pulsar/common/policies/data/TenantInfo.html" title="class in org.apache.pulsar.common.policies.data"><span class="typeNameLink">TenantInfo</span></a></li> <li type="circle">Throwable (implements Serializable) <ul> <li type="circle">Exception @@ -175,6 +175,7 @@ <li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Properties.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Properties</span></a></li> <li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/PulsarAdminBuilder.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">PulsarAdminBuilder</span></a></li> <li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/ResourceQuotas.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">ResourceQuotas</span></a></li> +<li type="circle">org.apache.pulsar.client.admin.<a href="org/apache/pulsar/client/admin/Tenants.html" title="interface in org.apache.pulsar.client.admin"><span class="typeNameLink">Tenants</span></a></li> </ul> <h2 title="Enum Hierarchy">Enum Hierarchy</h2> <ul> diff --git a/content/api/client/index-all.html b/content/api/client/index-all.html index db2dba9..ec53435 100644 --- a/content/api/client/index-all.html +++ b/content/api/client/index-all.html @@ -532,7 +532,8 @@ <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/ProducerConfiguration.html#getBatchingEnabled--">getBatchingEnabled()</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> - </dd> +<div class="block">Return the flag whether automatic message batching is enabled or not.</div> +</dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/ProducerConfiguration.html#getBatchingMaxMessages--">getBatchingMaxMessages()</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> @@ -686,7 +687,7 @@ <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/ProducerConfiguration.html#getMessageRoutingMode--">getMessageRoutingMode()</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> -<div class="block">Get the message routing mode for the partitioned producer</div> +<div class="block">Get the message routing mode for the partitioned producer.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/EncryptionKeyInfo.html#getMetadata--">getMetadata()</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/EncryptionKeyInfo.html" title="class in org.apache.pulsar.client.api">EncryptionKeyInfo</a></dt> <dd> </dd> @@ -1584,7 +1585,7 @@ <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/ProducerConfiguration.html#setMessageRoutingMode-org.apache.pulsar.client.api.ProducerConfiguration.MessageRoutingMode-">setMessageRoutingMode(ProducerConfiguration.MessageRoutingMode)</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a></dt> <dd> <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> -<div class="block">Set the message routing mode for the partitioned producer</div> +<div class="block">Set the message routing mode for the partitioned producer.</div> </dd> <dt><span class="memberNameLink"><a href="org/apache/pulsar/client/api/EncryptionKeyInfo.html#setMetadata-java.util.Map-">setMetadata(Map<String, String>)</a></span> - Method in class org.apache.pulsar.client.api.<a href="org/apache/pulsar/client/api/EncryptionKeyInfo.html" title="class in org.apache.pulsar.client.api">EncryptionKeyInfo</a></dt> <dd> </dd> diff --git a/content/api/client/org/apache/pulsar/client/api/ProducerBuilder.html b/content/api/client/org/apache/pulsar/client/api/ProducerBuilder.html index 4b2b5a1..a45cd22 100644 --- a/content/api/client/org/apache/pulsar/client/api/ProducerBuilder.html +++ b/content/api/client/org/apache/pulsar/client/api/ProducerBuilder.html @@ -406,7 +406,7 @@ extends Serializable, Cloneable</pre> <div class="block">Set the max size of the queue holding the messages pending to receive an acknowledgment from the broker. <p> When the queue is full, by default, all calls to <a href="../../../../../org/apache/pulsar/client/api/Producer.html#send-T-"><code>Producer.send(T)</code></a> and <a href="../../../../../org/apache/pulsar/client/api/Producer.html#sendAsync-T-"><code>Producer.sendAsync(T)</code></a> will fail - unless blockIfQueueFull is set to true. Use <code>#setBlockIfQueueFull</code> to change the blocking behavior.</div> + unless blockIfQueueFull is set to true. Use <a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html#blockIfQueueFull-boolean-"><code>blockIfQueueFull(boolean)</code></a> to change the blocking behavior.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>maxPendingMessages</code> - </dd> @@ -459,13 +459,17 @@ extends Serializable, Cloneable</pre> <pre><a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html" title="interface in org.apache.pulsar.client.api">ProducerBuilder</a><<a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html" title="type parameter in ProducerBuilder">T</a>> messageRoutingMode(<a href="../../../../../org/apache/pulsar/client/api/MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api">MessageRoutingMode</a> messageRoutingMode)</pre> <div class="block">Set the message routing mode for the partitioned producer. - Default routing mode for messages to partition. + Default routing mode is round-robin routing. This logic is applied when the application is not setting a key <a href="../../../../../org/apache/pulsar/client/api/MessageBuilder.html#setKey-java.lang.String-"><code>MessageBuilder.setKey(String)</code></a> on a particular message.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>messageRoutingMode</code> - the message routing mode</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>producer builder</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/pulsar/client/api/MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api"><code>MessageRoutingMode</code></a></dd> </dl> </li> </ul> @@ -541,10 +545,15 @@ extends Serializable, Cloneable</pre> messages will be compressed at the batch level, leading to a much better compression ratio for similar headers or contents. - When enabled default batch delay is set to 10 ms and default batch size is 1000 messages</div> + When enabled default batch delay is set to 1 ms and default batch size is 1000 messages + + <p>Batching is enabled by default since 2.0.0.</div> <dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>producer builder.</dd> <dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html#batchingMaxPublishDelay-long-java.util.concurrent.TimeUnit-"><code>batchingMaxPublishDelay(long, TimeUnit)</code></a></dd> +<dd><a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html#batchingMaxPublishDelay-long-java.util.concurrent.TimeUnit-"><code>batchingMaxPublishDelay(long, TimeUnit)</code></a>, +<a href="../../../../../org/apache/pulsar/client/api/ProducerBuilder.html#batchingMaxMessages-int-"><code>batchingMaxMessages(int)</code></a></dd> </dl> </li> </ul> diff --git a/content/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html b/content/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html index 2ccaf84..9b2fe61 100644 --- a/content/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html +++ b/content/api/client/org/apache/pulsar/client/api/ProducerConfiguration.html @@ -198,7 +198,8 @@ implements Serializable</pre> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.html#getBatchingEnabled--">getBatchingEnabled</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> - </td> +<div class="block">Return the flag whether automatic message batching is enabled or not.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>int</code></td> @@ -286,7 +287,7 @@ implements Serializable</pre> <td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api">ProducerConfiguration.MessageRoutingMode</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.html#getMessageRoutingMode--">getMessageRoutingMode</a></span>()</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> -<div class="block">Get the message routing mode for the partitioned producer</div> +<div class="block">Get the message routing mode for the partitioned producer.</div> </td> </tr> <tr id="i16" class="altColor"> @@ -416,7 +417,7 @@ implements Serializable</pre> <td class="colFirst"><code><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.html#setMessageRoutingMode-org.apache.pulsar.client.api.ProducerConfiguration.MessageRoutingMode-">setMessageRoutingMode</a></span>(<a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api">ProducerConfiguration.MessageRoutingMode</a> messageRouteMode)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> -<div class="block">Set the message routing mode for the partitioned producer</div> +<div class="block">Set the message routing mode for the partitioned producer.</div> </td> </tr> <tr id="i35" class="rowColor"> @@ -692,11 +693,14 @@ implements Serializable</pre> <h4>setMessageRoutingMode</h4> <pre>public <a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.html" title="class in org.apache.pulsar.client.api">ProducerConfiguration</a> setMessageRoutingMode(<a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api">ProducerConfiguration.MessageRoutingMode</a> messageRouteMode)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> -<div class="block">Set the message routing mode for the partitioned producer</div> +<div class="block">Set the message routing mode for the partitioned producer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>mode</code> - </dd> +<dd><code>messageRouteMode</code> - message routing mode.</dd> <dt><span class="returnLabel">Returns:</span></dt> +<dd>producer configuration</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api"><code>ProducerConfiguration.MessageRoutingMode</code></a></dd> </dl> </li> </ul> @@ -708,9 +712,12 @@ implements Serializable</pre> <h4>getMessageRoutingMode</h4> <pre>public <a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html" title="enum in org.apache.pulsar.client.api">ProducerConfiguration.MessageRoutingMode</a> getMessageRoutingMode()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> -<div class="block">Get the message routing mode for the partitioned producer</div> +<div class="block">Get the message routing mode for the partitioned producer.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> +<dd>message routing mode, default is round-robin routing.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html#RoundRobinPartition"><code>ProducerConfiguration.MessageRoutingMode.RoundRobinPartition</code></a></dd> </dl> </li> </ul> @@ -811,6 +818,14 @@ public <a href="../../../../../org/apache/pulsar/client/api/MessageRouter.h <h4>getBatchingEnabled</h4> <pre>public boolean getBatchingEnabled()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Return the flag whether automatic message batching is enabled or not.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if batch messages are enabled. otherwise false.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.0.0 <br> + It is enabled by default.</dd> +</dl> </li> </ul> <a name="setBatchingEnabled-boolean-"> -- To stop receiving notification emails like this one, please contact mme...@apache.org.