PartialScheduleDefinition

May 22, 2026 ยท View on GitHub

Schedule definition for partial updates.

All fields are optional (inherited from _ScheduleRequestBase). Only explicitly-set fields are applied during an update; unset fields preserve the existing schedule values.

Fields

FieldTypeRequiredDescription
inputOptional[Any]:heavy_minus_sign:Input to provide to the workflow when starting it.
calendarsList[models.ScheduleCalendar]:heavy_minus_sign:Calendar-based specification of times.
intervalsList[models.ScheduleInterval]:heavy_minus_sign:Interval-based specification of times.
cron_expressionsList[str]:heavy_minus_sign:Cron-based specification of times.
skipList[models.ScheduleCalendar]:heavy_minus_sign:Set of calendar times to skip.
start_atdate:heavy_minus_sign:Time after which the first action may be run.
end_atdate:heavy_minus_sign:Time after which no more actions will be run.
jitterOptionalNullable[str]:heavy_minus_sign: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).
time_zone_nameOptionalNullable[str]:heavy_minus_sign:IANA time zone name, for example US/Central.
policyOptional[models.SchedulePolicy]:heavy_minus_sign:N/A
max_executionsOptionalNullable[int]:heavy_minus_sign:Maximum number of times this schedule will trigger a workflow execution. Once this limit is reached, no further executions are triggered automatically. null means unlimited.