databricks::Jobs Class Reference

Client for interacting with the Databricks Jobs API. More...

#include <jobs.h>

Public Member Functions
	Jobs (const AuthConfig &auth)
	Construct a Jobs API client.
	Jobs (std::shared_ptr< internal::IHttpClient > http_client)
	Construct a Jobs API client with dependency injection (for testing)
	~Jobs ()
	Destructor.
	Jobs (const Jobs &)=delete
Jobs &	operator= (const Jobs &)=delete
std::vector< Job >	list_jobs (int limit=25, int offset=0)
	List jobs in the workspace with pagination.
Job	get_job (uint64_t job_id)
	Get detailed information about a specific job.
uint64_t	run_now (uint64_t job_id, const std::map< std::string, std::string > &notebook_params={})
	Trigger an immediate run of a job.

Detailed Description

Client for interacting with the Databricks Jobs API.

The Jobs API allows you to create, manage, and trigger jobs in your Databricks workspace. This implementation uses Jobs API 2.2 for full feature support including pagination.

Example usage:

databricks::AuthConfig auth = databricks::AuthConfig::from_environment();
databricks::Jobs jobs(auth);
 
// List all jobs
auto job_list = jobs.list_jobs(25, 0);
 
// Get specific job details
auto job = jobs.get_job(123456789);
 
// Trigger a job run
std::map<std::string, std::string> params = {{"key", "value"}};
uint64_t run_id = jobs.run_now(123456789, params);

Definition at line 40 of file jobs.h.

Constructor & Destructor Documentation

Jobs() [1/3]

databricks::Jobs::Jobs ( const AuthConfig &  auth )

explicit

Construct a Jobs API client.

Parameters

auth	Authentication configuration with host and token

Jobs() [2/3]

databricks::Jobs::Jobs ( std::shared_ptr< internal::IHttpClient >  http_client )

explicit

Construct a Jobs API client with dependency injection (for testing)

Parameters

http_client

Injected HTTP client (use MockHttpClient for unit tests)

Note

This constructor is primarily for testing with mock HTTP clients

~Jobs()

databricks::Jobs::~Jobs

(

)

Destructor.

Jobs() [3/3]

databricks::Jobs::Jobs ( const Jobs &  )

delete

Member Function Documentation

get_job()

Job databricks::Jobs::get_job

(

uint64_t

job_id

)

Get detailed information about a specific job.

Parameters

job_id

The unique identifier of the job

Returns

Job object with full details

Exceptions

std::runtime_error

if the job is not found or the API request fails

list_jobs()

std::vector< Job > databricks::Jobs::list_jobs	(	int	limit = 25,
		int	offset = 0
	)

List jobs in the workspace with pagination.

Parameters

limit	Maximum number of jobs to return (default: 25, max: 100)
offset	Number of jobs to skip for pagination (default: 0)

Returns

Vector of Job objects

Exceptions

std::runtime_error

if the API request fails

Note

Uses Jobs API 2.2 for pagination support

operator=()

Jobs & databricks::Jobs::operator= ( const Jobs &  )

delete

run_now()

uint64_t databricks::Jobs::run_now	(	uint64_t	job_id,
		const std::map< std::string, std::string > &	notebook_params = {}
	)

Trigger an immediate run of a job.

Parameters

job_id	The unique identifier of the job to run
notebook_params	Optional parameters to pass to the notebook (for notebook jobs)

Returns

The run_id of the triggered job run

Exceptions

std::runtime_error

if the API request fails

Note

This method returns immediately after triggering the job. Use the run_id to poll for status or wait for completion.

---

The documentation for this class was generated from the following file:

• include/databricks/jobs/jobs.h