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

All Known Subinterfaces:

PersistentTopics

All Known Implementing Classes:

TopicsImpl
```
public interface Topics
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompactionStatus`	`compactionStatus(String topic)` Check the status of an ongoing compaction for a topic.
`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.
`void`	`delete(String topic, boolean force)` Delete a topic.
`CompletableFuture<Void>`	`deleteAsync(String topic, boolean force)` Delete a topic asynchronously.
`void`	`deletePartitionedTopic(String topic)` Delete a partitioned topic.
`void`	`deletePartitionedTopic(String topic, boolean force)` Delete a partitioned topic.
`CompletableFuture<Void>`	`deletePartitionedTopicAsync(String topic, boolean force)` Delete a partitioned topic asynchronously.
`void`	`deleteSubscription(String topic, String subName)` Delete a subscription.
`CompletableFuture<Void>`	`deleteSubscriptionAsync(String topic, String subName)` Delete a subscription asynchronously.
`void`	`expireMessages(String topic, String subscriptionName, long expireTimeInSeconds)` 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
`void`	`expireMessagesForAllSubscriptions(String topic, long expireTimeInSeconds)` Expire all messages older than given N (expireTimeInSeconds) seconds for all subscriptions of the persistent-topic
`CompletableFuture<Void>`	`expireMessagesForAllSubscriptionsAsync(String topic, long expireTimeInSeconds)` Expire all messages older than given N (expireTimeInSeconds) seconds for all subscriptions of the persistent-topic asynchronously
`com.google.gson.JsonObject`	`getInternalInfo(String topic)` Get a JSON representation of the topic metadata stored in ZooKeeper
`CompletableFuture<com.google.gson.JsonObject>`	`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.
`CompletableFuture<PersistentTopicInternalStats>`	`getInternalStatsAsync(String topic)` Get the internal stats for the topic asynchronously.
`List<String>`	`getList(String namespace)` Get the list of topics under a namespace.
`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.
`PartitionedTopicStats`	`getPartitionedStats(String topic, boolean perPartition)` Get the stats for the partitioned topic
`CompletableFuture<PartitionedTopicStats>`	`getPartitionedStatsAsync(String topic, boolean perPartition)` Get the stats for the partitioned topic asynchronously
`List<String>`	`getPartitionedTopicList(String namespace)` Get the list of partitioned topics under a namespace.
`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.
`TopicStats`	`getStats(String topic)` Get the stats for the topic.
`CompletableFuture<TopicStats>`	`getStatsAsync(String topic)` Get the stats for the topic asynchronously.
`List<String>`	`getSubscriptions(String topic)` Get the list of subscriptions.
`CompletableFuture<List<String>>`	`getSubscriptionsAsync(String topic)` Get the list of subscriptions asynchronously.
`void`	`grantPermission(String topic, String role, Set<AuthAction> actions)` Grant permission on a topic.
`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
`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
`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
`void`	`revokePermissions(String topic, String role)` Revoke permissions on a topic.
`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.
`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.
`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.
`CompletableFuture<Void>`	`updatePartitionedTopicAsync(String topic, int numPartitions)` Update number of partitions of a non-global partitioned topic asynchronously.

- Method Detail
  - getList
```
List<String> getList(String namespace)
              throws PulsarAdminException
```
    Get the list of topics under a namespace.
    Response example:
```
 ["topic://my-tenant/my-namespace/topic-1",
  "topic://my-tenant/my-namespace/topic-2"]
 
```
    Parameters:
    
    namespace - Namespace name
    
    Returns:
    
    a list of topics
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - getPartitionedTopicList
```
List<String> getPartitionedTopicList(String namespace)
                              throws PulsarAdminException
```
    Get the list of partitioned topics under a namespace.
    Response example:
```
 ["persistent://my-tenant/my-namespace/topic-1",
  "persistent://my-tenant/my-namespace/topic-2"]
 
```
    Parameters:
    
    namespace - Namespace name
    
    Returns:
    
    a list of partitioned topics
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - getListInBundle
```
List<String> getListInBundle(String namespace,
                             String bundleRange)
                      throws PulsarAdminException
```
    Get list of topics exist into given bundle
    
    Parameters:
    
    namespace -
    
    bundleRange -
    
    Returns:
    
    Throws:
    
    PulsarAdminException
  - getListInBundleAsync
```
CompletableFuture<List<String>> getListInBundleAsync(String namespace,
                                                     String bundleRange)
```
    Get list of topics exist into given bundle asynchronously.
    
    Parameters:
    
    namespace -
    
    bundleRange -
    
    Returns:
  - getPermissions
```
Map<String,Set<AuthAction>> getPermissions(String topic)
                                    throws PulsarAdminException
```
    Get permissions on a topic.
    Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic.
    Response Example:
```
 {
   "role-1" : [ "produce" ],
   "role-2" : [ "consume" ]
 }
 
```
    Parameters:
    
    topic - Topic url
    
    Returns:
    
    a map of topics an their permissions set
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException - Unexpected error
  - grantPermission
```
void grantPermission(String topic,
                     String role,
                     Set<AuthAction> actions)
              throws PulsarAdminException
```
    Grant permission on a topic.
    Grant a new permission to a client role on a single topic.
    Request parameter example:
```
 ["produce", "consume"]
 
```
    Parameters:
    
    topic - Topic url
    
    role - Client role to which grant permission
    
    actions - Auth actions (produce and consume)
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Namespace does not exist
    
    PulsarAdminException.ConflictException - Concurrent modification
    
    PulsarAdminException - Unexpected error
  - revokePermissions
```
void revokePermissions(String topic,
                       String role)
                throws PulsarAdminException
```
    Revoke permissions on a topic.
    Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412).
    
    Parameters:
    
    topic - Topic url
    
    role - Client role to which remove permission
    
    Throws:
    
    UniformInterfaceException - if the operations was not successful
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    NotFound - Namespace does not exist
    
    PulsarAdminException.PreconditionFailedException - Permissions are not set at the topic level
    
    PulsarAdminException - Unexpected error
  - createPartitionedTopic
```
void createPartitionedTopic(String topic,
                            int numPartitions)
                     throws PulsarAdminException
```
    Create a partitioned topic.
    Create a partitioned topic. It needs to be called before creating a producer for a partitioned topic.
    
    Parameters:
    
    topic - Topic name
    
    numPartitions - Number of partitions to create of the topic
    
    Throws:
    
    PulsarAdminException
  - createPartitionedTopicAsync
```
CompletableFuture<Void> createPartitionedTopicAsync(String topic,
                                                    int numPartitions)
```
    Create a partitioned topic asynchronously.
    Create a partitioned topic asynchronously. It needs to be called before creating a producer for a partitioned topic.
    
    Parameters:
    
    topic - Topic name
    
    numPartitions - Number of partitions to create of the topic
    
    Returns:
    
    a future that can be used to track when the partitioned topic is created
  - updatePartitionedTopic
```
void updatePartitionedTopic(String topic,
                            int numPartitions)
                     throws PulsarAdminException
```
    Update number of partitions of a non-global partitioned topic.
    It requires partitioned-topic to be already exist and number of new partitions must be greater than existing number of partitions. Decrementing number of partitions requires deletion of topic which is not supported.
    
    Parameters:
    
    topic - Topic name
    
    numPartitions - Number of new partitions of already exist partitioned-topic
    
    Throws:
    
    PulsarAdminException
  - updatePartitionedTopicAsync
```
CompletableFuture<Void> updatePartitionedTopicAsync(String topic,
                                                    int numPartitions)
```
    Update number of partitions of a non-global partitioned topic asynchronously.
    It requires partitioned-topic to be already exist and number of new partitions must be greater than existing number of partitions. Decrementing number of partitions requires deletion of topic which is not supported.
    
    Parameters:
    
    topic - Topic name
    
    numPartitions - Number of new partitions of already exist partitioned-topic
    
    Returns:
    
    a future that can be used to track when the partitioned topic is updated
  - getPartitionedTopicMetadata
```
PartitionedTopicMetadata getPartitionedTopicMetadata(String topic)
                                              throws PulsarAdminException
```
    Get metadata of a partitioned topic.
    Get metadata of a partitioned topic.
    
    Parameters:
    
    topic - Topic name
    
    Returns:
    
    Partitioned topic metadata
    
    Throws:
    
    PulsarAdminException
  - getPartitionedTopicMetadataAsync
```
CompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadataAsync(String topic)
```
    Get metadata of a partitioned topic asynchronously.
    Get metadata of a partitioned topic asynchronously.
    
    Parameters:
    
    topic - Topic name
    
    Returns:
    
    a future that can be used to track when the partitioned topic metadata is returned
  - deletePartitionedTopic
```
void deletePartitionedTopic(String topic,
                            boolean force)
                     throws PulsarAdminException
```
    Delete a partitioned topic.
    It will also delete all the partitions of the topic if it exists.
    
    Parameters:
    
    topic - Topic name
    
    force - Delete topic forcefully
    
    Throws:
    
    PulsarAdminException
  - deletePartitionedTopic
```
void deletePartitionedTopic(String topic)
                     throws PulsarAdminException
```
    Delete a partitioned topic.
    It will also delete all the partitions of the topic if it exists.
    
    Parameters:
    
    topic - Topic name
    
    Throws:
    
    PulsarAdminException
  - deletePartitionedTopicAsync
```
CompletableFuture<Void> deletePartitionedTopicAsync(String topic,
                                                    boolean force)
```
    Delete a partitioned topic asynchronously.
    It will also delete all the partitions of the topic if it exists.
    
    Parameters:
    
    topic - Topic name
    
    force - Delete topic forcefully
    
    Returns:
    
    a future that can be used to track when the partitioned topic is deleted
  - delete
```
void delete(String topic,
            boolean force)
     throws PulsarAdminException
```
    Delete a topic.
    Delete a topic. The topic cannot be deleted if force flag is disable and there's any active subscription or producer connected to the it. Force flag deletes topic forcefully by closing all active producers and consumers.
    
    Parameters:
    
    topic - Topic name
    
    force - Delete topic forcefully
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException.PreconditionFailedException - Topic has active subscriptions or producers
    
    PulsarAdminException - Unexpected error
  - delete
```
void delete(String topic)
     throws PulsarAdminException
```
    Delete a topic.
    Delete a topic. The topic cannot be deleted if there's any active subscription or producer connected to the it.
    
    Parameters:
    
    topic - Topic name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException.PreconditionFailedException - Topic has active subscriptions or producers
    
    PulsarAdminException - Unexpected error
  - deleteAsync
```
CompletableFuture<Void> deleteAsync(String topic,
                                    boolean force)
```
    Delete a topic asynchronously.
    Delete a topic asynchronously. The topic cannot be deleted if force flag is disable and there's any active subscription or producer connected to the it. Force flag deletes topic forcefully by closing all active producers and consumers.
    
    Parameters:
    
    topic - topic name
    
    force - Delete topic forcefully
    
    Returns:
    
    a future that can be used to track when the topic is deleted
  - unload
```
void unload(String topic)
     throws PulsarAdminException
```
    Unload a topic.
    
    Parameters:
    
    topic - topic name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - topic does not exist
    
    PulsarAdminException - Unexpected error
  - unloadAsync
```
CompletableFuture<Void> unloadAsync(String topic)
```
    Unload a topic asynchronously.
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    a future that can be used to track when the topic is unloaded
  - terminateTopicAsync
```
CompletableFuture<MessageId> terminateTopicAsync(String topic)
```
    Terminate the topic and prevent any more messages being published on it.
    This
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    the message id of the last message that was published in the topic
  - getSubscriptions
```
List<String> getSubscriptions(String topic)
                       throws PulsarAdminException
```
    Get the list of subscriptions.
    Get the list of persistent subscriptions for a given topic.
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    the list of subscriptions
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getSubscriptionsAsync
```
CompletableFuture<List<String>> getSubscriptionsAsync(String topic)
```
    Get the list of subscriptions asynchronously.
    Get the list of persistent subscriptions for a given topic.
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    a future that can be used to track when the list of subscriptions is returned
  - getStats
```
TopicStats getStats(String topic)
             throws PulsarAdminException
```
    Get the stats for the topic.
    Response Example:
```
 
 {
   "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,
       "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.
    Parameters:
    
    topic - topic name
    
    Returns:
    
    the topic statistics
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getStatsAsync
```
CompletableFuture<TopicStats> getStatsAsync(String topic)
```
    Get the stats for the topic asynchronously. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    a future that can be used to track when the topic statistics are returned
  - getInternalStats
```
PersistentTopicInternalStats getInternalStats(String topic)
                                       throws PulsarAdminException
```
    Get the internal stats for the topic.
    Access the internal state of the topic
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    the topic statistics
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getInternalStatsAsync
```
CompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync(String topic)
```
    Get the internal stats for the topic asynchronously.
    
    Parameters:
    
    topic - topic Name
    
    Returns:
    
    a future that can be used to track when the internal topic statistics are returned
  - getInternalInfo
```
com.google.gson.JsonObject getInternalInfo(String topic)
                                    throws PulsarAdminException
```
    Get a JSON representation of the topic metadata stored in ZooKeeper
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    the topic internal metadata
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getInternalInfoAsync
```
CompletableFuture<com.google.gson.JsonObject> getInternalInfoAsync(String topic)
```
    Get a JSON representation of the topic metadata stored in ZooKeeper
    
    Parameters:
    
    topic - topic name
    
    Returns:
    
    a future to receive the topic internal metadata
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getPartitionedStats
```
PartitionedTopicStats getPartitionedStats(String topic,
                                          boolean perPartition)
                                   throws PulsarAdminException
```
    Get the stats for the partitioned topic
    Response Example:
```
 
 {
   "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.
    Parameters:
    
    topic - topic name
    
    perPartition -
    
    Returns:
    
    the partitioned topic statistics
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic does not exist
    
    PulsarAdminException - Unexpected error
  - getPartitionedStatsAsync
```
CompletableFuture<PartitionedTopicStats> getPartitionedStatsAsync(String topic,
                                                                  boolean perPartition)
```
    Get the stats for the partitioned topic asynchronously
    
    Parameters:
    
    topic - topic Name
    
    perPartition - flag to get stats per partition
    
    Returns:
    
    a future that can be used to track when the partitioned topic statistics are returned
  - deleteSubscription
```
void deleteSubscription(String topic,
                        String subName)
                 throws PulsarAdminException
```
    Delete a subscription.
    Delete a persistent subscription from a topic. There should not be any active consumers on the subscription.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException.PreconditionFailedException - Subscription has active consumers
    
    PulsarAdminException - Unexpected error
  - deleteSubscriptionAsync
```
CompletableFuture<Void> deleteSubscriptionAsync(String topic,
                                                String subName)
```
    Delete a subscription asynchronously.
    Delete a persistent subscription from a topic. There should not be any active consumers on the subscription.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    Returns:
    
    a future that can be used to track when the subscription is deleted
  - skipAllMessages
```
void skipAllMessages(String topic,
                     String subName)
              throws PulsarAdminException
```
    Skip all messages on a topic subscription.
    Completely clears the backlog on the subscription.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException - Unexpected error
  - skipAllMessagesAsync
```
CompletableFuture<Void> skipAllMessagesAsync(String topic,
                                             String subName)
```
    Skip all messages on a topic subscription asynchronously.
    Completely clears the backlog on the subscription.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    Returns:
    
    a future that can be used to track when all the messages are skipped
  - skipMessages
```
void skipMessages(String topic,
                  String subName,
                  long numMessages)
           throws PulsarAdminException
```
    Skip messages on a topic subscription.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    numMessages - Number of messages
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException - Unexpected error
  - skipMessagesAsync
```
CompletableFuture<Void> skipMessagesAsync(String topic,
                                          String subName,
                                          long numMessages)
```
    Skip messages on a topic subscription asynchronously.
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    numMessages - Number of messages
    
    Returns:
    
    a future that can be used to track when the number of messages are skipped
  - expireMessages
```
void expireMessages(String topic,
                    String subscriptionName,
                    long expireTimeInSeconds)
             throws PulsarAdminException
```
    Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    expireTimeInSeconds - Expire messages older than time in seconds
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - expireMessagesAsync
```
CompletableFuture<Void> expireMessagesAsync(String topic,
                                            String subscriptionName,
                                            long expireTimeInSeconds)
```
    Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    expireTimeInSeconds - Expire messages older than time in seconds
    
    Returns:
  - expireMessagesForAllSubscriptions
```
void expireMessagesForAllSubscriptions(String topic,
                                       long expireTimeInSeconds)
                                throws PulsarAdminException
```
    Expire all messages older than given N (expireTimeInSeconds) seconds for all subscriptions of the persistent-topic
    
    Parameters:
    
    topic - topic name
    
    expireTimeInSeconds - Expire messages older than time in seconds
    
    Throws:
    
    PulsarAdminException - Unexpected error
  - expireMessagesForAllSubscriptionsAsync
```
CompletableFuture<Void> expireMessagesForAllSubscriptionsAsync(String topic,
                                                               long expireTimeInSeconds)
```
    Expire all messages older than given N (expireTimeInSeconds) seconds for all subscriptions of the persistent-topic asynchronously
    
    Parameters:
    
    topic - topic name
    
    expireTimeInSeconds - Expire messages older than time in seconds
  - peekMessages
```
List<Message<byte[]>> peekMessages(String topic,
                                   String subName,
                                   int numMessages)
                            throws PulsarAdminException
```
    Peek messages from a topic subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    numMessages - Number of messages
    
    Returns:
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException - Unexpected error
  - peekMessagesAsync
```
CompletableFuture<List<Message<byte[]>>> peekMessagesAsync(String topic,
                                                           String subName,
                                                           int numMessages)
```
    Peek messages from a topic subscription asynchronously
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    numMessages - Number of messages
    
    Returns:
    
    a future that can be used to track when the messages are returned
  - createSubscription
```
void createSubscription(String topic,
                        String subscriptionName,
                        MessageId messageId)
                 throws PulsarAdminException
```
    Create a new subscription on a topic
    
    Parameters:
    
    topic - topic name
    
    subscriptionName - Subscription name
    
    messageId - The MessageId on where to initialize the subscription. It could be MessageId.latest, MessageId.earliest or a specific message id.
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.ConflictException - Subscription already exists
    
    PulsarAdminException.NotAllowedException - Command disallowed for requested resource
    
    PulsarAdminException - Unexpected error
  - createSubscriptionAsync
```
CompletableFuture<Void> createSubscriptionAsync(String topic,
                                                String subscriptionName,
                                                MessageId messageId)
```
    Create a new subscription on a topic
    
    Parameters:
    
    topic - topic name
    
    subscriptionName - Subscription name
    
    messageId - The MessageId on where to initialize the subscription. It could be MessageId.latest, MessageId.earliest or a specific message id.
  - resetCursor
```
void resetCursor(String topic,
                 String subName,
                 long timestamp)
          throws PulsarAdminException
```
    Reset cursor position on a topic subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    timestamp - reset subscription to position closest to time in ms since epoch
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException.NotAllowedException - Command disallowed for requested resource
    
    PulsarAdminException - Unexpected error
  - resetCursorAsync
```
CompletableFuture<Void> resetCursorAsync(String topic,
                                         String subName,
                                         long timestamp)
```
    Reset cursor position on a topic subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    timestamp - reset subscription to position closest to time in ms since epoch
  - resetCursor
```
void resetCursor(String topic,
                 String subName,
                 MessageId messageId)
          throws PulsarAdminException
```
    Reset cursor position on a topic subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    messageId - reset subscription to messageId (or previous nearest messageId if given messageId is not valid)
    
    Throws:
    
    PulsarAdminException.NotAuthorizedException - Don't have admin permission
    
    PulsarAdminException.NotFoundException - Topic or subscription does not exist
    
    PulsarAdminException.NotAllowedException - Command disallowed for requested resource
    
    PulsarAdminException - Unexpected error
  - resetCursorAsync
```
CompletableFuture<Void> resetCursorAsync(String topic,
                                         String subName,
                                         MessageId messageId)
```
    Reset cursor position on a topic subscription
    
    Parameters:
    
    topic - topic name
    
    subName - Subscription name
    
    MessageId - reset subscription to messageId (or previous nearest messageId if given messageId is not valid)
  - triggerCompaction
```
void triggerCompaction(String topic)
                throws PulsarAdminException
```
    Trigger compaction to run for a topic. A single topic can only have one instance of compaction running at any time. Any attempt to trigger another will be met with a ConflictException.
    
    Parameters:
    
    topic - The topic on which to trigger compaction
    
    Throws:
    
    PulsarAdminException
  - compactionStatus
```
CompactionStatus compactionStatus(String topic)
                           throws PulsarAdminException
```
    Check the status of an ongoing compaction for a topic.
    
    Parameters:
    
    topic - The topic whose compaction status we wish to check
    
    Throws:
    
    PulsarAdminException

Interface Topics

Method Summary

Method Detail

getList

getPartitionedTopicList

getListInBundle

getListInBundleAsync

getPermissions

grantPermission

revokePermissions

createPartitionedTopic

createPartitionedTopicAsync

updatePartitionedTopic

updatePartitionedTopicAsync

getPartitionedTopicMetadata

getPartitionedTopicMetadataAsync

deletePartitionedTopic

deletePartitionedTopic

deletePartitionedTopicAsync

delete

delete

deleteAsync

unload

unloadAsync

terminateTopicAsync

getSubscriptions

getSubscriptionsAsync

getStats

getStatsAsync

getInternalStats

getInternalStatsAsync

getInternalInfo

getInternalInfoAsync

getPartitionedStats

getPartitionedStatsAsync

deleteSubscription

deleteSubscriptionAsync

skipAllMessages

skipAllMessagesAsync

skipMessages

skipMessagesAsync

expireMessages

expireMessagesAsync

expireMessagesForAllSubscriptions

expireMessagesForAllSubscriptionsAsync

peekMessages

peekMessagesAsync

createSubscription

createSubscriptionAsync

resetCursor

resetCursorAsync

resetCursor

resetCursorAsync

triggerCompaction

compactionStatus