Class: NATS::JetStream::API::ConsumerConfig

Inherits:
Struct
  • Object
show all
Defined in:
lib/nats/io/jetstream/api.rb

Overview

ConsumerConfig is the consumer configuration.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ ConsumerConfig

Returns a new instance of ConsumerConfig.



128
129
130
131
132
133
 
# File 'lib/nats/io/jetstream/api.rb', line 128

def initialize(opts = {})
  # Filter unrecognized fields just in case.
  rem = opts.keys - members
  opts.delete_if { |k| rem.include?(k) }
  super
end

Instance Attribute Details

#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

#backoff ⇒ Object

Returns the value of attribute backoff

Returns:

  • (Object) —

    the current value of backoff



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def backoff
  @backoff
end

#deliver_group ⇒ Object

Returns the value of attribute deliver_group

Returns:

  • (Object) —

    the current value of deliver_group



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def deliver_group
  @deliver_group
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

#deliver_subject ⇒ Object

Returns the value of attribute deliver_subject

Returns:

  • (Object) —

    the current value of deliver_subject



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def deliver_subject
  @deliver_subject
end

#description ⇒ Object

Returns the value of attribute description

Returns:

  • (Object) —

    the current value of description



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def description
  @description
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

#filter_subject ⇒ Object

Returns the value of attribute filter_subject

Returns:

  • (Object) —

    the current value of filter_subject



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def filter_subject
  @filter_subject
end

#filter_subjects ⇒ Object

Returns the value of attribute filter_subjects

Returns:

  • (Object) —

    the current value of filter_subjects



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def filter_subjects
  @filter_subjects
end

#flow_control ⇒ Object

Returns the value of attribute flow_control

Returns:

  • (Object) —

    the current value of flow_control



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def flow_control
  @flow_control
end

#headers_only ⇒ Object

Returns the value of attribute headers_only

Returns:

  • (Object) —

    the current value of headers_only



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def headers_only
  @headers_only
end

#idle_heartbeat ⇒ Object

Returns the value of attribute idle_heartbeat

Returns:

  • (Object) —

    the current value of idle_heartbeat



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def idle_heartbeat
  @idle_heartbeat
end

#inactive_threshold ⇒ Object

Returns the value of attribute inactive_threshold

Returns:

  • (Object) —

    the current value of inactive_threshold



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def inactive_threshold
  @inactive_threshold
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_batch ⇒ Object

Returns the value of attribute max_batch

Returns:

  • (Object) —

    the current value of max_batch



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def max_batch
  @max_batch
end

#max_bytes ⇒ Object

Returns the value of attribute max_bytes

Returns:

  • (Object) —

    the current value of max_bytes



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def max_bytes
  @max_bytes
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_expires ⇒ Object

Returns the value of attribute max_expires

Returns:

  • (Object) —

    the current value of max_expires



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def max_expires
  @max_expires
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

#mem_storage ⇒ Object

Returns the value of attribute mem_storage

Returns:

  • (Object) —

    the current value of mem_storage



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def mem_storage
  @mem_storage
end

#metadata ⇒ Object

Returns the value of attribute metadata

Returns:

  • (Object) —

    the current value of metadata



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def name
  @name
end

#num_replicas ⇒ Object

Returns the value of attribute num_replicas

Returns:

  • (Object) —

    the current value of num_replicas



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def num_replicas
  @num_replicas
end

#opt_start_seq ⇒ Object

Returns the value of attribute opt_start_seq

Returns:

  • (Object) —

    the current value of opt_start_seq



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def opt_start_seq
  @opt_start_seq
end

#opt_start_time ⇒ Object

Returns the value of attribute opt_start_time

Returns:

  • (Object) —

    the current value of opt_start_time



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def opt_start_time
  @opt_start_time
end

#rate_limit_bps ⇒ Object

Returns the value of attribute rate_limit_bps

Returns:

  • (Object) —

    the current value of rate_limit_bps



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def rate_limit_bps
  @rate_limit_bps
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

#sample_freq ⇒ Object

Returns the value of attribute sample_freq

Returns:

  • (Object) —

    the current value of sample_freq



108
109
110
 
# File 'lib/nats/io/jetstream/api.rb', line 108

def sample_freq
  @sample_freq
end