delete_job: Delete a job on Databricks

In RafiKurlansik/bricksteR: R Package for Making Databricks Easy to Use.

Delete a job on Databricks

Description

Delete the job and send an email to the addresses specified in JobSettings.email_notifications. No action occurs if the job has already been removed. After the job is removed, neither its details or its run history is visible via the Jobs UI or API.

Usage

delete_job(job_id = NULL, name = NULL, workspace, token = NULL, verbose = T)

Arguments

job_id	A number representing the unique identifier of a job on Databricks.
name	Optional. A string representing the name of the job. If multiple jobs share the same name, you'll need to rename the jobs or provide the unique job ID.
workspace	A string representing the web workspace of your Databricks instance. E.g., "https://eastus2.azuredatabricks.net" or "https://demo.cloud.databricks.com".
token	A valid authentication token generated via User Settings in Databricks or via the Databricks REST API 2.0. If none is provided, netrc will be used.
verbose	If true, will pretty print the success or failure of the request and add a 'job_id' variable to the R environment. Defaults to TRUE.

Details

The job is guaranteed to be removed upon completion of this request. However, runs that were active before the receipt of this request may still be active. They will be terminated asynchronously. The API endpoint for deleting a job is '2.0/jobs/delete'. For all details on API calls please see the official documentation at https://docs.databricks.com/dev-tools/api/latest/.

Value

The API response.

Examples

delete_job(job_id = 206,
workspace = "https://dbc-z64b06b4-d212.cloud.databricks.com",
token = "dapi310240980a9dgqwebdsfadsf21")

RafiKurlansik/bricksteR documentation built on Oct. 13, 2022, 6:58 a.m.