temporalio.client.WithStartWorkflowOperation

class documentation

class WithStartWorkflowOperation(Generic[SelfType, ReturnType]): (source)

Constructor: WithStartWorkflowOperation(workflow, arg, args, id, ...)

View In Hierarchy

Defines a start-workflow operation used by update-with-start requests.

Update-With-Start allows you to send an update to a workflow, while starting the workflow if necessary.

Warning

This API is experimental

Method __init__ Create a WithStartWorkflowOperation.
Async Method workflow_handle Wait until workflow is running and return a WorkflowHandle.
Instance Variable _start_workflow_input Undocumented
Instance Variable _used Undocumented
Instance Variable _workflow_handle Undocumented
@overload
def __init__(self, workflow: MethodAsyncNoParam[SelfType, ReturnType], *, id: str, task_queue: str, id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy, execution_timeout: Optional[timedelta] = None, run_timeout: Optional[timedelta] = None, task_timeout: Optional[timedelta] = None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[temporalio.common.RetryPolicy] = None, cron_schedule: str = '', memo: Optional[Mapping[str, Any]] = None, search_attributes: Optional[Union[temporalio.common.TypedSearchAttributes, temporalio.common.SearchAttributes]] = None, static_summary: Optional[str] = None, static_details: Optional[str] = None, start_delay: Optional[timedelta] = None, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None):
@overload
def __init__(self, workflow: MethodAsyncSingleParam[SelfType, ParamType, ReturnType], arg: ParamType, *, id: str, task_queue: str, id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy, execution_timeout: Optional[timedelta] = None, run_timeout: Optional[timedelta] = None, task_timeout: Optional[timedelta] = None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[temporalio.common.RetryPolicy] = None, cron_schedule: str = '', memo: Optional[Mapping[str, Any]] = None, search_attributes: Optional[Union[temporalio.common.TypedSearchAttributes, temporalio.common.SearchAttributes]] = None, static_summary: Optional[str] = None, static_details: Optional[str] = None, start_delay: Optional[timedelta] = None, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None):
@overload
def __init__(self, workflow: Callable[Concatenate[SelfType, MultiParamSpec], Awaitable[ReturnType]], *, args: Sequence[Any], id: str, task_queue: str, id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy, execution_timeout: Optional[timedelta] = None, run_timeout: Optional[timedelta] = None, task_timeout: Optional[timedelta] = None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[temporalio.common.RetryPolicy] = None, cron_schedule: str = '', memo: Optional[Mapping[str, Any]] = None, search_attributes: Optional[Union[temporalio.common.TypedSearchAttributes, temporalio.common.SearchAttributes]] = None, static_summary: Optional[str] = None, static_details: Optional[str] = None, start_delay: Optional[timedelta] = None, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None):
@overload
def __init__(self, workflow: str, arg: Any = temporalio.common._arg_unset, *, args: Sequence[Any] = [], id: str, task_queue: str, id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy, result_type: Optional[Type] = None, execution_timeout: Optional[timedelta] = None, run_timeout: Optional[timedelta] = None, task_timeout: Optional[timedelta] = None, id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = temporalio.common.WorkflowIDReusePolicy.ALLOW_DUPLICATE, retry_policy: Optional[temporalio.common.RetryPolicy] = None, cron_schedule: str = '', memo: Optional[Mapping[str, Any]] = None, search_attributes: Optional[Union[temporalio.common.TypedSearchAttributes, temporalio.common.SearchAttributes]] = None, static_summary: Optional[str] = None, static_details: Optional[str] = None, start_delay: Optional[timedelta] = None, rpc_metadata: Mapping[str, str] = {}, rpc_timeout: Optional[timedelta] = None):
(source)

Create a WithStartWorkflowOperation.

Warning

This API is experimental

See temporalio.client.Client.start_workflow for documentation of the arguments.

async def workflow_handle(self) -> WorkflowHandle[SelfType, ReturnType]: (source)

Wait until workflow is running and return a WorkflowHandle.

Warning

This API is experimental

_start_workflow_input = (source)

Undocumented

_used: bool = (source)

Undocumented

_workflow_handle: Future[WorkflowHandle[SelfType, ReturnType]] = (source)

Undocumented