Module: NATS::JetStream::API

Defined in:
lib/nats/io/jetstream/api.rb

Overview

JetStream::API are the types used to interact with the JetStream API.

Defined Under Namespace

Classes: ConsumerConfig, ConsumerInfo, RawStreamMsg, SequenceInfo, StreamConfig, StreamCreateResponse, StreamInfo, StreamState

Constant Summary collapse

Error =

When the server responds with an error from the JetStream API.

::NATS::JetStream::Error::APIError

Instance Attribute Summary collapse

Instance Attribute Details

#ack_floor ⇒ SequenceInfo

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#ack_policy ⇒ String

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#ack_wait ⇒ Integer

Returns:

  • (Integer) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#bytes ⇒ Integer

Returns:

  • (Integer) 


250
251
252
253
254
255
256
257
258
 
# File 'lib/nats/io/jetstream/api.rb', line 250

StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
  :last_seq, :last_ts, :consumer_count,
  keyword_init: true) do
  def initialize(opts = {})
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#cluster ⇒ Hash

Returns:

  • (Hash) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#config ⇒ Hash

Returns:

  • (Hash) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#consumer_count ⇒ Integer

Returns:

  • (Integer) 


250
251
252
253
254
255
256
257
258
 
# File 'lib/nats/io/jetstream/api.rb', line 250

StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
  :last_seq, :last_ts, :consumer_count,
  keyword_init: true) do
  def initialize(opts = {})
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#consumer_seq ⇒ Integer

Returns The consumer sequence.

Returns:

  • (Integer) —

    The consumer sequence.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/nats/io/jetstream/api.rb', line 33

SequenceInfo = Struct.new(:consumer_seq, :stream_seq, :last_active,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields and freeze.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#created ⇒ String

Returns:

  • (String) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#deliver_policy ⇒ String

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#delivered ⇒ SequenceInfo

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#did_create ⇒ Boolean

Returns:

  • (Boolean) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#discard ⇒ String

Returns:

  • (String) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#duplicate_window ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#durable_name ⇒ String

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#first_seq ⇒ Integer

Returns:

  • (Integer) 


250
251
252
253
254
255
256
257
258
 
# File 'lib/nats/io/jetstream/api.rb', line 250

StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
  :last_seq, :last_ts, :consumer_count,
  keyword_init: true) do
  def initialize(opts = {})
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#last_seq ⇒ Integer

Returns:

  • (Integer) 


250
251
252
253
254
255
256
257
258
 
# File 'lib/nats/io/jetstream/api.rb', line 250

StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
  :last_seq, :last_ts, :consumer_count,
  keyword_init: true) do
  def initialize(opts = {})
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_ack_pending ⇒ Integer

Returns:

  • (Integer) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_age ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_bytes ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_consumers ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_deliver ⇒ Integer

Returns:

  • (Integer) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_msg_size ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_msgs ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_msgs_per_subject ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#max_waiting ⇒ Integer

Returns:

  • (Integer) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#messages ⇒ Integer

Returns:

  • (Integer) 


250
251
252
253
254
255
256
257
258
 
# File 'lib/nats/io/jetstream/api.rb', line 250

StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
  :last_seq, :last_ts, :consumer_count,
  keyword_init: true) do
  def initialize(opts = {})
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#name ⇒ String

Returns:

  • (String) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#num_ack_pending ⇒ Integer

Returns:

  • (Integer) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#num_pending ⇒ Integer

Returns:

  • (Integer) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#num_redelivered ⇒ Integer

Returns:

  • (Integer) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#num_replicas ⇒ Integer

Returns:

  • (Integer) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#num_waiting ⇒ Integer

Returns:

  • (Integer) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#replay_policy ⇒ String

Returns:

  • (String) 


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/nats/io/jetstream/api.rb', line 108

ConsumerConfig = Struct.new(:name, :durable_name, :description,
  :deliver_policy, :opt_start_seq, :opt_start_time,
  :ack_policy, :ack_wait, :max_deliver, :backoff,
  :filter_subject, :replay_policy, :rate_limit_bps,
  :sample_freq, :max_waiting, :max_ack_pending,
  :flow_control, :idle_heartbeat, :headers_only,
  # Pull based options
  :max_batch, :max_expires,
  # Push based consumers
  :deliver_subject, :deliver_group,
  # Ephemeral inactivity threshold
  :inactive_threshold,
  # Generally inherited by parent stream and other markers,
  # now can be configured directly.
  :num_replicas,
  # Force memory storage
  :mem_storage,
  # NATS v2.10 features
  :metadata, :filter_subjects, :max_bytes,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#retention ⇒ String

Returns:

  • (String) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#state ⇒ StreamState

Returns:



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#storage ⇒ String

Returns:

  • (String) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#stream_name ⇒ String

Returns name of the stream to which the consumer belongs.

Returns:

  • (String) —

    name of the stream to which the consumer belongs.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/nats/io/jetstream/api.rb', line 68

ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
  :config, :delivered, :ack_floor,
  :num_ack_pending, :num_redelivered, :num_waiting,
  :num_pending, :cluster, :push_bound,
  keyword_init: true) do
  def initialize(opts = {})
    opts[:created] = Time.parse(opts[:created])
    opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
    opts[:delivered] = SequenceInfo.new(opts[:delivered])
    opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
    opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
    opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
    opts[:config] = ConsumerConfig.new(opts[:config])
    opts.delete(:cluster)
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#stream_seq ⇒ Integer

Returns The stream sequence.

Returns:

  • (Integer) —

    The stream sequence.



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/nats/io/jetstream/api.rb', line 33

SequenceInfo = Struct.new(:consumer_seq, :stream_seq, :last_active,
  keyword_init: true) do
  def initialize(opts = {})
    # Filter unrecognized fields and freeze.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
    freeze
  end
end

#subjects ⇒ Array

Returns:

  • (Array) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end

#type ⇒ String

Returns:

  • (String) 


174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/nats/io/jetstream/api.rb', line 174

StreamConfig = Struct.new(
  :name,
  :description,
  :subjects,
  :retention,
  :max_consumers,
  :max_msgs,
  :max_bytes,
  :discard,
  :max_age,
  :max_msgs_per_subject,
  :max_msg_size,
  :storage,
  :num_replicas,
  :no_ack,
  :duplicate_window,
  :placement,
  :mirror,
  :sources,
  :sealed,
  :deny_delete,
  :deny_purge,
  :allow_rollup_hdrs,
  :republish,
  :allow_direct,
  :mirror_direct,
  :metadata,
  keyword_init: true
) do
  def initialize(opts = {})
    # Filter unrecognized fields just in case.
    rem = opts.keys - members
    opts.delete_if { |k| rem.include?(k) }
    super
  end
end