Class: Smplkit::Audit::ForwarderEnvironment

Inherits:
Struct
  • Object
show all
Defined in:
lib/smplkit/audit/models.rb

Overview

Per-environment enablement and optional configuration override for a forwarder.

A forwarder delivers events in a given environment only when that environment has an entry in Smplkit::Audit::Forwarder#environments with enabled: true. An environment with no entry (or enabled: false) receives no deliveries.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: false, configuration: nil) ⇒ ForwarderEnvironment

Returns a new instance of ForwarderEnvironment.



421
422
423
 
# File 'lib/smplkit/audit/models.rb', line 421

def initialize(enabled: false, configuration: nil)
  super
end

Instance Attribute Details

#configuration ⇒ HttpConfiguration?

Returns Optional per-environment destination configuration that fully replaces the forwarder’s base Smplkit::Audit::Forwarder#configuration for this environment. nil (the default) inherits the base configuration. As with the base configuration, header values are returned in plaintext on reads, so a get-mutate-put round-trip preserves them without re-entering secrets.

Returns:

  • (HttpConfiguration, nil) —

    Optional per-environment destination configuration that fully replaces the forwarder’s base Smplkit::Audit::Forwarder#configuration for this environment. nil (the default) inherits the base configuration. As with the base configuration, header values are returned in plaintext on reads, so a get-mutate-put round-trip preserves them without re-entering secrets.



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/smplkit/audit/models.rb', line 420

ForwarderEnvironment = Struct.new(:enabled, :configuration, keyword_init: true) do
  def initialize(enabled: false, configuration: nil)
    super
  end

  def self.from_wire(src)
    return new if src.nil?

    cfg = src.configuration
    new(
      enabled: src.enabled.nil? ? false : src.enabled,
      configuration: cfg.nil? ? nil : HttpConfiguration.from_wire(cfg)
    )
  end
end

#enabled ⇒ Boolean

Returns Whether the forwarder delivers events in this environment. Defaults to false.

Returns:

  • (Boolean) —

    Whether the forwarder delivers events in this environment. Defaults to false.



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/smplkit/audit/models.rb', line 420

ForwarderEnvironment = Struct.new(:enabled, :configuration, keyword_init: true) do
  def initialize(enabled: false, configuration: nil)
    super
  end

  def self.from_wire(src)
    return new if src.nil?

    cfg = src.configuration
    new(
      enabled: src.enabled.nil? ? false : src.enabled,
      configuration: cfg.nil? ? nil : HttpConfiguration.from_wire(cfg)
    )
  end
end

Class Method Details

.from_wire(src) ⇒ Object 



425
426
427
428
429
430
431
432
433
 
# File 'lib/smplkit/audit/models.rb', line 425

def self.from_wire(src)
  return new if src.nil?

  cfg = src.configuration
  new(
    enabled: src.enabled.nil? ? false : src.enabled,
    configuration: cfg.nil? ? nil : HttpConfiguration.from_wire(cfg)
  )
end