Class NatsJSConsumeOpts

Namespace

NATS.Client.JetStream

Assembly

NATS.Client.JetStream.dll

Consumer consume method options.

public record NatsJSConsumeOpts : IEquatable<NatsJSConsumeOpts>

Inheritance

object

NatsJSConsumeOpts

Implements

IEquatable<NatsJSConsumeOpts>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Expires

Amount of time to wait for a single pull request to expire

IdleHeartbeat

Amount idle time the server should wait before sending a heartbeat

MaxBytes

Maximum number of bytes stored in the buffer

MaxConsecutive503Errors

Maximum number of consecutive 503 "No Responders" errors before the consumer is considered deleted and consumption stops. This helps detect when an ephemeral consumer has vanished on the server. Set to -1 to disable this check. (default: 10)

MaxMsgs

Maximum number of messages stored in the buffer

NotificationHandler

A handler function invoked for notifications related to consumption, allowing custom handling of operational updates or state changes during the consumer's lifecycle.

PriorityGroup

Optional priority group configuration used for consuming messages. Defines a group name and constraints for minimum pending messages and acknowledgments.

ThresholdBytes

Hint for the number of bytes left in buffer that should trigger a low watermark on the client, and influence it to request more data.

ThresholdMsgs

Number of messages left in the buffer that should trigger a low watermark on the client, and influence it to request more messages