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.
If a spec has no matching times after the current time, then the schedule will be subject to automatic deletion (after several days).
Properties
calendar
calendar:
$Properties[]
Calendar-based specifications of times.
cronString
cronString:
string[]
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.
endTime?
optionalendTime?:$Properties|null
If end_time is set, any timestamps after end_time will be skipped.
excludeCalendar
excludeCalendar:
$Properties[]
Any timestamps matching any of exclude_* will be skipped. Deprecated. Use exclude_structured_calendar.
excludeStructuredCalendar
excludeStructuredCalendar:
$Properties[]
ScheduleSpec excludeStructuredCalendar.
interval
interval:
$Properties[]
Interval-based specifications of times.
jitter?
optionaljitter?:$Properties|null
All timestamps will be incremented by a random value from 0 to this amount of jitter. Default: 0
startTime?
optionalstartTime?:$Properties|null
If start_time is set, any timestamps before start_time will be skipped. (Together, start_time and end_time make an inclusive interval.)
structuredCalendar
structuredCalendar:
$Properties[]
Calendar-based specifications of times.
timezoneData
timezoneData:
Uint8Array
ScheduleSpec timezoneData.
timezoneName
timezoneName:
string
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).
Methods
toJSON()
toJSON():
object
Converts this ScheduleSpec to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):ScheduleSpec&$Properties
Creates a new ScheduleSpec instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ScheduleSpec & $Properties
ScheduleSpec instance
Call Signature
staticcreate(properties?):ScheduleSpec
Creates a new ScheduleSpec instance using the specified properties.
Parameters
properties?
Properties to set
Returns
ScheduleSpec
ScheduleSpec instance
decode()
staticdecode(reader,length?):ScheduleSpec&$Properties
Decodes a ScheduleSpec message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
length?
number
Message length if known beforehand
Returns
ScheduleSpec & $Properties
ScheduleSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):ScheduleSpec&$Properties
Decodes a ScheduleSpec message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
ScheduleSpec & $Properties
ScheduleSpec
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified ScheduleSpec message. Does not implicitly temporal.api.schedule.v1.ScheduleSpec.verify|verify messages.
Parameters
message
ScheduleSpec message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified ScheduleSpec message, length delimited. Does not implicitly temporal.api.schedule.v1.ScheduleSpec.verify|verify messages.
Parameters
message
ScheduleSpec message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):ScheduleSpec
Creates a ScheduleSpec message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
ScheduleSpec
ScheduleSpec
toObject()
statictoObject(message,options?):object
Creates a plain object from a ScheduleSpec message. Also converts values to other types if specified.
Parameters
message
ScheduleSpec
ScheduleSpec
options?
IConversionOptions
Conversion options
Returns
object
Plain object