Struct ScheduledOneOffJob

Namespace

Quartz

Assembly

Quartz.dll

What one call to the ScheduleJob<TJob, TInput> one-liners arranged: the trigger that was stored, and when it will first fire.

public readonly record struct ScheduledOneOffJob : IEquatable<ScheduledOneOffJob>

Implements

IEquatable<ScheduledOneOffJob>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The key is the handle, and the fire time is what a caller logging "scheduled for X" would otherwise have to guess from the time it asked for — which is not the same answer once a calendar or a misfire policy has had its say. Outcome says whether a firing already scheduled under the name was replaced or kept.

It is not a query object. Everything else about the firing is a property of the trigger the key names, and GetTrigger(TriggerKey, CancellationToken) is how to ask for it.

Constructors

ScheduledOneOffJob(TriggerKey, DateTimeOffset)

What one call to the ScheduleJob<TJob, TInput> one-liners arranged: the trigger that was stored, and when it will first fire.

public ScheduledOneOffJob(TriggerKey TriggerKey, DateTimeOffset FirstFireTimeUtc)

Parameters

TriggerKey TriggerKey

The key of the trigger that was stored, which is the handle to cancel it with — see UnscheduleJob(TriggerKey, CancellationToken) — or to replace it by scheduling the same name again.

FirstFireTimeUtc DateTimeOffset

The first time at which the trigger will fire, as the store computed it. The same value the ScheduleJob(ITrigger, ScheduleJobOptions, CancellationToken) overload the one-liner wraps returns. When Outcome is Kept, the next time the kept firing will fire.

Remarks

The key is the handle, and the fire time is what a caller logging "scheduled for X" would otherwise have to guess from the time it asked for — which is not the same answer once a calendar or a misfire policy has had its say. Outcome says whether a firing already scheduled under the name was replaced or kept.

It is not a query object. Everything else about the firing is a property of the trigger the key names, and GetTrigger(TriggerKey, CancellationToken) is how to ask for it.

See Also

SchedulerJobExtensions

OneOffJobOptions

Properties

FirstFireTimeUtc

The first time at which the trigger will fire, as the store computed it. The same value the ScheduleJob(ITrigger, ScheduleJobOptions, CancellationToken) overload the one-liner wraps returns. When Outcome is Kept, the next time the kept firing will fire.

public DateTimeOffset FirstFireTimeUtc { get; init; }

Property Value

DateTimeOffset

Outcome

Whether the call stored a new firing, stored it over one scheduled under the same name, or kept that one and stored nothing — which OnConflict decides.

public ScheduleOutcome Outcome { get; init; }

Property Value

ScheduleOutcome

Remarks

A non-positional member, so the constructor and the deconstruction are what they were.

TriggerKey

The key of the trigger that was stored, which is the handle to cancel it with — see UnscheduleJob(TriggerKey, CancellationToken) — or to replace it by scheduling the same name again.

public TriggerKey TriggerKey { get; init; }

Property Value

TriggerKey

See Also

SchedulerJobExtensions

OneOffJobOptions