Table of Contents

Class SagaQueryFilter

Namespace
Excalibur.Dispatch.Messaging
Assembly
Excalibur.Dispatch.Abstractions.dll

Filter criteria for querying saga instances via QuerySagasAsync(SagaQueryFilter, CancellationToken).

public sealed class SagaQueryFilter
Inheritance
SagaQueryFilter
Inherited Members
Extension Methods

Properties

IsCompleted

Gets the completion-state filter: false for running sagas, true for completed sagas, or null for both.

public bool? IsCompleted { get; init; }

Property Value

bool?

The completion-state filter, or null for no filter.

MaxResults

Gets the maximum number of instances to return.

public int MaxResults { get; init; }

Property Value

int

The page size; defaults to Excalibur.Dispatch.Messaging.SagaQueryFilter.DefaultMaxResults.

Remarks

The value is clamped to the range [1, Excalibur.Dispatch.Messaging.SagaQueryFilter.MaxAllowedResults] so a query can never request an unbounded result set, regardless of the underlying store provider.

Skip

Gets the number of matching instances to skip (for pagination).

public int Skip { get; init; }

Property Value

int

The skip count, clamped to a minimum of 0; defaults to 0.

TenantId

Gets the tenant filter, or null to include all tenants.

public string? TenantId { get; init; }

Property Value

string

The tenant id filter, or null.