Module: Temporalio::EnvConfig::ClientConfigExtension

Defined in:
lib/temporalio/env_config.rb

Overview

Extension mixin to include for extending client configuration with extra TOML properties and environment variables, and applying them to the client created from the configuration.

Each extension owns a TOML table under profile.<profile>.ext.<name>, e.g.:

[profile.default.ext.my_extension]
some_field = "value"

Extensions are recommended to use a TEMPORAL_EXT_<NAME>_ prefix for any environment variables they read.

WARNING: Extensions are experimental.

Instance Method Summary collapse

Instance Method Details

#client_plugin(request) ⇒ Client::Plugin?

This method is abstract.

Read this extension's config from the profile and env, and return a plugin that applies it.

Parameters:

Returns:

  • (Client::Plugin, nil) —

    Plugin, or nil if there's nothing to apply.

Raises:

  • (NotImplementedError)


257
258
259
# File 'lib/temporalio/env_config.rb', line 257

def client_plugin(request)
  raise NotImplementedError
end

#name ⇒ String

This method is abstract.

Returns The extension's table key under profile.<profile>.ext. Must be unique among loaded extensions.

Returns:

  • (String) —

    The extension's table key under profile.<profile>.ext. Must be unique among loaded extensions.

Raises:

  • (NotImplementedError)


248
249
250
# File 'lib/temporalio/env_config.rb', line 248

def name
  raise NotImplementedError
end