temporalio.workflow._activities

module documentation
(source)

Undocumented

Class ActivityCancellationType How an activity cancellation should be handled.
Class ActivityConfig TypedDict of config that can be used for start_activity and execute_activity.
Class ActivityHandle Handle returned from start_activity and start_local_activity.
Class LocalActivityConfig TypedDict of config that can be used for start_local_activity and execute_local_activity.
Async Function execute_activity Start an activity and wait for completion.
Async Function execute_activity_class Start an activity from a callable class and wait for completion.
Async Function execute_activity_method Start an activity from a method and wait for completion.
Async Function execute_local_activity Start a local activity and wait for completion.
Async Function execute_local_activity_class Start a local activity from a callable class and wait for completion.
Async Function execute_local_activity_method Start a local activity from a method and wait for completion.
Function start_activity Start an activity and return its handle.
Function start_activity_class Start an activity from a callable class.
Function start_activity_method Start an activity from a method.
Function start_local_activity Start a local activity and return its handle.
Function start_local_activity_class Start a local activity from a callable class.
Function start_local_activity_method Start a local activity from a method.
async def execute_activity(activity: CallableAsyncNoParam[ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: CallableSyncNoParam[ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: CallableAsyncSingleParam[ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: CallableSyncSingleParam[ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: Callable[..., Awaitable[ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: Callable[..., ReturnType], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity(activity: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], task_queue: str | None = None, result_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> Any:
(source)

Start an activity and wait for completion.

This is a shortcut for await start_activity.

async def execute_activity_class(activity: type[CallableAsyncNoParam[ReturnType]], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_class(activity: type[CallableSyncNoParam[ReturnType]], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_class(activity: type[CallableAsyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_class(activity: type[CallableSyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_class(activity: type[Callable[..., Awaitable[ReturnType]]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_class(activity: type[Callable[..., ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
(source)

Start an activity from a callable class and wait for completion.

This is a shortcut for await start_activity_class.

async def execute_activity_method(activity: MethodAsyncNoParam[SelfType, ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_method(activity: MethodSyncNoParam[SelfType, ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_method(activity: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_method(activity: MethodSyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
async def execute_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], ReturnType], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ReturnType:
(source)

Start an activity from a method and wait for completion.

This is a shortcut for await start_activity_method.

async def execute_local_activity(activity: CallableAsyncNoParam[ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: CallableSyncNoParam[ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: CallableAsyncSingleParam[ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: CallableSyncSingleParam[ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: Callable[..., Awaitable[ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: Callable[..., ReturnType], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity(activity: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], result_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> Any:
(source)

Start a local activity and wait for completion.

This is a shortcut for await start_local_activity.

async def execute_local_activity_class(activity: type[CallableAsyncNoParam[ReturnType]], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_class(activity: type[CallableSyncNoParam[ReturnType]], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_class(activity: type[CallableAsyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_class(activity: type[CallableSyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_class(activity: type[Callable[..., Awaitable[ReturnType]]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_class(activity: type[Callable[..., ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
(source)

Start a local activity from a callable class and wait for completion.

This is a shortcut for await start_local_activity_class.

async def execute_local_activity_method(activity: MethodAsyncNoParam[SelfType, ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_method(activity: MethodSyncNoParam[SelfType, ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_method(activity: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_method(activity: MethodSyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
async def execute_local_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], ReturnType], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ReturnType:
(source)

Start a local activity from a method and wait for completion.

This is a shortcut for await start_local_activity_method.

def start_activity(activity: CallableAsyncNoParam[ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: CallableSyncNoParam[ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: CallableAsyncSingleParam[ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: CallableSyncSingleParam[ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: Callable[..., Awaitable[ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: Callable[..., ReturnType], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity(activity: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], task_queue: str | None = None, result_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[Any]:
(source)

Start an activity and return its handle.

At least one of schedule_to_close_timeout or start_to_close_timeout must be present.

Parameters
activity:AnyActivity name or function reference.
arg:AnySingle argument to the activity.
args:Sequence[Any]Multiple arguments to the activity. Cannot be set if arg is.
task_queue:str | NoneTask queue to run the activity on. Defaults to the current workflow's task queue.
result_type:type | NoneFor string activities, this can set the specific result type hint to deserialize into.
schedule_to_close_timeout:timedelta | NoneMax amount of time the activity can take from first being scheduled to being completed before it times out. This is inclusive of all retries.
schedule_to_start_timeout:timedelta | NoneMax amount of time the activity can take to be started from first being scheduled.
start_to_close_timeout:timedelta | NoneMax amount of time a single activity run can take from when it starts to when it completes. This is per retry.
heartbeat_timeout:timedelta | NoneHow frequently an activity must invoke heartbeat while running before it is considered timed out.
retry_policy:temporalio.common.RetryPolicy | NoneHow an activity is retried on failure. If unset, a server-defined default is used. Set maximum attempts to 1 to disable retries.
cancellation_type:ActivityCancellationTypeHow the activity is treated when it is cancelled from the workflow.
activity_id:str | NoneOptional unique identifier for the activity. This is an advanced setting that should not be set unless users are sure they need to. Contact Temporal before setting this value.
versioning_intent:VersioningIntent | NoneWhen using the Worker Versioning feature, specifies whether this Activity should run on a worker with a compatible Build Id or not. Deprecated: Use Worker Deployment versioning instead.
summary:str | NoneA single-line fixed summary for this activity that may appear in UI/CLI. This can be in single-line Temporal markdown format.
priority:temporalio.common.PriorityPriority of the activity.
Returns
ActivityHandle[Any]An activity handle to the activity which is an async task.
def start_activity_class(activity: type[CallableAsyncNoParam[ReturnType]], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_class(activity: type[CallableSyncNoParam[ReturnType]], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_class(activity: type[CallableAsyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_class(activity: type[CallableSyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_class(activity: type[Callable[..., Awaitable[ReturnType]]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_class(activity: type[Callable[..., ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
(source)

Start an activity from a callable class.

See start_activity for parameter and return details.

def start_activity_method(activity: MethodAsyncNoParam[SelfType, ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_method(activity: MethodSyncNoParam[SelfType, ReturnType], *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_method(activity: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_method(activity: MethodSyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
def start_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], ReturnType], *, args: Sequence[Any], task_queue: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, heartbeat_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, versioning_intent: VersioningIntent | None = None, summary: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default) -> ActivityHandle[ReturnType]:
(source)

Start an activity from a method.

See start_activity for parameter and return details.

def start_local_activity(activity: CallableAsyncNoParam[ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: CallableSyncNoParam[ReturnType], *, activity_id: str | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: CallableAsyncSingleParam[ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: CallableSyncSingleParam[ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: Callable[..., Awaitable[ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: Callable[..., ReturnType], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity(activity: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], result_type: type | None = None, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[Any]:
(source)

Start a local activity and return its handle.

At least one of schedule_to_close_timeout or start_to_close_timeout must be present.

Parameters
activity:AnyActivity name or function reference.
arg:AnySingle argument to the activity.
args:Sequence[Any]Multiple arguments to the activity. Cannot be set if arg is.
result_type:type | NoneFor string activities, this can set the specific result type hint to deserialize into.
schedule_to_close_timeout:timedelta | NoneMax amount of time the activity can take from first being scheduled to being completed before it times out. This is inclusive of all retries.
schedule_to_start_timeout:timedelta | NoneMax amount of time the activity can take to be started from first being scheduled.
start_to_close_timeout:timedelta | NoneMax amount of time a single activity run can take from when it starts to when it completes. This is per retry.
retry_policy:temporalio.common.RetryPolicy | NoneHow an activity is retried on failure. If unset, an SDK-defined default is used. Set maximum attempts to 1 to disable retries.
local_retry_threshold:timedelta | NoneUndocumented
cancellation_type:ActivityCancellationTypeHow the activity is treated when it is cancelled from the workflow.
activity_id:str | NoneOptional unique identifier for the activity. This is an advanced setting that should not be set unless users are sure they need to. Contact Temporal before setting this value.
summary:str | NoneOptional summary for the activity.
Returns
ActivityHandle[Any]An activity handle to the activity which is an async task.
def start_local_activity_class(activity: type[CallableAsyncNoParam[ReturnType]], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_class(activity: type[CallableSyncNoParam[ReturnType]], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_class(activity: type[CallableAsyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_class(activity: type[CallableSyncSingleParam[ParamType, ReturnType]], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_class(activity: type[Callable[..., Awaitable[ReturnType]]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_class(activity: type[Callable[..., ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None) -> ActivityHandle[ReturnType]:
(source)

Start a local activity from a callable class.

See start_local_activity for parameter and return details.

def start_local_activity_method(activity: MethodAsyncNoParam[SelfType, ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_method(activity: MethodSyncNoParam[SelfType, ReturnType], *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_method(activity: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_method(activity: MethodSyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
def start_local_activity_method(activity: Callable[Concatenate[SelfType, MultiParamSpec], ReturnType], *, args: Sequence[Any], schedule_to_close_timeout: timedelta | None = None, schedule_to_start_timeout: timedelta | None = None, start_to_close_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, local_retry_threshold: timedelta | None = None, cancellation_type: ActivityCancellationType = ActivityCancellationType.TRY_CANCEL, activity_id: str | None = None, summary: str | None = None) -> ActivityHandle[ReturnType]:
(source)

Start a local activity from a method.

See start_local_activity for parameter and return details.