db_jobs_runs_list: List Job Runs
In brickster: R Toolkit for 'Databricks'

db_jobs_runs_list

R Documentation

List Job Runs

Description

List runs in descending order by end time, or start time for unfinished runs.

Usage

db_jobs_runs_list(
  job_id,
  active_only = FALSE,
  completed_only = FALSE,
  offset = NULL,
  limit = 25,
  run_type = c("JOB_RUN", "WORKFLOW_RUN", "SUBMIT_RUN"),
  expand_tasks = FALSE,
  page_token = NULL,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE
)

Arguments

`job_id`	The canonical identifier of the job.
`active_only`	Boolean (Default: `FALSE`). If `TRUE` only active runs are included in the results; otherwise, lists both active and completed runs. An active run is a run in the `PENDING`, `RUNNING`, or `TERMINATING`. This field cannot be true when `completed_only` is `TRUE`.
`completed_only`	Boolean (Default: `FALSE`). If `TRUE`, only completed runs are included in the results; otherwise, lists both active and completed runs. This field cannot be true when `active_only` is `TRUE`.
`offset`	Number of records to skip. Defaults to `NULL`.
`limit`	Number of runs to return, from 1 to 25 (default: 25). A value of 0 requests the service maximum.
`run_type`	The type of runs to return. One of `JOB_RUN`, `WORKFLOW_RUN`, `SUBMIT_RUN`.
`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 API response as a list, including runs, next_page_token, and prev_page_token when present. The runs field may be absent when there are no runs to list. If perform_request = FALSE, returns an httr2_request.

Other Jobs API: db_jobs_create(), db_jobs_delete(), db_jobs_get(), db_jobs_list(), 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_submit(), db_jobs_update()