struct NATS::JetStream::API::V1::ConsumerConfig

• NATS::JetStream::API::V1::ConsumerConfig
• NATS::JetStream::API::Message
• Struct
• Value
• Object

Defined in:

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, 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 = false, deliver_group : Nil | String = durable_name)

Instance Method Summary

• #ack_policy : AckPolicy

  AckPolicy How messages should be acknowledged, AckNone, AckAll or AckExplicit

• #ack_wait : Time::Span | Nil
• #deliver_group : String | Nil
• #deliver_policy : DeliverPolicy

  DeliverPolicy The initial starting mode of the consumer, DeliverAll, DeliverLast, DeliverNew, DeliverByStartSequence or DeliverByStartTime

• #deliver_subject : String | Nil

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

• #description : String | Nil
• #durable_name : String | Nil

  Durable The name of the Consumer

• #filter_subject : String | Nil

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

• #flow_control? : Bool
• #idle_heartbeat : Time::Span | Nil
• #max_ack_pending : Int64 | Nil

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

• #max_deliver : Int64 | Nil

  MaxDeliver Maximum amount times a specific message will be delivered.

• #max_waiting : Int64 | Nil
• #opt_start_seq : Int64 | Nil

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

• #opt_start_time : Time | Nil

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

• #rate_limit_bps : UInt64 | Nil

  RateLimit The rate of message delivery in bits per second

• #replay_policy : ReplayPolicy

  ReplayPolicy How messages are sent ReplayInstant or ReplayOriginal

• #sample_frequency : String | Nil

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

Constructor Detail

Instance Method Detail