JobServiceImplV21 (com.edmunds:databricks-rest-client 3.3.3 API)

java.lang.Object
- com.edmunds.rest.databricks.service.DatabricksService
- - com.edmunds.rest.databricks.service.JobServiceImplV21

All Implemented Interfaces:: JobServiceV21

public class JobServiceImplV21
extends DatabricksService
implements JobServiceV21

The implementation of JobService.

Field Summary
- Fields inherited from class com.edmunds.rest.databricks.service.DatabricksService
  client, mapper

Constructor Summary

Constructors
Constructor and Description

JobServiceImplV21(DatabricksRestClient client)

Constructors
Constructor and Description
`JobServiceImplV21(DatabricksRestClient client)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildRunJobRestUrl(long jobId, long numberInJob)` Formatting databricks job rest url.
`void`	`cancelRun(long runId)` Cancels a run.
`long`	`createJob(JobSettingsDTOv21 jobSettingsDTO)` Creates job from settings DTO.
`void`	`deleteJob(long jobId)` Deletes the job and sends an email to the addresses specified in email_notifications.
`void`	`deleteJob(String jobName)` Deletes a job with a given name.
`JobDTOv21`	`getJob(long jobId)` Retrieves information about a single job.
`JobDTOv21`	`getJobByName(String jobName)` Will try and get a job by name.
`JobDTOv21`	`getJobByName(String jobName, boolean failOnMultipleJobs)` Will try and get a job by name.
`String`	`getJobLink(long jobId)` Produces the URL of a job given job id.
`List<JobDTOv21>`	`getJobsByName(String jobName)` Retrieves all jobs matching a name exactly.
`List<JobDTOv21>`	`getJobsByRegex(Pattern regex)` Retrieves all jobs with a name matching a given regex.
`String`	`getOutput(long runId)` Retrieve the output of a run.
`RunDTO`	`getRun(long runId)` Retrieves the metadata of a run.
`List<JobDTOv21>`	`listAllJobs()` Returns a list of all jobs that are active.
`JobsDTOv21`	`listJobs(int limit, int offset, boolean expandTasks)` Retrieves a list of jobs.
`RunsDTO`	`listRuns(Long jobId, Boolean activeOnly, Integer offset, Integer limit)` Lists runs from most recently started to least.
`void`	`reset(long jobId, JobSettingsDTOv21 jobSettings)` "resets" or "edits" a job definition.
`RunNowDTO`	`runJobNow(long jobId)` Runs the job now.
`RunNowDTO`	`runJobNow(long jobId, Map<String,String> notebookParams)` Runs the job now.
`RunNowDTO`	`runJobNow(long jobId, RunParametersDTOv21 params)` Runs the job now.
`RunNowDTO`	`runSubmit(RunSubmitDTO runSettings)` Submit a one-time run.
`void`	`upsertJob(JobSettingsDTOv21 jobSettingsDTO, boolean failOnDuplicateJobNames)` Given a job settings DTO object it will: - try to find the id by name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JobServiceImplV21
```
public JobServiceImplV21(DatabricksRestClient client)
```
- Method Detail
  - createJob
```
public long createJob(JobSettingsDTOv21 jobSettingsDTO)
               throws IOException,
                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Creates job from settings DTO.
    
    Specified by:
    
    createJob in interface JobServiceV21
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#create
  - deleteJob
```
public void deleteJob(long jobId)
               throws IOException,
                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Deletes the job and sends an email to the addresses specified in email_notifications.
    
    Specified by:
    
    deleteJob in interface JobServiceV21
    
    Parameters:
    
    jobId - The canonical identifier of the job to delete
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#delete
  - deleteJob
```
public void deleteJob(String jobName)
               throws IOException,
                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Deletes a job with a given name. Will fail if multiple jobs exist.
    
    Specified by:
    
    deleteJob in interface JobServiceV21
    
    Parameters:
    
    jobName - - the job name to delete.
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#delete
  - getJob
```
public JobDTOv21 getJob(long jobId)
                 throws IOException,
                        DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Retrieves information about a single job.
    
    Specified by:
    
    getJob in interface JobServiceV21
    
    Parameters:
    
    jobId - The canonical identifier of the job to retrieve information about
    
    Returns:
    
    POJO of the Job information
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#get
  - getJobsByName
```
public List<JobDTOv21> getJobsByName(String jobName)
                              throws IOException,
                                     DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Retrieves all jobs matching a name exactly.
    
    Specified by:
    
    getJobsByName in interface JobServiceV21
    
    Parameters:
    
    jobName - - the full name of the job
    
    Returns:
    
    - all jobs that match.
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#list
  - getJobByName
```
public JobDTOv21 getJobByName(String jobName)
                       throws IOException,
                              DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Will try and get a job by name. If more then one job exists, it will fail. If no job exists it will return null. Uses a list behind the scenes, so is O(n) with number of jobs.
    
    Specified by:
    
    getJobByName in interface JobServiceV21
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#list
  - getJobByName
```
public JobDTOv21 getJobByName(String jobName,
                              boolean failOnMultipleJobs)
                       throws IOException,
                              DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Will try and get a job by name. If more then one job exists and failOnMultipleJobs set to false, it will return the first job created. Uses a list behind the scenes, so is O(n) with number of jobs.
    
    Specified by:
    
    getJobByName in interface JobServiceV21
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#list
  - getJobsByRegex
```
public List<JobDTOv21> getJobsByRegex(Pattern regex)
                               throws IOException,
                                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Retrieves all jobs with a name matching a given regex. Uses a list behind the scenes, so is O(n) with number of jobs.
    
    Specified by:
    
    getJobsByRegex in interface JobServiceV21
    
    Parameters:
    
    regex - - the regex to earch for
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#list
  - listAllJobs
```
public List<JobDTOv21> listAllJobs()
                            throws DatabricksRestException,
                                   IOException
```
    Description copied from interface: JobServiceV21
    
    Returns a list of all jobs that are active.
    
    Specified by:
    
    listAllJobs in interface JobServiceV21
    
    Returns:
    
    A POJO of the Jobs
    
    Throws:
    
    DatabricksRestException
    
    IOException
  - listJobs
```
public JobsDTOv21 listJobs(int limit,
                           int offset,
                           boolean expandTasks)
                    throws DatabricksRestException,
                           IOException
```
    Description copied from interface: JobServiceV21
    
    Retrieves a list of jobs.
    
    Specified by:
    
    listJobs in interface JobServiceV21
    
    Parameters:
    
    limit - The number of jobs to return. This value should be greater than 0 and less than 25.
    
    offset - The offset of the first job to return, relative to the most recently created job.
    
    expandTasks - Whether to include task and cluster details in the response. 1000 * @see https://docs.databricks.com/api/latest/jobs.html#list
    
    Returns:
    
    A POJO of the Jobs
    
    Throws:
    
    DatabricksRestException
    
    IOException
  - getJobLink
```
public String getJobLink(long jobId)
```
    Description copied from interface: JobServiceV21
    
    Produces the URL of a job given job id.
    
    Specified by:
    
    getJobLink in interface JobServiceV21
    
    Parameters:
    
    jobId - The canonical identifier of the job to retrieve information about
    
    Returns:
    
    URL of the job
  - runJobNow
```
public RunNowDTO runJobNow(long jobId)
                    throws DatabricksRestException,
                           IOException
```
    Description copied from interface: JobServiceV21
    
    Runs the job now.
    
    Specified by:
    
    runJobNow in interface JobServiceV21
    
    Parameters:
    
    jobId - The job to run
    
    Returns:
    
    Returns the run_id and number_in_run of the triggered run
    
    Throws:
    
    DatabricksRestException
    
    IOException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#run-now
  - runJobNow
```
public RunNowDTO runJobNow(long jobId,
                           Map<String,String> notebookParams)
                    throws DatabricksRestException,
                           IOException
```
    Description copied from interface: JobServiceV21
    
    Runs the job now. With specific notebook params.
    
    Specified by:
    
    runJobNow in interface JobServiceV21
    
    Parameters:
    
    jobId - The job to run
    
    notebookParams - A map from keys to values for jobs with notebook task
    
    Returns:
    
    Returns the run_id and number_in_run of the triggered run
    
    Throws:
    
    DatabricksRestException
    
    IOException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#run-now
  - runJobNow
```
public RunNowDTO runJobNow(long jobId,
                           RunParametersDTOv21 params)
                    throws DatabricksRestException,
                           IOException
```
    Description copied from interface: JobServiceV21
    
    Runs the job now. With specific run parameters.
    
    Specified by:
    
    runJobNow in interface JobServiceV21
    
    Parameters:
    
    jobId - the job id to run
    
    params - the run parameters
    
    Returns:
    
    the run now object
    
    Throws:
    
    DatabricksRestException - any db specific exceptions
    
    IOException - any other exceptions
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#run-now
  - listRuns
```
public RunsDTO listRuns(Long jobId,
                        Boolean activeOnly,
                        Integer offset,
                        Integer limit)
                 throws DatabricksRestException,
                        IOException
```
    Description copied from interface: JobServiceV21
    
    Lists runs from most recently started to least.
    
    Specified by:
    
    listRuns in interface JobServiceV21
    
    Parameters:
    
    jobId - The job for which to list runs. If omitted, the Jobs service will list runs from all jobs
    
    activeOnly - If true, lists active runs only; otherwise, lists both active and inactive runs
    
    offset - The offset of the first run to return, relative to the most recent run. The default value is 20
    
    limit - The number of runs to return. This value should be greater than 0 and less than 1000
    
    Returns:
    
    Returns RunsDTO containing an array of runs and a boolean indicating if there are more jobs that haven't been included
    
    Throws:
    
    DatabricksRestException
    
    IOException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#runs-list
  - getRun
```
public RunDTO getRun(long runId)
              throws DatabricksRestException,
                     IOException
```
    Description copied from interface: JobServiceV21
    
    Retrieves the metadata of a run.
    
    Specified by:
    
    getRun in interface JobServiceV21
    
    Parameters:
    
    runId - The canonical identifier of the run for which to retrieve the metadata
    
    Returns:
    
    Returns the metadata of the specified run
    
    Throws:
    
    DatabricksRestException
    
    IOException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#runs-get
  - cancelRun
```
public void cancelRun(long runId)
               throws IOException,
                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Cancels a run. The run is canceled asynchronously, so when this request completes, the run may still be running. The run will be terminated shortly.
    
    Specified by:
    
    cancelRun in interface JobServiceV21
    
    Parameters:
    
    runId - The desired run to cancel
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#runs-cancel
  - reset
```
public void reset(long jobId,
                  JobSettingsDTOv21 jobSettings)
           throws IOException,
                  DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    "resets" or "edits" a job definition.
    
    Specified by:
    
    reset in interface JobServiceV21
    
    Parameters:
    
    jobId - the job to edit
    
    jobSettings - the settings to change the job to
    
    Throws:
    
    IOException - any other errors
    
    DatabricksRestException - any specific db errors
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#reset
  - buildRunJobRestUrl
```
public String buildRunJobRestUrl(long jobId,
                                 long numberInJob)
```
    Description copied from interface: JobServiceV21
    
    Formatting databricks job rest url. ex> https://something.cloud.databricks.com/#job/123/run/123
    
    Specified by:
    
    buildRunJobRestUrl in interface JobServiceV21
  - upsertJob
```
public void upsertJob(JobSettingsDTOv21 jobSettingsDTO,
                      boolean failOnDuplicateJobNames)
               throws IOException,
                      DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Given a job settings DTO object it will: - try to find the id by name. If multiple exist, it will fail if the duplicate job name flag is set. Else it will update all jobs found. - create the job if it doesn't exist - reset the job if it does exist. Uses a combination of If job doesn't exist:
    
    Specified by:
    
    upsertJob in interface JobServiceV21
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#create If job exists:, https://docs.databricks.com/api/latest/jobs.html#reset
  - runSubmit
```
public RunNowDTO runSubmit(RunSubmitDTO runSettings)
                    throws IOException,
                           DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Submit a one-time run. This endpoint doesn’t require a Databricks job to be created
    
    Specified by:
    
    runSubmit in interface JobServiceV21
    
    Parameters:
    
    runSettings - the settings to change the job to
    
    Returns:
    
    Returns the run_id of the triggered run
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#runs-submit
  - getOutput
```
public String getOutput(long runId)
                 throws IOException,
                        DatabricksRestException
```
    Description copied from interface: JobServiceV21
    
    Retrieve the output of a run.
    
    Specified by:
    
    getOutput in interface JobServiceV21
    
    Parameters:
    
    runId - The desired run id
    
    Returns:
    
    Returns the data output of the specified run
    
    Throws:
    
    IOException
    
    DatabricksRestException
    
    See Also:
    
    https://docs.databricks.com/api/latest/jobs.html#runs-get-output

Class JobServiceImplV21

Field Summary

Fields inherited from class com.edmunds.rest.databricks.service.DatabricksService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobServiceImplV21

Method Detail

createJob

deleteJob

deleteJob

getJob

getJobsByName

getJobByName

getJobByName

getJobsByRegex

listAllJobs

listJobs

getJobLink

runJobNow

runJobNow

runJobNow

listRuns

getRun

cancelRun

reset

buildRunJobRestUrl

upsertJob

runSubmit

getOutput