DurableOrchestrationStatus class

Package:

durable-functions

Represents the status of a durable orchestration instance.

Can be fetched using DurableClient.getStatus()

Properties

createdTime	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.
customStatus	The custom status payload (if any) that was set by DurableClient.setCustomStatus().
history	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 DurableClient.getStatus().
input	The input of the orchestration instance.
instanceId	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 GUID, or it can be user-specified with any format.
lastUpdatedTime	The time at which the orchestration instance last updated its execution history.
name	The orchestrator function name.
output	The output of the orchestration instance.
runtimeStatus	The runtime status of the orchestration instance.

Property Details

createdTime

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.

createdTime: Date

Property Value

Date

customStatus

The custom status payload (if any) that was set by DurableClient.setCustomStatus().

customStatus?: unknown

Property Value

unknown

history

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 DurableClient.getStatus().

history?: unknown[]

Property Value

unknown[]

input

The input of the orchestration instance.

input: unknown

Property Value

unknown

instanceId

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 GUID, or it can be user-specified with any format.

instanceId: string

Property Value

string

lastUpdatedTime

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

lastUpdatedTime: Date

Property Value

Date

name

The orchestrator function name.

name: string

Property Value

string

output

The output of the orchestration instance.

output: unknown

Property Value

unknown

runtimeStatus

The runtime status of the orchestration instance.

runtimeStatus: OrchestrationRuntimeStatus

Property Value

OrchestrationRuntimeStatus