io.nats.client.api

Class ConsumerInfo

java.lang.Object

io.nats.client.api.ApiResponse<ConsumerInfo>

io.nats.client.api.ConsumerInfo

public class ConsumerInfo
extends ApiResponse<ConsumerInfo>

The ConsumerInfo class returns information about a JetStream consumer.

Field Summary

Fields inherited from class io.nats.client.api.ApiResponse

jv, NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
ConsumerInfo(JsonValue vConsumerInfo)
ConsumerInfo(Message msg)

Method Summary

Modifier and Type	Method and Description
SequenceInfo	getAckFloor()
long	getCalculatedPending()
ClusterInfo	getClusterInfo()
ConsumerConfiguration	getConsumerConfiguration()
java.time.ZonedDateTime	getCreationTime() Gets the creation time of the consumer.
SequenceInfo	getDelivered()
java.lang.String	getName()
long	getNumAckPending()
long	getNumPending()
long	getNumWaiting()
boolean	getPaused()
java.time.Duration	getPauseRemaining()
long	getRedelivered()
java.lang.String	getStreamName()
java.time.ZonedDateTime	getTimestamp() Gets the server time the info was gathered
boolean	isPushBound()

Methods inherited from class io.nats.client.api.ApiResponse

getApiErrorCode, getDescription, getError, getErrorCode, getErrorObject, getJv, getType, hasError, parseMessage, throwOnHasError, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerInfo

public ConsumerInfo(Message msg)

ConsumerInfo

public ConsumerInfo(JsonValue vConsumerInfo)

Method Detail

getConsumerConfiguration

public ConsumerConfiguration getConsumerConfiguration()

getName

public java.lang.String getName()

getStreamName

public java.lang.String getStreamName()

getCreationTime

public java.time.ZonedDateTime getCreationTime()

Gets the creation time of the consumer.

Returns:

the creation date and time.

getDelivered

public SequenceInfo getDelivered()

getAckFloor

public SequenceInfo getAckFloor()

getNumPending

public long getNumPending()

getNumWaiting

public long getNumWaiting()

getNumAckPending

public long getNumAckPending()

getRedelivered

public long getRedelivered()

getPaused

public boolean getPaused()

getPauseRemaining

public java.time.Duration getPauseRemaining()

getClusterInfo

public ClusterInfo getClusterInfo()

isPushBound

public boolean isPushBound()

getTimestamp

public java.time.ZonedDateTime getTimestamp()

Gets the server time the info was gathered

Returns:

the server gathered timed

getCalculatedPending

public long getCalculatedPending()