temporalio.client.ScheduleActionStartWorkflow

temporalio.client.ScheduleActionStartWorkflow

class documentation

class ScheduleActionStartWorkflow(ScheduleAction): (source)

Constructors: ScheduleActionStartWorkflow(workflow, arg, args, id, ...), ScheduleActionStartWorkflow._from_proto(info)

View In Hierarchy

Schedule action to start a workflow.

@overload
def __init__(self, workflow: MethodAsyncNoParam[SelfType, ReturnType], *, id: str, task_queue: str, execution_timeout: timedelta | None = None, run_timeout: timedelta | None = None, task_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, memo: Mapping[str, Any] | None = None, typed_search_attributes: temporalio.common.TypedSearchAttributes = temporalio.common.TypedSearchAttributes.empty, static_summary: str | None = None, static_details: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default):
@overload
def __init__(self, workflow: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, id: str, task_queue: str, execution_timeout: timedelta | None = None, run_timeout: timedelta | None = None, task_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, memo: Mapping[str, Any] | None = None, typed_search_attributes: temporalio.common.TypedSearchAttributes = temporalio.common.TypedSearchAttributes.empty, static_summary: str | None = None, static_details: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default):
@overload
def __init__(self, workflow: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], id: str, task_queue: str, execution_timeout: timedelta | None = None, run_timeout: timedelta | None = None, task_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, memo: Mapping[str, Any] | None = None, typed_search_attributes: temporalio.common.TypedSearchAttributes = temporalio.common.TypedSearchAttributes.empty, static_summary: str | None = None, static_details: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default):
@overload
def __init__(self, workflow: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], id: str, task_queue: str, execution_timeout: timedelta | None = None, run_timeout: timedelta | None = None, task_timeout: timedelta | None = None, retry_policy: temporalio.common.RetryPolicy | None = None, memo: Mapping[str, Any] | None = None, typed_search_attributes: temporalio.common.TypedSearchAttributes = temporalio.common.TypedSearchAttributes.empty, static_summary: str | None = None, static_details: str | None = None, priority: temporalio.common.Priority = temporalio.common.Priority.default):
@overload
def __init__(self, workflow: str, *, raw_info: temporalio.api.workflow.v1.NewWorkflowExecutionInfo):
(source)

Create a start-workflow action.

See Client.start_workflow for details on these parameter values.

args: Sequence[Any] | Sequence[temporalio.api.common.v1.Payload] = (source)

Undocumented

execution_timeout: timedelta | None = (source)

Undocumented

headers: Mapping[str, temporalio.api.common.v1.Payload] | None = (source)

Headers may still be encoded by the payload codec if present.

id: str = (source)

Undocumented

memo: None | Mapping[str, Any] | Mapping[str, temporalio.api.common.v1.Payload] = (source)

Undocumented

priority: temporalio.common.Priority = (source)

Undocumented

retry_policy: temporalio.common.RetryPolicy | None = (source)

Undocumented

run_timeout: timedelta | None = (source)

Undocumented

static_details: str | temporalio.api.common.v1.Payload | None = (source)

Undocumented

static_summary: str | temporalio.api.common.v1.Payload | None = (source)

Undocumented

task_queue: str = (source)

Undocumented

task_timeout: timedelta | None = (source)

Undocumented

typed_search_attributes: temporalio.common.TypedSearchAttributes = (source)

Undocumented

untyped_search_attributes: temporalio.common.SearchAttributes = (source)

This is deprecated and is only present in case existing untyped attributes already exist for update. This should never be used when creating.

workflow: str = (source)

Undocumented

def _from_proto(info: temporalio.api.workflow.v1.NewWorkflowExecutionInfo) -> ScheduleActionStartWorkflow: (source)
overrides temporalio.client.ScheduleAction._from_proto

Undocumented

async def _to_proto(self, client: Client) -> temporalio.api.schedule.v1.ScheduleAction: (source)
overrides temporalio.client.ScheduleAction._to_proto

Undocumented

_from_raw: bool = (source)

Undocumented