Class ScheduleCalendarSpec

Namespace

Temporalio.Client.Schedules

Assembly

Temporalio.dll

Specification relative to calendar time when to run an action.

public record ScheduleCalendarSpec : IEquatable<ScheduleCalendarSpec>

Inheritance

object

ScheduleCalendarSpec

Implements

IEquatable<ScheduleCalendarSpec>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

A timestamp matches if at least one range of each field matches except for year. If year is missing, that means all years match. For all fields besides year, at least one range must be present to match anything.

Fields

AllMonthDays

Default range set for all days in a month.

public static readonly IReadOnlyCollection<ScheduleRange> AllMonthDays

Field Value

IReadOnlyCollection<ScheduleRange>

AllMonths

Default range set for all months in a year.

public static readonly IReadOnlyCollection<ScheduleRange> AllMonths

Field Value

IReadOnlyCollection<ScheduleRange>

AllWeekDays

Default range set for all days in a week.

public static readonly IReadOnlyCollection<ScheduleRange> AllWeekDays

Field Value

IReadOnlyCollection<ScheduleRange>

Beginning

Default range set for zero.

public static readonly IReadOnlyCollection<ScheduleRange> Beginning

Field Value

IReadOnlyCollection<ScheduleRange>

Properties

Comment

Gets the description of this specification.

public string? Comment { get; init; }

Property Value

string

DayOfMonth

Gets the day of month range to match, 1-31. Default matches all days.

public IReadOnlyCollection<ScheduleRange> DayOfMonth { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

DayOfWeek

Gets the day of week range to match, 0-6, 0 is Sunday. Default matches all days.

public IReadOnlyCollection<ScheduleRange> DayOfWeek { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

Hour

Gets the hour range to match, 0-23. Default matches 0.

public IReadOnlyCollection<ScheduleRange> Hour { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

Minute

Gets the minute range to match, 0-59. Default matches 0.

public IReadOnlyCollection<ScheduleRange> Minute { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

Month

Gets the month range to match, 1-12. Default matches all months.

public IReadOnlyCollection<ScheduleRange> Month { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

Second

Gets the second range to match, 0-59. Default matches 0.

public IReadOnlyCollection<ScheduleRange> Second { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>

Year

Gets the optional year to match. Default of empty matches all years.

public IReadOnlyCollection<ScheduleRange> Year { get; init; }

Property Value

IReadOnlyCollection<ScheduleRange>