GrpcDurableTaskClient.PurgeInstanceAsync(String, CancellationToken) Method
Definition
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.
Purges orchestration instance metadata from the durable store.
public override System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult> PurgeInstanceAsync (string instanceId, System.Threading.CancellationToken cancellation = default);override this.PurgeInstanceAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult>Public Overrides Function PurgeInstanceAsync (instanceId As String, Optional cancellation As CancellationToken = Nothing) As Task(Of PurgeResult)Parameters
- instanceId
- String
The unique ID of the orchestration instance to purge.
- cancellation
- CancellationToken
A CancellationToken that can be used to cancel the purge operation.
Returns
This method returns a PurgeResult object after the operation has completed with a
PurgedInstanceCount value of 1 or 0, depending on whether the target
instance was successfully purged.