Class TriggerHeader

Namespace

Quartz

Assembly

Quartz.dll

A trigger listing entry: everything a listing needs — including the state and execution group that previously required one extra round trip per trigger — without materializing the trigger or its JobDataMap.

public sealed record TriggerHeader : IEquatable<TriggerHeader>

Inheritance

object

TriggerHeader

Implements

IEquatable<TriggerHeader>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TriggerHeader(TriggerKey, JobKey, string?, string, TriggerState, DateTimeOffset, DateTimeOffset?, DateTimeOffset?, DateTimeOffset?, string?, int, string?, string?, int)

A trigger listing entry: everything a listing needs — including the state and execution group that previously required one extra round trip per trigger — without materializing the trigger or its JobDataMap.

public TriggerHeader(TriggerKey Key, JobKey JobKey, string? Description, string TriggerType, TriggerState State, DateTimeOffset StartTimeUtc, DateTimeOffset? EndTimeUtc, DateTimeOffset? NextFireTimeUtc, DateTimeOffset? PreviousFireTimeUtc, string? CalendarName, int Priority, string? ExecutionGroup, string? RetryPolicy, int RetryAttempt)

Parameters

Key TriggerKey

The trigger's key.

JobKey JobKey

The key of the job the trigger fires.

Description string

The trigger's description, if one was given.

TriggerType string

The store's trigger type discriminator, for example "CRON" or "SIMPLE" — the value of the TRIGGER_TYPE column, which is what GetHandledTriggerTypeDiscriminator() returns. It is a discriminator, not a type name, and so is deliberately not called one: contrast JobTypeName and JobTypeName, both of which carry a CLR type name that a type loader can resolve.

State TriggerState

The trigger's current state.

StartTimeUtc DateTimeOffset

The time the trigger's schedule comes into effect.

EndTimeUtc DateTimeOffset?

The time the trigger's schedule ends, if bounded.

NextFireTimeUtc DateTimeOffset?

The next time the trigger will fire, if any.

PreviousFireTimeUtc DateTimeOffset?

The previous time the trigger fired, if any.

CalendarName string

The name of the calendar the trigger observes, if any.

Priority int

The trigger's priority.

ExecutionGroup string

The trigger's execution group, if any.

RetryPolicy string

The trigger's retry policy in its stored form, if it has one. A string rather than a RetryPolicy because a listing reports the column: a row whose policy a newer node wrote in a shape this one cannot read still has to list.

RetryAttempt int

How many times the occurrence currently being executed has already been retried; 0 when it has not.

Properties

CalendarName

The name of the calendar the trigger observes, if any.

public string? CalendarName { get; init; }

Property Value

string

ContinuationCondition

The outcomes of that firing which release the wait, or null when the trigger waits for nothing.

public ContinuationCondition? ContinuationCondition { get; init; }

Property Value

ContinuationCondition?

ContinuesAfter

The trigger whose firing this one is waiting for, or null when it waits for nothing. Set while State is Awaiting, and on a continuation parked in Error because its parent was deleted. A released continuation waits for nothing — the release clears the parent — so it is null for one.

public TriggerKey? ContinuesAfter { get; init; }

Property Value

TriggerKey

Remarks

An init property rather than a positional parameter, and the same goes for ContinuationCondition: the record's constructor is a public signature that 4.0 promised not to change, so 4.2 adds beside it rather than to it.

See Also

Continuation

Description

The trigger's description, if one was given.

public string? Description { get; init; }

Property Value

string

EndTimeUtc

The time the trigger's schedule ends, if bounded.

public DateTimeOffset? EndTimeUtc { get; init; }

Property Value

DateTimeOffset?

ExecutionGroup

The trigger's execution group, if any.

public string? ExecutionGroup { get; init; }

Property Value

string

JobKey

The key of the job the trigger fires.

public JobKey JobKey { get; init; }

Property Value

JobKey

Key

The trigger's key.

public TriggerKey Key { get; init; }

Property Value

TriggerKey

NextFireTimeUtc

The next time the trigger will fire, if any.

public DateTimeOffset? NextFireTimeUtc { get; init; }

Property Value

DateTimeOffset?

OverlapPolicy

What the trigger does when one of its firings comes due while an earlier one is still running.

public OverlapPolicy OverlapPolicy { get; init; }

Property Value

OverlapPolicy

Remarks

An init property for the reason ContinuesAfter is one.

See Also

OverlapPolicy

Pause

Why the trigger is paused, who asked, and when — the record on the trigger itself — or null when it is not paused or its pause recorded nothing.

public PauseInfo? Pause { get; init; }

Property Value

PauseInfo

Remarks

A trigger stored into a group that was already paused has no record of its own, and its listing entry says so; GetTriggerPause(TriggerKey, CancellationToken) answers the group's record for it. An init property for the reason ContinuesAfter is one.

PreviousFireTimeUtc

The previous time the trigger fired, if any.

public DateTimeOffset? PreviousFireTimeUtc { get; init; }

Property Value

DateTimeOffset?

Priority

The trigger's priority.

public int Priority { get; init; }

Property Value

int

RetryAttempt

How many times the occurrence currently being executed has already been retried; 0 when it has not.

public int RetryAttempt { get; init; }

Property Value

int

RetryPolicy

The trigger's retry policy in its stored form, if it has one. A string rather than a RetryPolicy because a listing reports the column: a row whose policy a newer node wrote in a shape this one cannot read still has to list.

public string? RetryPolicy { get; init; }

Property Value

string

StartTimeUtc

The time the trigger's schedule comes into effect.

public DateTimeOffset StartTimeUtc { get; init; }

Property Value

DateTimeOffset

State

The trigger's current state.

public TriggerState State { get; init; }

Property Value

TriggerState

TriggerType

The store's trigger type discriminator, for example "CRON" or "SIMPLE" — the value of the TRIGGER_TYPE column, which is what GetHandledTriggerTypeDiscriminator() returns. It is a discriminator, not a type name, and so is deliberately not called one: contrast JobTypeName and JobTypeName, both of which carry a CLR type name that a type loader can resolve.

public string TriggerType { get; init; }

Property Value

string