Class OrchestrationStateQuery

Namespace

DurableTask.Core

Assembly

DurableTask.Core.dll

Query class that can be used to filter results from the Orchestration instance store. Instance methods are not thread safe.

public class OrchestrationStateQuery

Inheritance

object

OrchestrationStateQuery

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

OrchestrationStateQuery()

Query class that can be used to filter results from the Orchestration instance store. Instance methods are not thread safe.

public OrchestrationStateQuery()

Properties

FilterMap

Gets the FilterMap for the query

public IDictionary<Type, OrchestrationStateQueryFilter> FilterMap { get; }

Property Value

IDictionary<Type, OrchestrationStateQueryFilter>

Methods

AddInstanceFilter(string)

Adds an exact match instance id filter on the returned orchestrations

public OrchestrationStateQuery AddInstanceFilter(string instanceId)

Parameters

instanceId string

Instance Id to filter by

Returns

OrchestrationStateQuery

AddInstanceFilter(string, bool)

Adds an instance id filter on the returned orchestrations

public OrchestrationStateQuery AddInstanceFilter(string instanceId, bool startsWith)

Parameters

instanceId string

Instance Id to filter by

startsWith bool

Exact match if set to false, otherwise do a starts-with match

Returns

OrchestrationStateQuery

AddInstanceFilter(string, string)

Adds an exact match instance id filter on the returned orchestrations

public OrchestrationStateQuery AddInstanceFilter(string instanceId, string executionId)

Parameters

instanceId string

Instance Id to filter by

executionId string

Execution Id to filter by

Returns

OrchestrationStateQuery

AddNameVersionFilter(string)

Adds a name filter on the returned orchestrations

public OrchestrationStateQuery AddNameVersionFilter(string name)

Parameters

name string

The name of the orchestration to filter by

Returns

OrchestrationStateQuery

AddNameVersionFilter(string, string)

Adds a name/version filter on the returned orchestrations

public OrchestrationStateQuery AddNameVersionFilter(string name, string version)

Parameters

name string

The name of the orchestration to filter by

version string

The version of the orchestration to filter by

Returns

OrchestrationStateQuery

AddStatusFilter(OrchestrationStatus)

Adds a status filter on the returned orchestrations. Defaults to the equality Comparison Type.

public OrchestrationStateQuery AddStatusFilter(OrchestrationStatus status)

Parameters

status OrchestrationStatus

The status to filter by

Returns

OrchestrationStateQuery

AddStatusFilter(OrchestrationStatus, FilterComparisonType)

Adds a status filter on the returned orchestrations

public OrchestrationStateQuery AddStatusFilter(OrchestrationStatus status, FilterComparisonType comparisonType)

Parameters

status OrchestrationStatus

The status to filter by

comparisonType FilterComparisonType

type of comparison to be performed on the status

Returns

OrchestrationStateQuery

AddTimeRangeFilter(DateTime, DateTime, OrchestrationStateTimeRangeFilterType)

Adds a time range filter on the returned orchestrations

public OrchestrationStateQuery AddTimeRangeFilter(DateTime startTime, DateTime endTime, OrchestrationStateTimeRangeFilterType filterType)

Parameters

startTime DateTime

Start of the time range to filter by

endTime DateTime

End of the time range to filter by

filterType OrchestrationStateTimeRangeFilterType

Type of orchestration timestamp to apply filter on

Returns

OrchestrationStateQuery

GetFilters()

Gets the primary_filter, collection_of(secondary_filters) for the query

public Tuple<OrchestrationStateQueryFilter, IEnumerable<OrchestrationStateQueryFilter>> GetFilters()

Returns

Tuple<OrchestrationStateQueryFilter, IEnumerable<OrchestrationStateQueryFilter>>