DurableOrchestrationStatus Class

Represents the status of a durable orchestration instance.

Can be fetched using [[DurableOrchestrationClient]].[[get_status]].

Inheritance

builtins.object

DurableOrchestrationStatus

Constructor

DurableOrchestrationStatus(name: str | None = None, instanceId: str | None = None, createdTime: str | None = None, lastUpdatedTime: str | None = None, input: Any | None = None, output: Any | None = None, runtimeStatus: OrchestrationRuntimeStatus | None = None, customStatus: Any | None = None, history: List[Any] | None = None, **kwargs)

Parameters

Name	Description
name	Default value: None
instanceId	Default value: None
createdTime	Default value: None
lastUpdatedTime	Default value: None
input	Default value: None
output	Default value: None
runtimeStatus	Default value: None
customStatus	Default value: None
history	Default value: None

Methods

from_json	Convert the value passed into a new instance of the class.
to_json	Convert object into a json dictionary.

from_json

Convert the value passed into a new instance of the class.

from_json(json_obj: Any)

Parameters

Name	Description
json_obj Required	<xref:azure.durable_functions.models.DurableOrchestrationStatus.any> JSON object to be converted into an instance of the class

Returns

Type	Description
DurableOrchestrationStatus	New instance of the durable orchestration status class

to_json

Convert object into a json dictionary.

to_json() -> Dict[str, int | str]

Returns

Type	Description
Dict[str, Union[int, str]]	The instance of the class converted into a json dictionary

Attributes

created_time

Get the time at which the orchestration instance was created.

If the orchestration instance is in the [[Pending]] status, this time represents the time at which the orchestration instance was scheduled.

custom_status

Get the custom status payload (if any).

Set by [[DurableOrchestrationContext]].[[set_custom_status]].

history

Get the execution history of the orchestration instance.

The history log can be large and is therefore undefined by default. It is populated only when explicitly requested in the call to [[DurableOrchestrationClient]].[[get_status]].

input_

Get the input of the orchestration instance.

instance_id

Get the unique ID of the instance.

The instance ID is generated and fixed when the orchestrator function is scheduled. It can either auto-generated, in which case it is formatted as a UUID, or it can be user-specified with any format.

last_updated_time

Get the time at which the orchestration instance last updated its execution history.

name

Get the orchestrator function name.

output

Get the output of the orchestration instance.

runtime_status

Get the runtime status of the orchestration instance.