Class ScheduleSpec
ScheduleSpec is a complete description of a set of absolute timestamps
(possibly infinite) that an action should occur at. The meaning of a
ScheduleSpec depends only on its contents and never changes, except that the
definition of a time zone can change over time (most commonly, when daylight
saving time policy changes for an area). To create a totally self-contained
ScheduleSpec, use UTC or include timezone_data.
For input, you can provide zero or more of: structured_calendar, calendar,
cron_string, interval, and exclude_structured_calendar, and all of them will
be used (the schedule will take action at the union of all of their times,
minus the ones that match exclude_structured_calendar).
On input, calendar and cron_string fields will be compiled into
structured_calendar (and maybe interval and timezone_name), so if you
Describe a schedule, you'll see only structured_calendar, interval, etc.
Implements
Google.Protobuf.IBufferMessage
Assembly: Temporalio.dll
Syntax
public sealed class ScheduleSpec : Google.Protobuf.IMessage<ScheduleSpec>, Google.Protobuf.IBufferMessage
Constructors
ScheduleSpec()
Declaration
ScheduleSpec(ScheduleSpec)
Declaration
public ScheduleSpec(ScheduleSpec other)
Parameters
Fields
CalendarFieldNumber
Field number for the "calendar" field.
Declaration
public const int CalendarFieldNumber = null
Field Value
CronStringFieldNumber
Field number for the "cron_string" field.
Declaration
public const int CronStringFieldNumber = null
Field Value
EndTimeFieldNumber
Field number for the "end_time" field.
Declaration
public const int EndTimeFieldNumber = null
Field Value
ExcludeCalendarFieldNumber
Field number for the "exclude_calendar" field.
Declaration
public const int ExcludeCalendarFieldNumber = null
Field Value
ExcludeStructuredCalendarFieldNumber
Field number for the "exclude_structured_calendar" field.
Declaration
public const int ExcludeStructuredCalendarFieldNumber = null
Field Value
IntervalFieldNumber
Field number for the "interval" field.
Declaration
public const int IntervalFieldNumber = null
Field Value
JitterFieldNumber
Field number for the "jitter" field.
Declaration
public const int JitterFieldNumber = null
Field Value
StartTimeFieldNumber
Field number for the "start_time" field.
Declaration
public const int StartTimeFieldNumber = null
Field Value
StructuredCalendarFieldNumber
Field number for the "structured_calendar" field.
Declaration
public const int StructuredCalendarFieldNumber = null
Field Value
TimezoneDataFieldNumber
Field number for the "timezone_data" field.
Declaration
public const int TimezoneDataFieldNumber = null
Field Value
TimezoneNameFieldNumber
Field number for the "timezone_name" field.
Declaration
public const int TimezoneNameFieldNumber = null
Field Value
Properties
Calendar
Calendar-based specifications of times.
Declaration
public Google.Protobuf.Collections.RepeatedField<CalendarSpec> Calendar { get; }
Property Value
| Type |
Description |
| Google.Protobuf.Collections.RepeatedField<CalendarSpec> |
|
CronString
cron_string holds a traditional cron specification as a string. It
accepts 5, 6, or 7 fields, separated by spaces, and interprets them the
same way as CalendarSpec.
5 fields: minute, hour, day_of_month, month, day_of_week
6 fields: minute, hour, day_of_month, month, day_of_week, year
7 fields: second, minute, hour, day_of_month, month, day_of_week, year
If year is not given, it defaults to *. If second is not given, it
defaults to 0.
Shorthands @yearly, @monthly, @weekly, @daily, and @hourly are also
accepted instead of the 5-7 time fields.
Optionally, the string can be preceded by CRON_TZ=<timezone name> or
TZ=<timezone name>, which will get copied to timezone_name. (There must
not also be a timezone_name present.)
Optionally "#" followed by a comment can appear at the end of the string.
Note that the special case that some cron implementations have for
treating day_of_month and day_of_week as "or" instead of "and" when both
are set is not implemented.
@every <interval>[/<phase>] is accepted and gets compiled into an
IntervalSpec instead. <interval> and <phase> should be a decimal integer
with a unit suffix s, m, h, or d.
Declaration
public Google.Protobuf.Collections.RepeatedField<string> CronString { get; }
Property Value
| Type |
Description |
| Google.Protobuf.Collections.RepeatedField<String> |
|
Descriptor
Declaration
public static Google.Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
| Type |
Description |
| Google.Protobuf.Reflection.MessageDescriptor |
|
EndTime
If end_time is set, any timestamps after end_time will be skipped.
Declaration
public Google.Protobuf.WellKnownTypes.Timestamp EndTime { get; set; }
Property Value
| Type |
Description |
| Google.Protobuf.WellKnownTypes.Timestamp |
|
ExcludeCalendar
Any timestamps matching any of exclude_* will be skipped.
Declaration
public Google.Protobuf.Collections.RepeatedField<CalendarSpec> ExcludeCalendar { get; }
Property Value
| Type |
Description |
| Google.Protobuf.Collections.RepeatedField<CalendarSpec> |
|
ExcludeStructuredCalendar
Declaration
public Google.Protobuf.Collections.RepeatedField<StructuredCalendarSpec> ExcludeStructuredCalendar { get; }
Property Value
Interval
Interval-based specifications of times.
Declaration
public Google.Protobuf.Collections.RepeatedField<IntervalSpec> Interval { get; }
Property Value
| Type |
Description |
| Google.Protobuf.Collections.RepeatedField<IntervalSpec> |
|
Jitter
All timestamps will be incremented by a random value from 0 to this
amount of jitter. Default: 0
Declaration
public Google.Protobuf.WellKnownTypes.Duration Jitter { get; set; }
Property Value
| Type |
Description |
| Google.Protobuf.WellKnownTypes.Duration |
|
Parser
Declaration
public static Google.Protobuf.MessageParser<ScheduleSpec> Parser { get; }
Property Value
| Type |
Description |
| Google.Protobuf.MessageParser<ScheduleSpec> |
|
StartTime
If start_time is set, any timestamps before start_time will be skipped.
(Together, start_time and end_time make an inclusive interval.)
Declaration
public Google.Protobuf.WellKnownTypes.Timestamp StartTime { get; set; }
Property Value
| Type |
Description |
| Google.Protobuf.WellKnownTypes.Timestamp |
|
StructuredCalendar
Calendar-based specifications of times.
Declaration
public Google.Protobuf.Collections.RepeatedField<StructuredCalendarSpec> StructuredCalendar { get; }
Property Value
TimezoneData
Declaration
public Google.Protobuf.ByteString TimezoneData { get; set; }
Property Value
| Type |
Description |
| Google.Protobuf.ByteString |
|
TimezoneName
Time zone to interpret all calendar-based specs in.
If unset, defaults to UTC. We recommend using UTC for your application if
at all possible, to avoid various surprising properties of time zones.
Time zones may be provided by name, corresponding to names in the IANA
time zone database (see https://www.iana.org/time-zones). The definition
will be loaded by the Temporal server from the environment it runs in.
If your application requires more control over the time zone definition
used, it may pass in a complete definition in the form of a TZif file
from the time zone database. If present, this will be used instead of
loading anything from the environment. You are then responsible for
updating timezone_data when the definition changes.
Calendar spec matching is based on literal matching of the clock time
with no special handling of DST: if you write a calendar spec that fires
at 2:30am and specify a time zone that follows DST, that action will not
be triggered on the day that has no 2:30am. Similarly, an action that
fires at 1:30am will be triggered twice on the day that has two 1:30s.
Also note that no actions are taken on leap-seconds (e.g. 23:59:60 UTC).
Declaration
public string TimezoneName { get; set; }
Property Value
Methods
CalculateSize()
Declaration
public int CalculateSize()
Returns
Clone()
Declaration
public ScheduleSpec Clone()
Returns
Equals(Object)
Declaration
public override bool Equals(object other)
Parameters
| Type |
Name |
Description |
| Object |
other |
|
Returns
Equals(ScheduleSpec)
Declaration
public bool Equals(ScheduleSpec other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Declaration
public void MergeFrom(Google.Protobuf.CodedInputStream input)
Parameters
| Type |
Name |
Description |
| Google.Protobuf.CodedInputStream |
input |
|
MergeFrom(ScheduleSpec)
Declaration
public void MergeFrom(ScheduleSpec other)
Parameters
ToString()
Declaration
public override string ToString()
Returns
WriteTo(Google.Protobuf.CodedOutputStream)
Declaration
public void WriteTo(Google.Protobuf.CodedOutputStream output)
Parameters
| Type |
Name |
Description |
| Google.Protobuf.CodedOutputStream |
output |
|
Implements
Google.Protobuf.IBufferMessage