Skip to content

Commit 4816dda

Browse files
committed
Add experimental notices
1 parent 3d637f9 commit 4816dda

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

temporalio/client.py

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -892,6 +892,9 @@ async def execute_update_with_start_workflow(
892892
the call will not return successfully until the update has been delivered to a
893893
worker.
894894
895+
.. warning::
896+
This API is experimental
897+
895898
Args:
896899
update: Update function or name on the workflow. arg: Single argument to the
897900
update.
@@ -1014,6 +1017,9 @@ async def start_update_with_start_workflow(
10141017
means that the call will not return successfully until the update has been
10151018
delivered to a worker.
10161019
1020+
.. warning::
1021+
This API is experimental
1022+
10171023
Args:
10181024
update: Update function or name on the workflow. arg: Single argument to the
10191025
update.
@@ -2427,6 +2433,10 @@ class WithStartWorkflowOperation(Generic[SelfType, ReturnType]):
24272433
24282434
Update-With-Start allows you to send an update to a workflow, while starting the
24292435
workflow if necessary.
2436+
2437+
.. warning::
2438+
This API is experimental
2439+
24302440
"""
24312441

24322442
# Overload for no-param workflow, with_start
@@ -2584,6 +2594,9 @@ def __init__(
25842594
) -> None:
25852595
"""Create a WithStartWorkflowOperation.
25862596
2597+
.. warning::
2598+
This API is experimental
2599+
25872600
See :py:meth:`temporalio.client.Client.start_workflow` for documentation of the
25882601
arguments.
25892602
"""
@@ -2619,7 +2632,11 @@ def __init__(
26192632
self._workflow_handle: Future[WorkflowHandle[SelfType, ReturnType]] = Future()
26202633

26212634
async def workflow_handle(self) -> WorkflowHandle[SelfType, ReturnType]:
2622-
"""Wait until workflow is running and return a WorkflowHandle."""
2635+
"""Wait until workflow is running and return a WorkflowHandle.
2636+
2637+
.. warning::
2638+
This API is experimental
2639+
"""
26232640
return await self._workflow_handle
26242641

26252642

@@ -5231,7 +5248,11 @@ class StartWorkflowUpdateInput:
52315248

52325249
@dataclass
52335250
class UpdateWithStartUpdateWorkflowInput:
5234-
"""Update input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5251+
"""Update input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5252+
5253+
.. warning::
5254+
This API is experimental
5255+
"""
52355256

52365257
update_id: Optional[str]
52375258
update: str
@@ -5245,7 +5266,11 @@ class UpdateWithStartUpdateWorkflowInput:
52455266

52465267
@dataclass
52475268
class UpdateWithStartStartWorkflowInput:
5248-
"""StartWorkflow input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5269+
"""StartWorkflow input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5270+
5271+
.. warning::
5272+
This API is experimental
5273+
"""
52495274

52505275
# Similar to StartWorkflowInput but without e.g. run_id, start_signal,
52515276
# start_signal_args, request_eager_start.
@@ -5279,7 +5304,11 @@ class UpdateWithStartStartWorkflowInput:
52795304

52805305
@dataclass
52815306
class StartWorkflowUpdateWithStartInput:
5282-
"""Input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5307+
"""Input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5308+
5309+
.. warning::
5310+
This API is experimental
5311+
"""
52835312

52845313
start_workflow_input: UpdateWithStartStartWorkflowInput
52855314
update_workflow_input: UpdateWithStartUpdateWorkflowInput
@@ -5553,7 +5582,10 @@ async def start_workflow_update(
55535582
async def start_update_with_start_workflow(
55545583
self, input: StartWorkflowUpdateWithStartInput
55555584
) -> WorkflowUpdateHandle[Any]:
5556-
"""Called for every :py:meth:`Client.start_update_with_start` and :py:meth:`Client.execute_update_with_start` call."""
5585+
"""Called for every :py:meth:`Client.start_update_with_start` and :py:meth:`Client.execute_update_with_start` call.
5586+
.. warning::
5587+
This API is experimental
5588+
"""
55575589
return await self.next.start_update_with_start_workflow(input)
55585590

55595591
### Async activity calls

0 commit comments

Comments
 (0)