Class ConsumerConfig

Namespace: NATS.Client.JetStream.Models

Assembly: NATS.Client.JetStream.dll

public record ConsumerConfig : IEquatable<ConsumerConfig>

Inheritance: object

ConsumerConfig

Implements: IEquatable<ConsumerConfig>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConsumerConfig(): Create an ephemeral consumer configuration.

ConsumerConfig(string): Create a durable consumer configuration.

Properties

AckPolicy

AckWait: How long (in nanoseconds) to allow messages to remain un-acknowledged before attempting redelivery

Backoff: List of durations in Go format that represents a retry time scale for NaK'd messages

DeliverGroup

DeliverPolicy

DeliverSubject

Description: A short description of the purpose of this consumer

Direct: Creates a special consumer that does not touch the Raft layers, not for general use by clients, internal use only

DurableName: A unique name for a durable consumer

FilterSubject: Filter the stream by a single subjects

FilterSubjects: Filter the stream by multiple subjects

FlowControl: For push consumers this will regularly send an empty mess with Status header 100 and a reply subject, consumers must reply to these messages to control the rate of message delivery

HeadersOnly: Delivers only the headers of messages in the stream and not the bodies. Additionally adds Nats-Msg-Size header to indicate the size of the removed payload

IdleHeartbeat: If the Consumer is idle for more than this many nano seconds a empty message with Status header 100 will be sent indicating the consumer is still alive

InactiveThreshold: Duration that instructs the server to cleanup ephemeral consumers that are inactive for that long

MaxAckPending: The maximum number of messages without acknowledgement that can be outstanding, once this limit is reached message delivery will be suspended

MaxBatch: The largest batch property that may be specified when doing a pull on a Pull Consumer

MaxBytes: The maximum bytes value that maybe set when dong a pull on a Pull Consumer

MaxDeliver: The number of times a message will be redelivered to consumers if not acknowledged in time

MaxExpires: The maximum expires value that may be set when doing a pull on a Pull Consumer

MaxWaiting: The number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored

MemStorage: Force the consumer state to be kept in memory rather than inherit the setting from the stream

Metadata: Additional metadata for the Consumer

Name: A unique name for a consumer

NumReplicas: When set do not inherit the replica count from the stream but specifically set it to this amount

OptStartSeq

OptStartTime

PauseUntil: If the consumer is paused, this contains until which time it is paused.

RateLimitBps: The rate at which messages will be delivered to clients, expressed in bit per second

ReplayPolicy

SampleFreq

Edit this page