Class: Collavre::IntegrationSettings::KeyDefinition

Inherits:

Struct

• Object
• Struct
• Collavre::IntegrationSettings::KeyDefinition

Defined in:

lib/collavre/integration_settings/key_definition.rb

Overview

Value object describing a registered integration setting key.

Instance Attribute Summary

• #category ⇒ String readonly

  Grouping for the admin UI (e.g. “slack”, “google_oauth”).

• #default ⇒ String^? readonly

  Static default returned when neither DB nor ENV has a value.

• #env_var ⇒ String readonly

  Name of the ENV variable used as fallback / seed source.

• #key ⇒ Symbol readonly

  Canonical key identifier (e.g. :slack_client_id).

• #requires_restart ⇒ Boolean readonly

  When true the admin UI surfaces a “restart required” badge.

• #sensitive ⇒ Boolean readonly

  When true the value is masked in the admin UI.

Instance Attribute Details

#category ⇒ String (readonly)

Returns grouping for the admin UI (e.g. “slack”, “google_oauth”).

Returns:

• (String) —

  grouping for the admin UI (e.g. “slack”, “google_oauth”)

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)

#default ⇒ String^? (readonly)

Returns static default returned when neither DB nor ENV has a value.

Returns:

• (String, nil) —

  static default returned when neither DB nor ENV has a value

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)

#env_var ⇒ String (readonly)

Returns name of the ENV variable used as fallback / seed source.

Returns:

• (String) —

  name of the ENV variable used as fallback / seed source

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)

#key ⇒ Symbol (readonly)

Returns canonical key identifier (e.g. :slack_client_id).

Returns:

• (Symbol) —

  canonical key identifier (e.g. :slack_client_id)

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)

#requires_restart ⇒ Boolean (readonly)

Returns when true the admin UI surfaces a “restart required” badge.

Returns:

• (Boolean) —

  when true the admin UI surfaces a “restart required” badge

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)

#sensitive ⇒ Boolean (readonly)

Returns when true the value is masked in the admin UI.

Returns:

• (Boolean) —

  when true the value is masked in the admin UI

# File 'lib/collavre/integration_settings/key_definition.rb', line 19

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  keyword_init: true
)