Class: Collavre::IntegrationSettings::KeyDefinition

Inherits:
Struct
  • Object
show all
Defined in:
lib/collavre/integration_settings/key_definition.rb

Overview

Value object describing a registered integration setting key.

Instance Attribute Summary collapse

Instance Attribute Details

#admin_visible ⇒ Boolean (readonly)

Returns when false the key is resolvable but hidden from the admin UI.

Returns:

  • (Boolean) —

    when false the key is resolvable but hidden from the admin UI



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

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

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



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  :input_type,
  :admin_visible,
  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



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  :input_type,
  :admin_visible,
  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



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

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

#input_type ⇒ Symbol (readonly)

Returns admin UI input widget: :string (default, single line) or :textarea.

Returns:

  • (Symbol) —

    admin UI input widget: :string (default, single line) or :textarea



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  :input_type,
  :admin_visible,
  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)



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  :input_type,
  :admin_visible,
  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



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

KeyDefinition = Struct.new(
  :key,
  :category,
  :sensitive,
  :requires_restart,
  :env_var,
  :default,
  :input_type,
  :admin_visible,
  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



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/collavre/integration_settings/key_definition.rb', line 23

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