OrchestratorState Class

Orchestration State.

Used to communicate the state of the orchestration back to the durable extension

Constructor

OrchestratorState(is_done: bool, actions: List[List[Action]], output: Any, replay_schema: ReplaySchema, error: str = None, custom_status: Any = None)

Parameters

Name Description
is_done
Required
actions
Required
output
Required
replay_schema
Required
error
Default value: None
custom_status
Default value: None

Methods

to_json

Convert object into a json dictionary.
to_json_string

Convert object into a json string.

to_json

Convert object into a json dictionary.

to_json() -> Dict[str, Any]

Returns

Type Description
Dict[str, Any]

The instance of the class converted into a json dictionary

to_json_string

Convert object into a json string.

to_json_string() -> str

Returns

Type Description
str

The instance of the object in json string format

Attributes

actions

Get the ordered list of async actions the orchestrator function should perform.

This list is append-only; it must contain all scheduled async actions up to the latest requested work, even actions that have already been completed.

Actions are grouped by execution. Each subsequent orchestrator execution should add a new array of action objects to the collection.

custom_status

Get the JSON-serializable value used by DurableOrchestrationContext.SetCustomStatus.

error

Get the error received when running the orchestration.

Optional.

is_done

Get indicator of whether this is the last execution of this orchestrator instance.

When this value is true, the Durable Functions extension will consider the orchestration instance completed and will attempt to return the output value.

output

Get the JSON-serializable value returned by the orchestrator instance completion.

Optional.

schema_version

Get the Replay Schema represented in this OrchestratorState payload.