Class ScheduleSpec

Namespace

Temporalio.Client.Schedules

Assembly

Temporalio.dll

Specification of the times scheduled actions may occur. The times are the union of Calendars, Intervals, and CronExpressions excluding anything in Skip.

public record ScheduleSpec : IEquatable<ScheduleSpec>

Inheritance

object

ScheduleSpec

Implements

IEquatable<ScheduleSpec>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Calendars

Gets the calendar-based specification of times.

public IReadOnlyCollection<ScheduleCalendarSpec> Calendars { get; init; }

Property Value

IReadOnlyCollection<ScheduleCalendarSpec>

CronExpressions

Gets the cron-based specification of times.

public IReadOnlyCollection<string> CronExpressions { get; init; }

Property Value

IReadOnlyCollection<string>

Remarks

This is provided for easy migration from legacy string-based cron scheduling. New uses should use Calendars instead. These expressions will be translated to calendar-based specifications on the server.

EndAt

Gets the time after which any matching times will be skipped.

public DateTime? EndAt { get; init; }

Property Value

DateTime?

Intervals

gets the interval-based specification of times.

public IReadOnlyCollection<ScheduleIntervalSpec> Intervals { get; init; }

Property Value

IReadOnlyCollection<ScheduleIntervalSpec>

Jitter

Gets the jitter to apply to each action.

public TimeSpan? Jitter { get; init; }

Property Value

TimeSpan?

Remarks

An action's schedule time will be incremented by a random value between 0 and this value if present (but not past the next schedule).

Skip

Gets the set of matching calendar times that will be skipped.

public IReadOnlyCollection<ScheduleCalendarSpec> Skip { get; init; }

Property Value

IReadOnlyCollection<ScheduleCalendarSpec>

StartAt

Gets the time before which any matching times will be skipped.

public DateTime? StartAt { get; init; }

Property Value

DateTime?

TimeZoneName

Gets the IANA time zone name, for example US/Central.

public string? TimeZoneName { get; init; }

Property Value

string