Skip to main content

Job

View as Markdown

Job was retrieved successfully.

GetJobResponse object​

Job was retrieved successfully.

next_page_tokenstring

A token that can be used to list the next page of array properties.

Example: CAAos-uriYcxMN7_rt_v7B4=

job_idint64

The canonical identifier for this job.

Example: 11223344

creator_user_namestring

The creator user name. This field won’t be included in the response if the user has already been deleted.

Example: user.name@databricks.com

run_as_user_namestring

The email of an active workspace user or the application ID of a service principal that the job runs as. This value can be changed by setting the run_as field when creating or updating a job.

By default, run_as_user_name is based on the current job settings and is set to the creator of the job if job access control is disabled or to the user with the is_owner permission if job access control is enabled.

Example: user.name@databricks.com

settingsobject

Settings for this job and all of its runs. These settings can be updated using the resetJob method.

Show child attributesHide child attributes
namestring<= 4096 characters

An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding.

Default: Untitled

Example: A multitask job

descriptionstring<= 27700 characters

An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.

Example: This job contain multiple tasks that are required to produce the weekly shark sightings report.

email_notificationsobject

An optional set of email addresses that is notified when runs of this job begin or complete as well as when this job is deleted.

Show child attributesHide child attributes
on_startarray of string

A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.

Example: user.name@databricks.com

on_successarray of string

A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a TERMINATED life_cycle_state and a SUCCESS result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.

Example: user.name@databricks.com

on_failurearray of string

A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an INTERNAL_ERROR life_cycle_state or a FAILED, or TIMED_OUT result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.

Example: user.name@databricks.com

on_duration_warning_threshold_exceededarray of string

A list of email addresses to be notified when the duration of a run exceeds the threshold specified for the RUN_DURATION_SECONDS metric in the health field. If no rule for the RUN_DURATION_SECONDS metric is specified in the health field for the job, notifications are not sent.

Example: user.name@databricks.com

on_streaming_backlog_exceededarray of stringPublic Preview

A list of email addresses to notify when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the health field using the following metrics: STREAMING_BACKLOG_BYTES, STREAMING_BACKLOG_RECORDS, STREAMING_BACKLOG_SECONDS, or STREAMING_BACKLOG_FILES. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes.

Example: user.name@databricks.com

on_maintenance_startarray of stringGA

A list of email addresses to notify when platform-initiated maintenance starts for a continuous job.