All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.databricks.sdk.service.jobs.JobsService Maven / Gradle / Ivy

There is a newer version: 0.35.0
Show newest version
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.jobs;

import com.databricks.sdk.support.Generated;

/**
 * The Jobs API allows you to create, edit, and delete jobs.
 *
 * 

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. */ @Generated public interface JobsService { /** * Cancel all runs of a job. * *

Cancels all active runs of a job. The runs are canceled asynchronously, so it doesn't * prevent new runs from being started. */ void cancelAllRuns(CancelAllRuns cancelAllRuns); /** * Cancel a run. * *

Cancels a job run or a task run. The run is canceled asynchronously, so it may still be * running when this request completes. */ void cancelRun(CancelRun cancelRun); /** * Create a new job. * *

Create a new job. */ CreateResponse create(CreateJob createJob); /** * Delete a job. * *

Deletes a job. */ void delete(DeleteJob deleteJob); /** * Delete a job run. * *

Deletes a non-active run. Returns an error if the run is active. */ void deleteRun(DeleteRun deleteRun); /** * Export and retrieve a job run. * *

Export and retrieve the job run task. */ ExportRunOutput exportRun(ExportRunRequest exportRunRequest); /** * Get a single job. * *

Retrieves the details for a single job. */ Job get(GetJobRequest getJobRequest); /** * Get job permission levels. * *

Gets the permission levels that a user can have on an object. */ GetJobPermissionLevelsResponse getPermissionLevels( GetJobPermissionLevelsRequest getJobPermissionLevelsRequest); /** * Get job permissions. * *

Gets the permissions of a job. Jobs can inherit permissions from their root object. */ JobPermissions getPermissions(GetJobPermissionsRequest getJobPermissionsRequest); /** * Get a single job run. * *

Retrieve the metadata of a run. */ Run getRun(GetRunRequest getRunRequest); /** * Get the output for a single run. * *

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. */ RunOutput getRunOutput(GetRunOutputRequest getRunOutputRequest); /** * List jobs. * *

Retrieves a list of jobs. */ ListJobsResponse list(ListJobsRequest listJobsRequest); /** * List job runs. * *

List runs in descending order by start time. */ ListRunsResponse listRuns(ListRunsRequest listRunsRequest); /** * Repair a job run. * *

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. */ RepairRunResponse repairRun(RepairRun repairRun); /** * Update all job settings (reset). * *

Overwrite all settings for the given job. Use the [_Update_ endpoint](:method:jobs/update) * to update job settings partially. */ void reset(ResetJob resetJob); /** * Trigger a new job run. * *

Run a job and return the `run_id` of the triggered run. */ RunNowResponse runNow(RunNow runNow); /** * Set job permissions. * *

Sets permissions on a job. Jobs can inherit permissions from their root object. */ JobPermissions setPermissions(JobPermissionsRequest jobPermissionsRequest); /** * Create and trigger a one-time run. * *

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. */ SubmitRunResponse submit(SubmitRun submitRun); /** * Update job settings partially. * *

Add, update, or remove specific settings of an existing job. Use the [_Reset_ * endpoint](:method:jobs/reset) to overwrite all job settings. */ void update(UpdateJob updateJob); /** * Update job permissions. * *

Updates the permissions on a job. Jobs can inherit permissions from their root object. */ JobPermissions updatePermissions(JobPermissionsRequest jobPermissionsRequest); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy