public interface Topics
| Modifier and Type | Method and Description |
|---|---|
LongRunningProcessStatus |
compactionStatus(String topic)
Check the status of an ongoing compaction for a topic.
|
CompletableFuture<LongRunningProcessStatus> |
compactionStatusAsync(String topic)
Check the status of an ongoing compaction for a topic asynchronously.
|
void |
createMissedPartitions(String topic)
Create missed partitions for partitioned topic.
|
CompletableFuture<Void> |
createMissedPartitionsAsync(String topic)
Create missed partitions for partitioned topic asynchronously.
|
void |
createNonPartitionedTopic(String topic)
Create a non-partitioned topic.
|
CompletableFuture<Void> |
createNonPartitionedTopicAsync(String topic)
Create a non-partitioned topic asynchronously.
|
void |
createPartitionedTopic(String topic,
int numPartitions)
Create a partitioned topic.
|
CompletableFuture<Void> |
createPartitionedTopicAsync(String topic,
int numPartitions)
Create a partitioned topic asynchronously.
|
void |
createSubscription(String topic,
String subscriptionName,
MessageId messageId)
Create a new subscription on a topic.
|
CompletableFuture<Void> |
createSubscriptionAsync(String topic,
String subscriptionName,
MessageId messageId)
Create a new subscription on a topic.
|
void |
delete(String topic)
Delete a topic.
|
default void |
delete(String topic,
boolean force) |
void |
delete(String topic,
boolean force,
boolean deleteSchema)
Delete a topic.
|
CompletableFuture<Void> |
deleteAsync(String topic)
Delete a topic asynchronously.
|
default CompletableFuture<Void> |
deleteAsync(String topic,
boolean force) |
CompletableFuture<Void> |
deleteAsync(String topic,
boolean force,
boolean deleteSchema)
Delete a topic asynchronously.
|
void |
deletePartitionedTopic(String topic)
Delete a partitioned topic.
|
default void |
deletePartitionedTopic(String topic,
boolean force) |
void |
deletePartitionedTopic(String topic,
boolean force,
boolean deleteSchema)
Delete a partitioned topic.
|
CompletableFuture<Void> |
deletePartitionedTopicAsync(String topic)
Delete a partitioned topic asynchronously.
|
default CompletableFuture<Void> |
deletePartitionedTopicAsync(String topic,
boolean force) |
CompletableFuture<Void> |
deletePartitionedTopicAsync(String topic,
boolean force,
boolean deleteSchema)
Delete a partitioned topic asynchronously.
|
void |
deleteSubscription(String topic,
String subName)
Delete a subscription.
|
void |
deleteSubscription(String topic,
String subName,
boolean force)
Delete a subscription.
|
CompletableFuture<Void> |
deleteSubscriptionAsync(String topic,
String subName)
Delete a subscription asynchronously.
|
CompletableFuture<Void> |
deleteSubscriptionAsync(String topic,
String subName,
boolean force)
Delete a subscription asynchronously.
|
void |
disableDeduplication(String topic)
Deprecated.
|
CompletableFuture<Void> |
disableDeduplicationAsync(String topic)
Deprecated.
|
void |
enableDeduplication(String topic,
boolean enabled)
Deprecated.
|
CompletableFuture<Void> |
enableDeduplicationAsync(String topic,
boolean enabled)
Deprecated.
|
Message<byte[]> |
examineMessage(String topic,
String initialPosition,
long messagePosition)
Examine a specific message on a topic by position relative to the earliest or the latest message.
|
CompletableFuture<Message<byte[]>> |
examineMessageAsync(String topic,
String initialPosition,
long messagePosition)
Examine a specific message on a topic by position relative to the earliest or the latest message.
|
void |
expireMessages(String topic,
String subscriptionName,
long expireTimeInSeconds)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
|
void |
expireMessages(String topic,
String subscriptionName,
MessageId messageId,
boolean isExcluded)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
|
CompletableFuture<Void> |
expireMessagesAsync(String topic,
String subscriptionName,
long expireTimeInSeconds)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
|
CompletableFuture<Void> |
expireMessagesAsync(String topic,
String subscriptionName,
MessageId messageId,
boolean isExcluded)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
|
void |
expireMessagesForAllSubscriptions(String topic,
long expireTimeInSeconds)
Expire all messages older than given N seconds for all subscriptions of the persistent-topic.
|
CompletableFuture<Void> |
expireMessagesForAllSubscriptionsAsync(String topic,
long expireTimeInSeconds)
Expire all messages older than given N seconds for all subscriptions of the persistent-topic asynchronously.
|
Map<BacklogQuota.BacklogQuotaType,BacklogQuota> |
getBacklogQuotaMap(String topic)
Deprecated.
|
Map<BacklogQuota.BacklogQuotaType,BacklogQuota> |
getBacklogQuotaMap(String topic,
boolean applied)
Deprecated.
|
Long |
getBacklogSizeByMessageId(String topic,
MessageId messageId)
Get backlog size by a message ID.
|
CompletableFuture<Long> |
getBacklogSizeByMessageIdAsync(String topic,
MessageId messageId)
Get backlog size by a message ID asynchronously.
|
Long |
getCompactionThreshold(String topic)
Deprecated.
|
Long |
getCompactionThreshold(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Long> |
getCompactionThresholdAsync(String topic)
Deprecated.
|
CompletableFuture<Long> |
getCompactionThresholdAsync(String topic,
boolean applied)
Deprecated.
|
Boolean |
getDeduplicationEnabled(String topic)
Deprecated.
|
CompletableFuture<Boolean> |
getDeduplicationEnabledAsync(String topic)
Deprecated.
|
Integer |
getDeduplicationSnapshotInterval(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getDeduplicationSnapshotIntervalAsync(String topic)
Deprecated.
|
Boolean |
getDeduplicationStatus(String topic)
Deprecated.
|
Boolean |
getDeduplicationStatus(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Boolean> |
getDeduplicationStatusAsync(String topic)
Deprecated.
|
CompletableFuture<Boolean> |
getDeduplicationStatusAsync(String topic,
boolean applied)
Deprecated.
|
DelayedDeliveryPolicies |
getDelayedDeliveryPolicy(String topic)
Deprecated.
|
DelayedDeliveryPolicies |
getDelayedDeliveryPolicy(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<DelayedDeliveryPolicies> |
getDelayedDeliveryPolicyAsync(String topic)
Deprecated.
|
CompletableFuture<DelayedDeliveryPolicies> |
getDelayedDeliveryPolicyAsync(String topic,
boolean applied)
Deprecated.
|
DispatchRate |
getDispatchRate(String topic)
Deprecated.
|
DispatchRate |
getDispatchRate(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<DispatchRate> |
getDispatchRateAsync(String topic)
Deprecated.
|
CompletableFuture<DispatchRate> |
getDispatchRateAsync(String topic,
boolean applied)
Deprecated.
|
InactiveTopicPolicies |
getInactiveTopicPolicies(String topic)
Deprecated.
|
InactiveTopicPolicies |
getInactiveTopicPolicies(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<InactiveTopicPolicies> |
getInactiveTopicPoliciesAsync(String topic)
Deprecated.
|
CompletableFuture<InactiveTopicPolicies> |
getInactiveTopicPoliciesAsync(String topic,
boolean applied)
Deprecated.
|
String |
getInternalInfo(String topic)
Get a JSON representation of the topic metadata stored in ZooKeeper.
|
CompletableFuture<String> |
getInternalInfoAsync(String topic)
Get a JSON representation of the topic metadata stored in ZooKeeper.
|
PersistentTopicInternalStats |
getInternalStats(String topic)
Get the internal stats for the topic.
|
PersistentTopicInternalStats |
getInternalStats(String topic,
boolean metadata)
Get the internal stats for the topic.
|
CompletableFuture<PersistentTopicInternalStats> |
getInternalStatsAsync(String topic)
Get the internal stats for the topic asynchronously.
|
CompletableFuture<PersistentTopicInternalStats> |
getInternalStatsAsync(String topic,
boolean metadata)
Get the internal stats for the topic asynchronously.
|
MessageId |
getLastMessageId(String topic)
Get the last commit message Id of a topic.
|
CompletableFuture<MessageId> |
getLastMessageIdAsync(String topic)
Get the last commit message Id of a topic asynchronously.
|
List<String> |
getList(String namespace)
Get the both persistent and non-persistent topics under a namespace.
|
List<String> |
getList(String namespace,
TopicDomain topicDomain)
Get the list of topics under a namespace.
|
CompletableFuture<List<String>> |
getListAsync(String namespace)
Get both persistent and non-persistent topics under a namespace asynchronously.
|
CompletableFuture<List<String>> |
getListAsync(String namespace,
TopicDomain topicDomain)
Get the list of topics under a namespace asynchronously.
|
List<String> |
getListInBundle(String namespace,
String bundleRange)
Get list of topics exist into given bundle.
|
CompletableFuture<List<String>> |
getListInBundleAsync(String namespace,
String bundleRange)
Get list of topics exist into given bundle asynchronously.
|
Integer |
getMaxConsumers(String topic)
Deprecated.
|
Integer |
getMaxConsumers(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Integer> |
getMaxConsumersAsync(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxConsumersAsync(String topic,
boolean applied)
Deprecated.
|
Integer |
getMaxConsumersPerSubscription(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxConsumersPerSubscriptionAsync(String topic)
Deprecated.
|
Integer |
getMaxMessageSize(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxMessageSizeAsync(String topic)
Deprecated.
|
Integer |
getMaxProducers(String topic)
Deprecated.
|
Integer |
getMaxProducers(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Integer> |
getMaxProducersAsync(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxProducersAsync(String topic,
boolean applied)
Deprecated.
|
Integer |
getMaxSubscriptionsPerTopic(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxSubscriptionsPerTopicAsync(String topic)
Deprecated.
|
Integer |
getMaxUnackedMessagesOnConsumer(String topic)
Deprecated.
|
Integer |
getMaxUnackedMessagesOnConsumer(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesOnConsumerAsync(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesOnConsumerAsync(String topic,
boolean applied)
Deprecated.
|
Integer |
getMaxUnackedMessagesOnSubscription(String topic)
Deprecated.
|
Integer |
getMaxUnackedMessagesOnSubscription(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesOnSubscriptionAsync(String topic)
Deprecated.
|
CompletableFuture<Integer> |
getMaxUnackedMessagesOnSubscriptionAsync(String topic,
boolean applied)
Deprecated.
|
Message<byte[]> |
getMessageById(String topic,
long ledgerId,
long entryId)
Get a message by its messageId via a topic subscription.
|
CompletableFuture<Message<byte[]>> |
getMessageByIdAsync(String topic,
long ledgerId,
long entryId)
Get a message by its messageId via a topic subscription asynchronously.
|
MessageId |
getMessageIdByTimestamp(String topic,
long timestamp)
Get message ID published at or just after this absolute timestamp (in ms).
|
CompletableFuture<MessageId> |
getMessageIdByTimestampAsync(String topic,
long timestamp)
Get message ID published at or just after this absolute timestamp (in ms) asynchronously.
|
Integer |
getMessageTTL(String topic)
Deprecated.
|
Integer |
getMessageTTL(String topic,
boolean applied)
Deprecated.
|
OffloadPolicies |
getOffloadPolicies(String topic)
Deprecated.
|
OffloadPolicies |
getOffloadPolicies(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<OffloadPolicies> |
getOffloadPoliciesAsync(String topic)
Deprecated.
|
CompletableFuture<OffloadPolicies> |
getOffloadPoliciesAsync(String topic,
boolean applied)
Deprecated.
|
PartitionedTopicInternalStats |
getPartitionedInternalStats(String topic)
Get the stats for the partitioned topic.
|
CompletableFuture<PartitionedTopicInternalStats> |
getPartitionedInternalStatsAsync(String topic)
Get the stats-internal for the partitioned topic asynchronously.
|
default PartitionedTopicStats |
getPartitionedStats(String topic,
boolean perPartition) |
PartitionedTopicStats |
getPartitionedStats(String topic,
boolean perPartition,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize)
Get the stats for the partitioned topic
Response Example:
|
default CompletableFuture<PartitionedTopicStats> |
getPartitionedStatsAsync(String topic,
boolean perPartition) |
CompletableFuture<PartitionedTopicStats> |
getPartitionedStatsAsync(String topic,
boolean perPartition,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize)
Get the stats for the partitioned topic asynchronously.
|
List<String> |
getPartitionedTopicList(String namespace)
Get the list of partitioned topics under a namespace.
|
CompletableFuture<List<String>> |
getPartitionedTopicListAsync(String namespace)
Get the list of partitioned topics under a namespace asynchronously.
|
PartitionedTopicMetadata |
getPartitionedTopicMetadata(String topic)
Get metadata of a partitioned topic.
|
CompletableFuture<PartitionedTopicMetadata> |
getPartitionedTopicMetadataAsync(String topic)
Get metadata of a partitioned topic asynchronously.
|
Map<String,Set<AuthAction>> |
getPermissions(String topic)
Get permissions on a topic.
|
CompletableFuture<Map<String,Set<AuthAction>>> |
getPermissionsAsync(String topic)
Get permissions on a topic asynchronously.
|
PersistencePolicies |
getPersistence(String topic)
Deprecated.
|
PersistencePolicies |
getPersistence(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<PersistencePolicies> |
getPersistenceAsync(String topic)
Deprecated.
|
CompletableFuture<PersistencePolicies> |
getPersistenceAsync(String topic,
boolean applied)
Deprecated.
|
PublishRate |
getPublishRate(String topic)
Deprecated.
|
CompletableFuture<PublishRate> |
getPublishRateAsync(String topic)
Deprecated.
|
Map<String,Boolean> |
getReplicatedSubscriptionStatus(String topic,
String subName)
Get replicated subscription status on a topic.
|
CompletableFuture<Map<String,Boolean>> |
getReplicatedSubscriptionStatusAsync(String topic,
String subName)
Get replicated subscription status on a topic asynchronously.
|
Set<String> |
getReplicationClusters(String topic,
boolean applied)
Get the replication clusters for a topic.
|
CompletableFuture<Set<String>> |
getReplicationClustersAsync(String topic,
boolean applied)
Get the replication clusters for a topic asynchronously.
|
DispatchRate |
getReplicatorDispatchRate(String topic)
Deprecated.
|
DispatchRate |
getReplicatorDispatchRate(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<DispatchRate> |
getReplicatorDispatchRateAsync(String topic)
Deprecated.
|
CompletableFuture<DispatchRate> |
getReplicatorDispatchRateAsync(String topic,
boolean applied)
Deprecated.
|
RetentionPolicies |
getRetention(String topic)
Deprecated.
|
RetentionPolicies |
getRetention(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<RetentionPolicies> |
getRetentionAsync(String topic)
Deprecated.
|
CompletableFuture<RetentionPolicies> |
getRetentionAsync(String topic,
boolean applied)
Deprecated.
|
default TopicStats |
getStats(String topic) |
default TopicStats |
getStats(String topic,
boolean getPreciseBacklog) |
default TopicStats |
getStats(String topic,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize) |
default TopicStats |
getStats(String topic,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize,
boolean getEarliestTimeInBacklog) |
TopicStats |
getStats(String topic,
GetStatsOptions getStatsOptions)
Get the stats for the topic.
|
default CompletableFuture<TopicStats> |
getStatsAsync(String topic) |
CompletableFuture<TopicStats> |
getStatsAsync(String topic,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize,
boolean getEarliestTimeInBacklog)
Get the stats for the topic asynchronously.
|
SubscribeRate |
getSubscribeRate(String topic)
Deprecated.
|
SubscribeRate |
getSubscribeRate(String topic,
boolean applied)
Deprecated.
|
CompletableFuture<SubscribeRate> |
getSubscribeRateAsync(String topic)
Deprecated.
|
CompletableFuture<SubscribeRate> |
getSubscribeRateAsync(String topic,
boolean applied)
Deprecated.
|
DispatchRate |
getSubscriptionDispatchRate(String topic)
Deprecated.
|
DispatchRate |
getSubscriptionDispatchRate(String namespace,
boolean applied)
Deprecated.
|
CompletableFuture<DispatchRate> |
getSubscriptionDispatchRateAsync(String topic)
Deprecated.
|
CompletableFuture<DispatchRate> |
getSubscriptionDispatchRateAsync(String namespace,
boolean applied)
Deprecated.
|
List<String> |
getSubscriptions(String topic)
Get the list of subscriptions.
|
CompletableFuture<List<String>> |
getSubscriptionsAsync(String topic)
Get the list of subscriptions asynchronously.
|
Set<SubscriptionType> |
getSubscriptionTypesEnabled(String topic)
Deprecated.
|
CompletableFuture<Set<SubscriptionType>> |
getSubscriptionTypesEnabledAsync(String topic)
Deprecated.
|
void |
grantPermission(String topic,
String role,
Set<AuthAction> actions)
Grant permission on a topic.
|
CompletableFuture<Void> |
grantPermissionAsync(String topic,
String role,
Set<AuthAction> actions)
Grant permission on a topic asynchronously.
|
OffloadProcessStatus |
offloadStatus(String topic)
Check the status of an ongoing offloading operation for a topic.
|
CompletableFuture<OffloadProcessStatus> |
offloadStatusAsync(String topic)
Check the status of an ongoing offloading operation for a topic asynchronously.
|
List<Message<byte[]>> |
peekMessages(String topic,
String subName,
int numMessages)
Peek messages from a topic subscription.
|
CompletableFuture<List<Message<byte[]>>> |
peekMessagesAsync(String topic,
String subName,
int numMessages)
Peek messages from a topic subscription asynchronously.
|
default void |
removeBacklogQuota(String topic)
Deprecated.
|
void |
removeBacklogQuota(String topic,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Deprecated.
|
void |
removeCompactionThreshold(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeCompactionThresholdAsync(String topic)
Deprecated.
|
void |
removeDeduplicationSnapshotInterval(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeDeduplicationSnapshotIntervalAsync(String topic)
Deprecated.
|
void |
removeDeduplicationStatus(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeDeduplicationStatusAsync(String topic)
Deprecated.
|
void |
removeDelayedDeliveryPolicy(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeDelayedDeliveryPolicyAsync(String topic)
Deprecated.
|
void |
removeDispatchRate(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeDispatchRateAsync(String topic)
Deprecated.
|
void |
removeInactiveTopicPolicies(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeInactiveTopicPoliciesAsync(String topic)
Deprecated.
|
void |
removeMaxConsumers(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxConsumersAsync(String topic)
Deprecated.
|
void |
removeMaxConsumersPerSubscription(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxConsumersPerSubscriptionAsync(String topic)
Deprecated.
|
void |
removeMaxMessageSize(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxMessageSizeAsync(String topic)
Deprecated.
|
void |
removeMaxProducers(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxProducersAsync(String topic)
Deprecated.
|
void |
removeMaxSubscriptionsPerTopic(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxSubscriptionsPerTopicAsync(String topic)
Deprecated.
|
void |
removeMaxUnackedMessagesOnConsumer(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxUnackedMessagesOnConsumerAsync(String topic)
Deprecated.
|
void |
removeMaxUnackedMessagesOnSubscription(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeMaxUnackedMessagesOnSubscriptionAsync(String topic)
Deprecated.
|
void |
removeMessageTTL(String topic)
Deprecated.
|
void |
removeOffloadPolicies(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeOffloadPoliciesAsync(String topic)
Deprecated.
|
void |
removePersistence(String topic)
Deprecated.
|
CompletableFuture<Void> |
removePersistenceAsync(String topic)
Deprecated.
|
void |
removePublishRate(String topic)
Deprecated.
|
CompletableFuture<Void> |
removePublishRateAsync(String topic)
Deprecated.
|
void |
removeReplicationClusters(String topic)
Remove the replication clusters for the topic.
|
CompletableFuture<Void> |
removeReplicationClustersAsync(String topic)
Remove the replication clusters for the topic asynchronously.
|
void |
removeReplicatorDispatchRate(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeReplicatorDispatchRateAsync(String topic)
Deprecated.
|
void |
removeRetention(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeRetentionAsync(String topic)
Deprecated.
|
void |
removeSubscribeRate(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeSubscribeRateAsync(String topic)
Deprecated.
|
void |
removeSubscriptionDispatchRate(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeSubscriptionDispatchRateAsync(String topic)
Deprecated.
|
void |
removeSubscriptionTypesEnabled(String topic)
Deprecated.
|
CompletableFuture<Void> |
removeSubscriptionTypesEnabledAsync(String topic)
Deprecated.
|
void |
resetCursor(String topic,
String subName,
long timestamp)
Reset cursor position on a topic subscription.
|
void |
resetCursor(String topic,
String subName,
MessageId messageId)
Reset cursor position on a topic subscription.
|
void |
resetCursor(String topic,
String subName,
MessageId messageId,
boolean isExcluded)
Reset cursor position on a topic subscription.
|
CompletableFuture<Void> |
resetCursorAsync(String topic,
String subName,
long timestamp)
Reset cursor position on a topic subscription.
|
CompletableFuture<Void> |
resetCursorAsync(String topic,
String subName,
MessageId messageId)
Reset cursor position on a topic subscription.
|
CompletableFuture<Void> |
resetCursorAsync(String topic,
String subName,
MessageId messageId,
boolean isExcluded)
Reset cursor position on a topic subscription.
|
void |
revokePermissions(String topic,
String role)
Revoke permissions on a topic.
|
CompletableFuture<Void> |
revokePermissionsAsync(String topic,
String role)
Revoke permissions on a topic asynchronously.
|
default void |
setBacklogQuota(String topic,
BacklogQuota backlogQuota)
Deprecated.
|
void |
setBacklogQuota(String topic,
BacklogQuota backlogQuota,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Deprecated.
|
void |
setCompactionThreshold(String topic,
long compactionThreshold)
Deprecated.
|
CompletableFuture<Void> |
setCompactionThresholdAsync(String topic,
long compactionThreshold)
Deprecated.
|
void |
setDeduplicationSnapshotInterval(String topic,
int interval)
Deprecated.
|
CompletableFuture<Void> |
setDeduplicationSnapshotIntervalAsync(String topic,
int interval)
Deprecated.
|
void |
setDeduplicationStatus(String topic,
boolean enabled)
Deprecated.
|
CompletableFuture<Void> |
setDeduplicationStatusAsync(String topic,
boolean enabled)
Deprecated.
|
void |
setDelayedDeliveryPolicy(String topic,
DelayedDeliveryPolicies delayedDeliveryPolicies)
Deprecated.
|
CompletableFuture<Void> |
setDelayedDeliveryPolicyAsync(String topic,
DelayedDeliveryPolicies delayedDeliveryPolicies)
Deprecated.
|
void |
setDispatchRate(String topic,
DispatchRate dispatchRate)
Deprecated.
|
CompletableFuture<Void> |
setDispatchRateAsync(String topic,
DispatchRate dispatchRate)
Deprecated.
|
void |
setInactiveTopicPolicies(String topic,
InactiveTopicPolicies inactiveTopicPolicies)
Deprecated.
|
CompletableFuture<Void> |
setInactiveTopicPoliciesAsync(String topic,
InactiveTopicPolicies inactiveTopicPolicies)
Deprecated.
|
void |
setMaxConsumers(String topic,
int maxConsumers)
Deprecated.
|
CompletableFuture<Void> |
setMaxConsumersAsync(String topic,
int maxConsumers)
Deprecated.
|
void |
setMaxConsumersPerSubscription(String topic,
int maxConsumersPerSubscription)
Deprecated.
|
CompletableFuture<Void> |
setMaxConsumersPerSubscriptionAsync(String topic,
int maxConsumersPerSubscription)
Deprecated.
|
void |
setMaxMessageSize(String topic,
int maxMessageSize)
Deprecated.
|
CompletableFuture<Void> |
setMaxMessageSizeAsync(String topic,
int maxMessageSize)
Deprecated.
|
void |
setMaxProducers(String topic,
int maxProducers)
Deprecated.
|
CompletableFuture<Void> |
setMaxProducersAsync(String topic,
int maxProducers)
Deprecated.
|
void |
setMaxSubscriptionsPerTopic(String topic,
int maxSubscriptionsPerTopic)
Deprecated.
|
CompletableFuture<Void> |
setMaxSubscriptionsPerTopicAsync(String topic,
int maxSubscriptionsPerTopic)
Deprecated.
|
void |
setMaxUnackedMessagesOnConsumer(String topic,
int maxNum)
Deprecated.
|
CompletableFuture<Void> |
setMaxUnackedMessagesOnConsumerAsync(String topic,
int maxNum)
Deprecated.
|
void |
setMaxUnackedMessagesOnSubscription(String topic,
int maxNum)
Deprecated.
|
CompletableFuture<Void> |
setMaxUnackedMessagesOnSubscriptionAsync(String topic,
int maxNum)
Deprecated.
|
void |
setMessageTTL(String topic,
int messageTTLInSecond)
Deprecated.
|
void |
setOffloadPolicies(String topic,
OffloadPolicies offloadPolicies)
Deprecated.
|
CompletableFuture<Void> |
setOffloadPoliciesAsync(String topic,
OffloadPolicies offloadPolicies)
Deprecated.
|
void |
setPersistence(String topic,
PersistencePolicies persistencePolicies)
Deprecated.
|
CompletableFuture<Void> |
setPersistenceAsync(String topic,
PersistencePolicies persistencePolicies)
Deprecated.
|
void |
setPublishRate(String topic,
PublishRate publishMsgRate)
Deprecated.
|
CompletableFuture<Void> |
setPublishRateAsync(String topic,
PublishRate publishMsgRate)
Deprecated.
|
void |
setReplicatedSubscriptionStatus(String topic,
String subName,
boolean enabled)
Enable or disable a replicated subscription on a topic.
|
CompletableFuture<Void> |
setReplicatedSubscriptionStatusAsync(String topic,
String subName,
boolean enabled)
Enable or disable a replicated subscription on a topic asynchronously.
|
void |
setReplicationClusters(String topic,
List<String> clusterIds)
Set the replication clusters for the topic.
|
CompletableFuture<Void> |
setReplicationClustersAsync(String topic,
List<String> clusterIds)
Set the replication clusters for the topic asynchronously.
|
void |
setReplicatorDispatchRate(String topic,
DispatchRate dispatchRate)
Deprecated.
|
CompletableFuture<Void> |
setReplicatorDispatchRateAsync(String topic,
DispatchRate dispatchRate)
Deprecated.
|
void |
setRetention(String topic,
RetentionPolicies retention)
Deprecated.
|
CompletableFuture<Void> |
setRetentionAsync(String topic,
RetentionPolicies retention)
Deprecated.
|
void |
setSubscribeRate(String topic,
SubscribeRate subscribeRate)
Deprecated.
|
CompletableFuture<Void> |
setSubscribeRateAsync(String topic,
SubscribeRate subscribeRate)
Deprecated.
|
void |
setSubscriptionDispatchRate(String topic,
DispatchRate dispatchRate)
Deprecated.
|
CompletableFuture<Void> |
setSubscriptionDispatchRateAsync(String topic,
DispatchRate dispatchRate)
Deprecated.
|
void |
setSubscriptionTypesEnabled(String topic,
Set<SubscriptionType> subscriptionTypesEnabled)
Deprecated.
|
CompletableFuture<Void> |
setSubscriptionTypesEnabledAsync(String topic,
Set<SubscriptionType> subscriptionTypesEnabled)
Deprecated.
|
void |
skipAllMessages(String topic,
String subName)
Skip all messages on a topic subscription.
|
CompletableFuture<Void> |
skipAllMessagesAsync(String topic,
String subName)
Skip all messages on a topic subscription asynchronously.
|
void |
skipMessages(String topic,
String subName,
long numMessages)
Skip messages on a topic subscription.
|
CompletableFuture<Void> |
skipMessagesAsync(String topic,
String subName,
long numMessages)
Skip messages on a topic subscription asynchronously.
|
MessageId |
terminateTopic(String topic)
Terminate the topic and prevent any more messages being published on it.
|
CompletableFuture<MessageId> |
terminateTopicAsync(String topic)
Terminate the topic and prevent any more messages being published on it.
|
void |
triggerCompaction(String topic)
Trigger compaction to run for a topic.
|
CompletableFuture<Void> |
triggerCompactionAsync(String topic)
Trigger compaction to run for a topic asynchronously.
|
void |
triggerOffload(String topic,
MessageId messageId)
Trigger offloading messages in topic to longterm storage.
|
CompletableFuture<Void> |
triggerOffloadAsync(String topic,
MessageId messageId)
Trigger offloading messages in topic to longterm storage asynchronously.
|
void |
truncate(String topic)
Truncate a topic.
|
CompletableFuture<Void> |
truncateAsync(String topic)
Truncate a topic asynchronously.
|
void |
unload(String topic)
Unload a topic.
|
CompletableFuture<Void> |
unloadAsync(String topic)
Unload a topic asynchronously.
|
void |
updatePartitionedTopic(String topic,
int numPartitions)
Update number of partitions of a non-global partitioned topic.
|
void |
updatePartitionedTopic(String topic,
int numPartitions,
boolean updateLocalTopicOnly)
Update number of partitions of a non-global partitioned topic.
|
void |
updatePartitionedTopic(String topic,
int numPartitions,
boolean updateLocalTopicOnly,
boolean force)
Update number of partitions of a non-global partitioned topic.
|
CompletableFuture<Void> |
updatePartitionedTopicAsync(String topic,
int numPartitions)
Update number of partitions of a non-global partitioned topic asynchronously.
|
CompletableFuture<Void> |
updatePartitionedTopicAsync(String topic,
int numPartitions,
boolean updateLocalTopicOnly)
Update number of partitions of a non-global partitioned topic asynchronously.
|
CompletableFuture<Void> |
updatePartitionedTopicAsync(String topic,
int numPartitions,
boolean updateLocalTopicOnly,
boolean force)
Update number of partitions of a non-global partitioned topic asynchronously.
|
List<String> getList(String namespace) throws PulsarAdminException
["topic://my-tenant/my-namespace/topic-1",
"topic://my-tenant/my-namespace/topic-2"]
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorList<String> getList(String namespace, TopicDomain topicDomain) throws PulsarAdminException
["topic://my-tenant/my-namespace/topic-1",
"topic://my-tenant/my-namespace/topic-2"]
namespace - Namespace nametopicDomain - use TopicDomain.persistent to get persistent topics
use TopicDomain.non_persistent to get non-persistent topics
Use null to get both persistent and non-persistent topicsPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getListAsync(String namespace)
["topic://my-tenant/my-namespace/topic-1",
"topic://my-tenant/my-namespace/topic-2"]
namespace - Namespace nameCompletableFuture<List<String>> getListAsync(String namespace, TopicDomain topicDomain)
["topic://my-tenant/my-namespace/topic-1",
"topic://my-tenant/my-namespace/topic-2"]
namespace - Namespace nametopicDomain - use TopicDomain.persistent to get persistent topics
use TopicDomain.non_persistent to get non-persistent topics
Use null to get both persistent and non-persistent topicsList<String> getPartitionedTopicList(String namespace) throws PulsarAdminException
["persistent://my-tenant/my-namespace/topic-1",
"persistent://my-tenant/my-namespace/topic-2"]
namespace - Namespace namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getPartitionedTopicListAsync(String namespace)
["persistent://my-tenant/my-namespace/topic-1",
"persistent://my-tenant/my-namespace/topic-2"]
namespace - Namespace nameList<String> getListInBundle(String namespace, String bundleRange) throws PulsarAdminException
namespace - bundleRange - PulsarAdminExceptionCompletableFuture<List<String>> getListInBundleAsync(String namespace, String bundleRange)
namespace - bundleRange - Map<String,Set<AuthAction>> getPermissions(String topic) throws PulsarAdminException
{
"role-1" : [ "produce" ],
"role-2" : [ "consume" ]
}
topic - Topic urlPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected errorCompletableFuture<Map<String,Set<AuthAction>>> getPermissionsAsync(String topic)
{
"role-1" : [ "produce" ],
"role-2" : [ "consume" ]
}
topic - Topic urlvoid grantPermission(String topic, String role, Set<AuthAction> actions) throws PulsarAdminException
["produce", "consume"]
topic - Topic urlrole - 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> grantPermissionAsync(String topic, String role, Set<AuthAction> actions)
["produce", "consume"]
topic - Topic urlrole - Client role to which grant permissionactions - Auth actions (produce and consume)void revokePermissions(String topic, String role) throws PulsarAdminException
topic - Topic urlrole - Client role to which remove permissionPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException.PreconditionFailedException - Permissions are not set at the topic levelPulsarAdminException - Unexpected errorCompletableFuture<Void> revokePermissionsAsync(String topic, String role)
topic - Topic urlrole - Client role to which remove permissionvoid createPartitionedTopic(String topic, int numPartitions) throws PulsarAdminException
topic - Topic namenumPartitions - Number of partitions to create of the topicPulsarAdminExceptionCompletableFuture<Void> createPartitionedTopicAsync(String topic, int numPartitions)
topic - Topic namenumPartitions - Number of partitions to create of the topicvoid createNonPartitionedTopic(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminExceptionCompletableFuture<Void> createNonPartitionedTopicAsync(String topic)
topic - Topic namevoid createMissedPartitions(String topic) throws PulsarAdminException
topic - partitioned topic namePulsarAdminExceptionCompletableFuture<Void> createMissedPartitionsAsync(String topic)
topic - partitioned topic namevoid updatePartitionedTopic(String topic, int numPartitions) throws PulsarAdminException
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicPulsarAdminExceptionCompletableFuture<Void> updatePartitionedTopicAsync(String topic, int numPartitions)
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicvoid updatePartitionedTopic(String topic, int numPartitions, boolean updateLocalTopicOnly, boolean force) throws PulsarAdminException
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicupdateLocalTopicOnly - Used by broker for global topic with multiple replicated clustersforce - Update forcefully without validating existing partitioned topicPulsarAdminExceptionCompletableFuture<Void> updatePartitionedTopicAsync(String topic, int numPartitions, boolean updateLocalTopicOnly, boolean force)
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicupdateLocalTopicOnly - Used by broker for global topic with multiple replicated clustersforce - Update forcefully without validating existing partitioned topicvoid updatePartitionedTopic(String topic, int numPartitions, boolean updateLocalTopicOnly) throws PulsarAdminException
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicupdateLocalTopicOnly - Used by broker for global topic with multiple replicated clustersPulsarAdminExceptionCompletableFuture<Void> updatePartitionedTopicAsync(String topic, int numPartitions, boolean updateLocalTopicOnly)
topic - Topic namenumPartitions - Number of new partitions of already exist partitioned-topicupdateLocalTopicOnly - Used by broker for global topic with multiple replicated clustersPartitionedTopicMetadata getPartitionedTopicMetadata(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminExceptionCompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadataAsync(String topic)
topic - Topic namevoid deletePartitionedTopic(String topic, boolean force, boolean deleteSchema) throws PulsarAdminException
topic - Topic nameforce - Delete topic forcefullydeleteSchema - Delete topic's schema storagePulsarAdminExceptiondefault void deletePartitionedTopic(String topic, boolean force) throws PulsarAdminException
PulsarAdminExceptiondeletePartitionedTopic(String, boolean, boolean)CompletableFuture<Void> deletePartitionedTopicAsync(String topic, boolean force, boolean deleteSchema)
topic - Topic nameforce - Delete topic forcefullydeleteSchema - Delete topic's schema storagedefault CompletableFuture<Void> deletePartitionedTopicAsync(String topic, boolean force)
void deletePartitionedTopic(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminExceptionCompletableFuture<Void> deletePartitionedTopicAsync(String topic)
topic - Topic namevoid delete(String topic, boolean force, boolean deleteSchema) throws PulsarAdminException
topic - Topic nameforce - Delete topic forcefullydeleteSchema - Delete topic's schema storagePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException.PreconditionFailedException - Topic has active subscriptions or producersPulsarAdminException - Unexpected errordefault void delete(String topic, boolean force) throws PulsarAdminException
PulsarAdminExceptiondelete(String, boolean, boolean)CompletableFuture<Void> deleteAsync(String topic, boolean force, boolean deleteSchema)
topic - topic nameforce - Delete topic forcefullydeleteSchema - Delete topic's schema storagedefault CompletableFuture<Void> deleteAsync(String topic, boolean force)
deleteAsync(String, boolean, boolean)void delete(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException.PreconditionFailedException - Topic has active subscriptions or producersPulsarAdminException - Unexpected errorCompletableFuture<Void> deleteAsync(String topic)
topic - Topic namevoid unload(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - topic does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> unloadAsync(String topic)
topic - topic nameMessageId terminateTopic(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - topic does not existPulsarAdminException - Unexpected errorCompletableFuture<MessageId> terminateTopicAsync(String topic)
topic - topic nameList<String> getSubscriptions(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorCompletableFuture<List<String>> getSubscriptionsAsync(String topic)
topic - topic nameTopicStats getStats(String topic, GetStatsOptions getStatsOptions) throws PulsarAdminException
{
"msgRateIn" : 100.0, // Total rate of messages published on the topic. msg/s
"msgThroughputIn" : 10240.0, // Total throughput of messages published on the topic. byte/s
"msgRateOut" : 100.0, // Total rate of messages delivered on the topic. msg/s
"msgThroughputOut" : 10240.0, // Total throughput of messages delivered on the topic. byte/s
"averageMsgSize" : 1024.0, // Average size of published messages. bytes
"publishers" : [ // List of publishes on this topic with their stats
{
"producerId" : 10 // producer id
"address" : 10.4.1.23:3425 // IP and port for this producer
"connectedSince" : 2014-11-21 23:54:46 // Timestamp of this published connection
"msgRateIn" : 100.0, // Total rate of messages published by this producer. msg/s
"msgThroughputIn" : 10240.0, // Total throughput of messages published by this producer. byte/s
"averageMsgSize" : 1024.0, // Average size of published messages by this producer. bytes
},
],
"subscriptions" : { // Map of subscriptions on this topic
"sub1" : {
"msgRateOut" : 100.0, // Total rate of messages delivered on this subscription. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered on this subscription. bytes/s
"msgBacklog" : 0, // Number of messages in the subscriotion backlog
"type" : Exclusive // Whether the subscription is exclusive or shared
"consumers" [ // List of consumers on this subscription
{
"id" : 5 // Consumer id
"address" : 10.4.1.23:3425 // IP and port for this consumer
"connectedSince" : 2014-11-21 23:54:46 // Timestamp of this consumer connection
"msgRateOut" : 100.0, // Total rate of messages delivered to this consumer. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered to this consumer. bytes/s
}
],
},
"replication" : { // Replication statistics
"cluster_1" : { // Cluster name in the context of from-cluster or to-cluster
"msgRateIn" : 100.0, // Total rate of messages received from this remote cluster. msg/s
"msgThroughputIn" : 10240.0, // Total throughput received from this remote cluster. bytes/s
"msgRateOut" : 100.0, // Total rate of messages delivered to the replication-subscriber. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered to the replication-subscriber. bytes/s
"replicationBacklog" : 0, // Number of messages pending to be replicated to this remote cluster
"connected" : true, // Whether the replication-subscriber is currently connected locally
},
"cluster_2" : {
"msgRateIn" : 100.0,
"msgThroughputIn" : 10240.0,
"msgRateOut" : 100.0,
"msgThroughputOut" : 10240.0,
"replicationBacklog" : 0,
"connected" : true,
}
},
}
All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
topic - topic namegetStatsOptions - get stats optionsPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errordefault TopicStats getStats(String topic, boolean getPreciseBacklog, boolean subscriptionBacklogSize, boolean getEarliestTimeInBacklog) throws PulsarAdminException
PulsarAdminExceptiondefault TopicStats getStats(String topic, boolean getPreciseBacklog, boolean subscriptionBacklogSize) throws PulsarAdminException
PulsarAdminExceptiondefault TopicStats getStats(String topic, boolean getPreciseBacklog) throws PulsarAdminException
PulsarAdminExceptiondefault TopicStats getStats(String topic) throws PulsarAdminException
PulsarAdminExceptionCompletableFuture<TopicStats> getStatsAsync(String topic, boolean getPreciseBacklog, boolean subscriptionBacklogSize, boolean getEarliestTimeInBacklog)
topic - topic namegetPreciseBacklog - Set to true to get precise backlog, Otherwise get imprecise backlog.subscriptionBacklogSize - Whether to get backlog size for each subscription.getEarliestTimeInBacklog - Whether to get the earliest time in backlog.default CompletableFuture<TopicStats> getStatsAsync(String topic)
PersistentTopicInternalStats getInternalStats(String topic, boolean metadata) throws PulsarAdminException
topic - topic namemetadata - flag to include ledger metadataPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorPersistentTopicInternalStats getInternalStats(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorCompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync(String topic, boolean metadata)
topic - topic Namemetadata - flag to include ledger metadataCompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync(String topic)
topic - topic NameString getInternalInfo(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorCompletableFuture<String> getInternalInfoAsync(String topic)
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorPartitionedTopicStats getPartitionedStats(String topic, boolean perPartition, boolean getPreciseBacklog, boolean subscriptionBacklogSize) throws PulsarAdminException
{
"msgRateIn" : 100.0, // Total rate of messages published on the partitioned topic. msg/s
"msgThroughputIn" : 10240.0, // Total throughput of messages published on the partitioned topic. byte/s
"msgRateOut" : 100.0, // Total rate of messages delivered on the partitioned topic. msg/s
"msgThroughputOut" : 10240.0, // Total throughput of messages delivered on the partitioned topic. byte/s
"averageMsgSize" : 1024.0, // Average size of published messages. bytes
"publishers" : [ // List of publishes on this partitioned topic with their stats
{
"msgRateIn" : 100.0, // Total rate of messages published by this producer. msg/s
"msgThroughputIn" : 10240.0, // Total throughput of messages published by this producer. byte/s
"averageMsgSize" : 1024.0, // Average size of published messages by this producer. bytes
},
],
"subscriptions" : { // Map of subscriptions on this topic
"sub1" : {
"msgRateOut" : 100.0, // Total rate of messages delivered on this subscription. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered on this subscription. bytes/s
"msgBacklog" : 0, // Number of messages in the subscriotion backlog
"type" : Exclusive // Whether the subscription is exclusive or shared
"consumers" [ // List of consumers on this subscription
{
"msgRateOut" : 100.0, // Total rate of messages delivered to this consumer. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered to this consumer. bytes/s
}
],
},
"replication" : { // Replication statistics
"cluster_1" : { // Cluster name in the context of from-cluster or to-cluster
"msgRateIn" : 100.0, // Total rate of messages received from this remote cluster. msg/s
"msgThroughputIn" : 10240.0, // Total throughput received from this remote cluster. bytes/s
"msgRateOut" : 100.0, // Total rate of messages delivered to the replication-subscriber. msg/s
"msgThroughputOut" : 10240.0, // Total throughput delivered to the replication-subscriber. bytes/s
"replicationBacklog" : 0, // Number of messages pending to be replicated to this remote cluster
"connected" : true, // Whether the replication-subscriber is currently connected locally
},
"cluster_2" : {
"msgRateIn" : 100.0,
"msgThroughputIn" : 10240.0,
"msgRateOut" : 100.0,
"msghroughputOut" : 10240.0,
"replicationBacklog" : 0,
"connected" : true,
}
},
}
All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
topic - topic nameperPartition - flag to get stats per partitiongetPreciseBacklog - Set to true to get precise backlog, Otherwise get imprecise backlog.subscriptionBacklogSize - Whether to get backlog size for each subscription.PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errordefault PartitionedTopicStats getPartitionedStats(String topic, boolean perPartition) throws PulsarAdminException
PulsarAdminExceptionCompletableFuture<PartitionedTopicStats> getPartitionedStatsAsync(String topic, boolean perPartition, boolean getPreciseBacklog, boolean subscriptionBacklogSize)
topic - topic NameperPartition - flag to get stats per partitiongetPreciseBacklog - Set to true to get precise backlog, Otherwise get imprecise backlog.subscriptionBacklogSize - Whether to get backlog size for each subscription.default CompletableFuture<PartitionedTopicStats> getPartitionedStatsAsync(String topic, boolean perPartition)
PartitionedTopicInternalStats getPartitionedInternalStats(String topic) throws PulsarAdminException
topic - topic namePulsarAdminExceptionCompletableFuture<PartitionedTopicInternalStats> getPartitionedInternalStatsAsync(String topic)
topic - topic Namevoid deleteSubscription(String topic, String subName) throws PulsarAdminException
topic - topic namesubName - Subscription namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException.PreconditionFailedException - Subscription has active consumersPulsarAdminException - Unexpected errorvoid deleteSubscription(String topic, String subName, boolean force) throws PulsarAdminException
topic - topic namesubName - Subscription nameforce - Delete topic forcefullyPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException.PreconditionFailedException - Subscription has active consumersPulsarAdminException - Unexpected errorCompletableFuture<Void> deleteSubscriptionAsync(String topic, String subName)
topic - topic namesubName - Subscription nameCompletableFuture<Void> deleteSubscriptionAsync(String topic, String subName, boolean force)
topic - topic namesubName - Subscription nameforce - Delete topic forcefullyvoid skipAllMessages(String topic, String subName) throws PulsarAdminException
topic - topic namesubName - Subscription namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> skipAllMessagesAsync(String topic, String subName)
topic - topic namesubName - Subscription namevoid skipMessages(String topic, String subName, long numMessages) throws PulsarAdminException
topic - topic namesubName - Subscription namenumMessages - Number of messagesPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException - Unexpected errorCompletableFuture<Void> skipMessagesAsync(String topic, String subName, long numMessages)
topic - topic namesubName - Subscription namenumMessages - Number of messagesvoid expireMessages(String topic, String subscriptionName, long expireTimeInSeconds) throws PulsarAdminException
topic - topic namesubscriptionName - Subscription nameexpireTimeInSeconds - Expire messages older than time in secondsPulsarAdminException - Unexpected errorCompletableFuture<Void> expireMessagesAsync(String topic, String subscriptionName, long expireTimeInSeconds)
topic - topic namesubscriptionName - Subscription nameexpireTimeInSeconds - Expire messages older than time in secondsvoid expireMessages(String topic, String subscriptionName, MessageId messageId, boolean isExcluded) throws PulsarAdminException
topic - topic namesubscriptionName - Subscription namemessageId - Position before which all messages will be expired.isExcluded - Will message at passed in position also be expired.PulsarAdminException - Unexpected errorCompletableFuture<Void> expireMessagesAsync(String topic, String subscriptionName, MessageId messageId, boolean isExcluded)
topic - topic namesubscriptionName - Subscription namemessageId - Position before which all messages will be expired.isExcluded - Will message at passed in position also be expired.CompletableFuture that'll be completed when expire message is done.void expireMessagesForAllSubscriptions(String topic, long expireTimeInSeconds) throws PulsarAdminException
topic - topic nameexpireTimeInSeconds - Expire messages older than time in secondsPulsarAdminException - Unexpected errorCompletableFuture<Void> expireMessagesForAllSubscriptionsAsync(String topic, long expireTimeInSeconds)
topic - topic nameexpireTimeInSeconds - Expire messages older than time in secondsList<Message<byte[]>> peekMessages(String topic, String subName, int numMessages) throws PulsarAdminException
topic - topic namesubName - Subscription namenumMessages - Number of messagesPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException - Unexpected errorCompletableFuture<List<Message<byte[]>>> peekMessagesAsync(String topic, String subName, int numMessages)
topic - topic namesubName - Subscription namenumMessages - Number of messagesMessage<byte[]> getMessageById(String topic, long ledgerId, long entryId) throws PulsarAdminException
topic - Topic nameledgerId - Ledger identryId - Entry idPulsarAdminException - Unexpected errorCompletableFuture<Message<byte[]>> getMessageByIdAsync(String topic, long ledgerId, long entryId)
topic - Topic nameledgerId - Ledger identryId - Entry idMessageId getMessageIdByTimestamp(String topic, long timestamp) throws PulsarAdminException
topic - Topic nametimestamp - TimestampPulsarAdminException - Unexpected errorCompletableFuture<MessageId> getMessageIdByTimestampAsync(String topic, long timestamp)
topic - Topic nametimestamp - Timestampvoid createSubscription(String topic, String subscriptionName, MessageId messageId) throws PulsarAdminException
topic - topic namesubscriptionName - Subscription namemessageId - The MessageId on where to initialize the subscription. It could be MessageId.latest,
MessageId.earliest or a specific message id.PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.ConflictException - Subscription already existsPulsarAdminException.NotAllowedException - Command disallowed for requested resourcePulsarAdminException - Unexpected errorCompletableFuture<Void> createSubscriptionAsync(String topic, String subscriptionName, MessageId messageId)
topic - topic namesubscriptionName - Subscription namemessageId - The MessageId on where to initialize the subscription. It could be MessageId.latest,
MessageId.earliest or a specific message id.void resetCursor(String topic, String subName, long timestamp) throws PulsarAdminException
topic - topic namesubName - Subscription nametimestamp - reset subscription to position closest to time in ms since epochPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException.NotAllowedException - Command disallowed for requested resourcePulsarAdminException - Unexpected errorvoid resetCursor(String topic, String subName, MessageId messageId, boolean isExcluded) throws PulsarAdminException
topic - subName - messageId - isExcluded - PulsarAdminExceptionCompletableFuture<Void> resetCursorAsync(String topic, String subName, long timestamp)
topic - topic namesubName - Subscription nametimestamp - reset subscription to position closest to time in ms since epochCompletableFuture<Void> resetCursorAsync(String topic, String subName, MessageId messageId, boolean isExcluded)
topic - subName - messageId - isExcluded - void resetCursor(String topic, String subName, MessageId messageId) throws PulsarAdminException
topic - topic namesubName - Subscription namemessageId - reset subscription to messageId (or previous nearest messageId if given messageId is not valid)PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic or subscription does not existPulsarAdminException.NotAllowedException - Command disallowed for requested resourcePulsarAdminException - Unexpected errorCompletableFuture<Void> resetCursorAsync(String topic, String subName, MessageId messageId)
topic - topic namesubName - Subscription namemessageId - reset subscription to messageId (or previous nearest messageId if given messageId is not valid)void triggerCompaction(String topic) throws PulsarAdminException
topic - The topic on which to trigger compactionPulsarAdminExceptionCompletableFuture<Void> triggerCompactionAsync(String topic)
topic - The topic on which to trigger compactionLongRunningProcessStatus compactionStatus(String topic) throws PulsarAdminException
topic - The topic whose compaction status we wish to checkPulsarAdminExceptionCompletableFuture<LongRunningProcessStatus> compactionStatusAsync(String topic)
topic - The topic whose compaction status we wish to checkvoid triggerOffload(String topic, MessageId messageId) throws PulsarAdminException
topic - the topic to offloadmessageId - ID of maximum message which should be offloadedPulsarAdminExceptionCompletableFuture<Void> triggerOffloadAsync(String topic, MessageId messageId)
topic - the topic to offloadmessageId - ID of maximum message which should be offloadedOffloadProcessStatus offloadStatus(String topic) throws PulsarAdminException
topic - the topic being offloadedPulsarAdminExceptionCompletableFuture<OffloadProcessStatus> offloadStatusAsync(String topic)
topic - the topic being offloadedMessageId getLastMessageId(String topic) throws PulsarAdminException
topic - the topic namePulsarAdminExceptionCompletableFuture<MessageId> getLastMessageIdAsync(String topic)
topic - the topic name@Deprecated Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String topic) throws PulsarAdminException
{
"namespace_memory" : {
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
},
"destination_storage" : {
"limit" : "-1",
"policy" : "producer_exception"
}
}
topic - Topic namePulsarAdminException.NotAuthorizedException - Permission deniedPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated Map<BacklogQuota.BacklogQuotaType,BacklogQuota> getBacklogQuotaMap(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminExceptionLong getBacklogSizeByMessageId(String topic, MessageId messageId) throws PulsarAdminException
topic - Topic namemessageId - message IDPulsarAdminException - Unexpected errorCompletableFuture<Long> getBacklogSizeByMessageIdAsync(String topic, MessageId messageId)
topic - Topic namemessageId - message ID@Deprecated void setBacklogQuota(String topic, BacklogQuota backlogQuota, BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException
Request parameter example:
{
"limit" : "134217728",
"policy" : "consumer_backlog_eviction"
}
topic - Topic namebacklogQuota - the new BacklogQuotabacklogQuotaType - PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated default void setBacklogQuota(String topic, BacklogQuota backlogQuota) throws PulsarAdminException
PulsarAdminException@Deprecated void removeBacklogQuota(String topic, BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException
topic - Topic namebacklogQuotaType - PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated default void removeBacklogQuota(String topic) throws PulsarAdminException
PulsarAdminException@Deprecated DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic, boolean applied)
topic - applied - @Deprecated DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic)
topic - @Deprecated void setDelayedDeliveryPolicy(String topic, DelayedDeliveryPolicies delayedDeliveryPolicies) throws PulsarAdminException
topic - delayedDeliveryPolicies - PulsarAdminException@Deprecated CompletableFuture<Void> setDelayedDeliveryPolicyAsync(String topic, DelayedDeliveryPolicies delayedDeliveryPolicies)
topic - delayedDeliveryPolicies - @Deprecated CompletableFuture<Void> removeDelayedDeliveryPolicyAsync(String topic)
topic - @Deprecated void removeDelayedDeliveryPolicy(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated void setMessageTTL(String topic, int messageTTLInSecond) throws PulsarAdminException
topic - Topic namemessageTTLInSecond - Message TTL in second.PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated Integer getMessageTTL(String topic) throws PulsarAdminException
topic - PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated Integer getMessageTTL(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException@Deprecated void removeMessageTTL(String topic) throws PulsarAdminException
topic - PulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected error@Deprecated void setRetention(String topic, RetentionPolicies retention) throws PulsarAdminException
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setRetentionAsync(String topic, RetentionPolicies retention)
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
topic - Topic name@Deprecated RetentionPolicies getRetention(String topic) throws PulsarAdminException
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected error@Deprecated CompletableFuture<RetentionPolicies> getRetentionAsync(String topic)
topic - Topic name@Deprecated RetentionPolicies getRetention(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<RetentionPolicies> getRetentionAsync(String topic, boolean applied)
topic - applied - @Deprecated void removeRetention(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException.ConflictException - Concurrent modificationPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeRetentionAsync(String topic)
{
"retentionTimeInMinutes" : 60, // how long to retain messages
"retentionSizeInMB" : 1024, // retention backlog limit
}
topic - Topic name@Deprecated Integer getMaxUnackedMessagesOnConsumer(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxUnackedMessagesOnConsumerAsync(String topic)
topic - @Deprecated Integer getMaxUnackedMessagesOnConsumer(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxUnackedMessagesOnConsumerAsync(String topic, boolean applied)
topic - applied - @Deprecated void setMaxUnackedMessagesOnConsumer(String topic, int maxNum) throws PulsarAdminException
topic - maxNum - PulsarAdminException@Deprecated CompletableFuture<Void> setMaxUnackedMessagesOnConsumerAsync(String topic, int maxNum)
topic - maxNum - @Deprecated void removeMaxUnackedMessagesOnConsumer(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeMaxUnackedMessagesOnConsumerAsync(String topic)
topic - @Deprecated InactiveTopicPolicies getInactiveTopicPolicies(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String topic, boolean applied)
topic - applied - @Deprecated InactiveTopicPolicies getInactiveTopicPolicies(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync(String topic)
topic - @Deprecated void setInactiveTopicPolicies(String topic, InactiveTopicPolicies inactiveTopicPolicies) throws PulsarAdminException
topic - inactiveTopicPolicies - PulsarAdminException@Deprecated CompletableFuture<Void> setInactiveTopicPoliciesAsync(String topic, InactiveTopicPolicies inactiveTopicPolicies)
topic - inactiveTopicPolicies - @Deprecated void removeInactiveTopicPolicies(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeInactiveTopicPoliciesAsync(String topic)
topic - @Deprecated OffloadPolicies getOffloadPolicies(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync(String topic)
topic - @Deprecated OffloadPolicies getOffloadPolicies(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync(String topic, boolean applied)
topic - @Deprecated void setOffloadPolicies(String topic, OffloadPolicies offloadPolicies) throws PulsarAdminException
topic - offloadPolicies - PulsarAdminException@Deprecated CompletableFuture<Void> setOffloadPoliciesAsync(String topic, OffloadPolicies offloadPolicies)
topic - offloadPolicies - @Deprecated void removeOffloadPolicies(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeOffloadPoliciesAsync(String topic)
topic - @Deprecated Integer getMaxUnackedMessagesOnSubscription(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxUnackedMessagesOnSubscriptionAsync(String topic)
topic - @Deprecated Integer getMaxUnackedMessagesOnSubscription(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxUnackedMessagesOnSubscriptionAsync(String topic, boolean applied)
topic - @Deprecated void setMaxUnackedMessagesOnSubscription(String topic, int maxNum) throws PulsarAdminException
topic - maxNum - PulsarAdminException@Deprecated CompletableFuture<Void> setMaxUnackedMessagesOnSubscriptionAsync(String topic, int maxNum)
topic - maxNum - @Deprecated void removeMaxUnackedMessagesOnSubscription(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeMaxUnackedMessagesOnSubscriptionAsync(String topic)
topic - @Deprecated void setPersistence(String topic, PersistencePolicies persistencePolicies) throws PulsarAdminException
topic - Topic namepersistencePolicies - Configuration of bookkeeper persistence policiesPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setPersistenceAsync(String topic, PersistencePolicies persistencePolicies)
topic - Topic namepersistencePolicies - Configuration of bookkeeper persistence policies@Deprecated PersistencePolicies getPersistence(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<PersistencePolicies> getPersistenceAsync(String topic)
topic - Topic name@Deprecated PersistencePolicies getPersistence(String topic, boolean applied) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<PersistencePolicies> getPersistenceAsync(String topic, boolean applied)
topic - Topic name@Deprecated void removePersistence(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removePersistenceAsync(String topic)
topic - Topic name@Deprecated Boolean getDeduplicationEnabled(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Boolean> getDeduplicationEnabledAsync(String topic)
topic - @Deprecated Boolean getDeduplicationStatus(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Boolean> getDeduplicationStatusAsync(String topic)
topic - @Deprecated Boolean getDeduplicationStatus(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Boolean> getDeduplicationStatusAsync(String topic, boolean applied)
topic - @Deprecated void enableDeduplication(String topic, boolean enabled) throws PulsarAdminException
topic - enabled - PulsarAdminException@Deprecated CompletableFuture<Void> enableDeduplicationAsync(String topic, boolean enabled)
topic - enabled - @Deprecated void setDeduplicationStatus(String topic, boolean enabled) throws PulsarAdminException
topic - enabled - PulsarAdminException@Deprecated CompletableFuture<Void> setDeduplicationStatusAsync(String topic, boolean enabled)
topic - enabled - @Deprecated void disableDeduplication(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> disableDeduplicationAsync(String topic)
topic - @Deprecated void removeDeduplicationStatus(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeDeduplicationStatusAsync(String topic)
topic - @Deprecated void setDispatchRate(String topic, DispatchRate dispatchRate) throws PulsarAdminException
topic - dispatchRate - number of messages per secondPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setDispatchRateAsync(String topic, DispatchRate dispatchRate)
topic - dispatchRate - number of messages per second@Deprecated DispatchRate getDispatchRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<DispatchRate> getDispatchRateAsync(String topic)
topic - @Deprecated DispatchRate getDispatchRate(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<DispatchRate> getDispatchRateAsync(String topic, boolean applied)
topic - @Deprecated void removeDispatchRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected error@Deprecated CompletableFuture<Void> removeDispatchRateAsync(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected error@Deprecated void setSubscriptionDispatchRate(String topic, DispatchRate dispatchRate) throws PulsarAdminException
topic - dispatchRate - number of messages per secondPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setSubscriptionDispatchRateAsync(String topic, DispatchRate dispatchRate)
topic - dispatchRate - number of messages per second@Deprecated DispatchRate getSubscriptionDispatchRate(String namespace, boolean applied) throws PulsarAdminException
namespace - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String namespace, boolean applied)
namespace - @Deprecated DispatchRate getSubscriptionDispatchRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync(String topic)
topic - @Deprecated void removeSubscriptionDispatchRate(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeSubscriptionDispatchRateAsync(String topic)
topic - Topic name@Deprecated void setReplicatorDispatchRate(String topic, DispatchRate dispatchRate) throws PulsarAdminException
topic - dispatchRate - number of messages per secondPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setReplicatorDispatchRateAsync(String topic, DispatchRate dispatchRate)
topic - dispatchRate - number of messages per second@Deprecated DispatchRate getReplicatorDispatchRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync(String topic)
topic - @Deprecated DispatchRate getReplicatorDispatchRate(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync(String topic, boolean applied)
topic - applied - @Deprecated void removeReplicatorDispatchRate(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeReplicatorDispatchRateAsync(String topic)
topic - Topic name@Deprecated Long getCompactionThreshold(String topic) throws PulsarAdminException
10000000
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Long> getCompactionThresholdAsync(String topic)
10000000
topic - Topic name@Deprecated Long getCompactionThreshold(String topic, boolean applied) throws PulsarAdminException
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Long> getCompactionThresholdAsync(String topic, boolean applied)
topic - Topic name@Deprecated void setCompactionThreshold(String topic, long compactionThreshold) throws PulsarAdminException
10000000
topic - Topic namecompactionThreshold - maximum number of backlog bytes before compaction is triggeredPulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setCompactionThresholdAsync(String topic, long compactionThreshold)
10000000
topic - Topic namecompactionThreshold - maximum number of backlog bytes before compaction is triggered@Deprecated void removeCompactionThreshold(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeCompactionThresholdAsync(String topic)
topic - Topic name@Deprecated void setPublishRate(String topic, PublishRate publishMsgRate) throws PulsarAdminException
topic - publishMsgRate - number of messages per secondPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setPublishRateAsync(String topic, PublishRate publishMsgRate)
topic - publishMsgRate - number of messages per second@Deprecated PublishRate getPublishRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<PublishRate> getPublishRateAsync(String topic)
topic - @Deprecated void removePublishRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected error@Deprecated CompletableFuture<Void> removePublishRateAsync(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected error@Deprecated Integer getMaxConsumersPerSubscription(String topic) throws PulsarAdminException
0
topic - Topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Integer> getMaxConsumersPerSubscriptionAsync(String topic)
0
topic - Topic name@Deprecated void setMaxConsumersPerSubscription(String topic, int maxConsumersPerSubscription) throws PulsarAdminException
10
topic - Topic namemaxConsumersPerSubscription - maxConsumersPerSubscription value for a namespacePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Namespace does not existPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setMaxConsumersPerSubscriptionAsync(String topic, int maxConsumersPerSubscription)
10
topic - Topic namemaxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace@Deprecated void removeMaxConsumersPerSubscription(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeMaxConsumersPerSubscriptionAsync(String topic)
topic - Topic name@Deprecated Integer getMaxProducers(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Integer> getMaxProducersAsync(String topic)
topic - Topic namePulsarAdminException - Unexpected error@Deprecated Integer getMaxProducers(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxProducersAsync(String topic, boolean applied)
topic - applied - @Deprecated void setMaxProducers(String topic, int maxProducers) throws PulsarAdminException
topic - Topic namemaxProducers - Max number of producerPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setMaxProducersAsync(String topic, int maxProducers)
topic - Topic namemaxProducers - Max number of producerPulsarAdminException - Unexpected error@Deprecated void removeMaxProducers(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeMaxProducersAsync(String topic)
topic - Topic name@Deprecated Integer getMaxSubscriptionsPerTopic(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Integer> getMaxSubscriptionsPerTopicAsync(String topic)
topic - Topic namePulsarAdminException - Unexpected error@Deprecated void setMaxSubscriptionsPerTopic(String topic, int maxSubscriptionsPerTopic) throws PulsarAdminException
topic - Topic namemaxSubscriptionsPerTopic - Max number of subscriptionsPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setMaxSubscriptionsPerTopicAsync(String topic, int maxSubscriptionsPerTopic)
topic - Topic namemaxSubscriptionsPerTopic - Max number of subscriptionsPulsarAdminException - Unexpected error@Deprecated void removeMaxSubscriptionsPerTopic(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeMaxSubscriptionsPerTopicAsync(String topic)
topic - Topic name@Deprecated Integer getMaxMessageSize(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Integer> getMaxMessageSizeAsync(String topic)
topic - Topic namePulsarAdminException - Unexpected error@Deprecated void setMaxMessageSize(String topic, int maxMessageSize) throws PulsarAdminException
topic - Topic namemaxMessageSize - Max message size of producerPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setMaxMessageSizeAsync(String topic, int maxMessageSize)
topic - Topic namemaxMessageSize - Max message size of topicPulsarAdminException - Unexpected error@Deprecated void removeMaxMessageSize(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeMaxMessageSizeAsync(String topic)
topic - Topic name@Deprecated Integer getMaxConsumers(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Integer> getMaxConsumersAsync(String topic)
topic - Topic namePulsarAdminException - Unexpected error@Deprecated Integer getMaxConsumers(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminException@Deprecated CompletableFuture<Integer> getMaxConsumersAsync(String topic, boolean applied)
topic - applied - @Deprecated void setMaxConsumers(String topic, int maxConsumers) throws PulsarAdminException
topic - Topic namemaxConsumers - Max number of consumerPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setMaxConsumersAsync(String topic, int maxConsumers)
topic - Topic namemaxConsumers - Max number of consumerPulsarAdminException - Unexpected error@Deprecated void removeMaxConsumers(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeMaxConsumersAsync(String topic)
topic - Topic name@Deprecated Integer getDeduplicationSnapshotInterval(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Integer> getDeduplicationSnapshotIntervalAsync(String topic)
topic - @Deprecated void setDeduplicationSnapshotInterval(String topic, int interval) throws PulsarAdminException
topic - interval - PulsarAdminException@Deprecated CompletableFuture<Void> setDeduplicationSnapshotIntervalAsync(String topic, int interval)
topic - interval - @Deprecated void removeDeduplicationSnapshotInterval(String topic) throws PulsarAdminException
topic - PulsarAdminException@Deprecated CompletableFuture<Void> removeDeduplicationSnapshotIntervalAsync(String topic)
topic - @Deprecated void setSubscriptionTypesEnabled(String topic, Set<SubscriptionType> subscriptionTypesEnabled) throws PulsarAdminException
topic - subscriptionTypesEnabled - is enable subTypesPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setSubscriptionTypesEnabledAsync(String topic, Set<SubscriptionType> subscriptionTypesEnabled)
topic - subscriptionTypesEnabled - is enable subTypes@Deprecated Set<SubscriptionType> getSubscriptionTypesEnabled(String topic) throws PulsarAdminException
topic - is topic for get is enable sub typesSetPulsarAdminException - Unexpected error@Deprecated CompletableFuture<Set<SubscriptionType>> getSubscriptionTypesEnabledAsync(String topic)
topic - is topic for get is enable sub types@Deprecated void removeSubscriptionTypesEnabled(String topic) throws PulsarAdminException
topic - Topic namePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> removeSubscriptionTypesEnabledAsync(String topic)
topic - Topic name@Deprecated void setSubscribeRate(String topic, SubscribeRate subscribeRate) throws PulsarAdminException
topic - subscribeRate - consumer subscribe limit by this subscribeRatePulsarAdminException - Unexpected error@Deprecated CompletableFuture<Void> setSubscribeRateAsync(String topic, SubscribeRate subscribeRate)
topic - subscribeRate - consumer subscribe limit by this subscribeRate@Deprecated SubscribeRate getSubscribeRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<SubscribeRate> getSubscribeRateAsync(String topic)
topic - @Deprecated SubscribeRate getSubscribeRate(String topic, boolean applied) throws PulsarAdminException
topic - PulsarAdminException - Unexpected error@Deprecated CompletableFuture<SubscribeRate> getSubscribeRateAsync(String topic, boolean applied)
topic - @Deprecated void removeSubscribeRate(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected error@Deprecated CompletableFuture<Void> removeSubscribeRateAsync(String topic) throws PulsarAdminException
topic - PulsarAdminException - unexpected errorMessage<byte[]> examineMessage(String topic, String initialPosition, long messagePosition) throws PulsarAdminException
topic - Topic nameinitialPosition - Relative start position to examine message. It can be 'latest' or 'earliest'messagePosition - The position of messages (default 1)PulsarAdminExceptionCompletableFuture<Message<byte[]>> examineMessageAsync(String topic, String initialPosition, long messagePosition) throws PulsarAdminException
topic - Topic nameinitialPosition - Relative start position to examine message. It can be 'latest' or 'earliest'messagePosition - The position of messages (default 1)PulsarAdminExceptionvoid truncate(String topic) throws PulsarAdminException
topic - topic namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException - Unexpected errorCompletableFuture<Void> truncateAsync(String topic)
topic - topic namevoid setReplicatedSubscriptionStatus(String topic, String subName, boolean enabled) throws PulsarAdminException
topic - subName - enabled - PulsarAdminExceptionCompletableFuture<Void> setReplicatedSubscriptionStatusAsync(String topic, String subName, boolean enabled)
topic - subName - enabled - Set<String> getReplicationClusters(String topic, boolean applied) throws PulsarAdminException
topic - applied - PulsarAdminExceptionCompletableFuture<Set<String>> getReplicationClustersAsync(String topic, boolean applied)
topic - applied - PulsarAdminExceptionvoid setReplicationClusters(String topic, List<String> clusterIds) throws PulsarAdminException
topic - clusterIds - PulsarAdminExceptionCompletableFuture<Void> setReplicationClustersAsync(String topic, List<String> clusterIds)
topic - clusterIds - PulsarAdminExceptionvoid removeReplicationClusters(String topic) throws PulsarAdminException
topic - PulsarAdminExceptionCompletableFuture<Void> removeReplicationClustersAsync(String topic)
topic - PulsarAdminExceptionMap<String,Boolean> getReplicatedSubscriptionStatus(String topic, String subName) throws PulsarAdminException
topic - topic namesubName - subscription namePulsarAdminException.NotAuthorizedException - Don't have admin permissionPulsarAdminException.NotFoundException - Topic does not existPulsarAdminException - Unexpected errorCopyright © 2017–2021 Apache Software Foundation. All rights reserved.