Skip to content

Commit 779d52a

Browse files
committed
Add experimental notices
1 parent 0fd7e34 commit 779d52a

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.
@@ -2436,6 +2442,10 @@ class WithStartWorkflowOperation(Generic[SelfType, ReturnType]):
24362442
24372443
Update-With-Start allows you to send an update to a workflow, while starting the
24382444
workflow if necessary.
2445+
2446+
.. warning::
2447+
This API is experimental
2448+
24392449
"""
24402450

24412451
# Overload for no-param workflow, with_start
@@ -2593,6 +2603,9 @@ def __init__(
25932603
) -> None:
25942604
"""Create a WithStartWorkflowOperation.
25952605
2606+
.. warning::
2607+
This API is experimental
2608+
25962609
See :py:meth:`temporalio.client.Client.start_workflow` for documentation of the
25972610
arguments.
25982611
"""
@@ -2628,7 +2641,11 @@ def __init__(
26282641
self._workflow_handle: Future[WorkflowHandle[SelfType, ReturnType]] = Future()
26292642

26302643
async def workflow_handle(self) -> WorkflowHandle[SelfType, ReturnType]:
2631-
"""Wait until workflow is running and return a WorkflowHandle."""
2644+
"""Wait until workflow is running and return a WorkflowHandle.
2645+
2646+
.. warning::
2647+
This API is experimental
2648+
"""
26322649
return await self._workflow_handle
26332650

26342651

@@ -5239,7 +5256,11 @@ class StartWorkflowUpdateInput:
52395256

52405257
@dataclass
52415258
class UpdateWithStartUpdateWorkflowInput:
5242-
"""Update input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5259+
"""Update input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5260+
5261+
.. warning::
5262+
This API is experimental
5263+
"""
52435264

52445265
update_id: Optional[str]
52455266
update: str
@@ -5253,7 +5274,11 @@ class UpdateWithStartUpdateWorkflowInput:
52535274

52545275
@dataclass
52555276
class UpdateWithStartStartWorkflowInput:
5256-
"""StartWorkflow input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5277+
"""StartWorkflow input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5278+
5279+
.. warning::
5280+
This API is experimental
5281+
"""
52575282

52585283
# Similar to StartWorkflowInput but without e.g. run_id, start_signal,
52595284
# start_signal_args, request_eager_start.
@@ -5287,7 +5312,11 @@ class UpdateWithStartStartWorkflowInput:
52875312

52885313
@dataclass
52895314
class StartWorkflowUpdateWithStartInput:
5290-
"""Input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`."""
5315+
"""Input for :py:meth:`OutboundInterceptor.start_workflow_update_with_start`.
5316+
5317+
.. warning::
5318+
This API is experimental
5319+
"""
52915320

52925321
start_workflow_input: UpdateWithStartStartWorkflowInput
52935322
update_workflow_input: UpdateWithStartUpdateWorkflowInput
@@ -5561,7 +5590,10 @@ async def start_workflow_update(
55615590
async def start_update_with_start_workflow(
55625591
self, input: StartWorkflowUpdateWithStartInput
55635592
) -> WorkflowUpdateHandle[Any]:
5564-
"""Called for every :py:meth:`Client.start_update_with_start` and :py:meth:`Client.execute_update_with_start` call."""
5593+
"""Called for every :py:meth:`Client.start_update_with_start` and :py:meth:`Client.execute_update_with_start` call.
5594+
.. warning::
5595+
This API is experimental
5596+
"""
55655597
return await self.next.start_update_with_start_workflow(input)
55665598

55675599
### Async activity calls

0 commit comments

Comments
 (0)