NamespacesImpl (Pulsar Client Admin Original 2.0.0-rc1-incubating API)

java.lang.Object
- org.apache.pulsar.client.admin.internal.BaseResource
- - org.apache.pulsar.client.admin.internal.NamespacesImpl

All Implemented Interfaces:: Namespaces

public class NamespacesImpl
extends BaseResource
implements Namespaces

Constructor Summary

Constructors
Constructor and Description

NamespacesImpl(javax.ws.rs.client.WebTarget web, Authentication auth)

Constructors
Constructor and Description
`NamespacesImpl(javax.ws.rs.client.WebTarget web, Authentication auth)`

Method Summary

All Methods Instance Methods Concrete Methods
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)` Get the list of namespaces.
`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

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource
asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NamespacesImpl
```
public NamespacesImpl(javax.ws.rs.client.WebTarget web,
                      Authentication auth)
```
- Method Detail
  - getNamespaces
```
public List<String> getNamespaces(String tenant)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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"]
 
```
    Specified by:
    
    getNamespaces in interface Namespaces
    
    Parameters:
    
    tenant - Tenant name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Tenant does not exist
    
    PulsarAdminException - Unexpected error
  - getNamespaces
```
public List<String> getNamespaces(String tenant,
                                  String cluster)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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"]
 
```
    Specified by:
    
    getNamespaces in interface Namespaces
    
    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
```
public List<String> getTopics(String namespace)
                       throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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"]
 
```
    Specified by:
    
    getTopics in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - You don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - getPolicies
```
public Policies getPolicies(String namespace)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 }
 
```
    Specified by:
    
    getPolicies in interface Namespaces
    
    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
```
public void createNamespace(String namespace,
                            Set<String> clusters)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Create a new namespace.
    Creates a new empty namespace with no policies attached.
    
    Specified by:
    
    createNamespace in interface Namespaces
    
    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
```
public void createNamespace(String namespace,
                            int numBundles)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Create a new namespace.
    Creates a new empty namespace with no policies attached.
    
    Specified by:
    
    createNamespace in interface Namespaces
    
    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
```
public void createNamespace(String namespace,
                            Policies policies)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Create a new namespace.
    Creates a new namespace with the specified policies.
    
    Specified by:
    
    createNamespace in interface Namespaces
    
    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
  - createNamespace
```
public void createNamespace(String namespace,
                            BundlesData bundlesData)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Create a new namespace.
    Creates a new empty namespace with no policies attached.
    
    Specified by:
    
    createNamespace in interface Namespaces
    
    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
```
public void createNamespace(String namespace)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Create a new namespace.
    Creates a new empty namespace with no policies attached.
    
    Specified by:
    
    createNamespace in interface Namespaces
    
    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
  - deleteNamespace
```
public void deleteNamespace(String namespace)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Delete an existing namespace.
    The namespace needs to be empty.
    
    Specified by:
    
    deleteNamespace in interface Namespaces
    
    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
```
public void deleteNamespaceBundle(String namespace,
                                  String bundleRange)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Delete an existing bundle in a namespace.
    The bundle needs to be empty.
    
    Specified by:
    
    deleteNamespaceBundle in interface Namespaces
    
    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
```
public Map<String,Set<AuthAction>> getPermissions(String namespace)
                                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get permissions on a namespace.
    Retrieve the permissions for a namespace.
    Response example:
```
 {
   "my-role" : [ "produce" ]
   "other-role" : [ "consume" ]
 }
 
```
    Specified by:
    
    getPermissions in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - You don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - grantPermissionOnNamespace
```
public void grantPermissionOnNamespace(String namespace,
                                       String role,
                                       Set<AuthAction> actions)
                                throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Grant permission on a namespace.
    Grant a new permission to a client role on a namespace.
    Request parameter example:
```
 ["produce", "consume"]
 
```
    Specified by:
    
    grantPermissionOnNamespace in interface Namespaces
    
    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
```
public void revokePermissionsOnNamespace(String namespace,
                                         String role)
                                  throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Revoke permissions on a namespace.
    Revoke all permissions to a client role on a namespace.
    
    Specified by:
    
    revokePermissionsOnNamespace in interface Namespaces
    
    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
```
public List<String> getNamespaceReplicationClusters(String namespace)
                                             throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get the replication clusters for a namespace.
    Response example:
```
 ["use", "usw", "usc"]
 
```
    Specified by:
    
    getNamespaceReplicationClusters in interface Namespaces
    
    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
```
public void setNamespaceReplicationClusters(String namespace,
                                            Set<String> clusterIds)
                                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Set the replication clusters for a namespace.
    Request example:
```
 ["us-west", "us-east", "us-cent"]
 
```
    Specified by:
    
    setNamespaceReplicationClusters in interface Namespaces
    
    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 - Unexpected error
  - getNamespaceMessageTTL
```
public int getNamespaceMessageTTL(String namespace)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get the message TTL for a namespace.
    Response example:
```
 60
 
```
    Specified by:
    
    getNamespaceMessageTTL in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setNamespaceMessageTTL
```
public void setNamespaceMessageTTL(String namespace,
                                   int ttlInSeconds)
                            throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Set the messages Time to Live for all the topics within a namespace.
    Request example:
```
 60
 
```
    Specified by:
    
    setNamespaceMessageTTL in interface Namespaces
    
    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
```
public void setNamespaceAntiAffinityGroup(String namespace,
                                          String namespaceAntiAffinityGroup)
                                   throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Set anti-affinity group name for a namespace
    Request example:
    
    Specified by:
    
    setNamespaceAntiAffinityGroup in interface Namespaces
    
    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
  - getNamespaceAntiAffinityGroup
```
public String getNamespaceAntiAffinityGroup(String namespace)
                                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get anti-affinity group name for a namespace
    Response example:
```
 60
 
```
    Specified by:
    
    getNamespaceAntiAffinityGroup in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - getAntiAffinityNamespaces
```
public List<String> getAntiAffinityNamespaces(String tenant,
                                              String cluster,
                                              String namespaceAntiAffinityGroup)
                                       throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Get all namespaces that grouped with given anti-affinity group
    
    Specified by:
    
    getAntiAffinityNamespaces in interface Namespaces
    
    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
  - deleteNamespaceAntiAffinityGroup
```
public void deleteNamespaceAntiAffinityGroup(String namespace)
                                      throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Delete anti-affinity group name for a namespace.
    
    Specified by:
    
    deleteNamespaceAntiAffinityGroup in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - You don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setDeduplicationStatus
```
public void setDeduplicationStatus(String namespace,
                                   boolean enableDeduplication)
                            throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 
```
    Specified by:
    
    setDeduplicationStatus in interface Namespaces
    
    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
```
public Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String namespace)
                                                                   throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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"
      }
  }
 
 
```
    Specified by:
    
    getBacklogQuotaMap in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Permission denied
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setBacklogQuota
```
public void setBacklogQuota(String namespace,
                            BacklogQuota backlogQuota)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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"
 }
 
 
```
    Specified by:
    
    setBacklogQuota in interface Namespaces
    
    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
```
public void removeBacklogQuota(String namespace)
                        throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    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.
    
    Specified by:
    
    removeBacklogQuota in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setPersistence
```
public void setPersistence(String namespace,
                           PersistencePolicies persistence)
                    throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 }
 
 
```
    Specified by:
    
    setPersistence in interface Namespaces
    
    Parameters:
    
    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
```
public PersistencePolicies getPersistence(String namespace)
                                   throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 }
 
 
```
    Specified by:
    
    getPersistence in interface Namespaces
    
    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
  - setRetention
```
public void setRetention(String namespace,
                         RetentionPolicies retention)
                  throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 }
 
 
```
    Specified by:
    
    setRetention in interface Namespaces
    
    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
```
public RetentionPolicies getRetention(String namespace)
                               throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 }
 
 
```
    Specified by:
    
    getRetention in interface Namespaces
    
    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
```
public void unload(String namespace)
            throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Unload a namespace from the current serving broker.
    
    Specified by:
    
    unload in interface Namespaces
    
    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
```
public String getReplicationConfigVersion(String namespace)
                                   throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Get the replication configuration version for a given namespace
    
    Specified by:
    
    getReplicationConfigVersion in interface Namespaces
    
    Returns:
    
    Replication configuration version
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - unloadNamespaceBundle
```
public void unloadNamespaceBundle(String namespace,
                                  String bundle)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Unload namespace bundle
    
    Specified by:
    
    unloadNamespaceBundle in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - splitNamespaceBundle
```
public void splitNamespaceBundle(String namespace,
                                 String bundle,
                                 boolean unloadSplitBundles)
                          throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Split namespace bundle
    
    Specified by:
    
    splitNamespaceBundle in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - setDispatchRate
```
public void setDispatchRate(String namespace,
                            DispatchRate dispatchRate)
                     throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second)
    
    Specified by:
    
    setDispatchRate in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - getDispatchRate
```
public DispatchRate getDispatchRate(String namespace)
                             throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second)
    
    Specified by:
    
    getDispatchRate in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - setSubscriptionDispatchRate
```
public void setSubscriptionDispatchRate(String namespace,
                                        DispatchRate dispatchRate)
                                 throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Set subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)
    
    Specified by:
    
    setSubscriptionDispatchRate in interface Namespaces
    
    dispatchRate - number of messages per second
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - getSubscriptionDispatchRate
```
public DispatchRate getSubscriptionDispatchRate(String namespace)
                                         throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Get subscription-message-dispatch-rate (subscriptions under this namespace can dispatch this many messages per second)
    
    Specified by:
    
    getSubscriptionDispatchRate in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - clearNamespaceBacklog
```
public void clearNamespaceBacklog(String namespace)
                           throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Clear backlog for all topics on a namespace
    
    Specified by:
    
    clearNamespaceBacklog in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - clearNamespaceBacklogForSubscription
```
public void clearNamespaceBacklogForSubscription(String namespace,
                                                 String subscription)
                                          throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Clear backlog for a given subscription on all topics on a namespace
    
    Specified by:
    
    clearNamespaceBacklogForSubscription in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - clearNamespaceBundleBacklog
```
public void clearNamespaceBundleBacklog(String namespace,
                                        String bundle)
                                 throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Clear backlog for all topics on a namespace bundle
    
    Specified by:
    
    clearNamespaceBundleBacklog in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - clearNamespaceBundleBacklogForSubscription
```
public void clearNamespaceBundleBacklogForSubscription(String namespace,
                                                       String bundle,
                                                       String subscription)
                                                throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Clear backlog for a given subscription on all topics on a namespace bundle
    
    Specified by:
    
    clearNamespaceBundleBacklogForSubscription in interface Namespaces
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - unsubscribeNamespace
```
public void unsubscribeNamespace(String namespace,
                                 String subscription)
                          throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Unsubscribes the given subscription on all topics on a namespace
    
    Specified by:
    
    unsubscribeNamespace in interface Namespaces
    
    Throws:
    
    PulsarAdminException
  - unsubscribeNamespaceBundle
```
public void unsubscribeNamespaceBundle(String namespace,
                                       String bundle,
                                       String subscription)
                                throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Unsubscribes the given subscription on all topics on a namespace bundle
    
    Specified by:
    
    unsubscribeNamespaceBundle in interface Namespaces
    
    Throws:
    
    PulsarAdminException
  - setSubscriptionAuthMode
```
public void setSubscriptionAuthMode(String namespace,
                                    SubscriptionAuthMode subscriptionAuthMode)
                             throws PulsarAdminException
```
    Description copied from interface: Namespaces
    
    Set the given subscription auth mode on all topics on a namespace
    
    Specified by:
    
    setSubscriptionAuthMode in interface Namespaces
    
    Throws:
    
    PulsarAdminException
  - setEncryptionRequiredStatus
```
public void setEncryptionRequiredStatus(String namespace,
                                        boolean encryptionRequired)
                                 throws PulsarAdminException
```
    Description copied from interface: Namespaces
    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
 
```
    Specified by:
    
    setEncryptionRequiredStatus in interface Namespaces
    
    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
  - getMaxProducersPerTopic
```
public int getMaxProducersPerTopic(String namespace)
                            throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get the maxProducersPerTopic for a namespace.
    Response example:
```
 0
 
```
    Specified by:
    
    getMaxProducersPerTopic in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setMaxProducersPerTopic
```
public void setMaxProducersPerTopic(String namespace,
                                    int maxProducersPerTopic)
                             throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Set maxProducersPerTopic for a namespace.
    Request example:
```
 10
 
```
    Specified by:
    
    setMaxProducersPerTopic in interface Namespaces
    
    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
```
public int getMaxConsumersPerTopic(String namespace)
                            throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get the maxProducersPerTopic for a namespace.
    Response example:
```
 0
 
```
    Specified by:
    
    getMaxConsumersPerTopic in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setMaxConsumersPerTopic
```
public void setMaxConsumersPerTopic(String namespace,
                                    int maxConsumersPerTopic)
                             throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Set maxConsumersPerTopic for a namespace.
    Request example:
```
 10
 
```
    Specified by:
    
    setMaxConsumersPerTopic in interface Namespaces
    
    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
```
public int getMaxConsumersPerSubscription(String namespace)
                                   throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Get the maxConsumersPerSubscription for a namespace.
    Response example:
```
 0
 
```
    Specified by:
    
    getMaxConsumersPerSubscription in interface Namespaces
    
    Parameters:
    
    namespace - Namespace name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - setMaxConsumersPerSubscription
```
public void setMaxConsumersPerSubscription(String namespace,
                                           int maxConsumersPerSubscription)
                                    throws PulsarAdminException
```
    Description copied from interface: Namespaces
    Set maxConsumersPerSubscription for a namespace.
    Request example:
```
 10
 
```
    Specified by:
    
    setMaxConsumersPerSubscription in interface Namespaces
    
    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

Class NamespacesImpl

Constructor Summary

Method Summary

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

Methods inherited from class java.lang.Object

Constructor Detail

NamespacesImpl

Method Detail

getNamespaces

getNamespaces

getTopics

getPolicies

createNamespace

createNamespace

createNamespace

createNamespace

createNamespace

deleteNamespace

deleteNamespaceBundle

getPermissions

grantPermissionOnNamespace

revokePermissionsOnNamespace

getNamespaceReplicationClusters

setNamespaceReplicationClusters

getNamespaceMessageTTL

setNamespaceMessageTTL

setNamespaceAntiAffinityGroup

getNamespaceAntiAffinityGroup

getAntiAffinityNamespaces

deleteNamespaceAntiAffinityGroup

setDeduplicationStatus

getBacklogQuotaMap

setBacklogQuota

removeBacklogQuota

setPersistence

getPersistence

setRetention

getRetention

unload

getReplicationConfigVersion

unloadNamespaceBundle

splitNamespaceBundle

setDispatchRate

getDispatchRate

setSubscriptionDispatchRate

getSubscriptionDispatchRate

clearNamespaceBacklog

clearNamespaceBacklogForSubscription

clearNamespaceBundleBacklog

clearNamespaceBundleBacklogForSubscription

unsubscribeNamespace

unsubscribeNamespaceBundle

setSubscriptionAuthMode

setEncryptionRequiredStatus

getMaxProducersPerTopic

setMaxProducersPerTopic

getMaxConsumersPerTopic

setMaxConsumersPerTopic

getMaxConsumersPerSubscription

setMaxConsumersPerSubscription