Class: NATS::JetStream::API::StreamConfig

Inherits:

Struct

• Object
• Struct
• NATS::JetStream::API::StreamConfig

Defined in:

lib/nats/io/jetstream/api.rb

Overview

StreamConfig represents the configuration of a stream from JetStream.

Instance Attribute Summary

• #allow_direct ⇒ Object

  Returns the value of attribute allow_direct.

• #allow_rollup_hdrs ⇒ Object

  Returns the value of attribute allow_rollup_hdrs.

• #config ⇒ Hash
• #created ⇒ String
• #deny_delete ⇒ Object

  Returns the value of attribute deny_delete.

• #deny_purge ⇒ Object

  Returns the value of attribute deny_purge.

• #description ⇒ Object

  Returns the value of attribute description.

• #did_create ⇒ Boolean
• #discard ⇒ String
• #duplicate_window ⇒ Integer
• #max_age ⇒ Integer
• #max_bytes ⇒ Integer
• #max_consumers ⇒ Integer
• #max_msg_size ⇒ Integer
• #max_msgs ⇒ Integer
• #max_msgs_per_subject ⇒ Integer
• #metadata ⇒ Object

  Returns the value of attribute metadata.

• #mirror ⇒ Object

  Returns the value of attribute mirror.

• #mirror_direct ⇒ Object

  Returns the value of attribute mirror_direct.

• #name ⇒ String
• #no_ack ⇒ Object

  Returns the value of attribute no_ack.

• #num_replicas ⇒ Integer
• #placement ⇒ Object

  Returns the value of attribute placement.

• #republish ⇒ Object

  Returns the value of attribute republish.

• #retention ⇒ String
• #sealed ⇒ Object

  Returns the value of attribute sealed.

• #sources ⇒ Object

  Returns the value of attribute sources.

• #state ⇒ StreamState
• #storage ⇒ String
• #subjects ⇒ Array
• #type ⇒ String

Instance Method Summary

• #initialize(opts = {}) ⇒ StreamConfig constructor

  A new instance of StreamConfig.

Constructor Details

#initialize(opts = {}) ⇒ StreamConfig

Returns a new instance of StreamConfig.

# File 'lib/nats/io/jetstream/api.rb', line 203

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

#allow_direct ⇒ Object

Returns the value of attribute allow_direct

Returns:

• (Object) —

  the current value of allow_direct

# File 'lib/nats/io/jetstream/api.rb', line 174

def allow_direct
  @allow_direct
end

#allow_rollup_hdrs ⇒ Object

Returns the value of attribute allow_rollup_hdrs

Returns:

• (Object) —

  the current value of allow_rollup_hdrs

# File 'lib/nats/io/jetstream/api.rb', line 174

def allow_rollup_hdrs
  @allow_rollup_hdrs
end

#config ⇒ Hash

Returns:

• (Hash)

# 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

#created ⇒ String

Returns:

• (String)

# 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

#deny_delete ⇒ Object

Returns the value of attribute deny_delete

Returns:

• (Object) —

  the current value of deny_delete

# File 'lib/nats/io/jetstream/api.rb', line 174

def deny_delete
  @deny_delete
end

#deny_purge ⇒ Object

Returns the value of attribute deny_purge

Returns:

• (Object) —

  the current value of deny_purge

# File 'lib/nats/io/jetstream/api.rb', line 174

def deny_purge
  @deny_purge
end

#description ⇒ Object

Returns the value of attribute description

Returns:

• (Object) —

  the current value of description

# File 'lib/nats/io/jetstream/api.rb', line 174

def description
  @description
end

#did_create ⇒ Boolean

Returns:

• (Boolean)

# 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)

# 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)

# 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_age ⇒ Integer

Returns:

• (Integer)

# 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)

# 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)

# 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_msg_size ⇒ Integer

Returns:

• (Integer)

# 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)

# 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)

# 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

#metadata ⇒ Object

Returns the value of attribute metadata

Returns:

• (Object) —

  the current value of metadata

# File 'lib/nats/io/jetstream/api.rb', line 174

def metadata
  @metadata
end

#mirror ⇒ Object

Returns the value of attribute mirror

Returns:

• (Object) —

  the current value of mirror

# File 'lib/nats/io/jetstream/api.rb', line 174

def mirror
  @mirror
end

#mirror_direct ⇒ Object

Returns the value of attribute mirror_direct

Returns:

• (Object) —

  the current value of mirror_direct

# File 'lib/nats/io/jetstream/api.rb', line 174

def mirror_direct
  @mirror_direct
end

#name ⇒ String

Returns:

• (String)

# 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

#no_ack ⇒ Object

Returns the value of attribute no_ack

Returns:

• (Object) —

  the current value of no_ack

# File 'lib/nats/io/jetstream/api.rb', line 174

def no_ack
  @no_ack
end

#num_replicas ⇒ Integer

Returns:

• (Integer)

# 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

#placement ⇒ Object

Returns the value of attribute placement

Returns:

• (Object) —

  the current value of placement

# File 'lib/nats/io/jetstream/api.rb', line 174

def placement
  @placement
end

#republish ⇒ Object

Returns the value of attribute republish

Returns:

• (Object) —

  the current value of republish

# File 'lib/nats/io/jetstream/api.rb', line 174

def republish
  @republish
end

#retention ⇒ String

Returns:

• (String)

# 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

#sealed ⇒ Object

Returns the value of attribute sealed

Returns:

• (Object) —

  the current value of sealed

# File 'lib/nats/io/jetstream/api.rb', line 174

def sealed
  @sealed
end

#sources ⇒ Object

Returns the value of attribute sources

Returns:

• (Object) —

  the current value of sources

# File 'lib/nats/io/jetstream/api.rb', line 174

def sources
  @sources
end

#state ⇒ StreamState

Returns:

• (StreamState)

# 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)

# 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

#subjects ⇒ Array

Returns:

• (Array)

# 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)

# 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