Schedule

Specification

{
  "name": String,
  "description": String,
  "expression": String,
  "state": String,
  "clusterName": String,
  "schemaName": String,
  "startTime": String,
  "endTime": 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. UTC time. More detail on specifying schedules using cron expressions can be found here – Cron Trigger Tutorial.

Required


state

String

Whether the schedule is enabled or disabled. Supported values: EnabledDisabled.


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

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. UTC time. Requires ISO 8601 date-time formatYYYY-MM-DDThh:mm:ssZ.


None

endTime

String

Specifies time after which the schedule will stop running. UTC time. Requires ISO 8601 date-time formatYYYY-MM-DDThh:mm:ssZ.


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"
}


Was this article helpful?
0 out of 0 found this helpful