Interface ILifeCycleNotificationHelper

Namespace

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Interface defining methods to life cycle notifications.

public interface ILifeCycleNotificationHelper

Methods

OrchestratorCompletedAsync(string, string, string, bool, bool)

The orchestrator was completed.

Task OrchestratorCompletedAsync(string hubName, string functionName, string instanceId, bool continuedAsNew, bool isReplay)

Parameters

hubName string

The name of the task hub.

functionName string

The name of the orchestrator function to call.

instanceId string

The ID to use for the orchestration instance.

continuedAsNew bool

The orchestration completed with ContinueAsNew as is in the process of restarting.

isReplay bool

The orchestrator function is currently replaying itself.

Returns

Task

A task that completes when the lifecycle notification message has been sent.

OrchestratorFailedAsync(string, string, string, string, bool)

The orchestrator was failed.

Task OrchestratorFailedAsync(string hubName, string functionName, string instanceId, string reason, bool isReplay)

Parameters

hubName string

The name of the task hub.

functionName string

The name of the orchestrator function to call.

instanceId string

The ID to use for the orchestration instance.

reason string

Additional data associated with the tracking event.

isReplay bool

The orchestrator function is currently replaying itself.

Returns

Task

A task that completes when the lifecycle notification message has been sent.

OrchestratorStartingAsync(string, string, string, bool)

The orchestrator was starting.

Task OrchestratorStartingAsync(string hubName, string functionName, string instanceId, bool isReplay)

Parameters

hubName string

The name of the task hub.

functionName string

The name of the orchestrator function to call.

instanceId string

The ID to use for the orchestration instance.

isReplay bool

The orchestrator function is currently replaying itself.

Returns

Task

A task that completes when the lifecycle notification message has been sent.

OrchestratorTerminatedAsync(string, string, string, string)

The orchestrator was terminated.

Task OrchestratorTerminatedAsync(string hubName, string functionName, string instanceId, string reason)

Parameters

hubName string

The name of the task hub.

functionName string

The name of the orchestrator function to call.

instanceId string

The ID to use for the orchestration instance.

reason string

Additional data associated with the tracking event.

Returns

Task

A task that completes when the lifecycle notification message has been sent.