Class ExecutionHistoryQuery

Namespace

Quartz

Assembly

Quartz.dll

One page of the execution history of a scheduler, optionally narrowed by node, job, trigger, firing, fire time and result.

public sealed record ExecutionHistoryQuery : PagedQuery, IEquatable<PagedQuery>, IEquatable<ExecutionHistoryQuery>

Inheritance

object

PagedQuery

ExecutionHistoryQuery

Implements

IEquatable<PagedQuery>

IEquatable<ExecutionHistoryQuery>

Inherited Members

PagedQuery.DefaultTake

PagedQuery.All

PagedQuery.Skip

PagedQuery.Take

PagedQuery.IncludeTotalCount

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A Contains filter matches a key's group, its name, or the two joined as group.name, case-insensitively — the same reading the dashboard's history search has always had. Results are newest first, which is the one ordering a history page is read in.

Properties

FailedFinally

Narrows the page to the executions that failed for the last time, or to everything else.

public bool? FailedFinally { get; init; }

Property Value

bool?

Remarks

true lists the rows where the job failed and the trigger did not answer with another attempt — !Succeeded && !RetryScheduled, the occurrence's last word. false lists every other row: the successes, and the failures that are going to be tried again. null, the default, lists them all.

"Failed for the last time" is the question an operator opens a history page with, and it cannot be asked with Succeeded alone: a job under a retry policy writes a failed row per attempt, so filtering on failure shows the same occurrence three times over.

FireInstanceId

Lists only the executions of this firing, matched exactly, or every firing's when null.

public string? FireInstanceId { get; init; }

Property Value

string

Remarks

The id FireInstanceId carries, which a job listener, JobProgressChanged(IJobExecutionContext, FireInstanceProgress, CancellationToken) and FireInstance hand out, so a caller holding one can read that firing's outcome once it has run.

FiredBefore

Lists only the executions that fired before this instant, or up to now when null.

public DateTimeOffset? FiredBefore { get; init; }

Property Value

DateTimeOffset?

Remarks

Exclusive, so two windows that meet at an instant list each execution once.

FiredFrom

Lists only the executions that fired at or after this instant, or from the start when null.

public DateTimeOffset? FiredFrom { get; init; }

Property Value

DateTimeOffset?

Job

Lists only the executions of this job, matched exactly, or every job's when null.

public JobKey? Job { get; init; }

Property Value

JobKey

JobContains

Lists only the executions whose job key matches this, or every job's when null.

public string? JobContains { get; init; }

Property Value

string

Results

Lists only the executions whose EffectiveResult is one of these, or every result when null. An empty set lists nothing.

public IReadOnlyCollection<JobRunResult>? Results { get; init; }

Property Value

IReadOnlyCollection<JobRunResult>

Remarks

Matched against the effective result, so a row written before 4.4 is found by Succeeded or Failed.

SchedulerInstanceId

The node whose executions to list, or null for every node's.

public string? SchedulerInstanceId { get; init; }

Property Value

string

SchedulerName

The scheduler whose history to list. Required: a store keeps every scheduler's rows together.

public required string SchedulerName { get; init; }

Property Value

string

Trigger

Lists only the executions this trigger fired, matched exactly, or every trigger's when null.

public TriggerKey? Trigger { get; init; }

Property Value

TriggerKey

TriggerContains

Lists only the executions whose trigger key matches this, or every trigger's when null.

public string? TriggerContains { get; init; }

Property Value

string