DurabilityProvider.PurgeHistoryByFilters Method

Definition

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:

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

Source:

DurabilityProvider.cs

Purges history that meet the required parameters.

public virtual System.Threading.Tasks.Task<int> PurgeHistoryByFilters (DateTime createdTimeFrom, DateTime? createdTimeTo, System.Collections.Generic.IEnumerable<DurableTask.Core.OrchestrationStatus> runtimeStatus);

abstract member PurgeHistoryByFilters : DateTime * Nullable<DateTime> * seq<DurableTask.Core.OrchestrationStatus> -> System.Threading.Tasks.Task<int>
override this.PurgeHistoryByFilters : DateTime * Nullable<DateTime> * seq<DurableTask.Core.OrchestrationStatus> -> System.Threading.Tasks.Task<int>

Public Overridable Function PurgeHistoryByFilters (createdTimeFrom As DateTime, createdTimeTo As Nullable(Of DateTime), runtimeStatus As IEnumerable(Of OrchestrationStatus)) As Task(Of Integer)

Parameters

createdTimeFrom

DateTime

Purge the history of orchestration instances which were created after this DateTime.

createdTimeTo

Nullable<DateTime>

Purge the history of orchestration instances which were created before this DateTime.

runtimeStatus

IEnumerable<DurableTask.Core.OrchestrationStatus>

Purge the history of orchestration instances which matches the runtimeStatus.

Returns

Task<Int32>

The number of instances purged.