Class DashboardHistoryQuery

Namespace

Quartz.Dashboard.Services

Assembly

Quartz.Dashboard.dll

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

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

Inheritance

object

PagedQuery

DashboardHistoryQuery

Implements

IEquatable<PagedQuery>

IEquatable<DashboardHistoryQuery>

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 filter matches a key's group, its name, or the two joined as group.name, case-insensitively.

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 — the occurrences that gave up. false lists every other row, and null, the default, lists them all. It is a question Succeeded alone cannot ask: a job under a retry policy writes a failed row per attempt, so filtering on failure shows one occurrence several times over.

FireInstanceId

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

public string? FireInstanceId { get; init; }

Property Value

string

FiredBefore

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

public DateTimeOffset? FiredBefore { get; init; }

Property Value

DateTimeOffset?

FiredFrom

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

public DateTimeOffset? FiredFrom { get; init; }

Property Value

DateTimeOffset?

Job

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

public JobKeyDto? Job { get; init; }

Property Value

JobKeyDto

JobFilter

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

public string? JobFilter { 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. Added in 4.4.

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

Property Value

IReadOnlyCollection<JobRunResult>

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: the 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. Added in 4.6.

public TriggerKeyDto? Trigger { get; init; }

Property Value

TriggerKeyDto

TriggerFilter

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

public string? TriggerFilter { get; init; }

Property Value

string