temporalio.client.ScheduleSpec

class documentation

class ScheduleSpec: (source)

Constructor: ScheduleSpec._from_proto(spec)

View In Hierarchy

Specification of the times scheduled actions may occur.

The times are the union of calendars, intervals, and cron_expressions excluding anything in skip.

Class Variable calendars Calendar-based specification of times.
Class Variable cron_expressions Cron-based specification of times.
Class Variable end_at Time after which any matching times will be skipped.
Class Variable intervals Interval-based specification of times.
Class Variable jitter Jitter to apply each action.
Class Variable skip Set of matching calendar times that will be skipped.
Class Variable start_at Time before which any matching times will be skipped.
Class Variable time_zone_name IANA time zone name, for example US/Central.
Static Method _from_proto Undocumented
Method _to_proto Undocumented
calendars: Sequence[ScheduleCalendarSpec] = (source)

Calendar-based specification of times.

cron_expressions: Sequence[str] = (source)

Cron-based specification of times.

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.

end_at: datetime | None = (source)

Time after which any matching times will be skipped.

intervals: Sequence[ScheduleIntervalSpec] = (source)

Interval-based specification of times.

jitter: timedelta | None = (source)

Jitter to apply each action.

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

skip: Sequence[ScheduleCalendarSpec] = (source)

Set of matching calendar times that will be skipped.

start_at: datetime | None = (source)

Time before which any matching times will be skipped.

time_zone_name: str | None = (source)

IANA time zone name, for example US/Central.

@staticmethod
def _from_proto(spec: temporalio.api.schedule.v1.ScheduleSpec) -> ScheduleSpec: (source)

Undocumented

def _to_proto(self) -> temporalio.api.schedule.v1.ScheduleSpec: (source)

Undocumented