public interface Namespaces
| Modifier and Type | Method and Description |
|---|---|
void |
clearNamespaceBacklog(String namespace)
Clear backlog for all topics on a namespace.
|
CompletableFuture<Void> |
clearNamespaceBacklogAsync(String namespace)
Clear backlog for all topics on a namespace asynchronously.
|
void |
clearNamespaceBacklogForSubscription(String namespace,
String subscription)
Clear backlog for a given subscription on all topics on a namespace.
|
CompletableFuture<Void> |
clearNamespaceBacklogForSubscriptionAsync(String namespace,
String subscription)
Clear backlog for a given subscription on all topics on a namespace asynchronously.
|
void |
clearNamespaceBundleBacklog(String namespace,
String bundle)
Clear backlog for all topics on a namespace bundle.
|
CompletableFuture<Void> |
clearNamespaceBundleBacklogAsync(String namespace,
String bundle)
Clear backlog for all topics on a namespace bundle asynchronously.
|
void |
clearNamespaceBundleBacklogForSubscription(String namespace,
String bundle,
String subscription)
Clear backlog for a given subscription on all topics on a namespace bundle.
|
CompletableFuture<Void> |
clearNamespaceBundleBacklogForSubscriptionAsync(String namespace,
String bundle,
String subscription)
Clear backlog for a given subscription on all topics on a namespace bundle asynchronously.
|
void |
clearOffloadDeleteLag(String namespace)
Clear the offload deletion lag for a namespace.
|
CompletableFuture<Void> |
clearOffloadDeleteLagAsync(String namespace)
Clear the offload deletion lag for a namespace asynchronously.
|
void |
createNamespace(String namespace)
Create a new namespace.
|
void |
createNamespace(String namespace,
org.apache.pulsar.common.policies.data.BundlesData bundlesData)
Create a new namespace.
|
void |
createNamespace(String namespace,
int numBundles)
Create a new namespace.
|
void |
createNamespace(String namespace,
org.apache.pulsar.common.policies.data.Policies policies)
Create a new namespace.
|
void |
createNamespace(String namespace,
Set<String> clusters)
Create a new namespace.
|
CompletableFuture<Void> |
createNamespaceAsync(String namespace)
Create a new namespace asynchronously.
|
CompletableFuture<Void> |
createNamespaceAsync(String namespace,
org.apache.pulsar.common.policies.data.BundlesData bundlesData)
Create a new namespace asynchronously.
|
CompletableFuture<Void> |
createNamespaceAsync(String namespace,
int numBundles)
Create a new namespace.
|
CompletableFuture<Void> |
createNamespaceAsync(String namespace,
org.apache.pulsar.common.policies.data.Policies policies)
Create a new namespace asynchronously.
|
CompletableFuture<Void> |
createNamespaceAsync(String namespace,
Set<String> clusters)
Create a new namespace asynchronously.
|
void |
deleteBookieAffinityGroup(String namespace)
Delete bookie affinity group configured for a namespace.
|
CompletableFuture<Void> |
deleteBookieAffinityGroupAsync(String namespace)
Delete bookie affinity group configured for a namespace asynchronously.
|
void |
deleteNamespace(String namespace)
Delete an existing namespace.
|
void |
deleteNamespace(String namespace,
boolean force)
Delete an existing namespace.
|
void |
deleteNamespaceAntiAffinityGroup(String namespace)
Delete anti-affinity group name for a namespace.
|
CompletableFuture<Void> |
deleteNamespaceAntiAffinityGroupAsync(String namespace)
Delete anti-affinity group name for a namespace.
|
CompletableFuture<Void> |
deleteNamespaceAsync(String namespace)
Delete an existing namespace asynchronously.
|
CompletableFuture<Void> |
deleteNamespaceAsync(String namespace,
boolean force)
Delete an existing namespace asynchronously.
|
void |
deleteNamespaceBundle(String namespace,
String bundleRange)
Delete an existing bundle in a namespace.
|
void |
deleteNamespaceBundle(String namespace,
String bundleRange,
boolean force)
Delete an existing bundle in a namespace.
|
CompletableFuture<Void> |
deleteNamespaceBundleAsync(String namespace,
String bundleRange)
Delete an existing bundle in a namespace asynchronously.
|
CompletableFuture<Void> |
deleteNamespaceBundleAsync(String namespace,
String bundleRange,
boolean force)
Delete an existing bundle in a namespace asynchronously.
|
List<String> |
getAntiAffinityNamespaces(String tenant,
String cluster,
String namespaceAntiAffinityGroup)
Get all namespaces that grouped with given anti-affinity group.
|
CompletableFuture<List<String>> |
getAntiAffinityNamespacesAsync(String tenant,
String cluster,
String namespaceAntiAffinityGroup)
Get all namespaces that grouped with given anti-affinity group asynchronously.
|
Map<org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType,org.apache.pulsar.common.policies.data.BacklogQuota> |
getBacklogQuotaMap(String namespace)
Get backlog quota map on a namespace.
|
CompletableFuture<Map<org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType,org.apache.pulsar.common.policies.data.BacklogQuota>> |
getBacklogQuotaMapAsync(String namespace)
Get backlog quota map on a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.BookieAffinityGroupData |
getBookieAffinityGroup(String namespace)
Get bookie affinity group configured for a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.BookieAffinityGroupData> |
getBookieAffinityGroupAsync(String namespace)
Get bookie affinity group configured for a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.BundlesData |
getBundles(String namespace)
Get the list of bundles.
|
CompletableFuture<org.apache.pulsar.common.policies.data.BundlesData> |
getBundlesAsync(String namespace)
Get the list of bundles asynchronously.
|
long |
getCompactionThreshold(String namespace)
Get the compactionThreshold for a namespace.
|
CompletableFuture<Long> |
getCompactionThresholdAsync(String namespace)
Get the compactionThreshold for a namespace asynchronously.
|
Integer |
getDeduplicationSnapshotInterval(String namespace)
Get the deduplicationSnapshotInterval for a namespace.
|
CompletableFuture<Integer> |
getDeduplicationSnapshotIntervalAsync(String namespace)
Get the deduplicationSnapshotInterval for a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies |
getDelayedDelivery(String namespace)
Get the delayed delivery messages for all topics within a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies> |
getDelayedDeliveryAsync(String namespace)
Get the delayed delivery messages for all topics within a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.DispatchRate |
getDispatchRate(String namespace)
Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
|
CompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> |
getDispatchRateAsync(String namespace)
Get message-dispatch-rate asynchronously.
|
org.apache.pulsar.common.policies.data.InactiveTopicPolicies |
getInactiveTopicPolicies(String namespace)
Get the inactive deletion strategy for all topics within a namespace synchronously.
|
CompletableFuture<org.apache.pulsar.common.policies.data.InactiveTopicPolicies> |
getInactiveTopicPoliciesAsync(String namespace)
Get the inactive deletion strategy for all topics within a namespace asynchronously.
|
boolean |
getIsAllowAutoUpdateSchema(String namespace)
Get whether allow auto update schema.
|
CompletableFuture<Boolean> |
getIsAllowAutoUpdateSchemaAsync(String namespace)
Get whether allow auto update schema asynchronously.
|
int |
getMaxConsumersPerSubscription(String namespace)
Get the maxConsumersPerSubscription for a namespace.
|
CompletableFuture<Integer> |
getMaxConsumersPerSubscriptionAsync(String namespace)
Get the maxConsumersPerSubscription for a namespace asynchronously.
|
int |
getMaxConsumersPerTopic(String namespace)
Get the maxProducersPerTopic for a namespace.
|
CompletableFuture<Integer> |
getMaxConsumersPerTopicAsync(String namespace)
Get the maxProducersPerTopic for a namespace asynchronously.
|
Integer |
getMaxProducersPerTopic(String namespace)
Get the maxProducersPerTopic for a namespace.
|
CompletableFuture<Integer> |
getMaxProducersPerTopicAsync(String namespace)
Get the maxProducersPerTopic for a namespace asynchronously.
|
Integer |
getMaxSubscriptionsPerTopic(String namespace)
Get the maxSubscriptionsPerTopic for a namespace.
|
CompletableFuture<Integer> |
getMaxSubscriptionsPerTopicAsync(String namespace)
Get the maxSubscriptionsPerTopic for a namespace asynchronously.
|
int |
getMaxUnackedMessagesPerConsumer(String namespace)
Get the maxUnackedMessagesPerConsumer for a namespace.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesPerConsumerAsync(String namespace)
Get the maxUnackedMessagesPerConsumer for a namespace asynchronously.
|
int |
getMaxUnackedMessagesPerSubscription(String namespace)
Get the maxUnackedMessagesPerSubscription for a namespace.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesPerSubscriptionAsync(String namespace)
Get the maxUnackedMessagesPerSubscription for a namespace asynchronously.
|
String |
getNamespaceAntiAffinityGroup(String namespace)
Get anti-affinity group name for a namespace.
|
CompletableFuture<String> |
getNamespaceAntiAffinityGroupAsync(String namespace)
Get anti-affinity group name for a namespace asynchronously.
|
int |
getNamespaceMessageTTL(String namespace)
Get the message TTL for a namespace.
|
CompletableFuture<Integer> |
getNamespaceMessageTTLAsync(String namespace)
Get the message TTL for a namespace asynchronously.
|
List<String> |
getNamespaceReplicationClusters(String namespace)
Get the replication clusters for a namespace.
|
CompletableFuture<List<String>> |
getNamespaceReplicationClustersAsync(String namespace)
Get the replication clusters for a namespace asynchronously.
|
List<String> |
getNamespaces(String tenant)
Get the list of namespaces.
|
List<String> |
getNamespaces(String tenant,
String cluster)
Deprecated.
|
CompletableFuture<List<String>> |
getNamespacesAsync(String tenant)
Get the list of namespaces asynchronously.
|
Long |
getOffloadDeleteLagMs(String namespace)
Get the offload deletion lag for a namespace, in milliseconds.
|
CompletableFuture<Long> |
getOffloadDeleteLagMsAsync(String namespace)
Get the offload deletion lag asynchronously for a namespace, in milliseconds.
|
org.apache.pulsar.common.policies.data.OffloadPolicies |
getOffloadPolicies(String namespace)
Get the offload configuration for a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.OffloadPolicies> |
getOffloadPoliciesAsync(String namespace)
Get the offload configuration for a namespace asynchronously.
|
long |
getOffloadThreshold(String namespace)
Get the offloadThreshold for a namespace.
|
CompletableFuture<Long> |
getOffloadThresholdAsync(String namespace)
Get the offloadThreshold for a namespace asynchronously.
|
Map<String,Set<org.apache.pulsar.common.policies.data.AuthAction>> |
getPermissions(String namespace)
Get permissions on a namespace.
|
CompletableFuture<Map<String,Set<org.apache.pulsar.common.policies.data.AuthAction>>> |
getPermissionsAsync(String namespace)
Get permissions on a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.PersistencePolicies |
getPersistence(String namespace)
Get the persistence configuration for a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.PersistencePolicies> |
getPersistenceAsync(String namespace)
Get the persistence configuration for a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.Policies |
getPolicies(String namespace)
Get policies for a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.Policies> |
getPoliciesAsync(String namespace)
Get policies for a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.PublishRate |
getPublishRate(String namespace)
Get message-publish-rate (topics under this namespace can publish this many messages per second).
|
CompletableFuture<org.apache.pulsar.common.policies.data.PublishRate> |
getPublishRateAsync(String namespace)
Get message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
|
String |
getReplicationConfigVersion(String namespace)
Get the replication configuration version for a given namespace.
|
CompletableFuture<String> |
getReplicationConfigVersionAsync(String namespace)
Get the replication configuration version for a given namespace asynchronously.
|
org.apache.pulsar.common.policies.data.DispatchRate |
getReplicatorDispatchRate(String namespace)
Get replicator-message-dispatch-rate.
|
CompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> |
getReplicatorDispatchRateAsync(String namespace)
Get replicator-message-dispatch-rate asynchronously.
|
org.apache.pulsar.common.policies.data.RetentionPolicies |
getRetention(String namespace)
Get the retention configuration for a namespace.
|
CompletableFuture<org.apache.pulsar.common.policies.data.RetentionPolicies> |
getRetentionAsync(String namespace)
Get the retention configuration for a namespace asynchronously.
|
org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy |
getSchemaAutoUpdateCompatibilityStrategy(String namespace)
Deprecated.
|
org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy |
getSchemaCompatibilityStrategy(String namespace)
Get the strategy used to check the a new schema provided by a producer is compatible with the current schema
before it is installed.
|
CompletableFuture<org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy> |
getSchemaCompatibilityStrategyAsync(String namespace)
Get the strategy used to check the a new schema provided by a producer is compatible with the current schema
before it is installed asynchronously.
|
boolean |
getSchemaValidationEnforced(String namespace)
Get schema validation enforced for namespace.
|
CompletableFuture<Boolean> |
getSchemaValidationEnforcedAsync(String namespace)
Get schema validation enforced for namespace asynchronously.
|
org.apache.pulsar.common.policies.data.SubscribeRate |
getSubscribeRate(String namespace)
Get namespace-subscribe-rate (topics under this namespace allow subscribe times per consumer in a period).
|
CompletableFuture<org.apache.pulsar.common.policies.data.SubscribeRate> |
getSubscribeRateAsync(String namespace)
Get namespace-subscribe-rate asynchronously.
|
org.apache.pulsar.common.policies.data.DispatchRate |
getSubscriptionDispatchRate(String namespace)
Get subscription-message-dispatch-rate.
|
CompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> |
getSubscriptionDispatchRateAsync(String namespace)
Get subscription-message-dispatch-rate asynchronously.
|
int |
getSubscriptionExpirationTime(String namespace)
Get the subscription expiration time for a namespace.
|
CompletableFuture<Integer> |
getSubscriptionExpirationTimeAsync(String namespace)
Get the subscription expiration time for a namespace asynchronously.
|
List<String> |
getTopics(String namespace)
Get the list of topics.
|
CompletableFuture<List<String>> |
getTopicsAsync(String namespace)
Get the list of topics asynchronously.
|
void |
grantPermissionOnNamespace(String namespace,
String role,
Set<org.apache.pulsar.common.policies.data.AuthAction> actions)
Grant permission on a namespace.
|
CompletableFuture<Void> |
grantPermissionOnNamespaceAsync(String namespace,
String role,
Set<org.apache.pulsar.common.policies.data.AuthAction> actions)
Grant permission on a namespace asynchronously.
|
void |
grantPermissionOnSubscription(String namespace,
String subscription,
Set<String> roles)
Grant permission to role to access subscription's admin-api.
|
CompletableFuture<Void> |
grantPermissionOnSubscriptionAsync(String namespace,
String subscription,
Set<String> roles)
Grant permission to role to access subscription's admin-api asynchronously.
|
void |
removeAutoSubscriptionCreation(String namespace)
Removes the autoSubscriptionCreation policy for a given namespace.
|
CompletableFuture<Void> |
removeAutoSubscriptionCreationAsync(String namespace)
Removes the autoSubscriptionCreation policy for a given namespace asynchronously.
|
void |
removeAutoTopicCreation(String namespace)
Removes the autoTopicCreation policy for a given namespace.
|
CompletableFuture<Void> |
removeAutoTopicCreationAsync(String namespace)
Removes the autoTopicCreation policy for a given namespace asynchronously.
|
void |
removeBacklogQuota(String namespace)
Remove a backlog quota policy from a namespace.
|
CompletableFuture<Void> |
removeBacklogQuotaAsync(String namespace)
Remove a backlog quota policy from a namespace asynchronously.
|
void |
removeDeduplicationSnapshotInterval(String namespace)
Remove the deduplicationSnapshotInterval for a namespace.
|
CompletableFuture<Void> |
removeDeduplicationSnapshotIntervalAsync(String namespace)
Remove the deduplicationSnapshotInterval for a namespace asynchronously.
|
void |
removeInactiveTopicPolicies(String namespace)
Remove inactive topic policies from a namespace.
|
CompletableFuture<Void> |
removeInactiveTopicPoliciesAsync(String namespace)
remove InactiveTopicPolicies from a namespace asynchronously.
|
void |
removeMaxProducersPerTopic(String namespace)
Remove maxProducersPerTopic for a namespace.
|
CompletableFuture<Void> |
removeMaxProducersPerTopicAsync(String namespace)
Set maxProducersPerTopic for a namespace asynchronously.
|
void |
removeMaxSubscriptionsPerTopic(String namespace)
Remove the maxSubscriptionsPerTopic for a namespace.
|
CompletableFuture<Void> |
removeMaxSubscriptionsPerTopicAsync(String namespace)
Remove the maxSubscriptionsPerTopic for a namespace asynchronously.
|
void |
removeNamespaceMessageTTL(String namespace)
Remove the messages Time to Live for all the topics within a namespace.
|
CompletableFuture<Void> |
removeNamespaceMessageTTLAsync(String namespace)
Remove the messages Time to Live for all the topics within a namespace asynchronously.
|
void |
removeOffloadPolicies(String namespace)
Remove the offload configuration for a namespace.
|
CompletableFuture<Void> |
removeOffloadPoliciesAsync(String namespace)
Remove the offload configuration for a namespace asynchronously.
|
void |
removePublishRate(String namespace)
Remove message-publish-rate (topics under this namespace can publish this many messages per second).
|
CompletableFuture<Void> |
removePublishRateAsync(String namespace)
Remove message-publish-rate asynchronously.
|
void |
revokePermissionOnSubscription(String namespace,
String subscription,
String role)
Revoke permissions on a subscription's admin-api access.
|
CompletableFuture<Void> |
revokePermissionOnSubscriptionAsync(String namespace,
String subscription,
String role)
Revoke permissions on a subscription's admin-api access asynchronously.
|
void |
revokePermissionsOnNamespace(String namespace,
String role)
Revoke permissions on a namespace.
|
CompletableFuture<Void> |
revokePermissionsOnNamespaceAsync(String namespace,
String role)
Revoke permissions on a namespace asynchronously.
|
void |
setAutoSubscriptionCreation(String namespace,
org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings.
|
CompletableFuture<Void> |
setAutoSubscriptionCreationAsync(String namespace,
org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings asynchronously.
|
void |
setAutoTopicCreation(String namespace,
org.apache.pulsar.common.policies.data.AutoTopicCreationOverride autoTopicCreationOverride)
Sets the autoTopicCreation policy for a given namespace, overriding broker settings.
|
CompletableFuture<Void> |
setAutoTopicCreationAsync(String namespace,
org.apache.pulsar.common.policies.data.AutoTopicCreationOverride autoTopicCreationOverride)
Sets the autoTopicCreation policy for a given namespace, overriding broker settings asynchronously.
|
void |
setBacklogQuota(String namespace,
org.apache.pulsar.common.policies.data.BacklogQuota backlogQuota)
Set a backlog quota for all the topics on a namespace.
|
CompletableFuture<Void> |
setBacklogQuotaAsync(String namespace,
org.apache.pulsar.common.policies.data.BacklogQuota backlogQuota)
Set a backlog quota for all the topics on a namespace asynchronously.
|
void |
setBookieAffinityGroup(String namespace,
org.apache.pulsar.common.policies.data.BookieAffinityGroupData bookieAffinityGroup)
Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity
group.
|
CompletableFuture<Void> |
setBookieAffinityGroupAsync(String namespace,
org.apache.pulsar.common.policies.data.BookieAffinityGroupData bookieAffinityGroup)
Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity
group asynchronously.
|
void |
setCompactionThreshold(String namespace,
long compactionThreshold)
Set the compactionThreshold for a namespace.
|
CompletableFuture<Void> |
setCompactionThresholdAsync(String namespace,
long compactionThreshold)
Set the compactionThreshold for a namespace asynchronously.
|
void |
setDeduplicationSnapshotInterval(String namespace,
Integer interval)
Set the deduplicationSnapshotInterval for a namespace.
|
CompletableFuture<Void> |
setDeduplicationSnapshotIntervalAsync(String namespace,
Integer interval)
Set the deduplicationSnapshotInterval for a namespace asynchronously.
|
void |
setDeduplicationStatus(String namespace,
boolean enableDeduplication)
Set the deduplication status for all topics within a namespace.
|
CompletableFuture<Void> |
setDeduplicationStatusAsync(String namespace,
boolean enableDeduplication)
Set the deduplication status for all topics within a namespace asynchronously.
|
void |
setDelayedDeliveryMessages(String namespace,
org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies delayedDeliveryPolicies)
Set the delayed delivery messages for all topics within a namespace.
|
CompletableFuture<Void> |
setDelayedDeliveryMessagesAsync(String namespace,
org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies delayedDeliveryPolicies)
Set the delayed delivery messages for all topics within a namespace asynchronously.
|
void |
setDispatchRate(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
|
CompletableFuture<Void> |
setDispatchRateAsync(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set message-dispatch-rate asynchronously.
|
void |
setEncryptionRequiredStatus(String namespace,
boolean encryptionRequired)
Set the encryption required status for all topics within a namespace.
|
CompletableFuture<Void> |
setEncryptionRequiredStatusAsync(String namespace,
boolean encryptionRequired)
Set the encryption required status for all topics within a namespace asynchronously.
|
void |
setInactiveTopicPolicies(String namespace,
org.apache.pulsar.common.policies.data.InactiveTopicPolicies inactiveTopicPolicies)
As same as setInactiveTopicPoliciesAsync,but it is synchronous.
|
CompletableFuture<Void> |
setInactiveTopicPoliciesAsync(String namespace,
org.apache.pulsar.common.policies.data.InactiveTopicPolicies inactiveTopicPolicies)
You can set the inactive deletion strategy at the namespace level.
|
void |
setIsAllowAutoUpdateSchema(String namespace,
boolean isAllowAutoUpdateSchema)
Set whether to allow automatic schema updates.
|
CompletableFuture<Void> |
setIsAllowAutoUpdateSchemaAsync(String namespace,
boolean isAllowAutoUpdateSchema)
Set whether to allow automatic schema updates asynchronously.
|
void |
setMaxConsumersPerSubscription(String namespace,
int maxConsumersPerSubscription)
Set maxConsumersPerSubscription for a namespace.
|
CompletableFuture<Void> |
setMaxConsumersPerSubscriptionAsync(String namespace,
int maxConsumersPerSubscription)
Set maxConsumersPerSubscription for a namespace asynchronously.
|
void |
setMaxConsumersPerTopic(String namespace,
int maxConsumersPerTopic)
Set maxConsumersPerTopic for a namespace.
|
CompletableFuture<Void> |
setMaxConsumersPerTopicAsync(String namespace,
int maxConsumersPerTopic)
Set maxConsumersPerTopic for a namespace asynchronously.
|
void |
setMaxProducersPerTopic(String namespace,
int maxProducersPerTopic)
Set maxProducersPerTopic for a namespace.
|
CompletableFuture<Void> |
setMaxProducersPerTopicAsync(String namespace,
int maxProducersPerTopic)
Set maxProducersPerTopic for a namespace asynchronously.
|
void |
setMaxSubscriptionsPerTopic(String namespace,
int maxSubscriptionsPerTopic)
Set the maxSubscriptionsPerTopic for a namespace.
|
CompletableFuture<Void> |
setMaxSubscriptionsPerTopicAsync(String namespace,
int maxSubscriptionsPerTopic)
Set the maxSubscriptionsPerTopic for a namespace asynchronously.
|
void |
setMaxUnackedMessagesPerConsumer(String namespace,
int maxUnackedMessagesPerConsumer)
Set maxUnackedMessagesPerConsumer for a namespace.
|
CompletableFuture<Void> |
setMaxUnackedMessagesPerConsumerAsync(String namespace,
int maxUnackedMessagesPerConsumer)
Set maxUnackedMessagesPerConsumer for a namespace asynchronously.
|
void |
setMaxUnackedMessagesPerSubscription(String namespace,
int maxUnackedMessagesPerSubscription)
Set maxUnackedMessagesPerSubscription for a namespace.
|
CompletableFuture<Void> |
setMaxUnackedMessagesPerSubscriptionAsync(String namespace,
int maxUnackedMessagesPerSubscription)
Set maxUnackedMessagesPerSubscription for a namespace asynchronously.
|
void |
setNamespaceAntiAffinityGroup(String namespace,
String namespaceAntiAffinityGroup)
Set anti-affinity group name for a namespace.
|
CompletableFuture<Void> |
setNamespaceAntiAffinityGroupAsync(String namespace,
String namespaceAntiAffinityGroup)
Set anti-affinity group name for a namespace asynchronously.
|
void |
setNamespaceMessageTTL(String namespace,
int ttlInSeconds)
Set the messages Time to Live for all the topics within a namespace.
|
CompletableFuture<Void> |
setNamespaceMessageTTLAsync(String namespace,
int ttlInSeconds)
Set the messages Time to Live for all the topics within a namespace asynchronously.
|
void |
setNamespaceReplicationClusters(String namespace,
Set<String> clusterIds)
Set the replication clusters for a namespace.
|
CompletableFuture<Void> |
setNamespaceReplicationClustersAsync(String namespace,
Set<String> clusterIds)
Set the replication clusters for a namespace asynchronously.
|
void |
setOffloadDeleteLag(String namespace,
long lag,
TimeUnit unit)
Set the offload deletion lag for a namespace.
|
CompletableFuture<Void> |
setOffloadDeleteLagAsync(String namespace,
long lag,
TimeUnit unit)
Set the offload deletion lag for a namespace asynchronously.
|
void |
setOffloadPolicies(String namespace,
org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
Set the offload configuration for all the topics in a namespace.
|
CompletableFuture<Void> |
setOffloadPoliciesAsync(String namespace,
org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
Set the offload configuration for all the topics in a namespace asynchronously.
|
void |
setOffloadThreshold(String namespace,
long offloadThreshold)
Set the offloadThreshold for a namespace.
|
CompletableFuture<Void> |
setOffloadThresholdAsync(String namespace,
long offloadThreshold)
Set the offloadThreshold for a namespace asynchronously.
|
void |
setPersistence(String namespace,
org.apache.pulsar.common.policies.data.PersistencePolicies persistence)
Set the persistence configuration for all the topics on a namespace.
|
CompletableFuture<Void> |
setPersistenceAsync(String namespace,
org.apache.pulsar.common.policies.data.PersistencePolicies persistence)
Set the persistence configuration for all the topics on a namespace asynchronously.
|
void |
setPublishRate(String namespace,
org.apache.pulsar.common.policies.data.PublishRate publishMsgRate)
Set message-publish-rate (topics under this namespace can publish this many messages per second).
|
CompletableFuture<Void> |
setPublishRateAsync(String namespace,
org.apache.pulsar.common.policies.data.PublishRate publishMsgRate)
Set message-publish-rate (topics under this namespace can publish this many messages per second) asynchronously.
|
void |
setReplicatorDispatchRate(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set replicator-message-dispatch-rate.
|
CompletableFuture<Void> |
setReplicatorDispatchRateAsync(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set replicator-message-dispatch-rate asynchronously.
|
void |
setRetention(String namespace,
org.apache.pulsar.common.policies.data.RetentionPolicies retention)
Set the retention configuration for all the topics on a namespace.
|
CompletableFuture<Void> |
setRetentionAsync(String namespace,
org.apache.pulsar.common.policies.data.RetentionPolicies retention)
Set the retention configuration for all the topics on a namespace asynchronously.
|
void |
setSchemaAutoUpdateCompatibilityStrategy(String namespace,
org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy strategy)
Deprecated.
|
void |
setSchemaCompatibilityStrategy(String namespace,
org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy strategy)
Set the strategy used to check the a new schema provided by a producer is compatible with the current schema
before it is installed.
|
CompletableFuture<Void> |
setSchemaCompatibilityStrategyAsync(String namespace,
org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy strategy)
Set the strategy used to check the a new schema provided by a producer is compatible with the current schema
before it is installed asynchronously.
|
void |
setSchemaValidationEnforced(String namespace,
boolean schemaValidationEnforced)
Set schema validation enforced for namespace.
|
CompletableFuture<Void> |
setSchemaValidationEnforcedAsync(String namespace,
boolean schemaValidationEnforced)
Set schema validation enforced for namespace asynchronously.
|
void |
setSubscribeRate(String namespace,
org.apache.pulsar.common.policies.data.SubscribeRate subscribeRate)
Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
|
CompletableFuture<Void> |
setSubscribeRateAsync(String namespace,
org.apache.pulsar.common.policies.data.SubscribeRate subscribeRate)
Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate) asynchronously.
|
void |
setSubscriptionAuthMode(String namespace,
org.apache.pulsar.common.policies.data.SubscriptionAuthMode subscriptionAuthMode)
Set the given subscription auth mode on all topics on a namespace.
|
CompletableFuture<Void> |
setSubscriptionAuthModeAsync(String namespace,
org.apache.pulsar.common.policies.data.SubscriptionAuthMode subscriptionAuthMode)
Set the given subscription auth mode on all topics on a namespace asynchronously.
|
void |
setSubscriptionDispatchRate(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set subscription-message-dispatch-rate.
|
CompletableFuture<Void> |
setSubscriptionDispatchRateAsync(String namespace,
org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
Set subscription-message-dispatch-rate asynchronously.
|
void |
setSubscriptionExpirationTime(String namespace,
int expirationTime)
Set the subscription expiration time in minutes for all the topics within a namespace.
|
CompletableFuture<Void> |
setSubscriptionExpirationTimeAsync(String namespace,
int expirationTime)
Set the subscription expiration time in minutes for all the topics within a namespace asynchronously.
|
void |
splitNamespaceBundle(String namespace,
String bundle,
boolean unloadSplitBundles,
String splitAlgorithmName)
Split namespace bundle.
|
CompletableFuture<Void> |
splitNamespaceBundleAsync(String namespace,
String bundle,
boolean unloadSplitBundles,
String splitAlgorithmName)
Split namespace bundle asynchronously.
|
void |
unload(String namespace)
Unload a namespace from the current serving broker.
|
CompletableFuture<Void> |
unloadAsync(String namespace)
Unload a namespace from the current serving broker asynchronously.
|
void |
unloadNamespaceBundle(String namespace,
String bundle)
Unload namespace bundle.
|
CompletableFuture<Void> |
unloadNamespaceBundleAsync(String namespace,
String bundle)
Unload namespace bundle asynchronously.
|
void |
unsubscribeNamespace(String namespace,
String subscription)
Unsubscribe the given subscription on all topics on a namespace.
|
CompletableFuture<Void> |
unsubscribeNamespaceAsync(String namespace,
String subscription)
Unsubscribe the given subscription on all topics on a namespace asynchronously.
|
void |
unsubscribeNamespaceBundle(String namespace,
String bundle,
String subscription)
Unsubscribe the given subscription on all topics on a namespace bundle.
|
CompletableFuture<Void> |
unsubscribeNamespaceBundleAsync(String namespace,
String bundle,
String subscription)
Unsubscribe the given subscription on all topics on a namespace bundle asynchronously.
|
List<String> getNamespaces(String tenant) throws PulsarAdminException
["my-tenant/c1/namespace1",
"my-tenant/global/namespace2",
"my-tenant/c2/namespace3"]
tenant - Tenant namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant does not existPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getNamespacesAsync(String tenant)
["my-tenant/c1/namespace1",
"my-tenant/global/namespace2",
"my-tenant/c2/namespace3"]
tenant - Tenant name@Deprecated List<String> getNamespaces(String tenant, String cluster) throws PulsarAdminException
["my-tenant/use/namespace1", "my-tenant/use/namespace2"]
tenant - Tenant namecluster - Cluster namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException - Unexpected errorList<String> getTopics(String namespace) throws PulsarAdminException
["persistent://my-tenant/use/namespace1/my-topic-1",
"persistent://my-tenant/use/namespace1/my-topic-2"]
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getTopicsAsync(String namespace)
["persistent://my-tenant/use/namespace1/my-topic-1",
"persistent://my-tenant/use/namespace1/my-topic-2"]
namespace - Namespace nameorg.apache.pulsar.common.policies.data.BundlesData getBundles(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.BundlesData> getBundlesAsync(String namespace)
namespace - Namespace nameorg.apache.pulsar.common.policies.data.Policies getPolicies(String namespace) throws PulsarAdminException
{
"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
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorPoliciesCompletableFuture<org.apache.pulsar.common.policies.data.Policies> getPoliciesAsync(String namespace)
{
"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
}
namespace - Namespace namePoliciesvoid createNamespace(String namespace, int numBundles) throws PulsarAdminException
namespace - Namespace namenumBundles - Number of bundlesPulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException.ConflictException - Namespace already existsPulsarAdminException - Unexpected errorCompletableFuture<Void> createNamespaceAsync(String namespace, int numBundles)
namespace - Namespace namenumBundles - Number of bundlesvoid createNamespace(String namespace, org.apache.pulsar.common.policies.data.BundlesData bundlesData) throws PulsarAdminException
namespace - Namespace namebundlesData - Bundles DataPulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException.ConflictException - Namespace already existsPulsarAdminException - Unexpected errorCompletableFuture<Void> createNamespaceAsync(String namespace, org.apache.pulsar.common.policies.data.BundlesData bundlesData)
namespace - Namespace namebundlesData - Bundles Datavoid createNamespace(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException.ConflictException - Namespace already existsPulsarAdminException - Unexpected errorCompletableFuture<Void> createNamespaceAsync(String namespace)
namespace - Namespace namevoid createNamespace(String namespace, Set<String> clusters) throws PulsarAdminException
namespace - Namespace nameclusters - Clusters in which the namespace will be present. If more than one cluster is present, replication
across clusters will be enabled.PulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException.ConflictException - Namespace already existsPulsarAdminException - Unexpected errorCompletableFuture<Void> createNamespaceAsync(String namespace, Set<String> clusters)
namespace - Namespace nameclusters - Clusters in which the namespace will be present. If more than one cluster is present, replication
across clusters will be enabled.void createNamespace(String namespace, org.apache.pulsar.common.policies.data.Policies policies) throws PulsarAdminException
namespace - Namespace namepolicies - Policies for the namespacePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Tenant or cluster does not existPulsarAdminException.ConflictException - Namespace already existsPulsarAdminException - Unexpected errorCompletableFuture<Void> createNamespaceAsync(String namespace, org.apache.pulsar.common.policies.data.Policies policies)
namespace - Namespace namepolicies - Policies for the namespacevoid deleteNamespace(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Namespace is not emptyPulsarAdminException - Unexpected errorvoid deleteNamespace(String namespace, boolean force) throws PulsarAdminException
namespace - Namespace nameforce - Delete namespace forcefullyPulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Namespace is not emptyPulsarAdminException - Unexpected errorCompletableFuture<Void> deleteNamespaceAsync(String namespace)
namespace - Namespace nameCompletableFuture<Void> deleteNamespaceAsync(String namespace, boolean force)
namespace - Namespace nameforce - Delete namespace forcefullyvoid deleteNamespaceBundle(String namespace, String bundleRange) throws PulsarAdminException
namespace - Namespace namebundleRange - range of the bundlePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace/bundle does not existPulsarAdminException.ConflictException - Bundle is not emptyPulsarAdminException - Unexpected errorvoid deleteNamespaceBundle(String namespace, String bundleRange, boolean force) throws PulsarAdminException
namespace - Namespace namebundleRange - range of the bundleforce - Delete bundle forcefullyPulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace/bundle does not existPulsarAdminException.ConflictException - Bundle is not emptyPulsarAdminException - Unexpected errorCompletableFuture<Void> deleteNamespaceBundleAsync(String namespace, String bundleRange)
namespace - Namespace namebundleRange - range of the bundleCompletableFuture<Void> deleteNamespaceBundleAsync(String namespace, String bundleRange, boolean force)
namespace - Namespace namebundleRange - range of the bundleforce - Delete bundle forcefullyMap<String,Set<org.apache.pulsar.common.policies.data.AuthAction>> getPermissions(String namespace) throws PulsarAdminException
{
"my-role" : [ "produce" ]
"other-role" : [ "consume" ]
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Map<String,Set<org.apache.pulsar.common.policies.data.AuthAction>>> getPermissionsAsync(String namespace)
{
"my-role" : [ "produce" ]
"other-role" : [ "consume" ]
}
namespace - Namespace namevoid grantPermissionOnNamespace(String namespace, String role, Set<org.apache.pulsar.common.policies.data.AuthAction> actions) throws PulsarAdminException
["produce", "consume"]
namespace - Namespace namerole - Client role to which grant permissionactions - Auth actions (produce and consume)PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<Void> grantPermissionOnNamespaceAsync(String namespace, String role, Set<org.apache.pulsar.common.policies.data.AuthAction> actions)
["produce", "consume"]
namespace - Namespace namerole - Client role to which grant permissionactions - Auth actions (produce and consume)void revokePermissionsOnNamespace(String namespace, String role) throws PulsarAdminException
namespace - Namespace namerole - Client role to which remove permissionsPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> revokePermissionsOnNamespaceAsync(String namespace, String role)
namespace - Namespace namerole - Client role to which remove permissionsvoid grantPermissionOnSubscription(String namespace, String subscription, Set<String> roles) throws PulsarAdminException
namespace - subscription - roles - PulsarAdminExceptionCompletableFuture<Void> grantPermissionOnSubscriptionAsync(String namespace, String subscription, Set<String> roles)
namespace - subscription - roles - void revokePermissionOnSubscription(String namespace, String subscription, String role) throws PulsarAdminException
namespace - subscription - role - PulsarAdminExceptionCompletableFuture<Void> revokePermissionOnSubscriptionAsync(String namespace, String subscription, String role)
namespace - subscription - role - List<String> getNamespaceReplicationClusters(String namespace) throws PulsarAdminException
["use", "usw", "usc"]
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.PreconditionFailedException - Namespace is not globalPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getNamespaceReplicationClustersAsync(String namespace)
["use", "usw", "usc"]
namespace - Namespace namevoid setNamespaceReplicationClusters(String namespace, Set<String> clusterIds) throws PulsarAdminException
["us-west", "us-east", "us-cent"]
namespace - Namespace nameclusterIds - Pulsar Cluster IdsPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.PreconditionFailedException - Namespace is not globalPulsarAdminException.PreconditionFailedException - Invalid cluster idsPulsarAdminException - Unexpected errorCompletableFuture<Void> setNamespaceReplicationClustersAsync(String namespace, Set<String> clusterIds)
["us-west", "us-east", "us-cent"]
namespace - Namespace nameclusterIds - Pulsar Cluster Idsint getNamespaceMessageTTL(String namespace) throws PulsarAdminException
60
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getNamespaceMessageTTLAsync(String namespace)
60
namespace - Namespace namevoid setNamespaceMessageTTL(String namespace, int ttlInSeconds) throws PulsarAdminException
60
namespace - Namespace namettlInSeconds - TTL values for all messages for all topics in this namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setNamespaceMessageTTLAsync(String namespace, int ttlInSeconds)
60
namespace - Namespace namettlInSeconds - TTL values for all messages for all topics in this namespacevoid removeNamespaceMessageTTL(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Void> removeNamespaceMessageTTLAsync(String namespace)
namespace - int getSubscriptionExpirationTime(String namespace) throws PulsarAdminException
1440
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getSubscriptionExpirationTimeAsync(String namespace)
1440
namespace - Namespace namevoid setSubscriptionExpirationTime(String namespace, int expirationTime) throws PulsarAdminException
1440
namespace - Namespace nameexpirationTime - Expiration time values for all subscriptions for all topics in this namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setSubscriptionExpirationTimeAsync(String namespace, int expirationTime)
1440
namespace - Namespace nameexpirationTime - Expiration time values for all subscriptions for all topics in this namespacevoid setNamespaceAntiAffinityGroup(String namespace, String namespaceAntiAffinityGroup) throws PulsarAdminException
namespace - Namespace namenamespaceAntiAffinityGroup - anti-affinity group name for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setNamespaceAntiAffinityGroupAsync(String namespace, String namespaceAntiAffinityGroup)
namespace - Namespace namenamespaceAntiAffinityGroup - anti-affinity group name for a namespaceList<String> getAntiAffinityNamespaces(String tenant, String cluster, String namespaceAntiAffinityGroup) throws PulsarAdminException
tenant - tenant is only used for authorization. Client has to be admin of any of the tenant to access this
api api.cluster - cluster namenamespaceAntiAffinityGroup - Anti-affinity group namePulsarAdminExceptionCompletableFuture<List<String>> getAntiAffinityNamespacesAsync(String tenant, String cluster, String namespaceAntiAffinityGroup)
tenant - tenant is only used for authorization. Client has to be admin of any of the tenant to access this
api api.cluster - cluster namenamespaceAntiAffinityGroup - Anti-affinity group nameString getNamespaceAntiAffinityGroup(String namespace) throws PulsarAdminException
60
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<String> getNamespaceAntiAffinityGroupAsync(String namespace)
60
namespace - Namespace namevoid deleteNamespaceAntiAffinityGroup(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - You don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> deleteNamespaceAntiAffinityGroupAsync(String namespace)
namespace - Namespace namevoid setDeduplicationStatus(String namespace, boolean enableDeduplication) throws PulsarAdminException
true
namespace - Namespace nameenableDeduplication - wether to enable or disable deduplication featurePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setDeduplicationStatusAsync(String namespace, boolean enableDeduplication)
true
namespace - Namespace nameenableDeduplication - wether to enable or disable deduplication featurevoid setAutoTopicCreation(String namespace, org.apache.pulsar.common.policies.data.AutoTopicCreationOverride autoTopicCreationOverride) throws PulsarAdminException
{
"allowAutoTopicCreation" : true,
"topicType" : "partitioned",
"defaultNumPartitions": 2
}
namespace - Namespace nameautoTopicCreationOverride - Override policies for auto topic creationPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setAutoTopicCreationAsync(String namespace, org.apache.pulsar.common.policies.data.AutoTopicCreationOverride autoTopicCreationOverride)
{
"allowAutoTopicCreation" : true,
"topicType" : "partitioned",
"defaultNumPartitions": 2
}
namespace - Namespace nameautoTopicCreationOverride - Override policies for auto topic creationvoid removeAutoTopicCreation(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> removeAutoTopicCreationAsync(String namespace)
namespace - Namespace namevoid setAutoSubscriptionCreation(String namespace, org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride autoSubscriptionCreationOverride) throws PulsarAdminException
{
"allowAutoSubscriptionCreation" : true
}
namespace - Namespace nameautoSubscriptionCreationOverride - Override policies for auto subscription creationPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setAutoSubscriptionCreationAsync(String namespace, org.apache.pulsar.common.policies.data.AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
{
"allowAutoSubscriptionCreation" : true
}
namespace - Namespace nameautoSubscriptionCreationOverride - Override policies for auto subscription creationvoid removeAutoSubscriptionCreation(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> removeAutoSubscriptionCreationAsync(String namespace)
namespace - Namespace nameMap<org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType,org.apache.pulsar.common.policies.data.BacklogQuota> getBacklogQuotaMap(String namespace) throws PulsarAdminException
{
"namespace_memory" : {
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
},
"destination_storage" : {
"limit" : "-1",
"policy" : "producer_exception"
}
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Permission deniedPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Map<org.apache.pulsar.common.policies.data.BacklogQuota.BacklogQuotaType,org.apache.pulsar.common.policies.data.BacklogQuota>> getBacklogQuotaMapAsync(String namespace)
{
"namespace_memory" : {
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
},
"destination_storage" : {
"limit" : "-1",
"policy" : "producer_exception"
}
}
namespace - Namespace namevoid setBacklogQuota(String namespace, org.apache.pulsar.common.policies.data.BacklogQuota backlogQuota) throws PulsarAdminException
{
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
}
namespace - Namespace namebacklogQuota - the new BacklogQuotaPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setBacklogQuotaAsync(String namespace, org.apache.pulsar.common.policies.data.BacklogQuota backlogQuota)
{
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
}
namespace - Namespace namebacklogQuota - the new BacklogQuotavoid removeBacklogQuota(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> removeBacklogQuotaAsync(String namespace)
namespace - Namespace namevoid setPersistence(String namespace, org.apache.pulsar.common.policies.data.PersistencePolicies persistence) throws PulsarAdminException
{
"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
}
namespace - Namespace namepersistence - Persistence policies objectPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<Void> setPersistenceAsync(String namespace, org.apache.pulsar.common.policies.data.PersistencePolicies persistence)
{
"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
}
namespace - Namespace namepersistence - Persistence policies objectorg.apache.pulsar.common.policies.data.PersistencePolicies getPersistence(String namespace) throws PulsarAdminException
{
"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
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.PersistencePolicies> getPersistenceAsync(String namespace)
{
"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
}
namespace - Namespace namevoid setBookieAffinityGroup(String namespace, org.apache.pulsar.common.policies.data.BookieAffinityGroupData bookieAffinityGroup) throws PulsarAdminException
namespace - namespace namebookieAffinityGroup - bookie affinity groupPulsarAdminExceptionCompletableFuture<Void> setBookieAffinityGroupAsync(String namespace, org.apache.pulsar.common.policies.data.BookieAffinityGroupData bookieAffinityGroup)
namespace - namespace namebookieAffinityGroup - bookie affinity groupvoid deleteBookieAffinityGroup(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Void> deleteBookieAffinityGroupAsync(String namespace)
namespace - org.apache.pulsar.common.policies.data.BookieAffinityGroupData getBookieAffinityGroup(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<org.apache.pulsar.common.policies.data.BookieAffinityGroupData> getBookieAffinityGroupAsync(String namespace)
namespace - void setRetention(String namespace, org.apache.pulsar.common.policies.data.RetentionPolicies retention) throws PulsarAdminException
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<Void> setRetentionAsync(String namespace, org.apache.pulsar.common.policies.data.RetentionPolicies retention)
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
namespace - Namespace nameorg.apache.pulsar.common.policies.data.RetentionPolicies getRetention(String namespace) throws PulsarAdminException
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.RetentionPolicies> getRetentionAsync(String namespace)
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
namespace - Namespace namevoid unload(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.PreconditionFailedException - Namespace is already unloadedPulsarAdminException - Unexpected errorCompletableFuture<Void> unloadAsync(String namespace)
namespace - Namespace nameString getReplicationConfigVersion(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<String> getReplicationConfigVersionAsync(String namespace)
namespace - void unloadNamespaceBundle(String namespace, String bundle) throws PulsarAdminException
namespace - bundle - range of bundle to unloadPulsarAdminException - Unexpected errorCompletableFuture<Void> unloadNamespaceBundleAsync(String namespace, String bundle)
namespace - bundle - range of bundle to unloadvoid splitNamespaceBundle(String namespace, String bundle, boolean unloadSplitBundles, String splitAlgorithmName) throws PulsarAdminException
namespace - bundle - range of bundle to splitunloadSplitBundles - splitAlgorithmName - PulsarAdminExceptionCompletableFuture<Void> splitNamespaceBundleAsync(String namespace, String bundle, boolean unloadSplitBundles, String splitAlgorithmName)
namespace - bundle - range of bundle to splitunloadSplitBundles - splitAlgorithmName - void setPublishRate(String namespace, org.apache.pulsar.common.policies.data.PublishRate publishMsgRate) throws PulsarAdminException
namespace - publishMsgRate - number of messages per secondPulsarAdminException - Unexpected errorvoid removePublishRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<Void> setPublishRateAsync(String namespace, org.apache.pulsar.common.policies.data.PublishRate publishMsgRate)
namespace - publishMsgRate - number of messages per secondCompletableFuture<Void> removePublishRateAsync(String namespace)
namespace - org.apache.pulsar.common.policies.data.PublishRate getPublishRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.PublishRate> getPublishRateAsync(String namespace)
namespace - void setDispatchRate(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate) throws PulsarAdminException
namespace - dispatchRate - number of messages per secondPulsarAdminException - Unexpected errorCompletableFuture<Void> setDispatchRateAsync(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
namespace - dispatchRate - number of messages per secondorg.apache.pulsar.common.policies.data.DispatchRate getDispatchRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> getDispatchRateAsync(String namespace)
namespace - void setSubscribeRate(String namespace, org.apache.pulsar.common.policies.data.SubscribeRate subscribeRate) throws PulsarAdminException
namespace - subscribeRate - consumer subscribe limit by this subscribeRatePulsarAdminException - Unexpected errorCompletableFuture<Void> setSubscribeRateAsync(String namespace, org.apache.pulsar.common.policies.data.SubscribeRate subscribeRate)
namespace - subscribeRate - consumer subscribe limit by this subscribeRateorg.apache.pulsar.common.policies.data.SubscribeRate getSubscribeRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.SubscribeRate> getSubscribeRateAsync(String namespace)
namespace - void setSubscriptionDispatchRate(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate) throws PulsarAdminException
namespace - dispatchRate - number of messages per secondPulsarAdminException - Unexpected errorCompletableFuture<Void> setSubscriptionDispatchRateAsync(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
namespace - dispatchRate - number of messages per secondorg.apache.pulsar.common.policies.data.DispatchRate getSubscriptionDispatchRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> getSubscriptionDispatchRateAsync(String namespace)
namespace - void setReplicatorDispatchRate(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate) throws PulsarAdminException
namespace - dispatchRate - number of messages per secondPulsarAdminException - Unexpected errorCompletableFuture<Void> setReplicatorDispatchRateAsync(String namespace, org.apache.pulsar.common.policies.data.DispatchRate dispatchRate)
namespace - dispatchRate - number of messages per secondorg.apache.pulsar.common.policies.data.DispatchRate getReplicatorDispatchRate(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.DispatchRate> getReplicatorDispatchRateAsync(String namespace)
namespace - void clearNamespaceBacklog(String namespace) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected errorCompletableFuture<Void> clearNamespaceBacklogAsync(String namespace)
namespace - void clearNamespaceBacklogForSubscription(String namespace, String subscription) throws PulsarAdminException
namespace - subscription - PulsarAdminException - Unexpected errorCompletableFuture<Void> clearNamespaceBacklogForSubscriptionAsync(String namespace, String subscription)
namespace - subscription - void clearNamespaceBundleBacklog(String namespace, String bundle) throws PulsarAdminException
namespace - bundle - PulsarAdminException - Unexpected errorCompletableFuture<Void> clearNamespaceBundleBacklogAsync(String namespace, String bundle)
namespace - bundle - void clearNamespaceBundleBacklogForSubscription(String namespace, String bundle, String subscription) throws PulsarAdminException
namespace - bundle - subscription - PulsarAdminException - Unexpected errorCompletableFuture<Void> clearNamespaceBundleBacklogForSubscriptionAsync(String namespace, String bundle, String subscription)
namespace - bundle - subscription - void unsubscribeNamespace(String namespace, String subscription) throws PulsarAdminException
namespace - subscription - PulsarAdminExceptionCompletableFuture<Void> unsubscribeNamespaceAsync(String namespace, String subscription)
namespace - subscription - void unsubscribeNamespaceBundle(String namespace, String bundle, String subscription) throws PulsarAdminException
namespace - bundle - subscription - PulsarAdminExceptionCompletableFuture<Void> unsubscribeNamespaceBundleAsync(String namespace, String bundle, String subscription)
namespace - bundle - subscription - void setEncryptionRequiredStatus(String namespace, boolean encryptionRequired) throws PulsarAdminException
true
namespace - Namespace nameencryptionRequired - whether message encryption is required or notPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setEncryptionRequiredStatusAsync(String namespace, boolean encryptionRequired)
true
namespace - Namespace nameencryptionRequired - whether message encryption is required or notorg.apache.pulsar.common.policies.data.DelayedDeliveryPolicies getDelayedDelivery(String namespace) throws PulsarAdminException
{
"active" : true, // Enable or disable delayed delivery for messages on a namespace
"tickTime" : 1000, // The tick time for when retrying on delayed delivery messages
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies> getDelayedDeliveryAsync(String namespace)
{
"active" : true, // Enable or disable delayed delivery for messages on a namespace
"tickTime" : 1000, // The tick time for when retrying on delayed delivery messages
}
namespace - Namespace namevoid setDelayedDeliveryMessages(String namespace, org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies delayedDeliveryPolicies) throws PulsarAdminException
{
"tickTime" : 1000, // Enable or disable delayed delivery for messages on a namespace
"active" : true, // The tick time for when retrying on delayed delivery messages
}
namespace - Namespace namedelayedDeliveryPolicies - Whether to enable the delayed delivery for messages.PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setDelayedDeliveryMessagesAsync(String namespace, org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies delayedDeliveryPolicies)
{
"tickTime" : 1000, // Enable or disable delayed delivery for messages on a namespace
"active" : true, // The tick time for when retrying on delayed delivery messages
}
namespace - Namespace namedelayedDeliveryPolicies - Whether to enable the delayed delivery for messages.org.apache.pulsar.common.policies.data.InactiveTopicPolicies getInactiveTopicPolicies(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Void> removeInactiveTopicPoliciesAsync(String namespace)
namespace - void removeInactiveTopicPolicies(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<org.apache.pulsar.common.policies.data.InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String namespace)
namespace - void setInactiveTopicPolicies(String namespace, org.apache.pulsar.common.policies.data.InactiveTopicPolicies inactiveTopicPolicies) throws PulsarAdminException
namespace - inactiveTopicPolicies - PulsarAdminExceptionCompletableFuture<Void> setInactiveTopicPoliciesAsync(String namespace, org.apache.pulsar.common.policies.data.InactiveTopicPolicies inactiveTopicPolicies)
namespace - inactiveTopicPolicies - void setSubscriptionAuthMode(String namespace, org.apache.pulsar.common.policies.data.SubscriptionAuthMode subscriptionAuthMode) throws PulsarAdminException
namespace - subscriptionAuthMode - PulsarAdminExceptionCompletableFuture<Void> setSubscriptionAuthModeAsync(String namespace, org.apache.pulsar.common.policies.data.SubscriptionAuthMode subscriptionAuthMode)
namespace - subscriptionAuthMode - Integer getDeduplicationSnapshotInterval(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Integer> getDeduplicationSnapshotIntervalAsync(String namespace)
namespace - void setDeduplicationSnapshotInterval(String namespace, Integer interval) throws PulsarAdminException
namespace - interval - PulsarAdminExceptionCompletableFuture<Void> setDeduplicationSnapshotIntervalAsync(String namespace, Integer interval)
namespace - interval - void removeDeduplicationSnapshotInterval(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Void> removeDeduplicationSnapshotIntervalAsync(String namespace)
namespace - Integer getMaxSubscriptionsPerTopic(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Integer> getMaxSubscriptionsPerTopicAsync(String namespace)
namespace - void setMaxSubscriptionsPerTopic(String namespace, int maxSubscriptionsPerTopic) throws PulsarAdminException
namespace - maxSubscriptionsPerTopic - PulsarAdminExceptionCompletableFuture<Void> setMaxSubscriptionsPerTopicAsync(String namespace, int maxSubscriptionsPerTopic)
namespace - maxSubscriptionsPerTopic - void removeMaxSubscriptionsPerTopic(String namespace) throws PulsarAdminException
namespace - PulsarAdminExceptionCompletableFuture<Void> removeMaxSubscriptionsPerTopicAsync(String namespace)
namespace - Integer getMaxProducersPerTopic(String namespace) throws PulsarAdminException
0
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getMaxProducersPerTopicAsync(String namespace)
0
namespace - Namespace namevoid setMaxProducersPerTopic(String namespace, int maxProducersPerTopic) throws PulsarAdminException
10
namespace - Namespace namemaxProducersPerTopic - maxProducersPerTopic value for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setMaxProducersPerTopicAsync(String namespace, int maxProducersPerTopic)
10
namespace - Namespace namemaxProducersPerTopic - maxProducersPerTopic value for a namespacevoid removeMaxProducersPerTopic(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> removeMaxProducersPerTopicAsync(String namespace)
namespace - Namespace nameint getMaxConsumersPerTopic(String namespace) throws PulsarAdminException
0
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getMaxConsumersPerTopicAsync(String namespace)
0
namespace - Namespace namevoid setMaxConsumersPerTopic(String namespace, int maxConsumersPerTopic) throws PulsarAdminException
10
namespace - Namespace namemaxConsumersPerTopic - maxConsumersPerTopic value for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setMaxConsumersPerTopicAsync(String namespace, int maxConsumersPerTopic)
10
namespace - Namespace namemaxConsumersPerTopic - maxConsumersPerTopic value for a namespaceint getMaxConsumersPerSubscription(String namespace) throws PulsarAdminException
0
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getMaxConsumersPerSubscriptionAsync(String namespace)
0
namespace - Namespace namevoid setMaxConsumersPerSubscription(String namespace, int maxConsumersPerSubscription) throws PulsarAdminException
10
namespace - Namespace namemaxConsumersPerSubscription - maxConsumersPerSubscription value for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setMaxConsumersPerSubscriptionAsync(String namespace, int maxConsumersPerSubscription)
10
namespace - Namespace namemaxConsumersPerSubscription - maxConsumersPerSubscription value for a namespaceint getMaxUnackedMessagesPerConsumer(String namespace) throws PulsarAdminException
0
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getMaxUnackedMessagesPerConsumerAsync(String namespace)
0
namespace - Namespace namevoid setMaxUnackedMessagesPerConsumer(String namespace, int maxUnackedMessagesPerConsumer) throws PulsarAdminException
10
namespace - Namespace namemaxUnackedMessagesPerConsumer - maxUnackedMessagesPerConsumer value for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setMaxUnackedMessagesPerConsumerAsync(String namespace, int maxUnackedMessagesPerConsumer)
10
namespace - Namespace namemaxUnackedMessagesPerConsumer - maxUnackedMessagesPerConsumer value for a namespaceint getMaxUnackedMessagesPerSubscription(String namespace) throws PulsarAdminException
0
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Integer> getMaxUnackedMessagesPerSubscriptionAsync(String namespace)
0
namespace - Namespace namevoid setMaxUnackedMessagesPerSubscription(String namespace, int maxUnackedMessagesPerSubscription) throws PulsarAdminException
10
namespace - Namespace namemaxUnackedMessagesPerSubscription - Max number of unacknowledged messages allowed per shared subscription.PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setMaxUnackedMessagesPerSubscriptionAsync(String namespace, int maxUnackedMessagesPerSubscription)
10
namespace - Namespace namemaxUnackedMessagesPerSubscription - Max number of unacknowledged messages allowed per shared subscription.long getCompactionThreshold(String namespace) throws PulsarAdminException
10000000
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Long> getCompactionThresholdAsync(String namespace)
10000000
namespace - Namespace namevoid setCompactionThreshold(String namespace, long compactionThreshold) throws PulsarAdminException
10000000
namespace - Namespace namecompactionThreshold - maximum number of backlog bytes before compaction is triggeredPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setCompactionThresholdAsync(String namespace, long compactionThreshold)
10000000
namespace - Namespace namecompactionThreshold - maximum number of backlog bytes before compaction is triggeredlong getOffloadThreshold(String namespace) throws PulsarAdminException
10000000
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Long> getOffloadThresholdAsync(String namespace)
10000000
namespace - Namespace namevoid setOffloadThreshold(String namespace, long offloadThreshold) throws PulsarAdminException
10000000
namespace - Namespace nameoffloadThreshold - maximum number of bytes stored before offloading is triggeredPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setOffloadThresholdAsync(String namespace, long offloadThreshold)
10000000
namespace - Namespace nameoffloadThreshold - maximum number of bytes stored before offloading is triggeredLong getOffloadDeleteLagMs(String namespace) throws PulsarAdminException
3600000
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Long> getOffloadDeleteLagMsAsync(String namespace)
3600000
namespace - Namespace namevoid setOffloadDeleteLag(String namespace, long lag, TimeUnit unit) throws PulsarAdminException
namespace - Namespace namelag - the duration to wait before deleting the local copyunit - the timeunit of the durationPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setOffloadDeleteLagAsync(String namespace, long lag, TimeUnit unit)
namespace - Namespace namelag - the duration to wait before deleting the local copyunit - the timeunit of the durationvoid clearOffloadDeleteLag(String namespace) throws PulsarAdminException
PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> clearOffloadDeleteLagAsync(String namespace)
@Deprecated org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy getSchemaAutoUpdateCompatibilityStrategy(String namespace) throws PulsarAdminException
SchemaAutoUpdateCompatibilityStrategy.AutoUpdateDisabled,
then all new schemas provided via the producer are rejected, and schemas must be updated through the REST api.namespace - The namespace in whose policy we are interestedPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated void setSchemaAutoUpdateCompatibilityStrategy(String namespace, org.apache.pulsar.common.policies.data.SchemaAutoUpdateCompatibilityStrategy strategy) throws PulsarAdminException
SchemaAutoUpdateCompatibilityStrategy.AutoUpdateDisabled.namespace - The namespace in whose policy should be setstrategy - PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorboolean getSchemaValidationEnforced(String namespace) throws PulsarAdminException
PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant or Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Boolean> getSchemaValidationEnforcedAsync(String namespace)
void setSchemaValidationEnforced(String namespace, boolean schemaValidationEnforced) throws PulsarAdminException
namespace - pulsar namespace nameschemaValidationEnforced - flag to enable or disable schema validation for the given namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant or Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setSchemaValidationEnforcedAsync(String namespace, boolean schemaValidationEnforced)
namespace - pulsar namespace nameschemaValidationEnforced - flag to enable or disable schema validation for the given namespaceorg.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy getSchemaCompatibilityStrategy(String namespace) throws PulsarAdminException
namespace - The namespace in whose policy we are interestedPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy> getSchemaCompatibilityStrategyAsync(String namespace)
namespace - The namespace in whose policy we are interestedvoid setSchemaCompatibilityStrategy(String namespace, org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy strategy) throws PulsarAdminException
namespace - The namespace in whose policy should be setstrategy - The schema compatibility strategyPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setSchemaCompatibilityStrategyAsync(String namespace, org.apache.pulsar.common.policies.data.SchemaCompatibilityStrategy strategy)
namespace - The namespace in whose policy should be setstrategy - The schema compatibility strategyboolean getIsAllowAutoUpdateSchema(String namespace) throws PulsarAdminException
namespace - pulsar namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant or Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Boolean> getIsAllowAutoUpdateSchemaAsync(String namespace)
namespace - pulsar namespace namevoid setIsAllowAutoUpdateSchema(String namespace, boolean isAllowAutoUpdateSchema) throws PulsarAdminException
namespace - pulsar namespace nameisAllowAutoUpdateSchema - flag to enable or disable auto update schemaPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Tenant or Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> setIsAllowAutoUpdateSchemaAsync(String namespace, boolean isAllowAutoUpdateSchema)
namespace - pulsar namespace nameisAllowAutoUpdateSchema - flag to enable or disable auto update schemavoid setOffloadPolicies(String namespace, org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies) throws PulsarAdminException
{
"region" : "us-east-2", // The long term storage region
"bucket" : "bucket", // Bucket to place offloaded ledger into
"endpoint" : "endpoint", // Alternative endpoint to connect to
"maxBlockSize" : 1024, // Max Block Size, default 64MB
"readBufferSize" : 1024, // Read Buffer Size, default 1MB
}
namespace - Namespace nameoffloadPolicies - Offload configurationPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorvoid removeOffloadPolicies(String namespace) throws PulsarAdminException
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<Void> setOffloadPoliciesAsync(String namespace, org.apache.pulsar.common.policies.data.OffloadPolicies offloadPolicies)
{
"region" : "us-east-2", // The long term storage region
"bucket" : "bucket", // Bucket to place offloaded ledger into
"endpoint" : "endpoint", // Alternative endpoint to connect to
"maxBlockSize" : 1024, // Max Block Size, default 64MB
"readBufferSize" : 1024, // Read Buffer Size, default 1MB
}
namespace - Namespace nameoffloadPolicies - Offload configurationCompletableFuture<Void> removeOffloadPoliciesAsync(String namespace)
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errororg.apache.pulsar.common.policies.data.OffloadPolicies getOffloadPolicies(String namespace) throws PulsarAdminException
{
"region" : "us-east-2", // The long term storage region
"bucket" : "bucket", // Bucket to place offloaded ledger into
"endpoint" : "endpoint", // Alternative endpoint to connect to
"maxBlockSize" : 1024, // Max Block Size, default 64MB
"readBufferSize" : 1024, // Read Buffer Size, default 1MB
}
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected errorCompletableFuture<org.apache.pulsar.common.policies.data.OffloadPolicies> getOffloadPoliciesAsync(String namespace)
{
"region" : "us-east-2", // The long term storage region
"bucket" : "bucket", // Bucket to place offloaded ledger into
"endpoint" : "endpoint", // Alternative endpoint to connect to
"maxBlockSize" : 1024, // Max Block Size, default 64MB
"readBufferSize" : 1024, // Read Buffer Size, default 1MB
}
namespace - Namespace nameCopyright © 2017–2021 Apache Software Foundation. All rights reserved.