SubscriptionStats (Pulsar Client Admin :: API 2.9.0-rc-20211005153744 API)

All Known Subinterfaces:

NonPersistentSubscriptionStats
```
public interface SubscriptionStats
```
Statistics about subscription.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getActiveConsumerName()` The name of the consumer that is active for single active consumer subscriptions i.e.
`long`	`getBacklogSize()` Size of backlog in byte.
`long`	`getBytesOutCounter()` Total bytes delivered to consumer (bytes).
`int`	`getChunkedMessageRate()` Chunked message dispatch rate.
`List<? extends ConsumerStats>`	`getConsumers()` List of connected consumers on this subscription w/ their stats.
`Map<String,String>`	`getConsumersAfterMarkDeletePosition()` This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
`String`	`getKeySharedMode()` Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
`long`	`getLastAckedTimestamp()` Last acked message timestamp.
`long`	`getLastConsumedFlowTimestamp()` Last received consume flow command timestamp.
`long`	`getLastConsumedTimestamp()` Last consume message timestamp.
`long`	`getLastExpireTimestamp()` Last message expire execution timestamp.
`long`	`getLastMarkDeleteAdvancedTimestamp()` Last MarkDelete position advanced timesetamp.
`long`	`getMsgBacklog()` Number of messages in the subscription backlog.
`long`	`getMsgBacklogNoDelayed()` Number of messages in the subscription backlog that do not contain the delay messages.
`long`	`getMsgDelayed()` Number of delayed messages currently being tracked.
`long`	`getMsgOutCounter()` Total messages delivered to consumer (msg).
`double`	`getMsgRateExpired()` Total rate of messages expired on this subscription (msg/s).
`double`	`getMsgRateOut()` Total rate of messages delivered on this subscription (msg/s).
`double`	`getMsgRateRedeliver()` Total rate of messages redelivered on this subscription (msg/s).
`double`	`getMsgThroughputOut()` Total throughput delivered on this subscription (bytes/s).
`int`	`getNonContiguousDeletedMessagesRanges()` The number of non-contiguous deleted messages ranges.
`int`	`getNonContiguousDeletedMessagesRangesSerializedSize()` The serialized size of non-contiguous deleted messages ranges.
`long`	`getTotalMsgExpired()` Total messages expired on this subscription.
`String`	`getType()` Whether this subscription is Exclusive or Shared or Failover.
`long`	`getUnackedMessages()` Number of unacknowledged messages for the subscription.
`boolean`	`isAllowOutOfOrderDelivery()` Whether out of order delivery is allowed on the Key_Shared subscription.
`boolean`	`isBlockedSubscriptionOnUnackedMsgs()` Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
`boolean`	`isDurable()` Tells whether this subscription is durable or ephemeral (eg.: from a reader).
`boolean`	`isReplicated()` Mark that the subscription state is kept in sync across different regions.

- Method Detail
  - getMsgRateOut
```
double getMsgRateOut()
```
    Total rate of messages delivered on this subscription (msg/s).
  - getMsgThroughputOut
```
double getMsgThroughputOut()
```
    Total throughput delivered on this subscription (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 on this subscription (msg/s).
  - getChunkedMessageRate
```
int getChunkedMessageRate()
```
    Chunked message dispatch rate.
  - getMsgBacklog
```
long getMsgBacklog()
```
    Number of messages in the subscription backlog.
  - getBacklogSize
```
long getBacklogSize()
```
    Size of backlog in byte.
  - getMsgBacklogNoDelayed
```
long getMsgBacklogNoDelayed()
```
    Number of messages in the subscription backlog that do not contain the delay messages.
  - isBlockedSubscriptionOnUnackedMsgs
```
boolean isBlockedSubscriptionOnUnackedMsgs()
```
    Flag to verify if subscription is blocked due to reaching threshold of unacked messages.
  - getMsgDelayed
```
long getMsgDelayed()
```
    Number of delayed messages currently being tracked.
  - getUnackedMessages
```
long getUnackedMessages()
```
    Number of unacknowledged messages for the subscription.
  - getType
```
String getType()
```
    Whether this subscription is Exclusive or Shared or Failover.
  - getActiveConsumerName
```
String getActiveConsumerName()
```
    The name of the consumer that is active for single active consumer subscriptions i.e. failover or exclusive.
  - getMsgRateExpired
```
double getMsgRateExpired()
```
    Total rate of messages expired on this subscription (msg/s).
  - getTotalMsgExpired
```
long getTotalMsgExpired()
```
    Total messages expired on this subscription.
  - getLastExpireTimestamp
```
long getLastExpireTimestamp()
```
    Last message expire execution timestamp.
  - getLastConsumedFlowTimestamp
```
long getLastConsumedFlowTimestamp()
```
    Last received consume flow command timestamp.
  - getLastConsumedTimestamp
```
long getLastConsumedTimestamp()
```
    Last consume message timestamp.
  - getLastAckedTimestamp
```
long getLastAckedTimestamp()
```
    Last acked message timestamp.
  - getLastMarkDeleteAdvancedTimestamp
```
long getLastMarkDeleteAdvancedTimestamp()
```
    Last MarkDelete position advanced timesetamp.
  - getConsumers
```
List<? extends ConsumerStats> getConsumers()
```
    List of connected consumers on this subscription w/ their stats.
  - isDurable
```
boolean isDurable()
```
    Tells whether this subscription is durable or ephemeral (eg.: from a reader).
  - isReplicated
```
boolean isReplicated()
```
    Mark that the subscription state is kept in sync across different regions.
  - isAllowOutOfOrderDelivery
```
boolean isAllowOutOfOrderDelivery()
```
    Whether out of order delivery is allowed on the Key_Shared subscription.
  - getKeySharedMode
```
String getKeySharedMode()
```
    Whether the Key_Shared subscription mode is AUTO_SPLIT or STICKY.
  - getConsumersAfterMarkDeletePosition
```
Map<String,String> getConsumersAfterMarkDeletePosition()
```
    This is for Key_Shared subscription to get the recentJoinedConsumers in the Key_Shared subscription.
  - getNonContiguousDeletedMessagesRanges
```
int getNonContiguousDeletedMessagesRanges()
```
    The number of non-contiguous deleted messages ranges.
  - getNonContiguousDeletedMessagesRangesSerializedSize
```
int getNonContiguousDeletedMessagesRangesSerializedSize()
```
    The serialized size of non-contiguous deleted messages ranges.

Interface SubscriptionStats

Method Summary

Method Detail

getMsgRateOut

getMsgThroughputOut

getBytesOutCounter

getMsgOutCounter

getMsgRateRedeliver

getChunkedMessageRate

getMsgBacklog

getBacklogSize

getMsgBacklogNoDelayed

isBlockedSubscriptionOnUnackedMsgs

getMsgDelayed

getUnackedMessages

getType

getActiveConsumerName

getMsgRateExpired

getTotalMsgExpired

getLastExpireTimestamp

getLastConsumedFlowTimestamp

getLastConsumedTimestamp

getLastAckedTimestamp

getLastMarkDeleteAdvancedTimestamp

getConsumers

isDurable

isReplicated

isAllowOutOfOrderDelivery

getKeySharedMode

getConsumersAfterMarkDeletePosition

getNonContiguousDeletedMessagesRanges

getNonContiguousDeletedMessagesRangesSerializedSize