namespaceRef | reference to WorkflowNamespace | yes | | | The namespace whose workflows are started. |
times | object | yes | | | When to start. At least one cron expression or interval. |
times.cron | list of string | | | up to 10 items | Five-field cron expressions (minute hour day-of-month month day-of-week) in the time zone. |
times.intervals | list of object | | | up to 10 items | Fixed intervals. |
times.intervals[].everySeconds | integer | yes | | 1 to 31536000 | Seconds between starts. |
times.intervals[].offsetSeconds | integer | | 0 | 0 to 31536000 | Seconds after the start of each period (counted from 1970-01-01 UTC). |
times.timezone | string | | "UTC" | up to 64 characters | Time zone of the cron expressions (UTC is the one supported at first). |
times.jitterSeconds | integer | | 0 | 0 to 3600 | Random delay added to each start, up to this many seconds. |
times.startAt | string | | | up to 40 characters | RFC 3339 time before which nothing starts. |
times.endAt | string | | | up to 40 characters | RFC 3339 time after which nothing starts. |
action | object | yes | | | The workflow to start. |
action.workflowType | string | yes | | length 1 to 255 | Workflow type name. |
action.idPrefix | string | | | up to 200 characters | Workflow ids are this prefix, a dash and the scheduled time. Defaults to the schedule's name. |
action.taskQueue | string | | | up to 255 characters | Task queue; defaults to the type's. |
action.input | string | | | up to 262144 characters | The input, as JSON text. |
action.executionTimeoutSeconds | integer | | | 0 to 157680000 | Longest each started workflow may run. |
policies | object | | {} | | What to do about overlap and missed starts. |
policies.overlap | string (one of) | | "Skip" | Skip, AllowAll | Skip: no start while the previous one still runs. AllowAll: always start. |
policies.catchupWindowSeconds | integer | | 600 | 0 to 31536000 | Starts missed while the engine was down run if they are not older than this; older ones are skipped. |
policies.pauseOnFailure | boolean | | false | | Pause the schedule when a started workflow fails. |
paused | boolean | | false | | Nothing starts while true. |