@Generated public interface JobsService
You can use a Databricks job to run a data processing or data analysis task in a Databricks cluster with scalable resources. Your job can consist of a single task or can be a large, multi-task workflow with complex dependencies. Databricks manages the task orchestration, cluster management, monitoring, and error reporting for all of your jobs. You can run your jobs immediately or periodically through an easy-to-use scheduling system. You can implement job tasks using notebooks, JARS, Delta Live Tables pipelines, or Python, Scala, Spark submit, and Java applications.
You should never hard code secrets or store them in plain text. Use the [Secrets CLI] to manage secrets in the [Databricks CLI]. Use the [Secrets utility] to reference secrets in notebooks and jobs.
[Databricks CLI]: https://docs.databricks.com/dev-tools/cli/index.html [Secrets CLI]: https://docs.databricks.com/dev-tools/cli/secrets-cli.html [Secrets utility]: https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-secrets
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
Modifier and Type | Method and Description |
---|---|
void |
cancelAllRuns(CancelAllRuns cancelAllRuns)
Cancel all runs of a job.
|
void |
cancelRun(CancelRun cancelRun)
Cancel a run.
|
CreateResponse |
create(CreateJob createJob)
Create a new job.
|
void |
delete(DeleteJob deleteJob)
Delete a job.
|
void |
deleteRun(DeleteRun deleteRun)
Delete a job run.
|
ExportRunOutput |
exportRun(ExportRunRequest exportRunRequest)
Export and retrieve a job run.
|
Job |
get(GetJobRequest getJobRequest)
Get a single job.
|
GetJobPermissionLevelsResponse |
getPermissionLevels(GetJobPermissionLevelsRequest getJobPermissionLevelsRequest)
Get job permission levels.
|
JobPermissions |
getPermissions(GetJobPermissionsRequest getJobPermissionsRequest)
Get job permissions.
|
Run |
getRun(GetRunRequest getRunRequest)
Get a single job run.
|
RunOutput |
getRunOutput(GetRunOutputRequest getRunOutputRequest)
Get the output for a single run.
|
ListJobsResponse |
list(ListJobsRequest listJobsRequest)
List jobs.
|
ListRunsResponse |
listRuns(ListRunsRequest listRunsRequest)
List job runs.
|
RepairRunResponse |
repairRun(RepairRun repairRun)
Repair a job run.
|
void |
reset(ResetJob resetJob)
Update all job settings (reset).
|
RunNowResponse |
runNow(RunNow runNow)
Trigger a new job run.
|
JobPermissions |
setPermissions(JobPermissionsRequest jobPermissionsRequest)
Set job permissions.
|
SubmitRunResponse |
submit(SubmitRun submitRun)
Create and trigger a one-time run.
|
void |
update(UpdateJob updateJob)
Update job settings partially.
|
JobPermissions |
updatePermissions(JobPermissionsRequest jobPermissionsRequest)
Update job permissions.
|
void cancelAllRuns(CancelAllRuns cancelAllRuns)
Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't prevent new runs from being started.
void cancelRun(CancelRun cancelRun)
Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when this request completes.
CreateResponse create(CreateJob createJob)
Create a new job.
void delete(DeleteJob deleteJob)
Deletes a job.
void deleteRun(DeleteRun deleteRun)
Deletes a non-active run. Returns an error if the run is active.
ExportRunOutput exportRun(ExportRunRequest exportRunRequest)
Export and retrieve the job run task.
Job get(GetJobRequest getJobRequest)
Retrieves the details for a single job.
GetJobPermissionLevelsResponse getPermissionLevels(GetJobPermissionLevelsRequest getJobPermissionLevelsRequest)
Gets the permission levels that a user can have on an object.
JobPermissions getPermissions(GetJobPermissionsRequest getJobPermissionsRequest)
Gets the permissions of a job. Jobs can inherit permissions from their root object.
Run getRun(GetRunRequest getRunRequest)
Retrieve the metadata of a run.
RunOutput getRunOutput(GetRunOutputRequest getRunOutputRequest)
Retrieve the output and metadata of a single task run. When a notebook task returns a value through the `dbutils.notebook.exit()` call, you can use this endpoint to retrieve that value. Databricks restricts this API to returning the first 5 MB of the output. To return a larger result, you can store job results in a cloud storage service.
This endpoint validates that the __run_id__ parameter is valid and returns an HTTP status code 400 if the __run_id__ parameter is invalid. Runs are automatically removed after 60 days. If you to want to reference them beyond 60 days, you must save old run results before they expire.
ListJobsResponse list(ListJobsRequest listJobsRequest)
Retrieves a list of jobs.
ListRunsResponse listRuns(ListRunsRequest listRunsRequest)
List runs in descending order by start time.
RepairRunResponse repairRun(RepairRun repairRun)
Re-run one or more tasks. Tasks are re-run as part of the original job run. They use the current job and task settings, and can be viewed in the history for the original job run.
void reset(ResetJob resetJob)
Overwrite all settings for the given job. Use the [_Update_ endpoint](:method:jobs/update) to update job settings partially.
RunNowResponse runNow(RunNow runNow)
Run a job and return the `run_id` of the triggered run.
JobPermissions setPermissions(JobPermissionsRequest jobPermissionsRequest)
Sets permissions on a job. Jobs can inherit permissions from their root object.
SubmitRunResponse submit(SubmitRun submitRun)
Submit a one-time run. This endpoint allows you to submit a workload directly without creating a job. Runs submitted using this endpoint don’t display in the UI. Use the `jobs/runs/get` API to check the run state after the job is submitted.
void update(UpdateJob updateJob)
Add, update, or remove specific settings of an existing job. Use the [_Reset_ endpoint](:method:jobs/reset) to overwrite all job settings.
JobPermissions updatePermissions(JobPermissionsRequest jobPermissionsRequest)
Updates the permissions on a job. Jobs can inherit permissions from their root object.
Copyright © 2024. All rights reserved.