Home Original page

temporalio.client.OutboundInterceptor

class documentation

class OutboundInterceptor: (source)

Known subclasses: temporalio.client._ClientImpl, temporalio.contrib.openai_agents._trace_interceptor._ContextPropagationClientOutboundInterceptor, temporalio.contrib.opentelemetry._interceptor._TracingClientOutboundInterceptor, temporalio.contrib.opentelemetry._otel_interceptor._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_activity Called for every ActivityHandle.cancel 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_activities Called for every Client.count_activities 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_activity Called for every ActivityHandle.describe 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_activities Called for every Client.list_activities 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_activity Called for every Client.start_activity 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_activity Called for every ActivityHandle.terminate 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

async def backfill_schedule(self, input: BackfillScheduleInput): (source)

Called for every ScheduleHandle.backfill call.

async def cancel_activity(self, input: CancelActivityInput): (source)

Called for every ActivityHandle.cancel call.

Warning

This API is experimental.

async def cancel_workflow(self, input: CancelWorkflowInput): (source)

Called for every WorkflowHandle.cancel call.

async def complete_async_activity(self, input: CompleteAsyncActivityInput): (source)

Called for every AsyncActivityHandle.complete call.

async def count_activities(self, input: CountActivitiesInput) -> ActivityExecutionCount: (source)

Called for every Client.count_activities call.

Warning

This API is experimental.

async def count_workflows(self, input: CountWorkflowsInput) -> WorkflowExecutionCount: (source)

Called for every Client.count_workflows call.

async def create_schedule(self, input: CreateScheduleInput) -> ScheduleHandle: (source)

Called for every Client.create_schedule call.

async def delete_schedule(self, input: DeleteScheduleInput): (source)

Called for every ScheduleHandle.delete call.

async def describe_activity(self, input: DescribeActivityInput) -> ActivityExecutionDescription: (source)

Called for every ActivityHandle.describe call.

Warning

This API is experimental.

async def describe_schedule(self, input: DescribeScheduleInput) -> ScheduleDescription: (source)

Called for every ScheduleHandle.describe call.

async def describe_workflow(self, input: DescribeWorkflowInput) -> WorkflowExecutionDescription: (source)

Called for every WorkflowHandle.describe call.

async def fail_async_activity(self, input: FailAsyncActivityInput): (source)

Called for every AsyncActivityHandle.fail call.

async def get_worker_build_id_compatibility(self, input: GetWorkerBuildIdCompatibilityInput) -> WorkerBuildIdVersionSets: (source)

async def get_worker_task_reachability(self, input: GetWorkerTaskReachabilityInput) -> WorkerTaskReachability: (source)

async def heartbeat_async_activity(self, input: HeartbeatAsyncActivityInput): (source)

Called for every AsyncActivityHandle.heartbeat call.

Called for every Client.list_activities call.

Warning

This API is experimental.

def list_schedules(self, input: ListSchedulesInput) -> ScheduleAsyncIterator: (source)

Called for every Client.list_schedules call.

Called for every Client.list_workflows call.

async def pause_schedule(self, input: PauseScheduleInput): (source)

Called for every ScheduleHandle.pause call.

async def report_cancellation_async_activity(self, input: ReportCancellationAsyncActivityInput): (source)

async def start_activity(self, input: StartActivityInput) -> ActivityHandle[Any]: (source)

Called for every Client.start_activity call.

Warning

This API is experimental.

async def terminate_activity(self, input: TerminateActivityInput): (source)

Called for every ActivityHandle.terminate call.

Warning

This API is experimental.

async def terminate_workflow(self, input: TerminateWorkflowInput): (source)

Called for every WorkflowHandle.terminate call.

async def trigger_schedule(self, input: TriggerScheduleInput): (source)

Called for every ScheduleHandle.trigger call.

async def unpause_schedule(self, input: UnpauseScheduleInput): (source)

Called for every ScheduleHandle.unpause call.

async def update_schedule(self, input: UpdateScheduleInput): (source)

Called for every ScheduleHandle.update call.

async def update_worker_build_id_compatibility(self, input: UpdateWorkerBuildIdCompatibilityInput): (source)

Undocumented