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

NO_TYPE, PARSE_ERROR_TYPE

Constructor Summary

Constructors

Constructor and Description
ConsumerInfo(io.nats.client.support.JsonValue jsonValue) Construct a ConsumerInfo instance from a JsonValue
ConsumerInfo(Message msg) Construct a ConsumerInfo instance from a message

Method Summary

Modifier and Type	Method and Description
@NonNull SequenceInfo	getAckFloor() The highest contiguous acknowledged message
long	getCalculatedPending() A way to more accurately calculate pending during the initial state of the consumer when messages may be unaccounted for in flight
@Nullable ClusterInfo	getClusterInfo() Information about the cluster for clustered environments
@NonNull ConsumerConfiguration	getConsumerConfiguration() The consumer configuration representing this consumer.
@NonNull java.time.ZonedDateTime	getCreationTime() Gets the creation time of the consumer.
@NonNull SequenceInfo	getDelivered() The last message delivered from this Consumer
@NonNull java.lang.String	getName() A unique name for the consumer, either machine generated or the durable name
long	getNumAckPending() The number of messages pending acknowledgement
long	getNumPending() The number of messages left unconsumed in this Consumer
long	getNumWaiting() The number of pull consumers waiting for messages
boolean	getPaused() Indicates if the consumer is currently in a paused state
@Nullable java.time.Duration	getPauseRemaining() When paused the time remaining until unpause
@Nullable java.util.List<PriorityGroupState>	getPriorityGroupStates() The state of Priority Groups
long	getRedelivered() The number of redeliveries that have been performed
@NonNull java.lang.String	getStreamName() The Stream the consumer belongs to
@Nullable java.time.ZonedDateTime	getTimestamp() Gets the server time the info was gathered
boolean	isPushBound() Indicates if any client is connected and receiving messages from a push consumer

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsumerInfo

public ConsumerInfo(Message msg)

Construct a ConsumerInfo instance from a message

Parameters:

msg - the message

ConsumerInfo

public ConsumerInfo(io.nats.client.support.JsonValue jsonValue)

Construct a ConsumerInfo instance from a JsonValue

Parameters:

jsonValue - the JsonValue

Method Detail

getConsumerConfiguration

public @NonNull ConsumerConfiguration getConsumerConfiguration()

The consumer configuration representing this consumer.

Returns:

the config

getName

public @NonNull java.lang.String getName()

A unique name for the consumer, either machine generated or the durable name

Returns:

the name

getStreamName

public @NonNull java.lang.String getStreamName()

The Stream the consumer belongs to

Returns:

the stream name

getCreationTime

public @NonNull java.time.ZonedDateTime getCreationTime()

Gets the creation time of the consumer.

Returns:

the creation date and time.

getDelivered

public @NonNull SequenceInfo getDelivered()

The last message delivered from this Consumer

Returns:

the last delivered sequence info

getAckFloor

public @NonNull SequenceInfo getAckFloor()

The highest contiguous acknowledged message

Returns:

the sequence info

getNumPending

public long getNumPending()

The number of messages left unconsumed in this Consumer

Returns:

the number of pending messages

getNumWaiting

public long getNumWaiting()

The number of pull consumers waiting for messages

Returns:

the number of waiting messages

getNumAckPending

public long getNumAckPending()

The number of messages pending acknowledgement

Returns:

the number of messages

getRedelivered

public long getRedelivered()

The number of redeliveries that have been performed

Returns:

the number of redeliveries

getPaused

public boolean getPaused()

Indicates if the consumer is currently in a paused state

Returns:

true if paused

getPauseRemaining

public @Nullable java.time.Duration getPauseRemaining()

When paused the time remaining until unpause

Returns:

the time remaining

getClusterInfo

public @Nullable ClusterInfo getClusterInfo()

Information about the cluster for clustered environments

Returns:

the cluster info object

isPushBound

public boolean isPushBound()

Indicates if any client is connected and receiving messages from a push consumer

Returns:

the flag

getTimestamp

public @Nullable java.time.ZonedDateTime getTimestamp()

Gets the server time the info was gathered

Returns:

the server gathered timed

getPriorityGroupStates

public @Nullable java.util.List<PriorityGroupState> getPriorityGroupStates()

The state of Priority Groups

Returns:

the list of Priority Groups, may be null

getCalculatedPending

public long getCalculatedPending()

A way to more accurately calculate pending during the initial state of the consumer when messages may be unaccounted for in flight

Returns:

the calculated amount