ConsumerStats (Pulsar Client Admin :: API 2.9.0-rc-202110122205 API)

```
public interface ConsumerStats
```
Consumer statistics.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getAddress()` Address of this consumer.
`int`	`getAvailablePermits()` Number of available message permits for the consumer.
`int`	`getAvgMessagesPerEntry()` Number of average messages per entry for the consumer consumed.
`long`	`getBytesOutCounter()` Total bytes delivered to consumer (bytes).
`double`	`getChunkedMessageRate()` Total chunked messages dispatched.
`String`	`getClientVersion()` Client library version.
`String`	`getConnectedSince()` Timestamp of connection.
`String`	`getConsumerName()` Name of the consumer.
`List<String>`	`getKeyHashRanges()` Hash ranges assigned to this consumer if is Key_Shared sub mode.
`long`	`getLastAckedTimestamp()`
`long`	`getLastConsumedTimestamp()`
`Map<String,String>`	`getMetadata()` Metadata (key/value strings) associated with this consumer.
`long`	`getMsgOutCounter()` Total messages delivered to consumer (msg).
`double`	`getMsgRateOut()` Total rate of messages delivered to the consumer (msg/s).
`double`	`getMsgRateRedeliver()` Total rate of messages redelivered by this consumer (msg/s).
`double`	`getMsgThroughputOut()` Total throughput delivered to the consumer (bytes/s).
`String`	`getReadPositionWhenJoining()` The read position of the cursor when the consumer joining.
`int`	`getUnackedMessages()` Number of unacknowledged messages for the consumer.
`boolean`	`isBlockedConsumerOnUnackedMsgs()` Flag to verify if consumer is blocked due to reaching threshold of unacked messages.

- Method Detail
  - getMsgRateOut
```
double getMsgRateOut()
```
    Total rate of messages delivered to the consumer (msg/s).
  - getMsgThroughputOut
```
double getMsgThroughputOut()
```
    Total throughput delivered to the consumer (bytes/s).
  - getBytesOutCounter
```
long getBytesOutCounter()
```
    Total bytes delivered to consumer (bytes).
  - getMsgOutCounter
```
long getMsgOutCounter()
```
    Total messages delivered to consumer (msg).
  - getMsgRateRedeliver
```
double getMsgRateRedeliver()
```
    Total rate of messages redelivered by this consumer (msg/s).
  - getChunkedMessageRate
```
double getChunkedMessageRate()
```
    Total chunked messages dispatched.
  - getConsumerName
```
String getConsumerName()
```
    Name of the consumer.
  - getAvailablePermits
```
int getAvailablePermits()
```
    Number of available message permits for the consumer.
  - getUnackedMessages
```
int getUnackedMessages()
```
    Number of unacknowledged messages for the consumer.
  - getAvgMessagesPerEntry
```
int getAvgMessagesPerEntry()
```
    Number of average messages per entry for the consumer consumed.
  - isBlockedConsumerOnUnackedMsgs
```
boolean isBlockedConsumerOnUnackedMsgs()
```
    Flag to verify if consumer is blocked due to reaching threshold of unacked messages.
  - getReadPositionWhenJoining
```
String getReadPositionWhenJoining()
```
    The read position of the cursor when the consumer joining.
  - getAddress
```
String getAddress()
```
    Address of this consumer.
  - getConnectedSince
```
String getConnectedSince()
```
    Timestamp of connection.
  - getClientVersion
```
String getClientVersion()
```
    Client library version.
  - getLastAckedTimestamp
```
long getLastAckedTimestamp()
```
  - getLastConsumedTimestamp
```
long getLastConsumedTimestamp()
```
  - getKeyHashRanges
```
List<String> getKeyHashRanges()
```
    Hash ranges assigned to this consumer if is Key_Shared sub mode.
  - getMetadata
```
Map<String,String> getMetadata()
```
    Metadata (key/value strings) associated with this consumer.

Interface ConsumerStats

Method Summary

Method Detail

getMsgRateOut

getMsgThroughputOut

getBytesOutCounter

getMsgOutCounter

getMsgRateRedeliver

getChunkedMessageRate

getConsumerName

getAvailablePermits

getUnackedMessages

getAvgMessagesPerEntry

isBlockedConsumerOnUnackedMsgs

getReadPositionWhenJoining

getAddress

getConnectedSince

getClientVersion

getLastAckedTimestamp

getLastConsumedTimestamp

getKeyHashRanges

getMetadata