Class SchedulerDetailDto

Namespace

Quartz.Dashboard.Services

Assembly

Quartz.Dashboard.dll

One scheduler and what it is made of: its identity, its state, and the settings and capabilities SchedulerMetadata reports.

public sealed record SchedulerDetailDto : IEquatable<SchedulerDetailDto>

Inheritance

object

SchedulerDetailDto

Implements

IEquatable<SchedulerDetailDto>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The metadata is on the detail rather than on SchedulerHeaderDto because reading it is a call per scheduler — over HTTP for a remote one — while the listing must stay one call.

Constructors

SchedulerDetailDto(string, string, SchedulerStatus, bool, bool, string, string, int, DateTimeOffset?, int, string)

One scheduler and what it is made of: its identity, its state, and the settings and capabilities SchedulerMetadata reports.

public SchedulerDetailDto(string SchedulerInstanceId, string SchedulerName, SchedulerStatus Status, bool Clustered, bool Persistent, string JobStoreTypeName, string ThreadPoolTypeName, int ThreadPoolSize, DateTimeOffset? RunningSince, int JobsExecuted, string Version)

Parameters

SchedulerInstanceId string

The scheduler's instance id.

SchedulerName string

The scheduler's name.

Status SchedulerStatus

Where the scheduler is in its lifecycle.

Clustered bool

Whether the job store is clustered. This is the answer to "is this scheduler part of a cluster"; the node listing cannot be, because a clustered store whose only node has not finished its first check-in looks exactly like a store that keeps no check-in state at all.

Persistent bool

Whether the job store survives a restart.

JobStoreTypeName string

The job store's type name, without its assembly version.

ThreadPoolTypeName string

The thread pool's type name, without its assembly version.

ThreadPoolSize int

How many threads the pool has.

RunningSince DateTimeOffset?

When the scheduler started, or null when it has not been started.

JobsExecuted int

How many jobs this node has executed since it started.

Version string

The version of Quartz that is running.

Remarks

The metadata is on the detail rather than on SchedulerHeaderDto because reading it is a call per scheduler — over HTTP for a remote one — while the listing must stay one call.

Properties

Clustered

Whether the job store is clustered. This is the answer to "is this scheduler part of a cluster"; the node listing cannot be, because a clustered store whose only node has not finished its first check-in looks exactly like a store that keeps no check-in state at all.

public bool Clustered { get; init; }

Property Value

bool

JobStoreTypeName

The job store's type name, without its assembly version.

public string JobStoreTypeName { get; init; }

Property Value

string

JobsExecuted

How many jobs this node has executed since it started.

public int JobsExecuted { get; init; }

Property Value

int

Persistent

Whether the job store survives a restart.

public bool Persistent { get; init; }

Property Value

bool

RunningSince

When the scheduler started, or null when it has not been started.

public DateTimeOffset? RunningSince { get; init; }

Property Value

DateTimeOffset?

SchedulerInstanceId

The scheduler's instance id.

public string SchedulerInstanceId { get; init; }

Property Value

string

SchedulerName

The scheduler's name.

public string SchedulerName { get; init; }

Property Value

string

Status

Where the scheduler is in its lifecycle.

public SchedulerStatus Status { get; init; }

Property Value

SchedulerStatus

ThreadPoolSize

How many threads the pool has.

public int ThreadPoolSize { get; init; }

Property Value

int

ThreadPoolTypeName

The thread pool's type name, without its assembly version.

public string ThreadPoolTypeName { get; init; }

Property Value

string

Version

The version of Quartz that is running.

public string Version { get; init; }

Property Value

string