temporalio.service.ServiceClient

class documentation

class ServiceClient(ABC): (source)

Known subclasses: temporalio.service._BridgeServiceClient

Constructors: ServiceClient.connect(config), ServiceClient(config)

View In Hierarchy

Direct client to Temporal services.

Async Static Method connect Connect directly to Temporal services.
Method __init__ Initialize the base service client.
Async Method check_health the WorkflowService is used.
Method update_api_key Update service client's API key.
Method update_rpc_metadata Update service client's RPC metadata.
Instance Variable cloud_service Undocumented
Instance Variable config Undocumented
Instance Variable health_service Undocumented
Instance Variable operator_service Undocumented
Instance Variable test_service Undocumented
Instance Variable workflow_service Undocumented
Property worker_service_client Underlying service client.
Async Method _rpc_call Undocumented
async def connect(config: ConnectConfig) -> ServiceClient: (source)
overridden in temporalio.service._BridgeServiceClient

Connect directly to Temporal services.

def __init__(self, config: ConnectConfig): (source)
overridden in temporalio.service._BridgeServiceClient

Initialize the base service client.

async def check_health(self, *, service: str = 'temporal.api.workflowservice.v1.WorkflowService', retry: bool = False, metadata: Mapping[str, str | bytes] = {}, timeout: timedelta | None = None) -> bool: (source)

Check whether the provided service is up. If no service is specified,
the WorkflowService is used.

Returns
boolTrue when available, false if the server is running but the service is unavailable (rare), or raises an error if server/service cannot be reached.
def update_api_key(self, api_key: str | None): (source)
overridden in temporalio.service._BridgeServiceClient

Update service client's API key.

def update_rpc_metadata(self, metadata: Mapping[str, str | bytes]): (source)
overridden in temporalio.service._BridgeServiceClient

Update service client's RPC metadata.

cloud_service = (source)

Undocumented

config = (source)

Undocumented

health_service = (source)

Undocumented

operator_service = (source)

Undocumented

test_service = (source)

Undocumented

workflow_service = (source)

Undocumented

worker_service_client: _BridgeServiceClient = (source)
overridden in temporalio.service._BridgeServiceClient

Underlying service client.

async def _rpc_call(self, rpc: str, req: google.protobuf.message.Message, resp_type: type[ServiceResponse], *, service: str, retry: bool, metadata: Mapping[str, str | bytes], timeout: timedelta | None) -> ServiceResponse: (source)
overridden in temporalio.service._BridgeServiceClient

Undocumented