@databricks/sdk-jobs 0.1.0-dev.4 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/dist/v2/client.d.ts +36 -13
- package/dist/v2/client.d.ts.map +1 -1
- package/dist/v2/client.js +141 -101
- package/dist/v2/client.js.map +1 -1
- package/dist/v2/index.d.ts +1 -1
- package/dist/v2/index.d.ts.map +1 -1
- package/dist/v2/model.d.ts +1 -219
- package/dist/v2/model.d.ts.map +1 -1
- package/dist/v2/model.js.map +1 -1
- package/dist/v2/transport.d.ts +30 -2
- package/dist/v2/transport.d.ts.map +1 -1
- package/dist/v2/transport.js +33 -16
- package/dist/v2/transport.js.map +1 -1
- package/package.json +9 -4
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @databricks/sdk-jobs
|
|
2
|
+
|
|
3
|
+
> [!NOTE]
|
|
4
|
+
>
|
|
5
|
+
> ## Beta
|
|
6
|
+
>
|
|
7
|
+
> **This SDK is in Beta and is supported for production use cases.** Interfaces might still change slightly before GA (e.g. name standardization and minor ergonomic tweaks). We are keen to hear feedback from early adopters — please [file issues](https://github.com/databricks/sdk-js/issues), and we will address them.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @databricks/sdk-jobs
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {JobsClient} from '@databricks/sdk-jobs/v2';
|
|
19
|
+
|
|
20
|
+
const client = new JobsClient({});
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
For a full getting-started guide, see the [root README](../../README.md).
|
package/dist/v2/client.d.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import type { CallOptions } from '@databricks/sdk-options/call';
|
|
2
2
|
import type { ClientOptions } from '@databricks/sdk-options/client';
|
|
3
3
|
import type { LroOptions } from '@databricks/sdk-options/lro';
|
|
4
|
-
import type { BaseJob, BaseRun, CancelAllRunsRequest, CancelAllRunsResponse, CancelRunRequest, CreateJobRequest, CreateJobResponse, DeleteJobRequest, DeleteJobResponse, DeleteRunRequest, DeleteRunResponse, EnforcePolicyComplianceForJob, EnforcePolicyComplianceResponse, ExportRunRequest, ExportRunResponse, GetJobRequest, GetJobResponse,
|
|
4
|
+
import type { BaseJob, BaseRun, CancelAllRunsRequest, CancelAllRunsResponse, CancelRunRequest, CreateJobRequest, CreateJobResponse, DeleteJobRequest, DeleteJobResponse, DeleteRunRequest, DeleteRunResponse, EnforcePolicyComplianceForJob, EnforcePolicyComplianceResponse, ExportRunRequest, ExportRunResponse, GetJobRequest, GetJobResponse, GetPolicyComplianceForJobRequest, GetPolicyComplianceForJobResponse, GetRunOutputRequest, GetRunOutputResponse, GetRunRequest, GetRunResponse, ListJobComplianceForPolicy, ListJobComplianceForPolicy_JobCompliance, ListJobComplianceResponse, ListJobsRequest, ListJobsResponse, ListRunsRequest, ListRunsResponse, RepairRunRequest, ResetJobRequest, ResetJobResponse, RunNowRequest, SubmitRunRequest, UpdateJobRequest, UpdateJobResponse } from './model';
|
|
5
5
|
export declare class JobsClient {
|
|
6
|
-
private readonly
|
|
7
|
-
private readonly workspaceId;
|
|
8
|
-
private readonly httpClient;
|
|
6
|
+
private readonly options;
|
|
9
7
|
private readonly logger;
|
|
10
8
|
private readonly userAgent;
|
|
9
|
+
private config;
|
|
11
10
|
constructor(options: ClientOptions);
|
|
11
|
+
private resolveConfig;
|
|
12
12
|
/**
|
|
13
13
|
* Updates a job so the job clusters that are created when running
|
|
14
14
|
* the job (specified in `new_cluster`) are compliant with the
|
|
@@ -22,7 +22,7 @@ export declare class JobsClient {
|
|
|
22
22
|
* last edited and some of its job clusters no longer comply with
|
|
23
23
|
* their updated policies.
|
|
24
24
|
*/
|
|
25
|
-
getPolicyComplianceForJob(req:
|
|
25
|
+
getPolicyComplianceForJob(req: GetPolicyComplianceForJobRequest, options?: CallOptions): Promise<GetPolicyComplianceForJobResponse>;
|
|
26
26
|
/**
|
|
27
27
|
* Returns the policy compliance status of all jobs that use a
|
|
28
28
|
* given policy. Jobs could be out of compliance if a cluster policy they
|
|
@@ -40,8 +40,12 @@ export declare class JobsClient {
|
|
|
40
40
|
* Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when
|
|
41
41
|
* this request completes.
|
|
42
42
|
*/
|
|
43
|
-
private
|
|
44
|
-
|
|
43
|
+
private cancelRunBase;
|
|
44
|
+
/**
|
|
45
|
+
* Cancels a job run or a task run. The run is canceled asynchronously, so it may still be running when
|
|
46
|
+
* this request completes.
|
|
47
|
+
*/
|
|
48
|
+
cancelRun(req: CancelRunRequest, options?: CallOptions): Promise<CancelRunWaiter>;
|
|
45
49
|
/** Create a new job. */
|
|
46
50
|
createJob(req: CreateJobRequest, options?: CallOptions): Promise<CreateJobResponse>;
|
|
47
51
|
/** Deletes a job. */
|
|
@@ -91,13 +95,33 @@ export declare class JobsClient {
|
|
|
91
95
|
* They use the current job and task settings, and can be viewed in the history for the
|
|
92
96
|
* original job run.
|
|
93
97
|
*/
|
|
94
|
-
private
|
|
95
|
-
|
|
98
|
+
private repairBase;
|
|
99
|
+
/**
|
|
100
|
+
* Re-run one or more tasks. Tasks are re-run as part of the original job run.
|
|
101
|
+
* They use the current job and task settings, and can be viewed in the history for the
|
|
102
|
+
* original job run.
|
|
103
|
+
*/
|
|
104
|
+
repair(req: RepairRunRequest, options?: CallOptions): Promise<RepairWaiter>;
|
|
96
105
|
/** Overwrite all settings for the given job. Use the [_Update_ endpoint](:method:jobs/update) to update job settings partially. */
|
|
97
106
|
resetJob(req: ResetJobRequest, options?: CallOptions): Promise<ResetJobResponse>;
|
|
98
107
|
/** Run a job and return the `run_id` of the triggered run. */
|
|
99
|
-
private
|
|
100
|
-
|
|
108
|
+
private runNowBase;
|
|
109
|
+
/** Run a job and return the `run_id` of the triggered run. */
|
|
110
|
+
runNow(req: RunNowRequest, options?: CallOptions): Promise<RunNowWaiter>;
|
|
111
|
+
/**
|
|
112
|
+
* Submit a one-time run. This endpoint allows you to submit a workload directly
|
|
113
|
+
* without creating a job. Runs submitted using this endpoint don’t display in
|
|
114
|
+
* the UI. Use the `jobs/runs/get` API to check the run state after the job is
|
|
115
|
+
* submitted.
|
|
116
|
+
*
|
|
117
|
+
* **Important:** Jobs submitted using this endpoint are not saved as a job.
|
|
118
|
+
* They do not show up in the Jobs UI, and do not retry when they fail. Because
|
|
119
|
+
* they are not saved, <Databricks> cannot auto-optimize serverless compute in case
|
|
120
|
+
* of failure. If your job fails, you may want to use classic compute to specify
|
|
121
|
+
* the compute needs for the job. Alternatively, use the `POST /jobs/create` and
|
|
122
|
+
* `POST /jobs/run-now` endpoints to create and run a saved job.
|
|
123
|
+
*/
|
|
124
|
+
private submitRunBase;
|
|
101
125
|
/**
|
|
102
126
|
* Submit a one-time run. This endpoint allows you to submit a workload directly
|
|
103
127
|
* without creating a job. Runs submitted using this endpoint don’t display in
|
|
@@ -111,8 +135,7 @@ export declare class JobsClient {
|
|
|
111
135
|
* the compute needs for the job. Alternatively, use the `POST /jobs/create` and
|
|
112
136
|
* `POST /jobs/run-now` endpoints to create and run a saved job.
|
|
113
137
|
*/
|
|
114
|
-
|
|
115
|
-
submitRunWaiter(req: SubmitRunRequest, options?: CallOptions): Promise<SubmitRunWaiter>;
|
|
138
|
+
submitRun(req: SubmitRunRequest, options?: CallOptions): Promise<SubmitRunWaiter>;
|
|
116
139
|
/** Add, update, or remove specific settings of an existing job. Use the [_Reset_ endpoint](:method:jobs/reset) to overwrite all job settings. */
|
|
117
140
|
updateJob(req: UpdateJobRequest, options?: CallOptions): Promise<UpdateJobResponse>;
|
|
118
141
|
}
|
package/dist/v2/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v2/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAa5D,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAEhB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,6BAA6B,EAC7B,+BAA+B,EAC/B,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v2/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAa5D,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAEhB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,6BAA6B,EAC7B,+BAA+B,EAC/B,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,cAAc,EACd,gCAAgC,EAChC,iCAAiC,EACjC,mBAAmB,EACnB,oBAAoB,EACpB,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,wCAAwC,EACxC,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAEhB,eAAe,EACf,gBAAgB,EAChB,aAAa,EAEb,gBAAgB,EAEhB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAyCjB,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAInC,OAAO,CAAC,MAAM,CAA4C;gBAE9C,OAAO,EAAE,aAAa;IAUlC,OAAO,CAAC,aAAa;IAKrB;;;;;OAKG;IACG,6BAA6B,CACjC,GAAG,EAAE,6BAA6B,EAClC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,+BAA+B,CAAC;IAgC3C;;;;;OAKG;IACG,yBAAyB,CAC7B,GAAG,EAAE,gCAAgC,EACrC,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iCAAiC,CAAC;IAkC7C;;;;;OAKG;IACG,0BAA0B,CAC9B,GAAG,EAAE,0BAA0B,EAC/B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,yBAAyB,CAAC;IAqC9B,8BAA8B,CACnC,GAAG,EAAE,0BAA0B,EAC/B,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,wCAAwC,CAAC;IAc3D;;;OAGG;IACG,aAAa,CACjB,GAAG,EAAE,oBAAoB,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC;IA0BjC;;;OAGG;YACW,aAAa;IA6B3B;;;OAGG;IACG,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,eAAe,CAAC;IAQ3B,wBAAwB;IAClB,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IA0B7B,qBAAqB;IACf,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IA0B7B,uEAAuE;IACjE,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IA0B7B,4CAA4C;IACtC,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;IAkC7B;;;;;;;OAOG;IACG,MAAM,CACV,GAAG,EAAE,aAAa,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,cAAc,CAAC;IAqC1B;;;;;;;OAOG;IACG,MAAM,CACV,GAAG,EAAE,aAAa,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,cAAc,CAAC;IA2C1B;;;;;;;;;;OAUG;IACG,YAAY,CAChB,GAAG,EAAE,mBAAmB,EACxB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC;IA+BhC,gCAAgC;IAC1B,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC;IA2CrB,YAAY,CACjB,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,OAAO,CAAC;IAc1B,mDAAmD;IAC7C,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC;IA6DrB,YAAY,CACjB,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,cAAc,CAAC,OAAO,CAAC;IAc1B;;;;OAIG;YACW,UAAU;IA6BxB;;;;OAIG;IACG,MAAM,CACV,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,YAAY,CAAC;IAQxB,mIAAmI;IAC7H,QAAQ,CACZ,GAAG,EAAE,eAAe,EACpB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC;IA0B5B,8DAA8D;YAChD,UAAU;IA6BxB,8DAA8D;IACxD,MAAM,CACV,GAAG,EAAE,aAAa,EAClB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,YAAY,CAAC;IAQxB;;;;;;;;;;;;OAYG;YACW,aAAa;IA6B3B;;;;;;;;;;;;OAYG;IACG,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,eAAe,CAAC;IAQ3B,iJAAiJ;IAC3I,SAAS,CACb,GAAG,EAAE,gBAAgB,EACrB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,iBAAiB,CAAC;CAyB9B;AAED,qBAAa,eAAe;IAExB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM;gBADL,MAAM,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAM;IAGxB;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IAqCzD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD;AAED,qBAAa,YAAY;IAErB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM;gBADL,MAAM,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAM;IAGxB;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IAqCzD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD;AAED,qBAAa,YAAY;IAErB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM;gBADL,MAAM,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAM;IAGxB;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IAqCzD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD;AAED,qBAAa,eAAe;IAExB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM;gBADL,MAAM,EAAE,UAAU,EAC1B,KAAK,EAAE,MAAM;IAGxB;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC;IAqCzD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD"}
|