Schedule

Specification

{
  "name": String,
  "description": String,
  "expression": String,
  "state": String,
  "clusterName": String,
  "userName": String,
  "schemaName": String,
  "startTime": String,
  "endTime": String,
  "timeZone": String
}

Structure values

Field Name	Type	Description	Required	Default
name	String	Schedule name.	Required
description	String	Expanded schedule information.		None
expression	String	Cron expression used to schedule jobs. Uses the schedule’s time zone if specified, or defaults to the scheduler’s time zone (typically UTC). More detail on specifying schedules using cronexpressions can be found here –Cron Trigger Tutorial.	Required
state	String	Whether the schedule is enabled or disabled. Supported values: Enabled, Disabled.		Enabled
clusterName	String	Cluster on which the scheduled job will run. If not specified, the default cluster will be used if one is set, or the job will not execute on a cluster.		None
userName	String	Name of the user account to run the job as		None
schemaName	String	Schema in which the scheduled job will be run. If not specified the default schema will be used if one is set, or the current schema will not be set for the job.		None
startTime	String	Specifies time after which the schedule will take effect. Requires ISO 8601 date-time format, YYYY-MM-DDThh:mm:ssZ.		None
endTime	String	Specifies time after which the schedule will stop running. Requires ISO 8601 date-time format, YYYY-MM-DDThh:mm:ssZ.		None
timeZone	String	The time zone in which the schedule will operate. Requires a valid Java time zone ID value, e.g. America/New_York for daylight-savings sensitive Eastern Time schedules. If not specified, the scheduler’s time zone (typically UTC) will be used.		None

Example

{
  "name": "daily",
  "description": "Run the ETL jobs at midnight EST.",
  "expression": "0 0 4 * * ?",
  "schemaName": "staging_schema",
  "startTime": "2004-11-21T00:00:00Z",
  "endTime": "2017-11-23T00:00:00Z"
}