Class SchedulerMetadata

Namespace

Quartz

Assembly

Quartz.dll

Describes the settings and capabilities of a given IScheduler instance.

public sealed record SchedulerMetadata : IEquatable<SchedulerMetadata>

Inheritance

object

SchedulerMetadata

Implements

IEquatable<SchedulerMetadata>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The values are an instantaneous snapshot: as soon as one is returned, the scheduler may already have moved on.

Properties

IsProxy

Whether this metadata describes a proxy to a scheduler running elsewhere — e.g. an HttpScheduler talking to a remote HTTP API — rather than the in-process instance. When true, the values are the remote scheduler's, read over the wire.

public bool IsProxy { get; init; }

Property Value

bool

JobStoreClustered

Whether the IScheduler's IJobStore is clustered.

public bool JobStoreClustered { get; init; }

Property Value

bool

JobStorePersistent

Whether the IScheduler's IJobStore supports persistence.

public bool JobStorePersistent { get; init; }

Property Value

bool

JobStoreTypeName

The assembly-qualified name (without version) of the IJobStore implementation the IScheduler uses.

public required string JobStoreTypeName { get; init; }

Property Value

string

JobsExecuted

The number of jobs executed since the IScheduler started.

public int JobsExecuted { get; init; }

Property Value

int

LocalExecutingJobs

The number of executions running on this node right now.

public int LocalExecutingJobs { get; init; }

Property Value

int

Remarks

Node-local, as the name says: it counts the executions this scheduler instance is hosting, and a clustered scheduler is running more than these elsewhere. Use QueryFireInstances(FireInstanceQuery, CancellationToken) for the cluster-wide count — the two numbers describe different things and will differ, which is why this one does not pretend otherwise.

RunningSince

The DateTimeOffset at which the scheduler started running, or null if it has not been started.

public DateTimeOffset? RunningSince { get; init; }

Property Value

DateTimeOffset?

SchedulerInstanceId

The instance id of the IScheduler.

public required string SchedulerInstanceId { get; init; }

Property Value

string

SchedulerName

The name of the IScheduler.

public required string SchedulerName { get; init; }

Property Value

string

SchedulerTypeName

The assembly-qualified name (without version) of the IScheduler implementation. A name rather than a Type, because for a proxy the type may live only in the remote process and could never be materialized here.

public required string SchedulerTypeName { get; init; }

Property Value

string

Status

Where the IScheduler is in its lifecycle.

public required SchedulerStatus Status { get; init; }

Property Value

SchedulerStatus

Remarks

The same value as Status, derived the same way whether the scheduler is in this process or another one.

ThreadPoolSize

The number of threads in the IScheduler's thread pool.

public int ThreadPoolSize { get; init; }

Property Value

int

ThreadPoolTypeName

The assembly-qualified name (without version) of the thread pool implementation the IScheduler uses.

public required string ThreadPoolTypeName { get; init; }

Property Value

string

Version

The version of Quartz that is running.

public required string Version { get; init; }

Property Value

string