Cluster Schedules

Specification

{
  "name": String,
  "description": String,
  "expression": String,
  "userName": String,
  "clusterAction": 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.

Optional

None

expression

String

Cron expression used to schedule cluster actions. Uses the schedule’s time zone if specified, or defaults to the scheduler’s time zone (typically UTC). More detail on specifying schedules using cron expressions can be found here – Cron Trigger Tutorial.

Required

userName

String

The account through which the cluster schedule action will be requested. Must have write permission on the cluster. Default user is the session user when the schedule is created.

Optional

Session user

clusterAction

String

The action to execute for the cluster associated with this schedule. Supported values: Stop, Start, Restart.

Required

startTime

String

Specifies time after which the schedule will take effect. Requires ISO 8601 date-time formatYYYY-MM-DDThh:mm:ssZ.

Optional

None

endTime

String

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

Optional

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.

Optional

None

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