Interface IMutableTrigger

Namespace

Quartz.Extensibility

Assembly

Quartz.dll

Should not be used by end users.

public interface IMutableTrigger : ITrigger

Inherited Members

ITrigger.GetTriggerBuilder()

ITrigger.GetScheduleBuilder()

ITrigger.FinalFireTimeUtc

ITrigger.MayFireAgain

ITrigger.GetFireTimeAfter(DateTimeOffset?)

ITrigger.Clone()

Properties

CalendarName

Associate the ICalendar with the given name with this Trigger. Use null - or a blank name, which the built-in triggers store as null - to dis-associate any calendar.

string? CalendarName { get; set; }

Property Value

string

Description

Set a description for the ITrigger instance - may be useful for remembering/displaying the purpose of the trigger, though the description has no meaning to Quartz.

string? Description { get; set; }

Property Value

string

EndTimeUtc

Set the time at which the ITrigger should quit repeating - regardless of any remaining repeats (based on the trigger's particular repeat settings).

DateTimeOffset? EndTimeUtc { get; set; }

Property Value

DateTimeOffset?

Remarks

The end time is inclusive: it is the last instant at which the trigger may fire.

ExecutionGroup

Gets or sets the execution group for this trigger. Execution groups allow thread limits to be configured - per node or across the cluster - so that resource-intensive jobs do not saturate all available threads.

string? ExecutionGroup { get; set; }

Property Value

string

Remarks

A null value means the trigger has no execution group (the default, backward-compatible behavior).

JobDataMap

Set the JobDataMap to be associated with the ITrigger.

JobDataMap JobDataMap { get; set; }

Property Value

JobDataMap

JobKey

The job this trigger fires.

JobKey JobKey { get; set; }

Property Value

JobKey

Key

The trigger's identity, which a store keys it by.

TriggerKey Key { get; set; }

Property Value

TriggerKey

MisfireInstructionCode

The raw code of the instruction the IScheduler follows when this trigger misses a firing.

int MisfireInstructionCode { get; set; }

Property Value

int

Remarks

The value is validated against the concrete trigger's family, which rejects a code outside its own range — but not one that is in range for two families and means something different in each. Assign a value cast from the family's own misfire enum.

See Also

MisfireInstruction

MisfireInstruction

NextFireTimeUtc

The next time at which the ITrigger is scheduled to fire.

DateTimeOffset? NextFireTimeUtc { get; set; }

Property Value

DateTimeOffset?

Remarks

Not for client code. The scheduler and job store advance this as the trigger fires.

PreferredNode

Get or set which cluster node this trigger prefers to run on. Only that node acquires the trigger, with automatic failover while it is down.

PreferredNode PreferredNode { get; set; }

Property Value

PreferredNode

Remarks

None means the trigger has no node preference. The assigned value is recorded as given, automatic-pin flag included.

PreviousFireTimeUtc

The previous time at which the ITrigger fired.

DateTimeOffset? PreviousFireTimeUtc { get; set; }

Property Value

DateTimeOffset?

Remarks

Not for client code. The scheduler and job store record this as the trigger fires.

Priority

The priority of a ITrigger acts as a tie breaker such that if two ITriggers have the same scheduled fire time, then Quartz will do its best to give the one with the higher priority first access to a worker thread.

int Priority { get; set; }

Property Value

int

Remarks

If not explicitly set, the default value is 5.

See Also

DefaultPriority

RetryAttempt

How many times the occurrence currently being executed has already been retried.

int RetryAttempt { get; set; }

Property Value

int

Remarks

Not for client code. The scheduler and job store advance and clear this as the trigger's retries are scheduled and spent; it is settable so that a store can restore what it read from its own row.

RetryPolicy

Get or set how the scheduler re-fires this trigger when its job fails. null means a failed job is reported and the trigger waits for its next scheduled occurrence.

RetryPolicy? RetryPolicy { get; set; }

Property Value

RetryPolicy

See Also

RetryPolicy

StartTimeUtc

The time at which the trigger's scheduling should start. May or may not be the first actual fire time of the trigger, depending upon the type of trigger and the settings of the other properties of the trigger. However the first actual first time will not be before this date.

Setting a value in the past may cause a new trigger to compute a first fire time that is in the past, which may cause an immediate misfire of the trigger.

DateTimeOffset StartTimeUtc { get; set; }

Property Value

DateTimeOffset