org.apache.pulsar.client.admin.internal

Class NonPersistentTopicsImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.NonPersistentTopicsImpl

All Implemented Interfaces:

NonPersistentTopics

public class NonPersistentTopicsImpl
extends BaseResource
implements NonPersistentTopics

Field Summary

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

auth, readTimeoutMs

Constructor Summary

Constructors

Constructor and Description
NonPersistentTopicsImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, long readTimeoutMs)

Method Summary

Modifier and Type	Method and Description
void	createPartitionedTopic(String topic, int numPartitions) Create a partitioned topic.
CompletableFuture<Void>	createPartitionedTopicAsync(String topic, int numPartitions) Create a partitioned topic asynchronously.
org.apache.pulsar.common.policies.data.PersistentTopicInternalStats	getInternalStats(String topic) Get the internal stats for the topic.
CompletableFuture<org.apache.pulsar.common.policies.data.PersistentTopicInternalStats>	getInternalStatsAsync(String topic) Get the internal stats for the topic asynchronously.
List<String>	getList(String namespace) Get list of topics exist into given namespace.
CompletableFuture<List<String>>	getListAsync(String namespace) Get list of topics exist into given namespace asynchronously.
List<String>	getListInBundle(String namespace, String bundleRange) Get list of topics exist into given bundle.
CompletableFuture<List<String>>	getListInBundleAsync(String namespace, String bundleRange) Get list of topics exist into given bundle asynchronously.
org.apache.pulsar.common.partition.PartitionedTopicMetadata	getPartitionedTopicMetadata(String topic) Get metadata of a partitioned topic.
CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata>	getPartitionedTopicMetadataAsync(String topic) Get metadata of a partitioned topic asynchronously.
org.apache.pulsar.common.policies.data.NonPersistentTopicStats	getStats(String topic) Get the stats for the topic.
CompletableFuture<org.apache.pulsar.common.policies.data.NonPersistentTopicStats>	getStatsAsync(String topic) Get the stats for the topic asynchronously.
void	unload(String topic) Unload a topic.
CompletableFuture<Void>	unloadAsync(String topic) Unload a topic asynchronously.

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

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonPersistentTopicsImpl

public NonPersistentTopicsImpl(javax.ws.rs.client.WebTarget web,
                               org.apache.pulsar.client.api.Authentication auth,
                               long readTimeoutMs)

Method Detail

createPartitionedTopic

public void createPartitionedTopic(String topic,
                                   int numPartitions)
                            throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Create a partitioned topic.

Create a partitioned topic. It needs to be called before creating a producer for a partitioned topic.

Specified by:

createPartitionedTopic in interface NonPersistentTopics

Parameters:

topic - Topic name

numPartitions - Number of partitions to create of the topic

Throws:

PulsarAdminException

createPartitionedTopicAsync

public CompletableFuture<Void> createPartitionedTopicAsync(String topic,
                                                           int numPartitions)

Description copied from interface: NonPersistentTopics

Create a partitioned topic asynchronously.

Create a partitioned topic asynchronously. It needs to be called before creating a producer for a partitioned topic.

Specified by:

createPartitionedTopicAsync in interface NonPersistentTopics

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

getPartitionedTopicMetadata

public org.apache.pulsar.common.partition.PartitionedTopicMetadata getPartitionedTopicMetadata(String topic)
                                                                                        throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Get metadata of a partitioned topic.

Get metadata of a partitioned topic.

Specified by:

getPartitionedTopicMetadata in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

Partitioned topic metadata

Throws:

PulsarAdminException

getPartitionedTopicMetadataAsync

public CompletableFuture<org.apache.pulsar.common.partition.PartitionedTopicMetadata> getPartitionedTopicMetadataAsync(String topic)

Description copied from interface: NonPersistentTopics

Get metadata of a partitioned topic asynchronously.

Get metadata of a partitioned topic asynchronously.

Specified by:

getPartitionedTopicMetadataAsync in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

a future that can be used to track when the partitioned topic metadata is returned

getStats

public org.apache.pulsar.common.policies.data.NonPersistentTopicStats getStats(String topic)
                                                                        throws PulsarAdminException

Description copied from interface: NonPersistentTopics

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
       "connected" : true,              // Whether the replication-subscriber is currently connected locally
     },
     "cluster_2" : {
       "msgRateIn" : 100.0,
       "msgThroughputIn" : 10240.0,
       "msgRateOut" : 100.0,
       "msghroughputOut" : 10240.0,
       "connected" : true,
     }
   },
 }
 
 

All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.

Specified by:

getStats in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

the topic statistics

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Topic does not exist

PulsarAdminException - Unexpected error

getStatsAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.NonPersistentTopicStats> getStatsAsync(String topic)

Description copied from interface: NonPersistentTopics

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.

Specified by:

getStatsAsync in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

a future that can be used to track when the topic statistics are returned

getInternalStats

public org.apache.pulsar.common.policies.data.PersistentTopicInternalStats getInternalStats(String topic)
                                                                                     throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Get the internal stats for the topic.

Access the internal state of the topic

Specified by:

getInternalStats in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

the topic statistics

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Topic does not exist

PulsarAdminException - Unexpected error

getInternalStatsAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.PersistentTopicInternalStats> getInternalStatsAsync(String topic)

Description copied from interface: NonPersistentTopics

Get the internal stats for the topic asynchronously.

Specified by:

getInternalStatsAsync in interface NonPersistentTopics

Parameters:

topic - Topic Name

Returns:

a future that can be used to track when the internal topic statistics are returned

unload

public void unload(String topic)
            throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Unload a topic.

Specified by:

unload in interface NonPersistentTopics

Parameters:

topic - Topic name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Topic does not exist

PulsarAdminException - Unexpected error

unloadAsync

public CompletableFuture<Void> unloadAsync(String topic)

Description copied from interface: NonPersistentTopics

Unload a topic asynchronously.

Specified by:

unloadAsync in interface NonPersistentTopics

Parameters:

topic - Topic name

Returns:

a future that can be used to track when the topic is unloaded

getListInBundle

public List<String> getListInBundle(String namespace,
                                    String bundleRange)
                             throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Get list of topics exist into given bundle.

Specified by:

getListInBundle in interface NonPersistentTopics

Returns:

Throws:

PulsarAdminException

getListInBundleAsync

public CompletableFuture<List<String>> getListInBundleAsync(String namespace,
                                                            String bundleRange)

Description copied from interface: NonPersistentTopics

Get list of topics exist into given bundle asynchronously.

Specified by:

getListInBundleAsync in interface NonPersistentTopics

Returns:

getList

public List<String> getList(String namespace)
                     throws PulsarAdminException

Description copied from interface: NonPersistentTopics

Get list of topics exist into given namespace.

Specified by:

getList in interface NonPersistentTopics

Returns:

Throws:

PulsarAdminException

getListAsync

public CompletableFuture<List<String>> getListAsync(String namespace)

Description copied from interface: NonPersistentTopics

Get list of topics exist into given namespace asynchronously.

Specified by:

getListAsync in interface NonPersistentTopics

Returns: