temporalio.client._RootPlugin

class documentation

class _RootPlugin(Plugin): (source)

View In Hierarchy

Undocumented

Method configure_client Hook called when creating a client to allow modification of configuration.
Async Method connect_service_client Hook called when connecting to the Temporal service.

Inherited from Plugin:

Method init_client_plugin Initialize this plugin in the plugin chain.
Method name Get the name of this plugin. Can be overridden if desired to provide a more appropriate name.
Instance Variable next_client_plugin Undocumented
def configure_client(self, config: ClientConfig) -> ClientConfig: (source)
overrides temporalio.client.Plugin.configure_client

Hook called when creating a client to allow modification of configuration.

This method is called during client creation and allows plugins to modify the client configuration before the client is fully initialized. Plugins can add interceptors, modify connection parameters, or change other settings.

Parameters
config:ClientConfigThe client configuration dictionary to potentially modify.
Returns
ClientConfigThe modified client configuration.
async def connect_service_client(self, config: temporalio.service.ConnectConfig) -> temporalio.service.ServiceClient: (source)
overrides temporalio.client.Plugin.connect_service_client

Hook called when connecting to the Temporal service.

This method is called during service client connection and allows plugins to intercept or modify the connection process. Plugins can modify connection parameters, add authentication, or provide custom connection logic.

Parameters
config:temporalio.service.ConnectConfigThe service connection configuration.
Returns
temporalio.service.ServiceClientThe connected service client.