struct

NATS::JetStream::ConsumerConfig

Inherits NATS::JetStream::Entity / JSON::Serializable / Struct / Value / Object

Constructors

new(pull : JSON::PullParser)

new(deliver_subject : Nil | String = nil, durable_name : Nil | String = nil, ack_policy : AckPolicy = :explicit, deliver_policy : DeliverPolicy = :all, replay_policy : ReplayPolicy = :instant, ack_wait : Time::Span | Nil = nil, filter_subject : Nil | String = nil, filter_subjects : Nil | Array(String) = nil, max_deliver = nil, opt_start_seq : Int64 | Nil = nil, sample_frequency : Nil | String = nil, opt_start_time : Time | Nil = nil, rate_limit_bps : UInt64 | Nil = nil, max_ack_pending : Int | Nil = nil, max_waiting : Int | Nil = nil, idle_heartbeat : Time::Span | Nil = nil, flow_control : Bool | Nil = nil, headers_only : Bool | Nil = nil, deliver_group : Nil | String = durable_name, max_request_batch : Int32 | Nil = nil, max_request_expires : Time::Span | Nil = nil, max_request_max_bytes : Int32 | Nil = nil, replicas : Int32 = 0, memory_storage : Bool | Nil = nil, inactive_threshold : Time::Span | Nil = nil)

Instance methods

ack_policy

How messages should be acknowledged: none, all, or explicit

ack_wait

How long to allow messages to remain un-acknowledged before attempting redelivery

deliver_group

deliver_policy

The initial starting mode of the consumer: all, last, new, by-start_sequence or by_start_time

deliver_subject

The subject to deliver observed messages, when not set, a pull-based Consumer is created

description

durable_name

The name of the Consumer, specifying this will persist the consumer to the NATS server

filter_subject

When consuming from a Stream with many subjects, or wildcards, select only a specific incoming subjects, supports wildcards

filter_subjects

When consuming from a Stream with many subjects, or wildcards, select only a specific incoming subjects, supports wildcards

flow_control?

headers_only?

idle_heartbeat

inactive_threshold

max_ack_pending

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

max_deliver

Maximum number of times a message will be delivered via this consumer. Use this to avoid poison pills crashing all your services forever.

max_request_batch

// Pull based options. MaxRequestBatch int json:"max_batch,omitempty" MaxRequestExpires time.Duration json:"max_expires,omitempty" MaxRequestMaxBytes int json:"max_bytes,omitempty" The maximum number of messages that can be requested from a pull consumer

max_request_expires

The

max_request_max_bytes

max_waiting

memory_storage?

opt_start_seq

When first consuming messages from the Stream start at this particular message in the set

opt_start_time

OptStartTime When first consuming messages from the Stream start with messages on or after this time

rate_limit_bps

The rate of message delivery in bits per second

replay_policy

How messages are sent: instant (default) or original

replicas

sample_frequency

What percentage of acknowledgements should be samples for observability, 0-100

Nested types