temporalio.client.ScheduleCalendarSpec

class documentation

class ScheduleCalendarSpec: (source)

Constructor: ScheduleCalendarSpec._from_proto(spec)

View In Hierarchy

Specification relative to calendar time when to run an action.

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.

Class Variable comment Description of this schedule.
Class Variable day_of_month Day of month range to match, 1-31. Default matches all days.
Class Variable day_of_week Day of week range to match, 0-6, 0 is Sunday. Default matches all days.
Class Variable hour Hour range to match, 0-23. Default matches 0.
Class Variable minute Minute range to match, 0-59. Default matches 0.
Class Variable month Month range to match, 1-12. Default matches all months.
Class Variable second Second range to match, 0-59. Default matches 0.
Class Variable year Optional year range to match. Default of empty matches all years.
Static Method _from_proto Undocumented
Method _to_proto Undocumented
comment: Optional[str] = (source)

Description of this schedule.

day_of_month: Sequence[ScheduleRange] = (source)

Day of month range to match, 1-31. Default matches all days.

day_of_week: Sequence[ScheduleRange] = (source)

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

hour: Sequence[ScheduleRange] = (source)

Hour range to match, 0-23. Default matches 0.

minute: Sequence[ScheduleRange] = (source)

Minute range to match, 0-59. Default matches 0.

month: Sequence[ScheduleRange] = (source)

Month range to match, 1-12. Default matches all months.

second: Sequence[ScheduleRange] = (source)

Second range to match, 0-59. Default matches 0.

year: Sequence[ScheduleRange] = (source)

Optional year range to match. Default of empty matches all years.

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

Undocumented

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

Undocumented