General · GraphQL type

Schedule type

When something runs. The type selects which fields define the schedule, and a schedule that fires can always be read as a cron expression.

Fields

Field Name Description
type - ScheduleType! How this schedule expresses when it fires, and therefore which of the fields below define it.
cronString - String!

The cron expression this schedule fires on. Set when the type is CRONTAB and blank otherwise. Accepts the standard five-field cron format (minute, hour, day of month, month, day of week) and the descriptors @yearly, @monthly, @weekly, @daily, @hourly and @every.

The expression is evaluated in UTC. The shortest supported interval is one minute, so an @every shorter than that is rejected. An embedded timezone (a TZ= or CRON_TZ= prefix) is not accepted.

Used by

  • Rule type: A policy rule evaluated against graph objects.
  • RuleInput input: Input variant of Rule carrying its writable fields.
  • RuleType enum: Describes how a rule gathers the input its function evaluates.

Example

Example

{"type": "NONE", "cronString": "xyz789"}