temporalio.envconfig.ClientConfigExtension

class documentation

class ClientConfigExtension(ABC): (source)

View In Hierarchy

Extension that adds config to client environment configuration.

An extension owns the TOML table under profile.<profile>.ext.<name>, where <name> is name, and turns its config into a client plugin. Extensions are recommended to use a TEMPORAL_EXT_<NAME>_ prefix for any environment variables they read. Pass extensions to ClientConfig.load_client_connect_config.

Warning

This API is experimental and unstable.

Method client_plugin Read this extension's config from the profile and env, and return a plugin that applies it, or None if there's nothing to apply.
Method name The extension's table key under profile.<profile>.ext. Must be unique among loaded extensions.
def client_plugin(self, req: ClientConfigExtensionRequest) -> temporalio.client.Plugin | None: (source)

Read this extension's config from the profile and env, and return a plugin that applies it, or None if there's nothing to apply.

def name(self) -> str: (source)

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