Class DeadLetterQueryFilter
- Namespace
- Excalibur.Dispatch.ErrorHandling
- Assembly
- Excalibur.Dispatch.dll
Filter criteria for querying dead letter queue entries.
public sealed class DeadLetterQueryFilter
- Inheritance
-
DeadLetterQueryFilter
- Inherited Members
- Extension Methods
Properties
CorrelationId
Gets or sets the correlation ID to filter by.
public string? CorrelationId { get; set; }
Property Value
FromDate
Gets or sets the start date for filtering entries.
public DateTimeOffset? FromDate { get; set; }
Property Value
IsReplayed
Gets or sets whether to include only replayed entries (true), only non-replayed entries (false), or all entries (null).
public bool? IsReplayed { get; set; }
Property Value
- bool?
MessageType
Gets or sets the message type to filter by.
public string? MessageType { get; set; }
Property Value
Remarks
This is the message's declared name, the same identity the event store, outbox and CloudEvents surfaces use. A message type that declares no name falls back to its CLR full name, and entries captured before a type declared a name are still stored under the CLR full name -- both remain resolvable, so filter by whichever name the entry was captured under.
MinAttempts
Gets or sets the minimum number of original attempts to filter by.
public int? MinAttempts { get; set; }
Property Value
- int?
Reason
Gets or sets the dead letter reason to filter by.
public DeadLetterReason? Reason { get; set; }
Property Value
Skip
Gets or sets the number of entries to skip (for pagination).
public int Skip { get; set; }
Property Value
SourceQueue
Gets or sets the source queue to filter by.
public string? SourceQueue { get; set; }
Property Value
Take
Gets or sets the maximum number of entries to return (for pagination).
public int Take { get; set; }
Property Value
- int
The page size. Defaults to 100.
Remarks
The companion to Skip. It lives here rather than beside the cancellation token on the query methods because an optional parameter cannot follow a required one: carrying the page size as a method argument forced the token to the FRONT of one estate-wide query while its sibling kept it last, so a single interface ordered the token two different ways.
ToDate
Gets or sets the end date for filtering entries.
public DateTimeOffset? ToDate { get; set; }
Property Value
Methods
ByDateRange(DateTimeOffset, DateTimeOffset)
Creates a filter for entries within a date range.
public static DeadLetterQueryFilter ByDateRange(DateTimeOffset from, DateTimeOffset to)
Parameters
fromDateTimeOffsetThe start date (inclusive).
toDateTimeOffsetThe end date (inclusive).
Returns
- DeadLetterQueryFilter
A new filter instance.
ByMessageType(string)
Creates a filter for entries with a specific message type.
public static DeadLetterQueryFilter ByMessageType(string messageType)
Parameters
messageTypestringThe message type to filter by.
Returns
- DeadLetterQueryFilter
A new filter instance.
ByReason(DeadLetterReason)
Creates a filter for entries with a specific reason.
public static DeadLetterQueryFilter ByReason(DeadLetterReason reason)
Parameters
reasonDeadLetterReasonThe dead letter reason to filter by.
Returns
- DeadLetterQueryFilter
A new filter instance.
PendingOnly()
Creates a filter for entries that have not been replayed.
public static DeadLetterQueryFilter PendingOnly()
Returns
- DeadLetterQueryFilter
A new filter instance.