Class SchedulerHeaderDto

Namespace

Quartz.Dashboard.Services

Assembly

Quartz.Dashboard.dll

One scheduler the container knows about, whether or not anything has built it.

public sealed record SchedulerHeaderDto : IEquatable<SchedulerHeaderDto>

Inheritance

object

SchedulerHeaderDto

Implements

IEquatable<SchedulerHeaderDto>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Status and SchedulerInstanceId are null for a registration nothing has created: there is no scheduler to ask, and listing the registrations must not build one. The rest of what a built scheduler is made of arrives with SchedulerDetailDto, which is a read per scheduler rather than part of the listing.

Constructors

SchedulerHeaderDto(string, string?, SchedulerStatus?, SchedulerOrigin)

One scheduler the container knows about, whether or not anything has built it.

public SchedulerHeaderDto(string SchedulerName, string? SchedulerInstanceId, SchedulerStatus? Status, SchedulerOrigin Origin)

Parameters

SchedulerName string

The scheduler's name, spelled as it was registered.

SchedulerInstanceId string

The instance id of the scheduler behind this registration, or null when nothing has built one.

Status SchedulerStatus?

What state the scheduler is in, or null when no scheduler exists under this name.

Origin SchedulerOrigin

Where the scheduler came from.

Remarks

Status and SchedulerInstanceId are null for a registration nothing has created: there is no scheduler to ask, and listing the registrations must not build one. The rest of what a built scheduler is made of arrives with SchedulerDetailDto, which is a read per scheduler rather than part of the listing.

Properties

IsCreated

Whether a scheduler exists under this name, which is what decides whether the rest of the dashboard has anything to show for it.

public bool IsCreated { get; }

Property Value

bool

Origin

Where the scheduler came from.

public SchedulerOrigin Origin { get; init; }

Property Value

SchedulerOrigin

SchedulerInstanceId

The instance id of the scheduler behind this registration, or null when nothing has built one.

public string? SchedulerInstanceId { get; init; }

Property Value

string

SchedulerName

The scheduler's name, spelled as it was registered.

public string SchedulerName { get; init; }

Property Value

string

Status

What state the scheduler is in, or null when no scheduler exists under this name.

public SchedulerStatus? Status { get; init; }

Property Value

SchedulerStatus?