Skip to contents

List Jobs

Source: R/jobs.R
db_jobs_list.Rd

List Jobs

Usage

db_jobs_list(
  limit = 25,
  offset = NULL,
  expand_tasks = FALSE,
  page_token = NULL,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE
)

Arguments

limit

Number of jobs to return, from 1 to 100 (default: 25).

offset

Number of records to skip. Defaults to NULL.

expand_tasks

Whether to include task and cluster details in the response.

page_token

Token from a previous response, or NULL for the first page.

host

Databricks workspace URL, defaults to calling db_host().

token

Databricks workspace token, defaults to calling db_token().

perform_request

If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

Value

If perform_request = TRUE, returns the full single-page response with class db_job_list. Each record in jobs has class db_job. Pagination tokens are included when available. If FALSE, returns an httr2_request.

See also

Other Jobs API: db_jobs_create(), db_jobs_delete(), db_jobs_get(), db_jobs_repair_run(), db_jobs_reset(), db_jobs_run_now(), db_jobs_runs_cancel(), db_jobs_runs_delete(), db_jobs_runs_export(), db_jobs_runs_get(), db_jobs_runs_get_output(), db_jobs_runs_list(), db_jobs_runs_submit(), db_jobs_update()

Examples

if (FALSE) { # \dontrun{
page <- db_jobs_list()
jobs <- page$jobs
if (!is.null(page$next_page_token)) {
  next_page <- db_jobs_list(page_token = page$next_page_token)
}
} # }