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.

Method __init__ Create a start-workflow action.
Instance Variable args Undocumented
Instance Variable execution_timeout Undocumented
Instance Variable headers Headers may still be encoded by the payload codec if present.
Instance Variable id Undocumented
Instance Variable memo Undocumented
Instance Variable priority Undocumented
Instance Variable retry_policy Undocumented
Instance Variable run_timeout Undocumented
Instance Variable static_details Undocumented
Instance Variable static_summary Undocumented
Instance Variable task_queue Undocumented
Instance Variable task_timeout Undocumented
Instance Variable typed_search_attributes Undocumented
Instance Variable untyped_search_attributes This is deprecated and is only present in case existing untyped attributes already exist for update. This should never be used when creating.
Instance Variable workflow Undocumented
Static Method _from_proto Undocumented
Async Method _to_proto Undocumented
Instance Variable _from_raw Undocumented
@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: Mapping[str, Any] | Mapping[str, temporalio.api.common.v1.Payload] | None = (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

@staticmethod
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