WhenAnyTask Class

A Task representing when_any scenarios.

Initialize a WhenAnyTask.

Constructor

WhenAnyTask(task: List[TaskBase], replay_schema: ReplaySchema)

Name	Description
task Required	<xref:List>[<xref:Task>] The list of child tasks
replay_schema Required	<xref:azure.durable_functions.models.Task.ReplaySchema> The ReplaySchema, which determines the inner action payload representation

change_state	Transition a running Task to a terminal state: success or failure.
handle_completion	Manage sub-task completion events.
propagate	Notify parent Task of this Task's state change.
set_is_played	Set the is_played flag for the Task. Needed for updating the orchestrator's is_replaying flag.
set_value	Set the value of this Task: either an exception of a result.
try_set_value	Transition a WhenAny Task to a terminal state and set its value.

Transition a running Task to a terminal state: success or failure.

change_state(state: TaskState)

Name	Description
state Required	TaskState The terminal state to assign to this Task

Type	Description
Exception	When the input state is RUNNING

Manage sub-task completion events.

handle_completion(child: TaskBase)

Name	Description
child Required	TaskBase The sub-task that completed

Type	Description
Exception	When the calling sub-task was not registered with this Task's pending sub-tasks.

Notify parent Task of this Task's state change.

propagate()

Set the is_played flag for the Task.

Needed for updating the orchestrator's is_replaying flag.

set_is_played(is_played: bool)

Name	Description
is_played Required	bool Whether the latest event for this Task has been played before.

Set the value of this Task: either an exception of a result.

set_value(is_error: bool, value: Any)

Name	Description
is_error Required	bool Whether the value represents an exception of a result.
value Required	Any The value of this Task

Type	Description
Exception	When the Task failed but its value was not an Exception

Transition a WhenAny Task to a terminal state and set its value.

try_set_value(child: TaskBase)

Name	Description
child Required	TaskBase A sub-task that just completed

Get indicator of whether the task completed.

Note that completion is not equivalent to success.

Is deze pagina nuttig?