GrpcDurableTaskClient Class

Reference

Definition

Namespace:: Microsoft.DurableTask.Client.Grpc

Assembly:: Microsoft.DurableTask.Client.Grpc.dll

Package:: Microsoft.DurableTask.Client.Grpc v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Durable Task client implementation that uses gRPC to connect to a remote "sidecar" process.

public sealed class GrpcDurableTaskClient : Microsoft.DurableTask.Client.DurableTaskClient

type GrpcDurableTaskClient = class
    inherit DurableTaskClient

Public NotInheritable Class GrpcDurableTaskClient
Inherits DurableTaskClient

Inheritance: Object

DurableTaskClient
GrpcDurableTaskClient

Constructors

GrpcDurableTaskClient(String, GrpcDurableTaskClientOptions, ILogger)	Initializes a new instance of the GrpcDurableTaskClient class.
GrpcDurableTaskClient(String, IOptionsMonitor<GrpcDurableTaskClientOptions>, ILogger<GrpcDurableTaskClient>)	Initializes a new instance of the GrpcDurableTaskClient class.

Properties

Name	Gets the name of the client. (Inherited from DurableTaskClient)

Methods

DisposeAsync()	Disposes any unmanaged resources associated with this DurableTaskClient.
GetAllInstancesAsync(OrchestrationQuery)	Queries orchestration instances.
GetInstancesAsync(String, Boolean, CancellationToken)	Fetches orchestration instance metadata from the configured durable store.
GetInstancesAsync(String, CancellationToken)	Fetches orchestration instance metadata from the configured durable store. (Inherited from DurableTaskClient)
PurgeAllInstancesAsync(PurgeInstancesFilter, CancellationToken)	Purges orchestration instances metadata from the durable store.
PurgeInstanceAsync(String, CancellationToken)	Purges orchestration instance metadata from the durable store.
RaiseEventAsync(String, String, CancellationToken)	Sends an event notification message to a waiting orchestration instance. (Inherited from DurableTaskClient)
RaiseEventAsync(String, String, Object, CancellationToken)	Sends an event notification message to a waiting orchestration instance.
ResumeInstanceAsync(String, CancellationToken)	Resumes an orchestration instance that was suspended via SuspendInstanceAsync(String, String, CancellationToken). (Inherited from DurableTaskClient)
ResumeInstanceAsync(String, String, CancellationToken)	Resumes an orchestration instance that was suspended via SuspendInstanceAsync(String, String, CancellationToken).
ScheduleNewOrchestrationInstanceAsync(TaskName, CancellationToken)	Schedules a new orchestration instance for execution. (Inherited from DurableTaskClient)
ScheduleNewOrchestrationInstanceAsync(TaskName, Object, CancellationToken)	Schedules a new orchestration instance for execution. (Inherited from DurableTaskClient)
ScheduleNewOrchestrationInstanceAsync(TaskName, Object, StartOrchestrationOptions, CancellationToken)	Schedules a new orchestration instance for execution.
ScheduleNewOrchestrationInstanceAsync(TaskName, StartOrchestrationOptions, CancellationToken)	Schedules a new orchestration instance for execution. (Inherited from DurableTaskClient)
SuspendInstanceAsync(String, CancellationToken)	Suspends an orchestration instance, halting processing of it until ResumeInstanceAsync(String, String, CancellationToken) is used to resume the orchestration. (Inherited from DurableTaskClient)
SuspendInstanceAsync(String, String, CancellationToken)	Suspends an orchestration instance, halting processing of it until ResumeInstanceAsync(String, String, CancellationToken) is used to resume the orchestration.
TerminateInstanceAsync(String, CancellationToken)	Terminates a running orchestration instance and updates its runtime status to Terminated. (Inherited from DurableTaskClient)
TerminateInstanceAsync(String, Object, CancellationToken)	Terminates a running orchestration instance and updates its runtime status to Terminated.
WaitForInstanceCompletionAsync(String, Boolean, CancellationToken)	Waits for an orchestration to complete and returns a OrchestrationMetadata object that contains metadata about the started instance.
WaitForInstanceCompletionAsync(String, CancellationToken)	Waits for an orchestration to complete and returns a OrchestrationMetadata object that contains metadata about the started instance. (Inherited from DurableTaskClient)
WaitForInstanceStartAsync(String, Boolean, CancellationToken)	Waits for an orchestration to start running and returns a OrchestrationMetadata object that contains metadata about the started instance.
WaitForInstanceStartAsync(String, CancellationToken)	Waits for an orchestration to start running and returns a OrchestrationMetadata object that contains metadata about the started instance. (Inherited from DurableTaskClient)

Extension Methods

PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)	Purges orchestration instances metadata from the durable store.
PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)	Purges orchestration instances metadata from the durable store.

Applies to

Share via