org.apache.pulsar.client.admin

Interface Namespaces

All Known Implementing Classes:

NamespacesImpl

public interface Namespaces

Admin interface for namespaces management

Method Summary

Modifier and Type	Method and Description
void	clearNamespaceBacklog(String namespace) Clear backlog for all topics on a namespace
void	clearNamespaceBacklogForSubscription(String namespace, String subscription) Clear backlog for a given subscription on all topics on a namespace
void	clearNamespaceBundleBacklog(String namespace, String bundle) Clear backlog for all topics on a namespace bundle
void	clearNamespaceBundleBacklogForSubscription(String namespace, String bundle, String subscription) Clear backlog for a given subscription on all topics on a namespace bundle
void	createNamespace(String namespace) Create a new namespace.
void	createNamespace(String namespace, BundlesData bundlesData) Create a new namespace.
void	createNamespace(String namespace, int numBundles) Create a new namespace.
void	createNamespace(String namespace, Policies policies) Create a new namespace.
void	createNamespace(String namespace, Set<String> clusters) Create a new namespace.
void	deleteNamespace(String namespace) Delete an existing namespace.
void	deleteNamespaceAntiAffinityGroup(String namespace) Delete anti-affinity group name for a namespace.
void	deleteNamespaceBundle(String namespace, String bundleRange) Delete an existing bundle in a namespace.
List<String>	getAntiAffinityNamespaces(String tenant, String cluster, String namespaceAntiAffinityGroup) Get all namespaces that grouped with given anti-affinity group
Map<BacklogQuota.BacklogQuotaType,BacklogQuota>	getBacklogQuotaMap(String namespace) Get backlog quota map on a namespace.
DispatchRate	getDispatchRate(String namespace) Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second)
int	getMaxConsumersPerSubscription(String namespace) Get the maxConsumersPerSubscription for a namespace.
int	getMaxConsumersPerTopic(String namespace) Get the maxProducersPerTopic for a namespace.
int	getMaxProducersPerTopic(String namespace) Get the maxProducersPerTopic for a namespace.
String	getNamespaceAntiAffinityGroup(String namespace) Get anti-affinity group name for a namespace
int	getNamespaceMessageTTL(String namespace) Get the message TTL for a namespace.
List<String>	getNamespaceReplicationClusters(String namespace) Get the replication clusters for a namespace.
List<String>	getNamespaces(String tenant) Get the list of namespaces.
List<String>	getNamespaces(String tenant, String cluster) Deprecated.
Map<String,Set<AuthAction>>	getPermissions(String namespace) Get permissions on a namespace.
PersistencePolicies	getPersistence(String namespace) Get the persistence configuration for a namespace.
Policies	getPolicies(String namespace) Get policies for a namespace.
String	getReplicationConfigVersion(String namespace) Get the replication configuration version for a given namespace
RetentionPolicies	getRetention(String namespace) Get the retention configuration for a namespace.
DispatchRate	getSubscriptionDispatchRate(String namespace) Get subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)
List<String>	getTopics(String namespace) Get the list of topics.
void	grantPermissionOnNamespace(String namespace, String role, Set<AuthAction> actions) Grant permission on a namespace.
void	removeBacklogQuota(String namespace) Remove a backlog quota policy from a namespace.
void	revokePermissionsOnNamespace(String namespace, String role) Revoke permissions on a namespace.
void	setBacklogQuota(String namespace, BacklogQuota backlogQuota) Set a backlog quota for all the topics on a namespace.
void	setDeduplicationStatus(String namespace, boolean enableDeduplication) Set the deduplication status for all topics within a namespace.
void	setDispatchRate(String namespace, DispatchRate dispatchRate) Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second)
void	setEncryptionRequiredStatus(String namespace, boolean encryptionRequired) Set the encryption required status for all topics within a namespace.
void	setMaxConsumersPerSubscription(String namespace, int maxConsumersPerSubscription) Set maxConsumersPerSubscription for a namespace.
void	setMaxConsumersPerTopic(String namespace, int maxConsumersPerTopic) Set maxConsumersPerTopic for a namespace.
void	setMaxProducersPerTopic(String namespace, int maxProducersPerTopic) Set maxProducersPerTopic for a namespace.
void	setNamespaceAntiAffinityGroup(String namespace, String namespaceAntiAffinityGroup) Set anti-affinity group name for a namespace
void	setNamespaceMessageTTL(String namespace, int ttlInSeconds) Set the messages Time to Live for all the topics within a namespace.
void	setNamespaceReplicationClusters(String namespace, Set<String> clusterIds) Set the replication clusters for a namespace.
void	setPersistence(String namespace, PersistencePolicies persistence) Set the persistence configuration for all the topics on a namespace.
void	setRetention(String namespace, RetentionPolicies retention) Set the retention configuration for all the topics on a namespace.
void	setSubscriptionAuthMode(String namespace, SubscriptionAuthMode subscriptionAuthMode) Set the given subscription auth mode on all topics on a namespace
void	setSubscriptionDispatchRate(String namespace, DispatchRate dispatchRate) Set subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)
void	splitNamespaceBundle(String namespace, String bundle, boolean unloadSplitBundles) Split namespace bundle
void	unload(String namespace) Unload a namespace from the current serving broker.
void	unloadNamespaceBundle(String namespace, String bundle) Unload namespace bundle
void	unsubscribeNamespace(String namespace, String subscription) Unsubscribes the given subscription on all topics on a namespace
void	unsubscribeNamespaceBundle(String namespace, String bundle, String subscription) Unsubscribes the given subscription on all topics on a namespace bundle

Method Detail

getNamespaces

List<String> getNamespaces(String tenant)
                    throws PulsarAdminException

Get the list of namespaces.

Get the list of all the namespaces for a certain tenant.

Response Example:

 ["my-tenant/c1/namespace1",
  "my-tenant/global/namespace2",
  "my-tenant/c2/namespace3"]
 

Parameters:

tenant - Tenant name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant does not exist

PulsarAdminException - Unexpected error

getNamespaces

@Deprecated
List<String> getNamespaces(String tenant,
                                       String cluster)
                                throws PulsarAdminException

Deprecated.

Get the list of namespaces.

Get the list of all the namespaces for a certain tenant on single cluster.

Response Example:

 ["my-tenant/use/namespace1", "my-tenant/use/namespace2"]
 

Parameters:

tenant - Tenant name

cluster - Cluster name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException - Unexpected error

getTopics

List<String> getTopics(String namespace)
                throws PulsarAdminException

Get the list of topics.

Get the list of all the topics under a certain namespace.

Response Example:

 ["persistent://my-tenant/use/namespace1/my-topic-1",
  "persistent://my-tenant/use/namespace1/my-topic-2"]
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getPolicies

Policies getPolicies(String namespace)
              throws PulsarAdminException

Get policies for a namespace.

Get the dump all the policies specified for a namespace.

Response example:

 {
   "auth_policies" : {
     "namespace_auth" : {
       "my-role" : [ "produce" ]
     },
     "destination_auth" : {
       "persistent://prop/local/ns1/my-topic" : {
         "role-1" : [ "produce" ],
         "role-2" : [ "consume" ]
       }
     }
   },
   "replication_clusters" : ["use", "usw"],
   "message_ttl_in_seconds" : 300
 }
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

See Also:

Policies

createNamespace

void createNamespace(String namespace,
                     int numBundles)
              throws PulsarAdminException

Create a new namespace.

Creates a new empty namespace with no policies attached.

Parameters:

namespace - Namespace name

numBundles - Number of bundles

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException.ConflictException - Namespace already exists

PulsarAdminException - Unexpected error

createNamespace

void createNamespace(String namespace,
                     BundlesData bundlesData)
              throws PulsarAdminException

Create a new namespace.

Creates a new empty namespace with no policies attached.

Parameters:

namespace - Namespace name

bundlesData - Bundles Data

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException.ConflictException - Namespace already exists

PulsarAdminException - Unexpected error

createNamespace

void createNamespace(String namespace)
              throws PulsarAdminException

Create a new namespace.

Creates a new empty namespace with no policies attached.

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException.ConflictException - Namespace already exists

PulsarAdminException - Unexpected error

createNamespace

void createNamespace(String namespace,
                     Set<String> clusters)
              throws PulsarAdminException

Create a new namespace.

Creates a new empty namespace with no policies attached.

Parameters:

namespace - Namespace name

clusters - Clusters in which the namespace will be present. If more than one cluster is present, replication across clusters will be enabled.

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException.ConflictException - Namespace already exists

PulsarAdminException - Unexpected error

createNamespace

void createNamespace(String namespace,
                     Policies policies)
              throws PulsarAdminException

Create a new namespace.

Creates a new namespace with the specified policies.

Parameters:

namespace - Namespace name

policies - Policies for the namespace

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Tenant or cluster does not exist

PulsarAdminException.ConflictException - Namespace already exists

PulsarAdminException - Unexpected error

Since:

2.0

deleteNamespace

void deleteNamespace(String namespace)
              throws PulsarAdminException

Delete an existing namespace.

The namespace needs to be empty.

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Namespace is not empty

PulsarAdminException - Unexpected error

deleteNamespaceBundle

void deleteNamespaceBundle(String namespace,
                           String bundleRange)
                    throws PulsarAdminException

Delete an existing bundle in a namespace.

The bundle needs to be empty.

Parameters:

namespace - Namespace name

bundleRange - range of the bundle

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace/bundle does not exist

PulsarAdminException.ConflictException - Bundle is not empty

PulsarAdminException - Unexpected error

getPermissions

Map<String,Set<AuthAction>> getPermissions(String namespace)
                                    throws PulsarAdminException

Get permissions on a namespace.

Retrieve the permissions for a namespace.

Response example:

 {
   "my-role" : [ "produce" ]
   "other-role" : [ "consume" ]
 }
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

grantPermissionOnNamespace

void grantPermissionOnNamespace(String namespace,
                                String role,
                                Set<AuthAction> actions)
                         throws PulsarAdminException

Grant permission on a namespace.

Grant a new permission to a client role on a namespace.

Request parameter example:

 ["produce", "consume"]
 

Parameters:

namespace - Namespace name

role - Client role to which grant permission

actions - Auth actions (produce and consume)

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Concurrent modification

PulsarAdminException - Unexpected error

revokePermissionsOnNamespace

void revokePermissionsOnNamespace(String namespace,
                                  String role)
                           throws PulsarAdminException

Revoke permissions on a namespace.

Revoke all permissions to a client role on a namespace.

Parameters:

namespace - Namespace name

role - Client role to which remove permissions

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getNamespaceReplicationClusters

List<String> getNamespaceReplicationClusters(String namespace)
                                      throws PulsarAdminException

Get the replication clusters for a namespace.

Response example:

 ["use", "usw", "usc"]
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.PreconditionFailedException - Namespace is not global

PulsarAdminException - Unexpected error

setNamespaceReplicationClusters

void setNamespaceReplicationClusters(String namespace,
                                     Set<String> clusterIds)
                              throws PulsarAdminException

Set the replication clusters for a namespace.

Request example:

 ["us-west", "us-east", "us-cent"]
 

Parameters:

namespace - Namespace name

clusterIds - Pulsar Cluster Ids

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.PreconditionFailedException - Namespace is not global

PulsarAdminException.PreconditionFailedException - Invalid cluster ids

PulsarAdminException - Unexpected error

getNamespaceMessageTTL

int getNamespaceMessageTTL(String namespace)
                    throws PulsarAdminException

Get the message TTL for a namespace.

Response example:

 60
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setNamespaceMessageTTL

void setNamespaceMessageTTL(String namespace,
                            int ttlInSeconds)
                     throws PulsarAdminException

Set the messages Time to Live for all the topics within a namespace.

Request example:

 60
 

Parameters:

namespace - Namespace name

ttlInSeconds - TTL values for all messages for all topics in this namespace

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setNamespaceAntiAffinityGroup

void setNamespaceAntiAffinityGroup(String namespace,
                                   String namespaceAntiAffinityGroup)
                            throws PulsarAdminException

Set anti-affinity group name for a namespace

Request example:

Parameters:

namespace - Namespace name

namespaceAntiAffinityGroup - anti-affinity group name for a namespace

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getAntiAffinityNamespaces

List<String> getAntiAffinityNamespaces(String tenant,
                                       String cluster,
                                       String namespaceAntiAffinityGroup)
                                throws PulsarAdminException

Get all namespaces that grouped with given anti-affinity group

Parameters:

tenant - tenant is only used for authorization. Client has to be admin of any of the tenant to access this api api.

cluster - cluster name

namespaceAntiAffinityGroup - Anti-affinity group name

Returns:

list of namespace grouped under a given anti-affinity group

Throws:

PulsarAdminException

getNamespaceAntiAffinityGroup

String getNamespaceAntiAffinityGroup(String namespace)
                              throws PulsarAdminException

Get anti-affinity group name for a namespace

Response example:

 60
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

deleteNamespaceAntiAffinityGroup

void deleteNamespaceAntiAffinityGroup(String namespace)
                               throws PulsarAdminException

Delete anti-affinity group name for a namespace.

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setDeduplicationStatus

void setDeduplicationStatus(String namespace,
                            boolean enableDeduplication)
                     throws PulsarAdminException

Set the deduplication status for all topics within a namespace.

When deduplication is enabled, the broker will prevent to store the same message multiple times.

Request example:

 true
 

Parameters:

namespace - Namespace name

enableDeduplication - wether to enable or disable deduplication feature

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getBacklogQuotaMap

Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String namespace)
                                                            throws PulsarAdminException

Get backlog quota map on a namespace.

Get backlog quota map on a namespace.

Response example:

 
  {
      "namespace_memory" : {
          "limit" : "134217728",
          "policy" : "consumer_backlog_eviction"
      },
      "destination_storage" : {
          "limit" : "-1",
          "policy" : "producer_exception"
      }
  }
 
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Permission denied

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setBacklogQuota

void setBacklogQuota(String namespace,
                     BacklogQuota backlogQuota)
              throws PulsarAdminException

Set a backlog quota for all the topics on a namespace.

Set a backlog quota on a namespace.

The backlog quota can be set on this resource:

Request parameter example:

 
 {
     "limit" : "134217728",
     "policy" : "consumer_backlog_eviction"
 }
 
 

Parameters:

namespace - Namespace name

backlogQuota - the new BacklogQuota

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

removeBacklogQuota

void removeBacklogQuota(String namespace)
                 throws PulsarAdminException

Remove a backlog quota policy from a namespace.

Remove a backlog quota policy from a namespace.

The backlog retention policy will fall back to the default.

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setPersistence

void setPersistence(String namespace,
                    PersistencePolicies persistence)
             throws PulsarAdminException

Set the persistence configuration for all the topics on a namespace.

Set the persistence configuration on a namespace.

Request parameter example:

 
 {
     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
                                               // to avoid high number of updates for each
                                               // consumer
 }
 
 

Parameters:

tenant - Tenant name

cluster - Cluster name

namespace - Namespace name

persistence - Persistence policies object

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Concurrent modification

PulsarAdminException - Unexpected error

getPersistence

PersistencePolicies getPersistence(String namespace)
                            throws PulsarAdminException

Get the persistence configuration for a namespace.

Get the persistence configuration for a namespace.

Response example:

 
 {
     "bookkeeperEnsemble" : 3,                 // Number of bookies to use for a topic
     "bookkeeperWriteQuorum" : 2,              // How many writes to make of each entry
     "bookkeeperAckQuorum" : 2,                // Number of acks (guaranteed copies) to wait for each entry
     "managedLedgerMaxMarkDeleteRate" : 10.0,  // Throttling rate of mark-delete operation
                                               // to avoid high number of updates for each
                                               // consumer
 }
 
 

Parameters:

tenant - Tenant name

cluster - Cluster name

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Concurrent modification

PulsarAdminException - Unexpected error

setRetention

void setRetention(String namespace,
                  RetentionPolicies retention)
           throws PulsarAdminException

Set the retention configuration for all the topics on a namespace.

Set the retention configuration on a namespace. This operation requires Pulsar super-user access.

Request parameter example:

 
 {
     "retentionTimeInMinutes" : 60,            // how long to retain messages
     "retentionSizeInMB" : 1024,              // retention backlog limit
 }
 
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Concurrent modification

PulsarAdminException - Unexpected error

getRetention

RetentionPolicies getRetention(String namespace)
                        throws PulsarAdminException

Get the retention configuration for a namespace.

Get the retention configuration for a namespace.

Response example:

 
 {
     "retentionTimeInMinutes" : 60,            // how long to retain messages
     "retentionSizeInMB" : 1024,              // retention backlog limit
 }
 
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.ConflictException - Concurrent modification

PulsarAdminException - Unexpected error

unload

void unload(String namespace)
     throws PulsarAdminException

Unload a namespace from the current serving broker.

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException.PreconditionFailedException - Namespace is already unloaded

PulsarAdminException - Unexpected error

getReplicationConfigVersion

String getReplicationConfigVersion(String namespace)
                            throws PulsarAdminException

Get the replication configuration version for a given namespace

Parameters:

namespace -

Returns:

Replication configuration version

Throws:

PulsarAdminException - Unexpected error

unloadNamespaceBundle

void unloadNamespaceBundle(String namespace,
                           String bundle)
                    throws PulsarAdminException

Unload namespace bundle

Parameters:

namespace -

Throws:

PulsarAdminException - Unexpected error

splitNamespaceBundle

void splitNamespaceBundle(String namespace,
                          String bundle,
                          boolean unloadSplitBundles)
                   throws PulsarAdminException

Split namespace bundle

Parameters:

namespace -

range - of bundle to split

unload - newly split bundles from the broker

Throws:

PulsarAdminException - Unexpected error

setDispatchRate

void setDispatchRate(String namespace,
                     DispatchRate dispatchRate)
              throws PulsarAdminException

Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second)

Parameters:

namespace -

messageRate - number of messages per second

Throws:

PulsarAdminException - Unexpected error

getDispatchRate

DispatchRate getDispatchRate(String namespace)
                      throws PulsarAdminException

Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second)

Parameters:

namespace -

Throws:

PulsarAdminException - Unexpected error

setSubscriptionDispatchRate

void setSubscriptionDispatchRate(String namespace,
                                 DispatchRate dispatchRate)
                          throws PulsarAdminException

Set subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)

Parameters:

namespace -

dispatchRate - number of messages per second

Throws:

PulsarAdminException - Unexpected error

getSubscriptionDispatchRate

DispatchRate getSubscriptionDispatchRate(String namespace)
                                  throws PulsarAdminException

Get subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)

Parameters:

namespace -

Throws:

PulsarAdminException - Unexpected error

clearNamespaceBacklog

void clearNamespaceBacklog(String namespace)
                    throws PulsarAdminException

Clear backlog for all topics on a namespace

Parameters:

namespace -

Throws:

PulsarAdminException - Unexpected error

clearNamespaceBacklogForSubscription

void clearNamespaceBacklogForSubscription(String namespace,
                                          String subscription)
                                   throws PulsarAdminException

Clear backlog for a given subscription on all topics on a namespace

Parameters:

namespace -

subscription -

Throws:

PulsarAdminException - Unexpected error

clearNamespaceBundleBacklog

void clearNamespaceBundleBacklog(String namespace,
                                 String bundle)
                          throws PulsarAdminException

Clear backlog for all topics on a namespace bundle

Parameters:

namespace -

bundle -

Throws:

PulsarAdminException - Unexpected error

clearNamespaceBundleBacklogForSubscription

void clearNamespaceBundleBacklogForSubscription(String namespace,
                                                String bundle,
                                                String subscription)
                                         throws PulsarAdminException

Clear backlog for a given subscription on all topics on a namespace bundle

Parameters:

namespace -

bundle -

subscription -

Throws:

PulsarAdminException - Unexpected error

unsubscribeNamespace

void unsubscribeNamespace(String namespace,
                          String subscription)
                   throws PulsarAdminException

Unsubscribes the given subscription on all topics on a namespace

Parameters:

namespace -

subscription -

Throws:

PulsarAdminException

unsubscribeNamespaceBundle

void unsubscribeNamespaceBundle(String namespace,
                                String bundle,
                                String subscription)
                         throws PulsarAdminException

Unsubscribes the given subscription on all topics on a namespace bundle

Parameters:

namespace -

bundle -

subscription -

Throws:

PulsarAdminException

setEncryptionRequiredStatus

void setEncryptionRequiredStatus(String namespace,
                                 boolean encryptionRequired)
                          throws PulsarAdminException

Set the encryption required status for all topics within a namespace.

When encryption required is true, the broker will prevent to store unencrypted messages.

Request example:

 true
 

Parameters:

namespace - Namespace name

encryptionRequired - whether message encryption is required or not

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setSubscriptionAuthMode

void setSubscriptionAuthMode(String namespace,
                             SubscriptionAuthMode subscriptionAuthMode)
                      throws PulsarAdminException

Set the given subscription auth mode on all topics on a namespace

Parameters:

namespace -

subscriptionAuthMode -

Throws:

PulsarAdminException

getMaxProducersPerTopic

int getMaxProducersPerTopic(String namespace)
                     throws PulsarAdminException

Get the maxProducersPerTopic for a namespace.

Response example:

 0
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setMaxProducersPerTopic

void setMaxProducersPerTopic(String namespace,
                             int maxProducersPerTopic)
                      throws PulsarAdminException

Set maxProducersPerTopic for a namespace.

Request example:

 10
 

Parameters:

namespace - Namespace name

maxProducersPerTopic - maxProducersPerTopic value for a namespace

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getMaxConsumersPerTopic

int getMaxConsumersPerTopic(String namespace)
                     throws PulsarAdminException

Get the maxProducersPerTopic for a namespace.

Response example:

 0
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setMaxConsumersPerTopic

void setMaxConsumersPerTopic(String namespace,
                             int maxConsumersPerTopic)
                      throws PulsarAdminException

Set maxConsumersPerTopic for a namespace.

Request example:

 10
 

Parameters:

namespace - Namespace name

maxConsumersPerTopic - maxConsumersPerTopic value for a namespace

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

getMaxConsumersPerSubscription

int getMaxConsumersPerSubscription(String namespace)
                            throws PulsarAdminException

Get the maxConsumersPerSubscription for a namespace.

Response example:

 0
 

Parameters:

namespace - Namespace name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setMaxConsumersPerSubscription

void setMaxConsumersPerSubscription(String namespace,
                                    int maxConsumersPerSubscription)
                             throws PulsarAdminException

Set maxConsumersPerSubscription for a namespace.

Request example:

 10
 

Parameters:

namespace - Namespace name

maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error