temporalio.client.OutboundInterceptor

class documentation

class OutboundInterceptor: (source)

Known subclasses: temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor, temporalio.testing._workflow._TimeSkippingClientOutboundInterceptor

Constructor: OutboundInterceptor(next)

View In Hierarchy

OutboundInterceptor for intercepting client calls.

This should be extended by any client outbound interceptors.

Method __init__ Create the outbound interceptor.
Async Method backfill_schedule Called for every ScheduleHandle.backfill call.
Async Method cancel_workflow Called for every WorkflowHandle.cancel call.
Async Method complete_async_activity Called for every AsyncActivityHandle.complete call.
Async Method count_workflows Called for every Client.count_workflows call.
Async Method create_schedule Called for every Client.create_schedule call.
Async Method delete_schedule Called for every ScheduleHandle.delete call.
Async Method describe_schedule Called for every ScheduleHandle.describe call.
Async Method describe_workflow Called for every WorkflowHandle.describe call.
Async Method fail_async_activity Called for every AsyncActivityHandle.fail call.
Method fetch_workflow_history_events Called for every WorkflowHandle.fetch_history_events call.
Async Method get_worker_build_id_compatibility Called for every Client.get_worker_build_id_compatibility call.
Async Method get_worker_task_reachability Called for every Client.get_worker_task_reachability call.
Async Method heartbeat_async_activity Called for every AsyncActivityHandle.heartbeat call.
Method list_schedules Called for every Client.list_schedules call.
Method list_workflows Called for every Client.list_workflows call.
Async Method pause_schedule Called for every ScheduleHandle.pause call.
Async Method query_workflow Called for every WorkflowHandle.query call.
Async Method report_cancellation_async_activity Called for every AsyncActivityHandle.report_cancellation call.
Async Method signal_workflow Called for every WorkflowHandle.signal call.
Async Method start_update_with_start_workflow Called for every Client.start_update_with_start_workflow and Client.execute_update_with_start_workflow call.
Async Method start_workflow Called for every Client.start_workflow call.
Async Method start_workflow_update Called for every WorkflowHandle.start_update and WorkflowHandle.execute_update call.
Async Method terminate_workflow Called for every WorkflowHandle.terminate call.
Async Method trigger_schedule Called for every ScheduleHandle.trigger call.
Async Method unpause_schedule Called for every ScheduleHandle.unpause call.
Async Method update_schedule Called for every ScheduleHandle.update call.
Async Method update_worker_build_id_compatibility Called for every Client.update_worker_build_id_compatibility call.
Instance Variable next Undocumented
def __init__(self, next: OutboundInterceptor): (source)
overridden in temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor, temporalio.testing._workflow._TimeSkippingClientOutboundInterceptor

Create the outbound interceptor.

Parameters
next:OutboundInterceptorThe next interceptor in the chain. The default implementation of all calls is to delegate to the next interceptor.
async def backfill_schedule(self, input: BackfillScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.backfill call.

async def cancel_workflow(self, input: CancelWorkflowInput): (source)
overridden in temporalio.client._ClientImpl

Called for every WorkflowHandle.cancel call.

async def complete_async_activity(self, input: CompleteAsyncActivityInput): (source)
overridden in temporalio.client._ClientImpl

Called for every AsyncActivityHandle.complete call.

async def count_workflows(self, input: CountWorkflowsInput) -> WorkflowExecutionCount: (source)
overridden in temporalio.client._ClientImpl

Called for every Client.count_workflows call.

async def create_schedule(self, input: CreateScheduleInput) -> ScheduleHandle: (source)
overridden in temporalio.client._ClientImpl

Called for every Client.create_schedule call.

async def delete_schedule(self, input: DeleteScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.delete call.

async def describe_schedule(self, input: DescribeScheduleInput) -> ScheduleDescription: (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.describe call.

async def describe_workflow(self, input: DescribeWorkflowInput) -> WorkflowExecutionDescription: (source)
overridden in temporalio.client._ClientImpl

Called for every WorkflowHandle.describe call.

async def fail_async_activity(self, input: FailAsyncActivityInput): (source)
overridden in temporalio.client._ClientImpl

Called for every AsyncActivityHandle.fail call.

def fetch_workflow_history_events(self, input: FetchWorkflowHistoryEventsInput) -> WorkflowHistoryEventAsyncIterator: (source)
overridden in temporalio.client._ClientImpl
async def get_worker_build_id_compatibility(self, input: GetWorkerBuildIdCompatibilityInput) -> WorkerBuildIdVersionSets: (source)
overridden in temporalio.client._ClientImpl
async def get_worker_task_reachability(self, input: GetWorkerTaskReachabilityInput) -> WorkerTaskReachability: (source)
overridden in temporalio.client._ClientImpl
async def heartbeat_async_activity(self, input: HeartbeatAsyncActivityInput): (source)
overridden in temporalio.client._ClientImpl

Called for every AsyncActivityHandle.heartbeat call.

def list_schedules(self, input: ListSchedulesInput) -> ScheduleAsyncIterator: (source)
overridden in temporalio.client._ClientImpl

Called for every Client.list_schedules call.

def list_workflows(self, input: ListWorkflowsInput) -> WorkflowExecutionAsyncIterator: (source)
overridden in temporalio.client._ClientImpl

Called for every Client.list_workflows call.

async def pause_schedule(self, input: PauseScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.pause call.

async def query_workflow(self, input: QueryWorkflowInput) -> Any: (source)
overridden in temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor

Called for every WorkflowHandle.query call.

async def report_cancellation_async_activity(self, input: ReportCancellationAsyncActivityInput): (source)
overridden in temporalio.client._ClientImpl
async def signal_workflow(self, input: SignalWorkflowInput): (source)
overridden in temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor

Called for every WorkflowHandle.signal call.

async def start_update_with_start_workflow(self, input: StartWorkflowUpdateWithStartInput) -> WorkflowUpdateHandle[Any]: (source)
overridden in temporalio.client._ClientImpl

Called for every Client.start_update_with_start_workflow and Client.execute_update_with_start_workflow call.

Warning

This API is experimental

async def start_workflow(self, input: StartWorkflowInput) -> WorkflowHandle[Any, Any]: (source)
overridden in temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor, temporalio.testing._workflow._TimeSkippingClientOutboundInterceptor

Called for every Client.start_workflow call.

async def start_workflow_update(self, input: StartWorkflowUpdateInput) -> WorkflowUpdateHandle[Any]: (source)
overridden in temporalio.client._ClientImpl, temporalio.contrib.opentelemetry._TracingClientOutboundInterceptor
async def terminate_workflow(self, input: TerminateWorkflowInput): (source)
overridden in temporalio.client._ClientImpl

Called for every WorkflowHandle.terminate call.

async def trigger_schedule(self, input: TriggerScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.trigger call.

async def unpause_schedule(self, input: UnpauseScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.unpause call.

async def update_schedule(self, input: UpdateScheduleInput): (source)
overridden in temporalio.client._ClientImpl

Called for every ScheduleHandle.update call.

async def update_worker_build_id_compatibility(self, input: UpdateWorkerBuildIdCompatibilityInput): (source)
overridden in temporalio.client._ClientImpl
next = (source)

Undocumented