IDurableClient Interface

Definition

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:

Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Source:

IDurableClient.cs

Provides functionality available to durable orchestration and entity clients.

public interface IDurableClient : Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableEntityClient, Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableOrchestrationClient

type IDurableClient = interface
    interface IDurableOrchestrationClient
    interface IDurableEntityClient

Public Interface IDurableClient
Implements IDurableEntityClient, IDurableOrchestrationClient

Implements

IDurableEntityClient IDurableOrchestrationClient

Properties

TaskHubName

Gets the name of the task hub configured on this client instance.

Methods

CleanEntityStorageAsync(Boolean, Boolean, CancellationToken)	Removes empty entities from storage and releases orphaned locks. (Inherited from IDurableEntityClient)
CreateCheckStatusResponse(HttpRequest, String, Boolean)	Creates an HTTP response that is useful for checking the status of the specified instance. (Inherited from IDurableOrchestrationClient)
CreateCheckStatusResponse(HttpRequestMessage, String, Boolean)	Creates an HTTP response that is useful for checking the status of the specified instance. (Inherited from IDurableOrchestrationClient)
CreateHttpManagementPayload(String)	Creates a HttpManagementPayload object that contains status, terminate and send external event HTTP endpoints. (Inherited from IDurableOrchestrationClient)
GetStatusAsync(Nullable<DateTime>, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)	Obsolete. Gets the status of all orchestration instances that match the specified conditions. (Inherited from IDurableOrchestrationClient)
GetStatusAsync(OrchestrationStatusQueryCondition, CancellationToken)	Obsolete. Gets the status of all orchestration instances with paging that match the specified conditions. (Inherited from IDurableOrchestrationClient)
GetStatusAsync(String, Boolean, Boolean, Boolean)	Gets the status of the specified orchestration instance. (Inherited from IDurableOrchestrationClient)
ListEntitiesAsync(EntityQuery, CancellationToken)	Gets the status of all entity instances with paging that match the specified query conditions. (Inherited from IDurableEntityClient)
ListInstancesAsync(OrchestrationStatusQueryCondition, CancellationToken)	Gets the status of all orchestration instances with paging that match the specified conditions. (Inherited from IDurableOrchestrationClient)
MakeCurrentAppPrimaryAsync()	Makes the current app the primary app, if it isn't already. Must be using the AppLease feature by setting UseAppLease to true in host.json. (Inherited from IDurableOrchestrationClient)
PurgeInstanceHistoryAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationStatus>)	Purge the orchestration history for instances that match the conditions. (Inherited from IDurableOrchestrationClient)
PurgeInstanceHistoryAsync(String)	Purge the history for a concrete instance. (Inherited from IDurableOrchestrationClient)
RaiseEventAsync(String, String, Object)	Sends an event notification message to a waiting orchestration instance. (Inherited from IDurableOrchestrationClient)
RaiseEventAsync(String, String, String, Object, String)	Sends an event notification message to a waiting orchestration instance. (Inherited from IDurableOrchestrationClient)
ReadEntityStateAsync<T>(EntityId, String, String)	Tries to read the current state of an entity. Returns default(T) if the entity does not exist. (Inherited from IDurableEntityClient)
RestartAsync(String, Boolean)	Restarts an existing orchestrator with the original input. (Inherited from IDurableOrchestrationClient)
ResumeAsync(String, String)	Resumes a suspended orchestration instance. (Inherited from IDurableOrchestrationClient)
RewindAsync(String, String)	Obsolete. Rewinds the specified failed orchestration instance with a reason. (Inherited from IDurableOrchestrationClient)
SignalEntityAsync(EntityId, DateTime, String, Object, String, String)	Signals an entity to perform an operation, at a specified time. (Inherited from IDurableEntityClient)
SignalEntityAsync(EntityId, String, Object, String, String)	Signals an entity to perform an operation. (Inherited from IDurableEntityClient)
SignalEntityAsync<TEntityInterface>(EntityId, Action<TEntityInterface>)	Signals an entity to perform an operation. (Inherited from IDurableEntityClient)
SignalEntityAsync<TEntityInterface>(EntityId, DateTime, Action<TEntityInterface>)	Signals an entity to perform an operation, at a specified time. (Inherited from IDurableEntityClient)
SignalEntityAsync<TEntityInterface>(String, Action<TEntityInterface>)	Signals an entity to perform an operation. (Inherited from IDurableEntityClient)
SignalEntityAsync<TEntityInterface>(String, DateTime, Action<TEntityInterface>)	Signals an entity to perform an operation, at a specified time. (Inherited from IDurableEntityClient)
StartNewAsync(String, String)	Starts a new execution of the specified orchestrator function. (Inherited from IDurableOrchestrationClient)
StartNewAsync<T>(String, String, T)	Starts a new instance of the specified orchestrator function. (Inherited from IDurableOrchestrationClient)
StartNewAsync<T>(String, T)	Starts a new execution of the specified orchestrator function. (Inherited from IDurableOrchestrationClient)
SuspendAsync(String, String)	Suspends a running orchestration instance. (Inherited from IDurableOrchestrationClient)
TerminateAsync(String, String)	Terminates a running orchestration instance. (Inherited from IDurableOrchestrationClient)
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequest, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)	Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration. (Inherited from IDurableOrchestrationClient)
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)	Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration. (Inherited from IDurableOrchestrationClient)