temporalio.nexus.system.workflow_service

package documentation
(source)

Undocumented

Module models No module docstring; 1/2 class documented
Package operations Undocumented
Module service No module docstring; 1/1 class documented
Package _resources Undocumented
Package _support Undocumented

From __init__.py:

Async Function signal_with_start_workflow Signal a workflow, starting it first if needed.
Variable __nexus_operation_registry__ Undocumented
async def signal_with_start_workflow(workflow: str, *args: object, id: str, task_queue: str, signal: str, signal_args: list[typing.Any] | None = ..., execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[object]:
async def signal_with_start_workflow(workflow: str, *, args: list[typing.Any] | None = ..., id: str, task_queue: str, signal: str, signal_args: list[typing.Any] | None = ..., execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[object]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *args: typing_extensions.Unpack[WorkflowArgs], id: str, task_queue: str, signal: str, signal_args: list[typing.Any] | None = ..., execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *, args: list[typing.Any], id: str, task_queue: str, signal: str, signal_args: list[typing.Any] | None = ..., execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: str, *args: object, id: str, task_queue: str, signal: collections.abc.Callable[[SelfType], None | collections.abc.Awaitable[None]], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: str, *, args: list[typing.Any] | None = ..., id: str, task_queue: str, signal: collections.abc.Callable[[SelfType], None | collections.abc.Awaitable[None]], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *args: typing_extensions.Unpack[WorkflowArgs], id: str, task_queue: str, signal: collections.abc.Callable[[SelfType], None | collections.abc.Awaitable[None]], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *, args: list[typing.Any], id: str, task_queue: str, signal: collections.abc.Callable[[SelfType], None | collections.abc.Awaitable[None]], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: str, *args: object, id: str, task_queue: str, signal: collections.abc.Callable[[SelfType, SignalArg], None | collections.abc.Awaitable[None]], signal_args: SignalArg, execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: str, *, args: list[typing.Any] | None = ..., id: str, task_queue: str, signal: collections.abc.Callable[[SelfType, SignalArg], None | collections.abc.Awaitable[None]], signal_args: SignalArg, execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *args: typing_extensions.Unpack[WorkflowArgs], id: str, task_queue: str, signal: collections.abc.Callable[[SelfType, SignalArg], None | collections.abc.Awaitable[None]], signal_args: SignalArg, execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *, args: list[typing.Any], id: str, task_queue: str, signal: collections.abc.Callable[[SelfType, SignalArg], None | collections.abc.Awaitable[None]], signal_args: SignalArg, execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: str, *args: object, id: str, task_queue: str, signal: collections.abc.Callable[..., None | collections.abc.Awaitable[None]], signal_args: list[typing.Any], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[object]:
async def signal_with_start_workflow(workflow: str, *, args: list[typing.Any] | None = ..., id: str, task_queue: str, signal: collections.abc.Callable[..., None | collections.abc.Awaitable[None]], signal_args: list[typing.Any], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[object]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *args: typing_extensions.Unpack[WorkflowArgs], id: str, task_queue: str, signal: collections.abc.Callable[..., None | collections.abc.Awaitable[None]], signal_args: list[typing.Any], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
async def signal_with_start_workflow(workflow: collections.abc.Callable[[SelfType, typing_extensions.Unpack[WorkflowArgs]], collections.abc.Awaitable[WorkflowResult]], *, args: list[typing.Any], id: str, task_queue: str, signal: collections.abc.Callable[..., None | collections.abc.Awaitable[None]], signal_args: list[typing.Any], execution_timeout: datetime.timedelta | None = ..., run_timeout: datetime.timedelta | None = ..., task_timeout: datetime.timedelta | None = ..., request_id: str | None = ..., id_reuse_policy: temporalio.common.WorkflowIDReusePolicy = ..., id_conflict_policy: temporalio.common.WorkflowIDConflictPolicy | None = ..., retry_policy: temporalio.common.RetryPolicy | None = ..., cron_schedule: str | None = ..., memo: collections.abc.Mapping[str, typing.Any] | None = ..., search_attributes: temporalio.common.TypedSearchAttributes | None = ..., priority: temporalio.common.Priority | None = ..., versioning_override: temporalio.common.VersioningOverride | None = ..., start_delay: datetime.timedelta | None = ..., static_summary: str | None = ..., static_details: str | None = ...) -> ExternalWorkflowHandle[SelfType]:
(source)

Signal a workflow, starting it first if needed.

Warning

This API is experimental and subject to change.

Parameters
workflow:str | collections.abc.Callable[..., collections.abc.Awaitable[object]]Workflow type name or callable identifying the workflow to start.
*positional_args:objectPositional arguments for workflow. Cannot be set if args is set.
args:list[typing.Any] | NoneList-form arguments for workflow. Cannot be set if positional_args are set. For typed workflow callables, list contents are not statically typechecked; pass workflow arguments positionally for precise typechecking.
id:strUnique identifier for the workflow execution.
task_queue:strTask queue to run the workflow on.
signal:str | collections.abc.Callable[..., None | collections.abc.Awaitable[None]]Signal name or callable to send with the start request.
signal_args:object | list[typing.Any] | NoneArgument value, or list of argument values, for signal. For typed single-argument signals, scalar signal_args values are statically typechecked. List-form signal_args values are not precisely typechecked. To pass a single signal argument that is itself a list, wrap it in another list; otherwise the list is interpreted as multiple signal arguments.
execution_timeout:datetime.timedelta | NoneTotal workflow execution timeout, including retries and continue-as-new.
run_timeout:datetime.timedelta | NoneTimeout of a single workflow run.
task_timeout:datetime.timedelta | NoneTimeout of a single workflow task.
request_id:str | NoneRequest ID used to deduplicate workflow start requests.
id_reuse_policy:temporalio.common.WorkflowIDReusePolicyBehavior when a closed workflow with the same ID exists. Default is allow-duplicate.
id_conflict_policy:temporalio.common.WorkflowIDConflictPolicy | NoneBehavior when a workflow is currently running with the same ID. Set to use-existing for idempotent deduplication on workflow ID. Cannot be set if id-reuse-policy is terminate-if-running.
retry_policy:temporalio.common.RetryPolicy | NoneRetry policy for the workflow.
cron_schedule:str | NoneCron schedule for recurring workflow executions. See https://docs.temporal.io/cron-job.
memo:collections.abc.Mapping[str, typing.Any] | NoneMemo for the workflow.
search_attributes:temporalio.common.TypedSearchAttributes | NoneTyped search attributes for the workflow.
priority:temporalio.common.Priority | NonePriority of the workflow execution.
versioning_override:temporalio.common.VersioningOverride | NoneOverride for workflow versioning behavior.
start_delay:datetime.timedelta | NoneAmount of time to wait before starting the workflow. This does not work with cron-schedule.
static_summary:str | NoneSingle-line fixed summary for the workflow execution that may appear in UI and CLI. This can be in single-line Temporal Markdown format.
static_details:str | NoneGeneral fixed details for the workflow execution that may appear in UI and CLI. This can be in Temporal Markdown format and can span multiple lines. This value is fixed on the workflow execution and cannot be updated.
Returns
ExternalWorkflowHandle[typing.Any]A workflow handle to the started workflow.
__nexus_operation_registry__ = (source)

Undocumented