Package org.apache.pulsar.client.admin

Interface Topics

  • public interface Topics
    Admin interface for Topics management.

    • Method Detail

      • getListAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getListAsync​(java.lang.String namespace)
        Get both persistent and non-persistent topics under a namespace asynchronously.

        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

      • getListAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getListAsync​(java.lang.String namespace,
                                                                                      TopicDomain topicDomain)
        Get the list of topics under a namespace asynchronously.

        Response example: 

         ["topic://my-tenant/my-namespace/topic-1",
  "topic://my-tenant/my-namespace/topic-2"]
        Parameters:
        namespace - Namespace name
        topicDomain - 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 topics
        Returns:
        a list of topics

      • getListAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getListAsync​(java.lang.String namespace,
                                                                                      TopicDomain topicDomain,
                                                                                      java.util.Map<Topics.QueryParam,​java.lang.Object> params)
        Get the list of topics under a namespace asynchronously.

        Response example: 

         ["topic://my-tenant/my-namespace/topic-1",
  "topic://my-tenant/my-namespace/topic-2"]
        Parameters:
        namespace - Namespace name
        topicDomain - 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 topics
        params - params to filter the results
        Returns:
        a list of topics

      • getPartitionedTopicListAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getPartitionedTopicListAsync​(java.lang.String namespace)
        Get the list of partitioned topics under a namespace asynchronously.

        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

      • getListInBundle

        java.util.List<java.lang.String> getListInBundle​(java.lang.String namespace,
                                                 java.lang.String bundleRange)
                                          throws PulsarAdminException
        Get list of topics exist into given bundle.
        Parameters:
        namespace -
        bundleRange -
        Returns:
        Throws:
        PulsarAdminException

      • getListInBundleAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getListInBundleAsync​(java.lang.String namespace,
                                                                                              java.lang.String bundleRange)
        Get list of topics exist into given bundle asynchronously.
        Parameters:
        namespace -
        bundleRange -
        Returns:

      • getPermissions

        java.util.Map<java.lang.String,​java.util.Set<AuthAction>> getPermissions​(java.lang.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

      • getPermissionsAsync

        java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,​java.util.Set<AuthAction>>> getPermissionsAsync​(java.lang.String topic)
        Get permissions on a topic asynchronously.

        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

      • grantPermissionAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> grantPermissionAsync​(java.lang.String topic,
                                                                            java.lang.String role,
                                                                            java.util.Set<AuthAction> actions)
        Grant permission on a topic asynchronously.

        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)

      • revokePermissionsAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> revokePermissionsAsync​(java.lang.String topic,
                                                                              java.lang.String role)
        Revoke permissions on a topic asynchronously.

        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

      • createPartitionedTopic

        default void createPartitionedTopic​(java.lang.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

      • createPartitionedTopic

        void createPartitionedTopic​(java.lang.String topic,
                            int numPartitions,
                            java.util.Map<java.lang.String,​java.lang.String> properties)
                     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
        properties - topic properties
        Throws:
        PulsarAdminException

      • createPartitionedTopicAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> createPartitionedTopicAsync​(java.lang.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

      • createPartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> createPartitionedTopicAsync​(java.lang.String topic,
                                                                                   int numPartitions,
                                                                                   java.util.Map<java.lang.String,​java.lang.String> properties)
        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
        properties - Topic properties
        Returns:
        a future that can be used to track when the partitioned topic is created

      • createNonPartitionedTopic

        default void createNonPartitionedTopic​(java.lang.String topic)
                                throws PulsarAdminException
        Create a non-partitioned topic.

        Create a non-partitioned topic.

        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException

      • createNonPartitionedTopic

        void createNonPartitionedTopic​(java.lang.String topic,
                               java.util.Map<java.lang.String,​java.lang.String> properties)
                        throws PulsarAdminException
        Create a non-partitioned topic.

        Create a non-partitioned topic.

        Parameters:
        topic - Topic name
        properties - Topic properties
        Throws:
        PulsarAdminException

      • createNonPartitionedTopicAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> createNonPartitionedTopicAsync​(java.lang.String topic)
        Create a non-partitioned topic asynchronously.
        Parameters:
        topic - Topic name

      • createNonPartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> createNonPartitionedTopicAsync​(java.lang.String topic,
                                                                                      java.util.Map<java.lang.String,​java.lang.String> properties)
        Create a non-partitioned topic asynchronously.
        Parameters:
        topic - Topic name
        properties - Topic properties

      • createMissedPartitions

        void createMissedPartitions​(java.lang.String topic)
                     throws PulsarAdminException
        Create missed partitions for partitioned topic.

        When disable topic auto creation, use this method to try create missed partitions while partitions create failed or users already have partitioned topic without partitions.

        Parameters:
        topic - partitioned topic name
        Throws:
        PulsarAdminException

      • createMissedPartitionsAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> createMissedPartitionsAsync​(java.lang.String topic)
        Create missed partitions for partitioned topic asynchronously.

        When disable topic auto creation, use this method to try create missed partitions while partitions create failed or users already have partitioned topic without partitions.

        Parameters:
        topic - partitioned topic name

      • updatePartitionedTopic

        void updatePartitionedTopic​(java.lang.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

        java.util.concurrent.CompletableFuture<java.lang.Void> updatePartitionedTopicAsync​(java.lang.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

      • updatePartitionedTopic

        void updatePartitionedTopic​(java.lang.String topic,
                            int numPartitions,
                            boolean updateLocalTopicOnly,
                            boolean force)
                     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
        updateLocalTopicOnly - Used by broker for global topic with multiple replicated clusters
        force - Update forcefully without validating existing partitioned topic
        Throws:
        PulsarAdminException

      • updatePartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> updatePartitionedTopicAsync​(java.lang.String topic,
                                                                                   int numPartitions,
                                                                                   boolean updateLocalTopicOnly,
                                                                                   boolean force)
        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
        updateLocalTopicOnly - Used by broker for global topic with multiple replicated clusters
        force - Update forcefully without validating existing partitioned topic
        Returns:
        a future that can be used to track when the partitioned topic is updated

      • updatePartitionedTopic

        void updatePartitionedTopic​(java.lang.String topic,
                            int numPartitions,
                            boolean updateLocalTopicOnly)
                     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
        updateLocalTopicOnly - Used by broker for global topic with multiple replicated clusters
        Throws:
        PulsarAdminException

      • updatePartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> updatePartitionedTopicAsync​(java.lang.String topic,
                                                                                   int numPartitions,
                                                                                   boolean updateLocalTopicOnly)
        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
        updateLocalTopicOnly - Used by broker for global topic with multiple replicated clusters
        Returns:
        a future that can be used to track when the partitioned topic is updated

      • getPartitionedTopicMetadataAsync

        java.util.concurrent.CompletableFuture<PartitionedTopicMetadata> getPartitionedTopicMetadataAsync​(java.lang.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

      • getProperties

        java.util.Map<java.lang.String,​java.lang.String> getProperties​(java.lang.String topic)
                                                              throws PulsarAdminException
        Get properties of a topic.
        Parameters:
        topic - Topic name
        Returns:
        Topic properties
        Throws:
        PulsarAdminException

      • getPropertiesAsync

        java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,​java.lang.String>> getPropertiesAsync​(java.lang.String topic)
        Get properties of a topic asynchronously.
        Parameters:
        topic - Topic name
        Returns:
        a future that can be used to track when the topic properties is returned

      • deletePartitionedTopic

        void deletePartitionedTopic​(java.lang.String topic,
                            boolean force,
                            boolean deleteSchema)
                     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
        deleteSchema - Delete topic's schema storage
        Throws:
        PulsarAdminException

      • deletePartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deletePartitionedTopicAsync​(java.lang.String topic,
                                                                                   boolean force,
                                                                                   boolean deleteSchema)
        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
        deleteSchema - Delete topic's schema storage
        Returns:
        a future that can be used to track when the partitioned topic is deleted

      • deletePartitionedTopic

        void deletePartitionedTopic​(java.lang.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

        java.util.concurrent.CompletableFuture<java.lang.Void> deletePartitionedTopicAsync​(java.lang.String topic)
        Delete a partitioned topic asynchronously.

        It will also delete all the partitions of the topic if it exists.

        Parameters:
        topic - Topic name

      • deleteAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync​(java.lang.String topic,
                                                                   boolean force,
                                                                   boolean deleteSchema)
        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
        deleteSchema - Delete topic's schema storage
        Returns:
        a future that can be used to track when the topic is deleted

      • deleteAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deleteAsync​(java.lang.String topic)
        Delete a topic asynchronously.

        Delete a topic. The topic cannot be deleted if there's any active subscription or producer connected to the it.

        Parameters:
        topic - Topic name

      • unloadAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> unloadAsync​(java.lang.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

        java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.MessageId> terminateTopicAsync​(java.lang.String topic)
        Terminate the topic and prevent any more messages being published on it.

        Parameters:
        topic - topic name
        Returns:
        the message id of the last message that was published in the topic

      • terminatePartitionedTopic

        java.util.Map<java.lang.Integer,​org.apache.pulsar.client.api.MessageId> terminatePartitionedTopic​(java.lang.String topic)
                                                                                                 throws PulsarAdminException
        Terminate the partitioned topic and prevent any more messages being published on it.

        Parameters:
        topic - topic name
        Returns:
        the message id of the last message that was published in the each partition of topic
        Throws:
        PulsarAdminException

      • terminatePartitionedTopicAsync

        java.util.concurrent.CompletableFuture<java.util.Map<java.lang.Integer,​org.apache.pulsar.client.api.MessageId>> terminatePartitionedTopicAsync​(java.lang.String topic)
        Terminate the partitioned topic and prevent any more messages being published on it.

        Parameters:
        topic - topic name
        Returns:
        the message id of the last message that was published in the each partition of topic

      • getSubscriptionsAsync

        java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getSubscriptionsAsync​(java.lang.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​(java.lang.String topic,
                    GetStatsOptions getStatsOptions)
             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,
       "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.

        Parameters:
        topic - topic name
        getStatsOptions - get stats options
        Returns:
        the topic statistics
        Throws:
        PulsarAdminException.NotAuthorizedException - Don't have admin permission
        PulsarAdminException.NotFoundException - Topic does not exist
        PulsarAdminException - Unexpected error

      • getStatsAsync

        java.util.concurrent.CompletableFuture<TopicStats> getStatsAsync​(java.lang.String topic,
                                                                 boolean getPreciseBacklog,
                                                                 boolean subscriptionBacklogSize,
                                                                 boolean getEarliestTimeInBacklog)
        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
        getPreciseBacklog - 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.
        Returns:
        a future that can be used to track when the topic statistics are returned

      • getStatsAsync

        default java.util.concurrent.CompletableFuture<TopicStats> getStatsAsync​(java.lang.String topic)

      • getInternalStatsAsync

        java.util.concurrent.CompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync​(java.lang.String topic,
                                                                                           boolean metadata)
        Get the internal stats for the topic asynchronously.
        Parameters:
        topic - topic Name
        metadata - flag to include ledger metadata
        Returns:
        a future that can be used to track when the internal topic statistics are returned

      • getInternalStatsAsync

        java.util.concurrent.CompletableFuture<PersistentTopicInternalStats> getInternalStatsAsync​(java.lang.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

      • getPartitionedStats

        PartitionedTopicStats getPartitionedStats​(java.lang.String topic,
                                          boolean perPartition,
                                          boolean getPreciseBacklog,
                                          boolean subscriptionBacklogSize)
                                   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 - flag to get stats per partition
        getPreciseBacklog - Set to true to get precise backlog, Otherwise get imprecise backlog.
        subscriptionBacklogSize - Whether to get backlog size for each subscription.
        Returns:
        the partitioned topic statistics
        Throws:
        PulsarAdminException.NotAuthorizedException - Don't have admin permission
        PulsarAdminException.NotFoundException - Topic does not exist
        PulsarAdminException - Unexpected error

      • getPartitionedStatsAsync

        java.util.concurrent.CompletableFuture<PartitionedTopicStats> getPartitionedStatsAsync​(java.lang.String topic,
                                                                                       boolean perPartition,
                                                                                       boolean getPreciseBacklog,
                                                                                       boolean subscriptionBacklogSize)
        Get the stats for the partitioned topic asynchronously.
        Parameters:
        topic - topic Name
        perPartition - flag to get stats per partition
        getPreciseBacklog - Set to true to get precise backlog, Otherwise get imprecise backlog.
        subscriptionBacklogSize - Whether to get backlog size for each subscription.
        Returns:
        a future that can be used to track when the partitioned topic statistics are returned

      • getPartitionedStatsAsync

        default java.util.concurrent.CompletableFuture<PartitionedTopicStats> getPartitionedStatsAsync​(java.lang.String topic,
                                                                                               boolean perPartition)

      • getPartitionedInternalStatsAsync

        java.util.concurrent.CompletableFuture<PartitionedTopicInternalStats> getPartitionedInternalStatsAsync​(java.lang.String topic)
        Get the stats-internal for the partitioned topic asynchronously.
        Parameters:
        topic - topic Name
        Returns:
        a future that can be used to track when the partitioned topic statistics are returned

      • deleteSubscriptionAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deleteSubscriptionAsync​(java.lang.String topic,
                                                                               java.lang.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

      • deleteSubscriptionAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> deleteSubscriptionAsync​(java.lang.String topic,
                                                                               java.lang.String subName,
                                                                               boolean force)
        Delete a subscription asynchronously.

        Delete a persistent subscription from a topic. There should not be any active consumers on the subscription. Force flag deletes subscription forcefully by closing all active consumers.

        Parameters:
        topic - topic name
        subName - Subscription name
        force - Delete topic forcefully
        Returns:
        a future that can be used to track when the subscription is deleted

      • skipAllMessagesAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> skipAllMessagesAsync​(java.lang.String topic,
                                                                            java.lang.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

      • skipMessagesAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> skipMessagesAsync​(java.lang.String topic,
                                                                         java.lang.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​(java.lang.String topic,
                    java.lang.String subscriptionName,
                    long expireTimeInSeconds)
             throws PulsarAdminException
        Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
        Parameters:
        topic - topic name
        subscriptionName - Subscription name
        expireTimeInSeconds - Expire messages older than time in seconds
        Throws:
        PulsarAdminException - Unexpected error

      • expireMessagesAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> expireMessagesAsync​(java.lang.String topic,
                                                                           java.lang.String subscriptionName,
                                                                           long expireTimeInSeconds)
        Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
        Parameters:
        topic - topic name
        subscriptionName - Subscription name
        expireTimeInSeconds - Expire messages older than time in seconds
        Returns:

      • expireMessages

        void expireMessages​(java.lang.String topic,
                    java.lang.String subscriptionName,
                    org.apache.pulsar.client.api.MessageId messageId,
                    boolean isExcluded)
             throws PulsarAdminException
        Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
        Parameters:
        topic - topic name
        subscriptionName - Subscription name
        messageId - Position before which all messages will be expired.
        isExcluded - Will message at passed in position also be expired.
        Throws:
        PulsarAdminException - Unexpected error

      • expireMessagesAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> expireMessagesAsync​(java.lang.String topic,
                                                                           java.lang.String subscriptionName,
                                                                           org.apache.pulsar.client.api.MessageId messageId,
                                                                           boolean isExcluded)
        Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription asynchronously.
        Parameters:
        topic - topic name
        subscriptionName - Subscription name
        messageId - Position before which all messages will be expired.
        isExcluded - Will message at passed in position also be expired.
        Returns:
        A CompletableFuture that'll be completed when expire message is done.

      • expireMessagesForAllSubscriptions

        void expireMessagesForAllSubscriptions​(java.lang.String topic,
                                       long expireTimeInSeconds)
                                throws PulsarAdminException
        Expire all messages older than given N 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

        java.util.concurrent.CompletableFuture<java.lang.Void> expireMessagesForAllSubscriptionsAsync​(java.lang.String topic,
                                                                                              long expireTimeInSeconds)
        Expire all messages older than given N seconds for all subscriptions of the persistent-topic asynchronously.
        Parameters:
        topic - topic name
        expireTimeInSeconds - Expire messages older than time in seconds

      • peekMessagesAsync

        java.util.concurrent.CompletableFuture<java.util.List<org.apache.pulsar.client.api.Message<byte[]>>> peekMessagesAsync​(java.lang.String topic,
                                                                                                                       java.lang.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

      • getMessageById

        org.apache.pulsar.client.api.Message<byte[]> getMessageById​(java.lang.String topic,
                                                            long ledgerId,
                                                            long entryId)
                                                     throws PulsarAdminException
        Get a message by its messageId via a topic subscription.
        Parameters:
        topic - Topic name
        ledgerId - Ledger id
        entryId - Entry id
        Returns:
        the message indexed by the messageId
        Throws:
        PulsarAdminException - Unexpected error

      • getMessageByIdAsync

        java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.Message<byte[]>> getMessageByIdAsync​(java.lang.String topic,
                                                                                                         long ledgerId,
                                                                                                         long entryId)
        Get a message by its messageId via a topic subscription asynchronously.
        Parameters:
        topic - Topic name
        ledgerId - Ledger id
        entryId - Entry id
        Returns:
        a future that can be used to track when the message is returned

      • getMessageIdByTimestamp

        org.apache.pulsar.client.api.MessageId getMessageIdByTimestamp​(java.lang.String topic,
                                                               long timestamp)
                                                        throws PulsarAdminException
        Get message ID published at or just after this absolute timestamp (in ms).
        Parameters:
        topic - Topic name
        timestamp - Timestamp
        Returns:
        MessageId
        Throws:
        PulsarAdminException - Unexpected error

      • getMessageIdByTimestampAsync

        java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.MessageId> getMessageIdByTimestampAsync​(java.lang.String topic,
                                                                                                            long timestamp)
        Get message ID published at or just after this absolute timestamp (in ms) asynchronously.
        Parameters:
        topic - Topic name
        timestamp - Timestamp
        Returns:
        a future that can be used to track when the message ID is returned.

      • createSubscriptionAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> createSubscriptionAsync​(java.lang.String topic,
                                                                                       java.lang.String subscriptionName,
                                                                                       org.apache.pulsar.client.api.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.

      • createSubscription

        void createSubscription​(java.lang.String topic,
                        java.lang.String subscriptionName,
                        org.apache.pulsar.client.api.MessageId messageId,
                        boolean replicated,
                        java.util.Map<java.lang.String,​java.lang.String> properties)
                 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.
        replicated - replicated subscriptions.
        properties - subscription properties.
        Throws:
        PulsarAdminException.NotAuthorizedException - Don't have admin permission
        PulsarAdminException.ConflictException - Subscription already exists
        PulsarAdminException.NotAllowedException - Command disallowed for requested resource
        PulsarAdminException - Unexpected error

      • createSubscriptionAsync

        default java.util.concurrent.CompletableFuture<java.lang.Void> createSubscriptionAsync​(java.lang.String topic,
                                                                                       java.lang.String subscriptionName,
                                                                                       org.apache.pulsar.client.api.MessageId messageId,
                                                                                       boolean replicated)
        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.

      • createSubscriptionAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> createSubscriptionAsync​(java.lang.String topic,
                                                                               java.lang.String subscriptionName,
                                                                               org.apache.pulsar.client.api.MessageId messageId,
                                                                               boolean replicated,
                                                                               java.util.Map<java.lang.String,​java.lang.String> properties)
        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.
        replicated - replicated subscriptions.
        properties - subscription properties.

      • resetCursor

        void resetCursor​(java.lang.String topic,
                 java.lang.String subName,
                 org.apache.pulsar.client.api.MessageId messageId,
                 boolean isExcluded)
          throws PulsarAdminException
        Reset cursor position on a topic subscription.

        and start consume messages from the next position of the reset position.

        Parameters:
        topic -
        subName -
        messageId -
        isExcluded -
        Throws:
        PulsarAdminException

      • updateSubscriptionProperties

        void updateSubscriptionProperties​(java.lang.String topic,
                                  java.lang.String subName,
                                  java.util.Map<java.lang.String,​java.lang.String> subscriptionProperties)
                           throws PulsarAdminException
        Update Subscription Properties on a topic subscription. The new properties will override the existing values, properties that are not passed will be removed.
        Parameters:
        topic -
        subName -
        subscriptionProperties -
        Throws:
        PulsarAdminException

      • resetCursorAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> resetCursorAsync​(java.lang.String topic,
                                                                        java.lang.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

      • resetCursorAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> resetCursorAsync​(java.lang.String topic,
                                                                        java.lang.String subName,
                                                                        org.apache.pulsar.client.api.MessageId messageId,
                                                                        boolean isExcluded)
        Reset cursor position on a topic subscription.

        and start consume messages from the next position of the reset position.

        Parameters:
        topic -
        subName -
        messageId -
        isExcluded -
        Returns:

      • updateSubscriptionPropertiesAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> updateSubscriptionPropertiesAsync​(java.lang.String topic,
                                                                                         java.lang.String subName,
                                                                                         java.util.Map<java.lang.String,​java.lang.String> subscriptionProperties)
        Update Subscription Properties on a topic subscription. The new properties will override the existing values, properties that are not passed will be removed.
        Parameters:
        topic -
        subName -
        subscriptionProperties -

      • resetCursorAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> resetCursorAsync​(java.lang.String topic,
                                                                        java.lang.String subName,
                                                                        org.apache.pulsar.client.api.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​(java.lang.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

      • triggerCompactionAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> triggerCompactionAsync​(java.lang.String topic)
        Trigger compaction to run for a topic asynchronously.
        Parameters:
        topic - The topic on which to trigger compaction

      • compactionStatusAsync

        java.util.concurrent.CompletableFuture<LongRunningProcessStatus> compactionStatusAsync​(java.lang.String topic)
        Check the status of an ongoing compaction for a topic asynchronously.
        Parameters:
        topic - The topic whose compaction status we wish to check

      • triggerOffload

        void triggerOffload​(java.lang.String topic,
                    org.apache.pulsar.client.api.MessageId messageId)
             throws PulsarAdminException
        Trigger offloading messages in topic to longterm storage.
        Parameters:
        topic - the topic to offload
        messageId - ID of maximum message which should be offloaded
        Throws:
        PulsarAdminException

      • triggerOffloadAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> triggerOffloadAsync​(java.lang.String topic,
                                                                           org.apache.pulsar.client.api.MessageId messageId)
        Trigger offloading messages in topic to longterm storage asynchronously.
        Parameters:
        topic - the topic to offload
        messageId - ID of maximum message which should be offloaded

      • offloadStatusAsync

        java.util.concurrent.CompletableFuture<OffloadProcessStatus> offloadStatusAsync​(java.lang.String topic)
        Check the status of an ongoing offloading operation for a topic asynchronously.
        Parameters:
        topic - the topic being offloaded
        Returns:
        the status of the offload operation

      • getLastMessageId

        org.apache.pulsar.client.api.MessageId getLastMessageId​(java.lang.String topic)
                                                 throws PulsarAdminException
        Get the last commit message Id of a topic.
        Parameters:
        topic - the topic name
        Returns:
        Throws:
        PulsarAdminException

      • getLastMessageIdAsync

        java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.MessageId> getLastMessageIdAsync​(java.lang.String topic)
        Get the last commit message Id of a topic asynchronously.
        Parameters:
        topic - the topic name
        Returns:

      • getBacklogSizeByMessageId

        java.lang.Long getBacklogSizeByMessageId​(java.lang.String topic,
                                         org.apache.pulsar.client.api.MessageId messageId)
                                  throws PulsarAdminException
        Get backlog size by a message ID.
        Parameters:
        topic - Topic name
        messageId - message ID
        Returns:
        the backlog size from
        Throws:
        PulsarAdminException - Unexpected error

      • getBacklogSizeByMessageIdAsync

        java.util.concurrent.CompletableFuture<java.lang.Long> getBacklogSizeByMessageIdAsync​(java.lang.String topic,
                                                                                      org.apache.pulsar.client.api.MessageId messageId)
        Get backlog size by a message ID asynchronously.
        Parameters:
        topic - Topic name
        messageId - message ID
        Returns:
        the backlog size from

      • getDelayedDeliveryPolicyAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync​(java.lang.String topic,
                                                                                              boolean applied)
        Deprecated.
        Get the delayed delivery policy applied for a specified topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • getDelayedDeliveryPolicyAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync​(java.lang.String topic)
        Deprecated.
        Get the delayed delivery policy for a specified topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setDelayedDeliveryPolicy

        @Deprecated
void setDelayedDeliveryPolicy​(java.lang.String topic,
                              DelayedDeliveryPolicies delayedDeliveryPolicies)
                       throws PulsarAdminException
        Deprecated.
        Set the delayed delivery policy for a specified topic.
        Parameters:
        topic -
        delayedDeliveryPolicies -
        Throws:
        PulsarAdminException

      • setDelayedDeliveryPolicyAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setDelayedDeliveryPolicyAsync​(java.lang.String topic,
                                                                                     DelayedDeliveryPolicies delayedDeliveryPolicies)
        Deprecated.
        Set the delayed delivery policy for a specified topic asynchronously.
        Parameters:
        topic -
        delayedDeliveryPolicies -
        Returns:

      • removeDelayedDeliveryPolicyAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeDelayedDeliveryPolicyAsync​(java.lang.String topic)
        Deprecated.
        Remove the delayed delivery policy for a specified topic asynchronously.
        Parameters:
        topic -
        Returns:

      • removeDelayedDeliveryPolicy

        @Deprecated
void removeDelayedDeliveryPolicy​(java.lang.String topic)
                          throws PulsarAdminException
        Deprecated.
        Remove the delayed delivery policy for a specified topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • getMessageTTL

        @Deprecated
java.lang.Integer getMessageTTL​(java.lang.String topic,
                                boolean applied)
                         throws PulsarAdminException
        Deprecated.
        Get message TTL applied for a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • setRetentionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setRetentionAsync​(java.lang.String topic,
                                                                         RetentionPolicies retention)
        Deprecated.
        Set the retention configuration for all the topics on a topic asynchronously.

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

        Request parameter example: 

         
 {
     "retentionTimeInMinutes" : 60,            // how long to retain messages
     "retentionSizeInMB" : 1024,              // retention backlog limit
 }
        Parameters:
        topic - Topic name

      • getRetentionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<RetentionPolicies> getRetentionAsync​(java.lang.String topic)
        Deprecated.
        Get the retention configuration for a topic asynchronously.

        Get the retention configuration for a topic.

        Parameters:
        topic - Topic name

      • getRetentionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<RetentionPolicies> getRetentionAsync​(java.lang.String topic,
                                                                            boolean applied)
        Deprecated.
        Get the applied retention configuration for a topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • removeRetentionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeRetentionAsync​(java.lang.String topic)
        Deprecated.
        Remove the retention configuration for all the topics on a topic asynchronously.

        Remove the retention configuration on a topic. This operation requires Pulsar super-user access.

        Request parameter example: 

         
 {
     "retentionTimeInMinutes" : 60,            // how long to retain messages
     "retentionSizeInMB" : 1024,              // retention backlog limit
 }
        Parameters:
        topic - Topic name

      • getMaxUnackedMessagesOnConsumer

        @Deprecated
java.lang.Integer getMaxUnackedMessagesOnConsumer​(java.lang.String topic)
                                           throws PulsarAdminException
        Deprecated.
        get max unacked messages on consumer of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxUnackedMessagesOnConsumerAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxUnackedMessagesOnConsumerAsync​(java.lang.String topic)
        Deprecated.
        get max unacked messages on consumer of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getMaxUnackedMessagesOnConsumer

        @Deprecated
java.lang.Integer getMaxUnackedMessagesOnConsumer​(java.lang.String topic,
                                                  boolean applied)
                                           throws PulsarAdminException
        Deprecated.
        get applied max unacked messages on consumer of a topic.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxUnackedMessagesOnConsumerAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxUnackedMessagesOnConsumerAsync​(java.lang.String topic,
                                                                                               boolean applied)
        Deprecated.
        get applied max unacked messages on consumer of a topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • setMaxUnackedMessagesOnConsumer

        @Deprecated
void setMaxUnackedMessagesOnConsumer​(java.lang.String topic,
                                     int maxNum)
                              throws PulsarAdminException
        Deprecated.
        set max unacked messages on consumer of a topic.
        Parameters:
        topic -
        maxNum -
        Throws:
        PulsarAdminException

      • setMaxUnackedMessagesOnConsumerAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxUnackedMessagesOnConsumerAsync​(java.lang.String topic,
                                                                                            int maxNum)
        Deprecated.
        set max unacked messages on consumer of a topic asynchronously.
        Parameters:
        topic -
        maxNum -
        Returns:

      • removeMaxUnackedMessagesOnConsumer

        @Deprecated
void removeMaxUnackedMessagesOnConsumer​(java.lang.String topic)
                                 throws PulsarAdminException
        Deprecated.
        remove max unacked messages on consumer of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeMaxUnackedMessagesOnConsumerAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxUnackedMessagesOnConsumerAsync​(java.lang.String topic)
        Deprecated.
        remove max unacked messages on consumer of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getInactiveTopicPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync​(java.lang.String topic,
                                                                                            boolean applied)
        Deprecated.
        Get inactive topic policies applied for a topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • getInactiveTopicPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<InactiveTopicPolicies> getInactiveTopicPoliciesAsync​(java.lang.String topic)
        Deprecated.
        get inactive topic policies of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setInactiveTopicPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setInactiveTopicPoliciesAsync​(java.lang.String topic,
                                                                                     InactiveTopicPolicies inactiveTopicPolicies)
        Deprecated.
        set inactive topic policies of a topic asynchronously.
        Parameters:
        topic -
        inactiveTopicPolicies -
        Returns:

      • removeInactiveTopicPolicies

        @Deprecated
void removeInactiveTopicPolicies​(java.lang.String topic)
                          throws PulsarAdminException
        Deprecated.
        remove inactive topic policies of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeInactiveTopicPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeInactiveTopicPoliciesAsync​(java.lang.String topic)
        Deprecated.
        remove inactive topic policies of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getOffloadPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync​(java.lang.String topic)
        Deprecated.
        get offload policies of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getOffloadPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<OffloadPolicies> getOffloadPoliciesAsync​(java.lang.String topic,
                                                                                boolean applied)
        Deprecated.
        get applied offload policies of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setOffloadPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setOffloadPoliciesAsync​(java.lang.String topic,
                                                                               OffloadPolicies offloadPolicies)
        Deprecated.
        set offload policies of a topic asynchronously.
        Parameters:
        topic -
        offloadPolicies -
        Returns:

      • removeOffloadPolicies

        @Deprecated
void removeOffloadPolicies​(java.lang.String topic)
                    throws PulsarAdminException
        Deprecated.
        remove offload policies of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeOffloadPoliciesAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeOffloadPoliciesAsync​(java.lang.String topic)
        Deprecated.
        remove offload policies of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getMaxUnackedMessagesOnSubscription

        @Deprecated
java.lang.Integer getMaxUnackedMessagesOnSubscription​(java.lang.String topic)
                                               throws PulsarAdminException
        Deprecated.
        get max unacked messages on subscription of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxUnackedMessagesOnSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxUnackedMessagesOnSubscriptionAsync​(java.lang.String topic)
        Deprecated.
        get max unacked messages on subscription of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getMaxUnackedMessagesOnSubscription

        @Deprecated
java.lang.Integer getMaxUnackedMessagesOnSubscription​(java.lang.String topic,
                                                      boolean applied)
                                               throws PulsarAdminException
        Deprecated.
        get max unacked messages on subscription of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxUnackedMessagesOnSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxUnackedMessagesOnSubscriptionAsync​(java.lang.String topic,
                                                                                                   boolean applied)
        Deprecated.
        get max unacked messages on subscription of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setMaxUnackedMessagesOnSubscription

        @Deprecated
void setMaxUnackedMessagesOnSubscription​(java.lang.String topic,
                                         int maxNum)
                                  throws PulsarAdminException
        Deprecated.
        set max unacked messages on subscription of a topic.
        Parameters:
        topic -
        maxNum -
        Throws:
        PulsarAdminException

      • setMaxUnackedMessagesOnSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxUnackedMessagesOnSubscriptionAsync​(java.lang.String topic,
                                                                                                int maxNum)
        Deprecated.
        set max unacked messages on subscription of a topic asynchronously.
        Parameters:
        topic -
        maxNum -
        Returns:

      • removeMaxUnackedMessagesOnSubscription

        @Deprecated
void removeMaxUnackedMessagesOnSubscription​(java.lang.String topic)
                                     throws PulsarAdminException
        Deprecated.
        remove max unacked messages on subscription of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeMaxUnackedMessagesOnSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxUnackedMessagesOnSubscriptionAsync​(java.lang.String topic)
        Deprecated.
        remove max unacked messages on subscription of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setPersistence

        @Deprecated
void setPersistence​(java.lang.String topic,
                    PersistencePolicies persistencePolicies)
             throws PulsarAdminException
        Deprecated.
        Set the configuration of persistence policies for specified topic.
        Parameters:
        topic - Topic name
        persistencePolicies - Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • setPersistenceAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setPersistenceAsync​(java.lang.String topic,
                                                                           PersistencePolicies persistencePolicies)
        Deprecated.
        Set the configuration of persistence policies for specified topic asynchronously.
        Parameters:
        topic - Topic name
        persistencePolicies - Configuration of bookkeeper persistence policies

      • getPersistence

        @Deprecated
PersistencePolicies getPersistence​(java.lang.String topic)
                            throws PulsarAdminException
        Deprecated.
        Get the configuration of persistence policies for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getPersistenceAsync

        @Deprecated
java.util.concurrent.CompletableFuture<PersistencePolicies> getPersistenceAsync​(java.lang.String topic)
        Deprecated.
        Get the configuration of persistence policies for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getPersistence

        @Deprecated
PersistencePolicies getPersistence​(java.lang.String topic,
                                   boolean applied)
                            throws PulsarAdminException
        Deprecated.
        Get the applied configuration of persistence policies for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getPersistenceAsync

        @Deprecated
java.util.concurrent.CompletableFuture<PersistencePolicies> getPersistenceAsync​(java.lang.String topic,
                                                                                boolean applied)
        Deprecated.
        Get the applied configuration of persistence policies for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • removePersistence

        @Deprecated
void removePersistence​(java.lang.String topic)
                throws PulsarAdminException
        Deprecated.
        Remove the configuration of persistence policies for specified topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removePersistenceAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removePersistenceAsync​(java.lang.String topic)
        Deprecated.
        Remove the configuration of persistence policies for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getDeduplicationEnabled

        @Deprecated
java.lang.Boolean getDeduplicationEnabled​(java.lang.String topic)
                                   throws PulsarAdminException
        Deprecated.
        get deduplication enabled of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getDeduplicationEnabledAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Boolean> getDeduplicationEnabledAsync​(java.lang.String topic)
        Deprecated.
        get deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getDeduplicationStatus

        @Deprecated
java.lang.Boolean getDeduplicationStatus​(java.lang.String topic)
                                  throws PulsarAdminException
        Deprecated.
        get deduplication enabled of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getDeduplicationStatusAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Boolean> getDeduplicationStatusAsync​(java.lang.String topic)
        Deprecated.
        get deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • getDeduplicationStatus

        @Deprecated
java.lang.Boolean getDeduplicationStatus​(java.lang.String topic,
                                         boolean applied)
                                  throws PulsarAdminException
        Deprecated.
        get applied deduplication enabled of a topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getDeduplicationStatusAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Boolean> getDeduplicationStatusAsync​(java.lang.String topic,
                                                                                      boolean applied)
        Deprecated.
        get applied deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • enableDeduplication

        @Deprecated
void enableDeduplication​(java.lang.String topic,
                         boolean enabled)
                  throws PulsarAdminException
        Deprecated.
        set deduplication enabled of a topic.
        Parameters:
        topic -
        enabled -
        Throws:
        PulsarAdminException

      • enableDeduplicationAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> enableDeduplicationAsync​(java.lang.String topic,
                                                                                boolean enabled)
        Deprecated.
        set deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        enabled -
        Returns:

      • setDeduplicationStatus

        @Deprecated
void setDeduplicationStatus​(java.lang.String topic,
                            boolean enabled)
                     throws PulsarAdminException
        Deprecated.
        set deduplication enabled of a topic.
        Parameters:
        topic -
        enabled -
        Throws:
        PulsarAdminException

      • setDeduplicationStatusAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setDeduplicationStatusAsync​(java.lang.String topic,
                                                                                   boolean enabled)
        Deprecated.
        set deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        enabled -
        Returns:

      • disableDeduplication

        @Deprecated
void disableDeduplication​(java.lang.String topic)
                   throws PulsarAdminException
        Deprecated.
        remove deduplication enabled of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • disableDeduplicationAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> disableDeduplicationAsync​(java.lang.String topic)
        Deprecated.
        remove deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • removeDeduplicationStatus

        @Deprecated
void removeDeduplicationStatus​(java.lang.String topic)
                        throws PulsarAdminException
        Deprecated.
        remove deduplication enabled of a topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeDeduplicationStatusAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeDeduplicationStatusAsync​(java.lang.String topic)
        Deprecated.
        remove deduplication enabled of a topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setDispatchRate

        @Deprecated
void setDispatchRate​(java.lang.String topic,
                     DispatchRate dispatchRate)
              throws PulsarAdminException
        Deprecated.
        Set message-dispatch-rate (topic can dispatch this many messages per second).
        Parameters:
        topic -
        dispatchRate - number of messages per second
        Throws:
        PulsarAdminException - Unexpected error

      • setDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setDispatchRateAsync​(java.lang.String topic,
                                                                            DispatchRate dispatchRate)
        Deprecated.
        Set message-dispatch-rate asynchronously.

        topic can dispatch this many messages per second

        Parameters:
        topic -
        dispatchRate - number of messages per second

      • getDispatchRate

        @Deprecated
DispatchRate getDispatchRate​(java.lang.String topic)
                      throws PulsarAdminException
        Deprecated.
        Get message-dispatch-rate (topic can dispatch this many messages per second).
        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getDispatchRateAsync​(java.lang.String topic)
        Deprecated.
        Get message-dispatch-rate asynchronously.

        Topic can dispatch this many messages per second.

        Parameters:
        topic -

      • getDispatchRate

        @Deprecated
DispatchRate getDispatchRate​(java.lang.String topic,
                             boolean applied)
                      throws PulsarAdminException
        Deprecated.
        Get applied message-dispatch-rate (topic can dispatch this many messages per second).
        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getDispatchRateAsync​(java.lang.String topic,
                                                                          boolean applied)
        Deprecated.
        Get applied message-dispatch-rate asynchronously.

        Topic can dispatch this many messages per second.

        Parameters:
        topic -

      • removeDispatchRate

        @Deprecated
void removeDispatchRate​(java.lang.String topic)
                 throws PulsarAdminException
        Deprecated.
        Remove message-dispatch-rate.

        Remove topic message dispatch rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • removeDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeDispatchRateAsync​(java.lang.String topic)
                                                                        throws PulsarAdminException
        Deprecated.
        Remove message-dispatch-rate asynchronously.

        Remove topic message dispatch rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • setSubscriptionDispatchRate

        @Deprecated
void setSubscriptionDispatchRate​(java.lang.String topic,
                                 DispatchRate dispatchRate)
                          throws PulsarAdminException
        Deprecated.
        Set subscription-message-dispatch-rate for the topic.

        Subscriptions under this namespace can dispatch this many messages per second

        Parameters:
        topic -
        dispatchRate - number of messages per second
        Throws:
        PulsarAdminException - Unexpected error

      • setSubscriptionDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setSubscriptionDispatchRateAsync​(java.lang.String topic,
                                                                                        DispatchRate dispatchRate)
        Deprecated.
        Set subscription-message-dispatch-rate for the topic asynchronously.

        Subscriptions under this namespace can dispatch this many messages per second.

        Parameters:
        topic -
        dispatchRate - number of messages per second

      • getSubscriptionDispatchRate

        @Deprecated
DispatchRate getSubscriptionDispatchRate​(java.lang.String namespace,
                                         boolean applied)
                                  throws PulsarAdminException
        Deprecated.
        Get applied subscription-message-dispatch-rate.

        Subscriptions under this namespace can dispatch this many messages per second.

        Parameters:
        namespace -
        Throws:
        PulsarAdminException - Unexpected error

      • getSubscriptionDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync​(java.lang.String namespace,
                                                                                      boolean applied)
        Deprecated.
        Get applied subscription-message-dispatch-rate asynchronously.

        Subscriptions under this namespace can dispatch this many messages per second.

        Parameters:
        namespace -

      • getSubscriptionDispatchRate

        @Deprecated
DispatchRate getSubscriptionDispatchRate​(java.lang.String topic)
                                  throws PulsarAdminException
        Deprecated.
        Get subscription-message-dispatch-rate for the topic.

        Subscriptions under this namespace can dispatch this many messages per second.

        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getSubscriptionDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getSubscriptionDispatchRateAsync​(java.lang.String topic)
        Deprecated.
        Get subscription-message-dispatch-rate asynchronously.

        Subscriptions under this namespace can dispatch this many messages per second.

        Parameters:
        topic -

      • removeSubscriptionDispatchRate

        @Deprecated
void removeSubscriptionDispatchRate​(java.lang.String topic)
                             throws PulsarAdminException
        Deprecated.
        Remove subscription-message-dispatch-rate for a topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeSubscriptionDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeSubscriptionDispatchRateAsync​(java.lang.String topic)
        Deprecated.
        Remove subscription-message-dispatch-rate for a topic asynchronously.
        Parameters:
        topic - Topic name

      • setReplicatorDispatchRate

        @Deprecated
void setReplicatorDispatchRate​(java.lang.String topic,
                               DispatchRate dispatchRate)
                        throws PulsarAdminException
        Deprecated.
        Set replicatorDispatchRate for the topic.

        Replicator dispatch rate under this topic can dispatch this many messages per second

        Parameters:
        topic -
        dispatchRate - number of messages per second
        Throws:
        PulsarAdminException - Unexpected error

      • setReplicatorDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setReplicatorDispatchRateAsync​(java.lang.String topic,
                                                                                      DispatchRate dispatchRate)
        Deprecated.
        Set replicatorDispatchRate for the topic asynchronously.

        Replicator dispatch rate under this topic can dispatch this many messages per second.

        Parameters:
        topic -
        dispatchRate - number of messages per second

      • getReplicatorDispatchRate

        @Deprecated
DispatchRate getReplicatorDispatchRate​(java.lang.String topic)
                                throws PulsarAdminException
        Deprecated.
        Get replicatorDispatchRate for the topic.

        Replicator dispatch rate under this topic can dispatch this many messages per second.

        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getReplicatorDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync​(java.lang.String topic)
        Deprecated.
        Get replicatorDispatchRate asynchronously.

        Replicator dispatch rate under this topic can dispatch this many messages per second.

        Parameters:
        topic -

      • getReplicatorDispatchRate

        @Deprecated
DispatchRate getReplicatorDispatchRate​(java.lang.String topic,
                                       boolean applied)
                                throws PulsarAdminException
        Deprecated.
        Get applied replicatorDispatchRate for the topic.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • getReplicatorDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<DispatchRate> getReplicatorDispatchRateAsync​(java.lang.String topic,
                                                                                    boolean applied)
        Deprecated.
        Get applied replicatorDispatchRate asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • removeReplicatorDispatchRate

        @Deprecated
void removeReplicatorDispatchRate​(java.lang.String topic)
                           throws PulsarAdminException
        Deprecated.
        Remove replicatorDispatchRate for a topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeReplicatorDispatchRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeReplicatorDispatchRateAsync​(java.lang.String topic)
        Deprecated.
        Remove replicatorDispatchRate for a topic asynchronously.
        Parameters:
        topic - Topic name

      • getCompactionThresholdAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Long> getCompactionThresholdAsync​(java.lang.String topic)
        Deprecated.
        Get the compactionThreshold for a topic asynchronously. The maximum number of bytes can have before compaction is triggered. 0 disables.

        Response example: 

         10000000
        Parameters:
        topic - Topic name

      • getCompactionThresholdAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Long> getCompactionThresholdAsync​(java.lang.String topic,
                                                                                   boolean applied)
        Deprecated.
        Get the compactionThreshold for a topic asynchronously. The maximum number of bytes can have before compaction is triggered. 0 disables.
        Parameters:
        topic - Topic name

      • setCompactionThreshold

        @Deprecated
void setCompactionThreshold​(java.lang.String topic,
                            long compactionThreshold)
                     throws PulsarAdminException
        Deprecated.
        Set the compactionThreshold for a topic. The maximum number of bytes can have before compaction is triggered. 0 disables.

        Request example: 

         10000000
        Parameters:
        topic - Topic name
        compactionThreshold - maximum number of backlog bytes before compaction is triggered
        Throws:
        PulsarAdminException.NotAuthorizedException - Don't have admin permission
        PulsarAdminException.NotFoundException - Namespace does not exist
        PulsarAdminException - Unexpected error

      • setCompactionThresholdAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setCompactionThresholdAsync​(java.lang.String topic,
                                                                                   long compactionThreshold)
        Deprecated.
        Set the compactionThreshold for a topic asynchronously. The maximum number of bytes can have before compaction is triggered. 0 disables.

        Request example: 

         10000000
        Parameters:
        topic - Topic name
        compactionThreshold - maximum number of backlog bytes before compaction is triggered

      • removeCompactionThreshold

        @Deprecated
void removeCompactionThreshold​(java.lang.String topic)
                        throws PulsarAdminException
        Deprecated.
        Remove the compactionThreshold for a topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeCompactionThresholdAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeCompactionThresholdAsync​(java.lang.String topic)
        Deprecated.
        Remove the compactionThreshold for a topic asynchronously.
        Parameters:
        topic - Topic name

      • setPublishRate

        @Deprecated
void setPublishRate​(java.lang.String topic,
                    PublishRate publishMsgRate)
             throws PulsarAdminException
        Deprecated.
        Set message-publish-rate (topics can publish this many messages per second).
        Parameters:
        topic -
        publishMsgRate - number of messages per second
        Throws:
        PulsarAdminException - Unexpected error

      • setPublishRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setPublishRateAsync​(java.lang.String topic,
                                                                           PublishRate publishMsgRate)
        Deprecated.
        Set message-publish-rate (topics can publish this many messages per second) asynchronously.
        Parameters:
        topic -
        publishMsgRate - number of messages per second

      • getPublishRate

        @Deprecated
PublishRate getPublishRate​(java.lang.String topic)
                    throws PulsarAdminException
        Deprecated.
        Get message-publish-rate (topics can publish this many messages per second).
        Parameters:
        topic -
        Returns:
        number of messages per second
        Throws:
        PulsarAdminException - Unexpected error

      • getPublishRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<PublishRate> getPublishRateAsync​(java.lang.String topic)
        Deprecated.
        Get message-publish-rate (topics can publish this many messages per second) asynchronously.
        Parameters:
        topic -
        Returns:
        number of messages per second

      • removePublishRate

        @Deprecated
void removePublishRate​(java.lang.String topic)
                throws PulsarAdminException
        Deprecated.
        Remove message-publish-rate.

        Remove topic message publish rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • removePublishRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removePublishRateAsync​(java.lang.String topic)
                                                                       throws PulsarAdminException
        Deprecated.
        Remove message-publish-rate asynchronously.

        Remove topic message publish rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • getMaxConsumersPerSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxConsumersPerSubscriptionAsync​(java.lang.String topic)
        Deprecated.
        Get the maxConsumersPerSubscription for a topic asynchronously.

        Response example: 

         0
        Parameters:
        topic - Topic name

      • setMaxConsumersPerSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxConsumersPerSubscriptionAsync​(java.lang.String topic,
                                                                                           int maxConsumersPerSubscription)
        Deprecated.
        Set maxConsumersPerSubscription for a topic asynchronously.

        Request example: 

         10
        Parameters:
        topic - Topic name
        maxConsumersPerSubscription - maxConsumersPerSubscription value for a namespace

      • removeMaxConsumersPerSubscription

        @Deprecated
void removeMaxConsumersPerSubscription​(java.lang.String topic)
                                throws PulsarAdminException
        Deprecated.
        Remove the maxConsumersPerSubscription for a topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxConsumersPerSubscriptionAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxConsumersPerSubscriptionAsync​(java.lang.String topic)
        Deprecated.
        Remove the maxConsumersPerSubscription for a topic asynchronously.
        Parameters:
        topic - Topic name

      • getMaxProducers

        @Deprecated
java.lang.Integer getMaxProducers​(java.lang.String topic)
                           throws PulsarAdminException
        Deprecated.
        Get the max number of producer for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxProducersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxProducersAsync​(java.lang.String topic)
        Deprecated.
        Get the max number of producer for specified topic asynchronously.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxProducers

        @Deprecated
java.lang.Integer getMaxProducers​(java.lang.String topic,
                                  boolean applied)
                           throws PulsarAdminException
        Deprecated.
        Get the max number of producer applied for specified topic.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxProducersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxProducersAsync​(java.lang.String topic,
                                                                               boolean applied)
        Deprecated.
        Get the max number of producer applied for specified topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • setMaxProducers

        @Deprecated
void setMaxProducers​(java.lang.String topic,
                     int maxProducers)
              throws PulsarAdminException
        Deprecated.
        Set the max number of producer for specified topic.
        Parameters:
        topic - Topic name
        maxProducers - Max number of producer
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxProducersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxProducersAsync​(java.lang.String topic,
                                                                            int maxProducers)
        Deprecated.
        Set the max number of producer for specified topic asynchronously.
        Parameters:
        topic - Topic name
        maxProducers - Max number of producer
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxProducers

        @Deprecated
void removeMaxProducers​(java.lang.String topic)
                 throws PulsarAdminException
        Deprecated.
        Remove the max number of producer for specified topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxProducersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxProducersAsync​(java.lang.String topic)
        Deprecated.
        Remove the max number of producer for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getMaxSubscriptionsPerTopic

        @Deprecated
java.lang.Integer getMaxSubscriptionsPerTopic​(java.lang.String topic)
                                       throws PulsarAdminException
        Deprecated.
        Get the max number of subscriptions for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxSubscriptionsPerTopicAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxSubscriptionsPerTopicAsync​(java.lang.String topic)
        Deprecated.
        Get the max number of subscriptions for specified topic asynchronously.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxSubscriptionsPerTopic

        @Deprecated
void setMaxSubscriptionsPerTopic​(java.lang.String topic,
                                 int maxSubscriptionsPerTopic)
                          throws PulsarAdminException
        Deprecated.
        Set the max number of subscriptions for specified topic.
        Parameters:
        topic - Topic name
        maxSubscriptionsPerTopic - Max number of subscriptions
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxSubscriptionsPerTopicAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxSubscriptionsPerTopicAsync​(java.lang.String topic,
                                                                                        int maxSubscriptionsPerTopic)
        Deprecated.
        Set the max number of subscriptions for specified topic asynchronously.
        Parameters:
        topic - Topic name
        maxSubscriptionsPerTopic - Max number of subscriptions
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxSubscriptionsPerTopic

        @Deprecated
void removeMaxSubscriptionsPerTopic​(java.lang.String topic)
                             throws PulsarAdminException
        Deprecated.
        Remove the max number of subscriptions for specified topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxSubscriptionsPerTopicAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxSubscriptionsPerTopicAsync​(java.lang.String topic)
        Deprecated.
        Remove the max number of subscriptions for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getMaxMessageSize

        @Deprecated
java.lang.Integer getMaxMessageSize​(java.lang.String topic)
                             throws PulsarAdminException
        Deprecated.
        Get the max message size for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxMessageSizeAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxMessageSizeAsync​(java.lang.String topic)
        Deprecated.
        Get the max message size for specified topic asynchronously.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxMessageSize

        @Deprecated
void setMaxMessageSize​(java.lang.String topic,
                       int maxMessageSize)
                throws PulsarAdminException
        Deprecated.
        Set the max message size for specified topic.
        Parameters:
        topic - Topic name
        maxMessageSize - Max message size of producer
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxMessageSizeAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxMessageSizeAsync​(java.lang.String topic,
                                                                              int maxMessageSize)
        Deprecated.
        Set the max message size for specified topic asynchronously.0 disables.
        Parameters:
        topic - Topic name
        maxMessageSize - Max message size of topic
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxMessageSize

        @Deprecated
void removeMaxMessageSize​(java.lang.String topic)
                   throws PulsarAdminException
        Deprecated.
        Remove the max message size for specified topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxMessageSizeAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxMessageSizeAsync​(java.lang.String topic)
        Deprecated.
        Remove the max message size for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getMaxConsumers

        @Deprecated
java.lang.Integer getMaxConsumers​(java.lang.String topic)
                           throws PulsarAdminException
        Deprecated.
        Get the max number of consumer for specified topic.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxConsumersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxConsumersAsync​(java.lang.String topic)
        Deprecated.
        Get the max number of consumer for specified topic asynchronously.
        Parameters:
        topic - Topic name
        Returns:
        Configuration of bookkeeper persistence policies
        Throws:
        PulsarAdminException - Unexpected error

      • getMaxConsumers

        @Deprecated
java.lang.Integer getMaxConsumers​(java.lang.String topic,
                                  boolean applied)
                           throws PulsarAdminException
        Deprecated.
        Get the max number of consumer applied for specified topic.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • getMaxConsumersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getMaxConsumersAsync​(java.lang.String topic,
                                                                               boolean applied)
        Deprecated.
        Get the max number of consumer applied for specified topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:

      • setMaxConsumers

        @Deprecated
void setMaxConsumers​(java.lang.String topic,
                     int maxConsumers)
              throws PulsarAdminException
        Deprecated.
        Set the max number of consumer for specified topic.
        Parameters:
        topic - Topic name
        maxConsumers - Max number of consumer
        Throws:
        PulsarAdminException - Unexpected error

      • setMaxConsumersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setMaxConsumersAsync​(java.lang.String topic,
                                                                            int maxConsumers)
        Deprecated.
        Set the max number of consumer for specified topic asynchronously.
        Parameters:
        topic - Topic name
        maxConsumers - Max number of consumer
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxConsumers

        @Deprecated
void removeMaxConsumers​(java.lang.String topic)
                 throws PulsarAdminException
        Deprecated.
        Remove the max number of consumer for specified topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeMaxConsumersAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeMaxConsumersAsync​(java.lang.String topic)
        Deprecated.
        Remove the max number of consumer for specified topic asynchronously.
        Parameters:
        topic - Topic name

      • getDeduplicationSnapshotInterval

        @Deprecated
java.lang.Integer getDeduplicationSnapshotInterval​(java.lang.String topic)
                                            throws PulsarAdminException
        Deprecated.
        Get the deduplication snapshot interval for specified topic.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getDeduplicationSnapshotIntervalAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Integer> getDeduplicationSnapshotIntervalAsync​(java.lang.String topic)
        Deprecated.
        Get the deduplication snapshot interval for specified topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setDeduplicationSnapshotInterval

        @Deprecated
void setDeduplicationSnapshotInterval​(java.lang.String topic,
                                      int interval)
                               throws PulsarAdminException
        Deprecated.
        Set the deduplication snapshot interval for specified topic.
        Parameters:
        topic -
        interval -
        Throws:
        PulsarAdminException

      • setDeduplicationSnapshotIntervalAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setDeduplicationSnapshotIntervalAsync​(java.lang.String topic,
                                                                                             int interval)
        Deprecated.
        Set the deduplication snapshot interval for specified topic asynchronously.
        Parameters:
        topic -
        interval -
        Returns:

      • removeDeduplicationSnapshotInterval

        @Deprecated
void removeDeduplicationSnapshotInterval​(java.lang.String topic)
                                  throws PulsarAdminException
        Deprecated.
        Remove the deduplication snapshot interval for specified topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeDeduplicationSnapshotIntervalAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeDeduplicationSnapshotIntervalAsync​(java.lang.String topic)
        Deprecated.
        Remove the deduplication snapshot interval for specified topic asynchronously.
        Parameters:
        topic -
        Returns:

      • setSubscriptionTypesEnabled

        @Deprecated
void setSubscriptionTypesEnabled​(java.lang.String topic,
                                 java.util.Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled)
                          throws PulsarAdminException
        Deprecated.
        Set is enable sub types.
        Parameters:
        topic -
        subscriptionTypesEnabled - is enable subTypes
        Throws:
        PulsarAdminException - Unexpected error

      • setSubscriptionTypesEnabledAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setSubscriptionTypesEnabledAsync​(java.lang.String topic,
                                                                                        java.util.Set<org.apache.pulsar.client.api.SubscriptionType> subscriptionTypesEnabled)
        Deprecated.
        Set is enable sub types asynchronously.
        Parameters:
        topic -
        subscriptionTypesEnabled - is enable subTypes

      • getSubscriptionTypesEnabled

        @Deprecated
java.util.Set<org.apache.pulsar.client.api.SubscriptionType> getSubscriptionTypesEnabled​(java.lang.String topic)
                                                                                  throws PulsarAdminException
        Deprecated.
        Get is enable sub types.
        Parameters:
        topic - is topic for get is enable sub types
        Returns:
        set of enable sub types Set
        Throws:
        PulsarAdminException - Unexpected error

      • getSubscriptionTypesEnabledAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.util.Set<org.apache.pulsar.client.api.SubscriptionType>> getSubscriptionTypesEnabledAsync​(java.lang.String topic)
        Deprecated.
        Get is enable sub types asynchronously.
        Parameters:
        topic - is topic for get is enable sub types

      • removeSubscriptionTypesEnabled

        @Deprecated
void removeSubscriptionTypesEnabled​(java.lang.String topic)
                             throws PulsarAdminException
        Deprecated.
        Remove subscription types enabled for a topic.
        Parameters:
        topic - Topic name
        Throws:
        PulsarAdminException - Unexpected error

      • removeSubscriptionTypesEnabledAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeSubscriptionTypesEnabledAsync​(java.lang.String topic)
        Deprecated.
        Remove subscription types enabled for a topic asynchronously.
        Parameters:
        topic - Topic name

      • setSubscribeRate

        @Deprecated
void setSubscribeRate​(java.lang.String topic,
                      SubscribeRate subscribeRate)
               throws PulsarAdminException
        Deprecated.
        Set topic-subscribe-rate (topic will limit by subscribeRate).
        Parameters:
        topic -
        subscribeRate - consumer subscribe limit by this subscribeRate
        Throws:
        PulsarAdminException - Unexpected error

      • setSubscribeRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> setSubscribeRateAsync​(java.lang.String topic,
                                                                             SubscribeRate subscribeRate)
        Deprecated.
        Set topic-subscribe-rate (topics will limit by subscribeRate) asynchronously.
        Parameters:
        topic -
        subscribeRate - consumer subscribe limit by this subscribeRate

      • getSubscribeRate

        @Deprecated
SubscribeRate getSubscribeRate​(java.lang.String topic)
                        throws PulsarAdminException
        Deprecated.
        Get topic-subscribe-rate (topics allow subscribe times per consumer in a period).
        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getSubscribeRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<SubscribeRate> getSubscribeRateAsync​(java.lang.String topic)
        Deprecated.
        Get topic-subscribe-rate asynchronously.

        Topic allow subscribe times per consumer in a period.

        Parameters:
        topic -

      • getSubscribeRate

        @Deprecated
SubscribeRate getSubscribeRate​(java.lang.String topic,
                               boolean applied)
                        throws PulsarAdminException
        Deprecated.
        Get applied topic-subscribe-rate (topics allow subscribe times per consumer in a period).
        Parameters:
        topic -
        Throws:
        PulsarAdminException - Unexpected error

      • getSubscribeRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<SubscribeRate> getSubscribeRateAsync​(java.lang.String topic,
                                                                            boolean applied)
        Deprecated.
        Get applied topic-subscribe-rate asynchronously.
        Parameters:
        topic -

      • removeSubscribeRate

        @Deprecated
void removeSubscribeRate​(java.lang.String topic)
                  throws PulsarAdminException
        Deprecated.
        Remove topic-subscribe-rate.

        Remove topic subscribe rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • removeSubscribeRateAsync

        @Deprecated
java.util.concurrent.CompletableFuture<java.lang.Void> removeSubscribeRateAsync​(java.lang.String topic)
                                                                         throws PulsarAdminException
        Deprecated.
        Remove topic-subscribe-rate asynchronously.

        Remove topic subscribe rate

        Parameters:
        topic -
        Throws:
        PulsarAdminException - unexpected error

      • examineMessage

        org.apache.pulsar.client.api.Message<byte[]> examineMessage​(java.lang.String topic,
                                                            java.lang.String initialPosition,
                                                            long messagePosition)
                                                     throws PulsarAdminException
        Examine a specific message on a topic by position relative to the earliest or the latest message.
        Parameters:
        topic - Topic name
        initialPosition - Relative start position to examine message. It can be 'latest' or 'earliest'
        messagePosition - The position of messages (default 1)
        Throws:
        PulsarAdminException

      • examineMessageAsync

        java.util.concurrent.CompletableFuture<org.apache.pulsar.client.api.Message<byte[]>> examineMessageAsync​(java.lang.String topic,
                                                                                                         java.lang.String initialPosition,
                                                                                                         long messagePosition)
                                                                                                  throws PulsarAdminException
        Examine a specific message on a topic by position relative to the earliest or the latest message.
        Parameters:
        topic - Topic name
        initialPosition - Relative start position to examine message. It can be 'latest' or 'earliest'
        messagePosition - The position of messages (default 1)
        Throws:
        PulsarAdminException

      • truncateAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> truncateAsync​(java.lang.String topic)
        Truncate a topic asynchronously.

        The latest ledger cannot be deleted.

        Parameters:
        topic - topic name
        Returns:
        a future that can be used to track when the topic is truncated

      • setReplicatedSubscriptionStatus

        void setReplicatedSubscriptionStatus​(java.lang.String topic,
                                     java.lang.String subName,
                                     boolean enabled)
                              throws PulsarAdminException
        Enable or disable a replicated subscription on a topic.
        Parameters:
        topic -
        subName -
        enabled -
        Throws:
        PulsarAdminException

      • setReplicatedSubscriptionStatusAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> setReplicatedSubscriptionStatusAsync​(java.lang.String topic,
                                                                                            java.lang.String subName,
                                                                                            boolean enabled)
        Enable or disable a replicated subscription on a topic asynchronously.
        Parameters:
        topic -
        subName -
        enabled -
        Returns:

      • getReplicationClusters

        java.util.Set<java.lang.String> getReplicationClusters​(java.lang.String topic,
                                                       boolean applied)
                                                throws PulsarAdminException
        Get the replication clusters for a topic.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • getReplicationClustersAsync

        java.util.concurrent.CompletableFuture<java.util.Set<java.lang.String>> getReplicationClustersAsync​(java.lang.String topic,
                                                                                                    boolean applied)
        Get the replication clusters for a topic asynchronously.
        Parameters:
        topic -
        applied -
        Returns:
        Throws:
        PulsarAdminException

      • setReplicationClusters

        void setReplicationClusters​(java.lang.String topic,
                            java.util.List<java.lang.String> clusterIds)
                     throws PulsarAdminException
        Set the replication clusters for the topic.
        Parameters:
        topic -
        clusterIds -
        Throws:
        PulsarAdminException

      • setReplicationClustersAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> setReplicationClustersAsync​(java.lang.String topic,
                                                                                   java.util.List<java.lang.String> clusterIds)
        Set the replication clusters for the topic asynchronously.
        Parameters:
        topic -
        clusterIds -
        Returns:
        Throws:
        PulsarAdminException

      • removeReplicationClusters

        void removeReplicationClusters​(java.lang.String topic)
                        throws PulsarAdminException
        Remove the replication clusters for the topic.
        Parameters:
        topic -
        Throws:
        PulsarAdminException

      • removeReplicationClustersAsync

        java.util.concurrent.CompletableFuture<java.lang.Void> removeReplicationClustersAsync​(java.lang.String topic)
        Remove the replication clusters for the topic asynchronously.
        Parameters:
        topic -
        Returns:
        Throws:
        PulsarAdminException

      • getReplicatedSubscriptionStatusAsync

        java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,​java.lang.Boolean>> getReplicatedSubscriptionStatusAsync​(java.lang.String topic,
                                                                                                                                     java.lang.String subName)
        Get replicated subscription status on a topic asynchronously.
        Parameters:
        topic - topic name
        Returns:
        a map of replicated subscription status on a topic