@databricks/sdk-jobs 0.1.0-dev.3 → 0.1.0-dev.4

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.
@@ -1,39 +1,42 @@
1
1
  import { z } from 'zod';
2
- export declare enum AuthenticationMethod {
3
- OAUTH = "OAUTH",
4
- PAT = "PAT"
5
- }
2
+ export declare const AuthenticationMethod: {
3
+ readonly OAUTH: "OAUTH";
4
+ readonly PAT: "PAT";
5
+ };
6
+ export type AuthenticationMethod = (typeof AuthenticationMethod)[keyof typeof AuthenticationMethod] | (string & {});
6
7
  /**
7
8
  * Availability type used for all subsequent nodes past the `first_on_demand` ones.
8
9
  *
9
10
  * Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster.
10
11
  */
11
- export declare enum AwsAvailability {
12
+ export declare const AwsAvailability: {
12
13
  /** Use spot instances. */
13
- SPOT = "SPOT",
14
+ readonly SPOT: "SPOT";
14
15
  /** Use on-demand instances. */
15
- ON_DEMAND = "ON_DEMAND",
16
+ readonly ON_DEMAND: "ON_DEMAND";
16
17
  /**
17
18
  * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
18
19
  * be acquired (e.g., if AWS spot prices are too high).
19
20
  */
20
- SPOT_WITH_FALLBACK = "SPOT_WITH_FALLBACK"
21
- }
21
+ readonly SPOT_WITH_FALLBACK: "SPOT_WITH_FALLBACK";
22
+ };
23
+ export type AwsAvailability = (typeof AwsAvailability)[keyof typeof AwsAvailability] | (string & {});
22
24
  /**
23
25
  * Availability type used for all subsequent nodes past the `first_on_demand` ones.
24
26
  * Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster.
25
27
  */
26
- export declare enum AzureAvailability {
28
+ export declare const AzureAvailability: {
27
29
  /** Use spot instances. */
28
- SPOT_AZURE = "SPOT_AZURE",
30
+ readonly SPOT_AZURE: "SPOT_AZURE";
29
31
  /** Use on-demand instances. */
30
- ON_DEMAND_AZURE = "ON_DEMAND_AZURE",
32
+ readonly ON_DEMAND_AZURE: "ON_DEMAND_AZURE";
31
33
  /**
32
34
  * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
33
35
  * be acquired (e.g., if Azure is out of Quota).
34
36
  */
35
- SPOT_WITH_FALLBACK_AZURE = "SPOT_WITH_FALLBACK_AZURE"
36
- }
37
+ readonly SPOT_WITH_FALLBACK_AZURE: "SPOT_WITH_FALLBACK_AZURE";
38
+ };
39
+ export type AzureAvailability = (typeof AzureAvailability)[keyof typeof AzureAvailability] | (string & {});
37
40
  /**
38
41
  * The kind of compute described by this compute specification.
39
42
  *
@@ -45,21 +48,23 @@ export declare enum AzureAvailability {
45
48
  *
46
49
  * By using the [simple form](https://docs.databricks.com/compute/simple-form.html), your clusters are automatically using `kind = CLASSIC_PREVIEW`.
47
50
  */
48
- export declare enum ComputeKind {
49
- COMPUTE_KIND_UNSPECIFIED = "COMPUTE_KIND_UNSPECIFIED",
50
- CLASSIC_PREVIEW = "CLASSIC_PREVIEW"
51
- }
51
+ export declare const ComputeKind: {
52
+ readonly COMPUTE_KIND_UNSPECIFIED: "COMPUTE_KIND_UNSPECIFIED";
53
+ readonly CLASSIC_PREVIEW: "CLASSIC_PREVIEW";
54
+ };
55
+ export type ComputeKind = (typeof ComputeKind)[keyof typeof ComputeKind] | (string & {});
52
56
  /**
53
57
  * Confidential computing technology for GCP instances.
54
58
  * Aligns with gcloud's --confidential-compute-type flag and the REST API's
55
59
  * confidentialInstanceConfig.confidentialInstanceType field.
56
60
  * See: https://cloud.google.com/confidential-computing/confidential-vm/docs/create-a-confidential-vm-instance
57
61
  */
58
- export declare enum ConfidentialComputeType {
59
- CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED = "CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED",
60
- CONFIDENTIAL_COMPUTE_TYPE_NONE = "CONFIDENTIAL_COMPUTE_TYPE_NONE",
61
- SEV_SNP = "SEV_SNP"
62
- }
62
+ export declare const ConfidentialComputeType: {
63
+ readonly CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED: "CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED";
64
+ readonly CONFIDENTIAL_COMPUTE_TYPE_NONE: "CONFIDENTIAL_COMPUTE_TYPE_NONE";
65
+ readonly SEV_SNP: "SEV_SNP";
66
+ };
67
+ export type ConfidentialComputeType = (typeof ConfidentialComputeType)[keyof typeof ConfidentialComputeType] | (string & {});
63
68
  /**
64
69
  * Data security mode decides what data governance model to use when accessing data
65
70
  * from a cluster.
@@ -81,96 +86,103 @@ export declare enum ConfidentialComputeType {
81
86
  * * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy Passthrough on standard clusters.
82
87
  * * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way that doesn’t have UC nor passthrough enabled.
83
88
  */
84
- export declare enum DataSecurityMode {
89
+ export declare const DataSecurityMode: {
85
90
  /**
86
91
  * No security isolation for multiple users sharing the cluster. Data governance features
87
92
  * are not available in this mode.
88
93
  */
89
- NONE = "NONE",
94
+ readonly NONE: "NONE";
90
95
  /** Legacy alias for `DATA_SECURITY_MODE_DEDICATED`. */
91
- SINGLE_USER = "SINGLE_USER",
96
+ readonly SINGLE_USER: "SINGLE_USER";
92
97
  /** Legacy alias for `DATA_SECURITY_MODE_STANDARD`. */
93
- USER_ISOLATION = "USER_ISOLATION",
98
+ readonly USER_ISOLATION: "USER_ISOLATION";
94
99
  /** This mode is for users migrating from legacy Table ACL clusters. */
95
- LEGACY_TABLE_ACL = "LEGACY_TABLE_ACL",
100
+ readonly LEGACY_TABLE_ACL: "LEGACY_TABLE_ACL";
96
101
  /** This mode is for users migrating from legacy Passthrough on high concurrency clusters. */
97
- LEGACY_PASSTHROUGH = "LEGACY_PASSTHROUGH",
102
+ readonly LEGACY_PASSTHROUGH: "LEGACY_PASSTHROUGH";
98
103
  /** This mode is for users migrating from legacy Passthrough on standard clusters. */
99
- LEGACY_SINGLE_USER = "LEGACY_SINGLE_USER",
104
+ readonly LEGACY_SINGLE_USER: "LEGACY_SINGLE_USER";
100
105
  /** This is mode where single user is enforced but no actual security feature enabled. */
101
- LEGACY_SINGLE_USER_STANDARD = "LEGACY_SINGLE_USER_STANDARD",
106
+ readonly LEGACY_SINGLE_USER_STANDARD: "LEGACY_SINGLE_USER_STANDARD";
102
107
  /**
103
108
  * A secure cluster that can be shared by multiple users. Cluster users are fully isolated
104
109
  * so that they cannot see each other's data and credentials. Most data governance features
105
110
  * are supported in this mode. But programming languages and cluster features might be limited.
106
111
  */
107
- DATA_SECURITY_MODE_STANDARD = "DATA_SECURITY_MODE_STANDARD",
112
+ readonly DATA_SECURITY_MODE_STANDARD: "DATA_SECURITY_MODE_STANDARD";
108
113
  /**
109
114
  * A secure cluster that can only be exclusively used by a single user specified in
110
115
  * `single_user_name`. Most programming languages, cluster features and data governance
111
116
  * features are available in this mode.
112
117
  */
113
- DATA_SECURITY_MODE_DEDICATED = "DATA_SECURITY_MODE_DEDICATED",
118
+ readonly DATA_SECURITY_MODE_DEDICATED: "DATA_SECURITY_MODE_DEDICATED";
114
119
  /**
115
120
  * Databricks will choose `DATA_SECURITY_MODE_STANDARD` or `DATA_SECURITY_MODE_DEDICATED`
116
121
  * depending on the compute configuration.
117
122
  */
118
- DATA_SECURITY_MODE_AUTO = "DATA_SECURITY_MODE_AUTO"
119
- }
123
+ readonly DATA_SECURITY_MODE_AUTO: "DATA_SECURITY_MODE_AUTO";
124
+ };
125
+ export type DataSecurityMode = (typeof DataSecurityMode)[keyof typeof DataSecurityMode] | (string & {});
120
126
  /** Response enumeration from calling the dbt platform API, for inclusion in output */
121
- export declare enum DbtPlatformRunStatus {
122
- DBT_PLATFORM_RUN_STATUS_UNSPECIFIED = "DBT_PLATFORM_RUN_STATUS_UNSPECIFIED",
123
- QUEUED = "QUEUED",
124
- STARTING = "STARTING",
125
- RUNNING = "RUNNING",
126
- SUCCESS = "SUCCESS",
127
- ERROR = "ERROR",
128
- CANCELLED = "CANCELLED"
129
- }
127
+ export declare const DbtPlatformRunStatus: {
128
+ readonly DBT_PLATFORM_RUN_STATUS_UNSPECIFIED: "DBT_PLATFORM_RUN_STATUS_UNSPECIFIED";
129
+ readonly QUEUED: "QUEUED";
130
+ readonly STARTING: "STARTING";
131
+ readonly RUNNING: "RUNNING";
132
+ readonly SUCCESS: "SUCCESS";
133
+ readonly ERROR: "ERROR";
134
+ readonly CANCELLED: "CANCELLED";
135
+ };
136
+ export type DbtPlatformRunStatus = (typeof DbtPlatformRunStatus)[keyof typeof DbtPlatformRunStatus] | (string & {});
130
137
  /**
131
138
  * All EBS volume types that <Databricks> supports.
132
139
  * See https://aws.amazon.com/ebs/details/ for details.
133
140
  */
134
- export declare enum EbsVolumeType {
141
+ export declare const EbsVolumeType: {
135
142
  /** Provision extra storage using AWS gp2 EBS volumes. */
136
- GENERAL_PURPOSE_SSD = "GENERAL_PURPOSE_SSD",
143
+ readonly GENERAL_PURPOSE_SSD: "GENERAL_PURPOSE_SSD";
137
144
  /** Provision extra storage using AWS st1 volumes. */
138
- THROUGHPUT_OPTIMIZED_HDD = "THROUGHPUT_OPTIMIZED_HDD"
139
- }
140
- export declare enum Format {
141
- SINGLE_TASK = "SINGLE_TASK",
142
- MULTI_TASK = "MULTI_TASK"
143
- }
145
+ readonly THROUGHPUT_OPTIMIZED_HDD: "THROUGHPUT_OPTIMIZED_HDD";
146
+ };
147
+ export type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType] | (string & {});
148
+ export declare const Format: {
149
+ readonly SINGLE_TASK: "SINGLE_TASK";
150
+ readonly MULTI_TASK: "MULTI_TASK";
151
+ };
152
+ export type Format = (typeof Format)[keyof typeof Format] | (string & {});
144
153
  /**
145
154
  * This field determines whether the instance pool will contain preemptible
146
155
  * VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
147
156
  */
148
- export declare enum GcpAvailability {
149
- PREEMPTIBLE_GCP = "PREEMPTIBLE_GCP",
150
- ON_DEMAND_GCP = "ON_DEMAND_GCP",
151
- PREEMPTIBLE_WITH_FALLBACK_GCP = "PREEMPTIBLE_WITH_FALLBACK_GCP"
152
- }
157
+ export declare const GcpAvailability: {
158
+ readonly PREEMPTIBLE_GCP: "PREEMPTIBLE_GCP";
159
+ readonly ON_DEMAND_GCP: "ON_DEMAND_GCP";
160
+ readonly PREEMPTIBLE_WITH_FALLBACK_GCP: "PREEMPTIBLE_WITH_FALLBACK_GCP";
161
+ };
162
+ export type GcpAvailability = (typeof GcpAvailability)[keyof typeof GcpAvailability] | (string & {});
153
163
  /**
154
164
  * HardwareAcceleratorType: The type of hardware accelerator to use for compute workloads.
155
165
  * NOTE: This enum is referenced and is intended to be used by other <Databricks> services
156
166
  * that need to specify hardware accelerator requirements for AI compute workloads.
157
167
  */
158
- export declare enum HardwareAcceleratorType {
168
+ export declare const HardwareAcceleratorType: {
159
169
  /** GPU_1xA10: Single A10 GPU configuration. */
160
- GPU_1X_A10 = "GPU_1xA10",
170
+ readonly GPU_1X_A10: "GPU_1xA10";
161
171
  /** GPU_8xH100: 8x H100 GPU configuration. */
162
- GPU_8X_H100 = "GPU_8xH100"
163
- }
172
+ readonly GPU_8X_H100: "GPU_8xH100";
173
+ };
174
+ export type HardwareAcceleratorType = (typeof HardwareAcceleratorType)[keyof typeof HardwareAcceleratorType] | (string & {});
164
175
  /**
165
176
  * Edit mode of the job.
166
177
  *
167
178
  * * `UI_LOCKED`: The job is in a locked UI state and cannot be modified.
168
179
  * * `EDITABLE`: The job is in an editable state and can be modified.
169
180
  */
170
- export declare enum JobEditMode {
171
- UI_LOCKED = "UI_LOCKED",
172
- EDITABLE = "EDITABLE"
173
- }
181
+ export declare const JobEditMode: {
182
+ readonly UI_LOCKED: "UI_LOCKED";
183
+ readonly EDITABLE: "EDITABLE";
184
+ };
185
+ export type JobEditMode = (typeof JobEditMode)[keyof typeof JobEditMode] | (string & {});
174
186
  /**
175
187
  * Specifies the health metric that is being evaluated for a particular health rule.
176
188
  *
@@ -180,51 +192,57 @@ export declare enum JobEditMode {
180
192
  * * `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This metric is in Public Preview.
181
193
  * * `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of outstanding files across all streams. This metric is in Public Preview.
182
194
  */
183
- export declare enum JobsHealthMetric {
184
- RUN_DURATION_SECONDS = "RUN_DURATION_SECONDS",
185
- STREAMING_BACKLOG_BYTES = "STREAMING_BACKLOG_BYTES",
186
- STREAMING_BACKLOG_RECORDS = "STREAMING_BACKLOG_RECORDS",
187
- STREAMING_BACKLOG_SECONDS = "STREAMING_BACKLOG_SECONDS",
188
- STREAMING_BACKLOG_FILES = "STREAMING_BACKLOG_FILES"
189
- }
195
+ export declare const JobsHealthMetric: {
196
+ readonly RUN_DURATION_SECONDS: "RUN_DURATION_SECONDS";
197
+ readonly STREAMING_BACKLOG_BYTES: "STREAMING_BACKLOG_BYTES";
198
+ readonly STREAMING_BACKLOG_RECORDS: "STREAMING_BACKLOG_RECORDS";
199
+ readonly STREAMING_BACKLOG_SECONDS: "STREAMING_BACKLOG_SECONDS";
200
+ readonly STREAMING_BACKLOG_FILES: "STREAMING_BACKLOG_FILES";
201
+ };
202
+ export type JobsHealthMetric = (typeof JobsHealthMetric)[keyof typeof JobsHealthMetric] | (string & {});
190
203
  /** Specifies the operator used to compare the health metric value with the specified threshold. */
191
- export declare enum JobsHealthOperator {
192
- GREATER_THAN = "GREATER_THAN"
193
- }
204
+ export declare const JobsHealthOperator: {
205
+ readonly GREATER_THAN: "GREATER_THAN";
206
+ };
207
+ export type JobsHealthOperator = (typeof JobsHealthOperator)[keyof typeof JobsHealthOperator] | (string & {});
194
208
  /**
195
209
  * The repair history item type. Indicates whether a run is the original run or
196
210
  * a repair run.
197
211
  */
198
- export declare enum RepairType {
199
- ORIGINAL = "ORIGINAL",
200
- REPAIR = "REPAIR"
201
- }
212
+ export declare const RepairType: {
213
+ readonly ORIGINAL: "ORIGINAL";
214
+ readonly REPAIR: "REPAIR";
215
+ };
216
+ export type RepairType = (typeof RepairType)[keyof typeof RepairType] | (string & {});
202
217
  /**
203
218
  * The type of a run.
204
219
  * * `JOB_RUN`: Normal job run. A run created with :method:jobs/runNow.
205
220
  * * `WORKFLOW_RUN`: Workflow run. A run created with [dbutils.notebook.run](/dev-tools/databricks-utils.html#dbutils-workflow).
206
221
  * * `SUBMIT_RUN`: Submit run. A run created with :method:jobs/submit.
207
222
  */
208
- export declare enum RunType {
209
- JOB_RUN = "JOB_RUN",
210
- WORKFLOW_RUN = "WORKFLOW_RUN",
211
- SUBMIT_RUN = "SUBMIT_RUN"
212
- }
213
- export declare enum RuntimeEngine {
223
+ export declare const RunType: {
224
+ readonly JOB_RUN: "JOB_RUN";
225
+ readonly WORKFLOW_RUN: "WORKFLOW_RUN";
226
+ readonly SUBMIT_RUN: "SUBMIT_RUN";
227
+ };
228
+ export type RunType = (typeof RunType)[keyof typeof RunType] | (string & {});
229
+ export declare const RuntimeEngine: {
214
230
  /**
215
231
  * Default value. In this case, ignore the RUNTIME_ENGINE
216
232
  * parameter and do a spark version lookup entirely on the sparkVersion string.
217
233
  */
218
- NULL = "NULL",
234
+ readonly NULL: "NULL";
219
235
  /** Use standard engine */
220
- STANDARD = "STANDARD",
236
+ readonly STANDARD: "STANDARD";
221
237
  /** Use Photon engine */
222
- PHOTON = "PHOTON"
223
- }
224
- export declare enum SchedulePauseStatus {
225
- UNPAUSED = "UNPAUSED",
226
- PAUSED = "PAUSED"
227
- }
238
+ readonly PHOTON: "PHOTON";
239
+ };
240
+ export type RuntimeEngine = (typeof RuntimeEngine)[keyof typeof RuntimeEngine] | (string & {});
241
+ export declare const SchedulePauseStatus: {
242
+ readonly UNPAUSED: "UNPAUSED";
243
+ readonly PAUSED: "PAUSED";
244
+ };
245
+ export type SchedulePauseStatus = (typeof SchedulePauseStatus)[keyof typeof SchedulePauseStatus] | (string & {});
228
246
  /**
229
247
  * Optional location type of the SQL file. When set to `WORKSPACE`, the SQL file will be retrieved\
230
248
  * from the local <Databricks> workspace. When set to `GIT`, the SQL file will be retrieved from a Git repository
@@ -233,15 +251,17 @@ export declare enum SchedulePauseStatus {
233
251
  * * `WORKSPACE`: SQL file is located in <Databricks> workspace.
234
252
  * * `GIT`: SQL file is located in cloud Git provider.
235
253
  */
236
- export declare enum Source {
237
- WORKSPACE = "WORKSPACE",
238
- GIT = "GIT"
239
- }
240
- export declare enum StorageMode {
241
- DIRECT_QUERY = "DIRECT_QUERY",
242
- IMPORT = "IMPORT",
243
- DUAL = "DUAL"
244
- }
254
+ export declare const Source: {
255
+ readonly WORKSPACE: "WORKSPACE";
256
+ readonly GIT: "GIT";
257
+ };
258
+ export type Source = (typeof Source)[keyof typeof Source] | (string & {});
259
+ export declare const StorageMode: {
260
+ readonly DIRECT_QUERY: "DIRECT_QUERY";
261
+ readonly IMPORT: "IMPORT";
262
+ readonly DUAL: "DUAL";
263
+ };
264
+ export type StorageMode = (typeof StorageMode)[keyof typeof StorageMode] | (string & {});
245
265
  /**
246
266
  * An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed. When omitted, defaults to `ALL_SUCCESS`.
247
267
  *
@@ -253,24 +273,26 @@ export declare enum StorageMode {
253
273
  * * `AT_LEAST_ONE_FAILED`: At least one dependency failed
254
274
  * * `ALL_FAILED`: ALl dependencies have failed
255
275
  */
256
- export declare enum TaskDependencyType {
257
- ALL_SUCCESS = "ALL_SUCCESS",
258
- ALL_DONE = "ALL_DONE",
259
- NONE_FAILED = "NONE_FAILED",
260
- AT_LEAST_ONE_SUCCESS = "AT_LEAST_ONE_SUCCESS",
261
- ALL_FAILED = "ALL_FAILED",
262
- AT_LEAST_ONE_FAILED = "AT_LEAST_ONE_FAILED"
263
- }
276
+ export declare const TaskDependencyType: {
277
+ readonly ALL_SUCCESS: "ALL_SUCCESS";
278
+ readonly ALL_DONE: "ALL_DONE";
279
+ readonly NONE_FAILED: "NONE_FAILED";
280
+ readonly AT_LEAST_ONE_SUCCESS: "AT_LEAST_ONE_SUCCESS";
281
+ readonly ALL_FAILED: "ALL_FAILED";
282
+ readonly AT_LEAST_ONE_FAILED: "AT_LEAST_ONE_FAILED";
283
+ };
284
+ export type TaskDependencyType = (typeof TaskDependencyType)[keyof typeof TaskDependencyType] | (string & {});
264
285
  /**
265
286
  * task retry mode of the continuous job
266
287
  * * NEVER: The failed task will not be retried.
267
288
  * * ON_FAILURE: Retry a failed task if at least one other task in the job is still running its first attempt.
268
289
  * When this condition is no longer met or the retry limit is reached, the job run is cancelled and a new run is started.
269
290
  */
270
- export declare enum TaskRetryMode {
271
- NEVER = "NEVER",
272
- ON_FAILURE = "ON_FAILURE"
273
- }
291
+ export declare const TaskRetryMode: {
292
+ readonly NEVER: "NEVER";
293
+ readonly ON_FAILURE: "ON_FAILURE";
294
+ };
295
+ export type TaskRetryMode = (typeof TaskRetryMode)[keyof typeof TaskRetryMode] | (string & {});
274
296
  /**
275
297
  * The type of trigger that fired this run.
276
298
  *
@@ -284,106 +306,115 @@ export declare enum TaskRetryMode {
284
306
  * * `CONTINUOUS_RESTART`: Indicates a run created by user to manually restart a continuous job run.
285
307
  * * `MODEL`: Indicates a run that is triggered by a model update.
286
308
  */
287
- export declare enum TriggerType {
288
- PERIODIC = "PERIODIC",
289
- ONE_TIME = "ONE_TIME",
290
- RETRY = "RETRY",
291
- RUN_JOB_TASK = "RUN_JOB_TASK",
292
- FILE_ARRIVAL = "FILE_ARRIVAL",
293
- CONTINUOUS = "CONTINUOUS",
294
- TABLE = "TABLE",
295
- CONTINUOUS_RESTART = "CONTINUOUS_RESTART"
296
- }
309
+ export declare const TriggerType: {
310
+ readonly PERIODIC: "PERIODIC";
311
+ readonly ONE_TIME: "ONE_TIME";
312
+ readonly RETRY: "RETRY";
313
+ readonly RUN_JOB_TASK: "RUN_JOB_TASK";
314
+ readonly FILE_ARRIVAL: "FILE_ARRIVAL";
315
+ readonly CONTINUOUS: "CONTINUOUS";
316
+ readonly TABLE: "TABLE";
317
+ readonly CONTINUOUS_RESTART: "CONTINUOUS_RESTART";
318
+ };
319
+ export type TriggerType = (typeof TriggerType)[keyof typeof TriggerType] | (string & {});
297
320
  /**
298
321
  * * `NOTEBOOK`: Notebook view item.
299
322
  * * `DASHBOARD`: Dashboard view item.
300
323
  */
301
- export declare enum ViewType {
302
- NOTEBOOK = "NOTEBOOK",
303
- DASHBOARD = "DASHBOARD"
304
- }
324
+ export declare const ViewType: {
325
+ readonly NOTEBOOK: "NOTEBOOK";
326
+ readonly DASHBOARD: "DASHBOARD";
327
+ };
328
+ export type ViewType = (typeof ViewType)[keyof typeof ViewType] | (string & {});
305
329
  /**
306
330
  * * `CODE`: Code view of the notebook.
307
331
  * * `DASHBOARDS`: All dashboard views of the notebook.
308
332
  * * `ALL`: All views of the notebook.
309
333
  */
310
- export declare enum ViewsToExport {
311
- CODE = "CODE",
312
- DASHBOARDS = "DASHBOARDS",
313
- ALL = "ALL"
314
- }
315
- export declare enum AccessControlRequest_JobPermission {
316
- CAN_VIEW = "CAN_VIEW",
317
- CAN_MANAGE_RUN = "CAN_MANAGE_RUN",
318
- IS_OWNER = "IS_OWNER",
319
- CAN_MANAGE = "CAN_MANAGE"
320
- }
334
+ export declare const ViewsToExport: {
335
+ readonly CODE: "CODE";
336
+ readonly DASHBOARDS: "DASHBOARDS";
337
+ readonly ALL: "ALL";
338
+ };
339
+ export type ViewsToExport = (typeof ViewsToExport)[keyof typeof ViewsToExport] | (string & {});
340
+ export declare const AccessControlRequest_JobPermission: {
341
+ readonly CAN_VIEW: "CAN_VIEW";
342
+ readonly CAN_MANAGE_RUN: "CAN_MANAGE_RUN";
343
+ readonly IS_OWNER: "IS_OWNER";
344
+ readonly CAN_MANAGE: "CAN_MANAGE";
345
+ };
346
+ export type AccessControlRequest_JobPermission = (typeof AccessControlRequest_JobPermission)[keyof typeof AccessControlRequest_JobPermission] | (string & {});
321
347
  /** Same alert evaluation state as in redash-v2/api/proto/alertsv2/alerts.proto */
322
- export declare enum AlertEvaluationState_AlertEvaluationState {
323
- ALERT_EVALUATION_STATE_UNSPECIFIED = "ALERT_EVALUATION_STATE_UNSPECIFIED",
324
- UNKNOWN = "UNKNOWN",
325
- TRIGGERED = "TRIGGERED",
326
- OK = "OK",
327
- ERROR = "ERROR"
328
- }
348
+ export declare const AlertEvaluationState_AlertEvaluationState: {
349
+ readonly ALERT_EVALUATION_STATE_UNSPECIFIED: "ALERT_EVALUATION_STATE_UNSPECIFIED";
350
+ readonly UNKNOWN: "UNKNOWN";
351
+ readonly TRIGGERED: "TRIGGERED";
352
+ readonly OK: "OK";
353
+ readonly ERROR: "ERROR";
354
+ };
355
+ export type AlertEvaluationState_AlertEvaluationState = (typeof AlertEvaluationState_AlertEvaluationState)[keyof typeof AlertEvaluationState_AlertEvaluationState] | (string & {});
329
356
  /**
330
357
  * Copied from elastic-spark-common/api/messages/runs.proto.
331
358
  * Using the original definition to remove coupling with jobs API definition
332
359
  */
333
- export declare enum CleanRoomTaskRunLifeCycleState_CleanRoomTaskRunLifeCycleState {
334
- RUN_LIFE_CYCLE_STATE_UNSPECIFIED = "RUN_LIFE_CYCLE_STATE_UNSPECIFIED",
335
- PENDING = "PENDING",
336
- RUNNING = "RUNNING",
337
- TERMINATING = "TERMINATING",
338
- TERMINATED = "TERMINATED",
339
- SKIPPED = "SKIPPED",
340
- INTERNAL_ERROR = "INTERNAL_ERROR",
341
- BLOCKED = "BLOCKED",
342
- WAITING_FOR_RETRY = "WAITING_FOR_RETRY",
343
- QUEUED = "QUEUED"
344
- }
360
+ export declare const CleanRoomTaskRunLifeCycleState_CleanRoomTaskRunLifeCycleState: {
361
+ readonly RUN_LIFE_CYCLE_STATE_UNSPECIFIED: "RUN_LIFE_CYCLE_STATE_UNSPECIFIED";
362
+ readonly PENDING: "PENDING";
363
+ readonly RUNNING: "RUNNING";
364
+ readonly TERMINATING: "TERMINATING";
365
+ readonly TERMINATED: "TERMINATED";
366
+ readonly SKIPPED: "SKIPPED";
367
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
368
+ readonly BLOCKED: "BLOCKED";
369
+ readonly WAITING_FOR_RETRY: "WAITING_FOR_RETRY";
370
+ readonly QUEUED: "QUEUED";
371
+ };
372
+ export type CleanRoomTaskRunLifeCycleState_CleanRoomTaskRunLifeCycleState = (typeof CleanRoomTaskRunLifeCycleState_CleanRoomTaskRunLifeCycleState)[keyof typeof CleanRoomTaskRunLifeCycleState_CleanRoomTaskRunLifeCycleState] | (string & {});
345
373
  /**
346
374
  * Copied from elastic-spark-common/api/messages/runs.proto.
347
375
  * Using the original definition to avoid cyclic dependency.
348
376
  */
349
- export declare enum CleanRoomTaskRunResultState_CleanRoomTaskRunResultState {
350
- RUN_RESULT_STATE_UNSPECIFIED = "RUN_RESULT_STATE_UNSPECIFIED",
351
- SUCCESS = "SUCCESS",
352
- FAILED = "FAILED",
353
- TIMEDOUT = "TIMEDOUT",
354
- CANCELED = "CANCELED",
355
- MAXIMUM_CONCURRENT_RUNS_REACHED = "MAXIMUM_CONCURRENT_RUNS_REACHED",
356
- UPSTREAM_CANCELED = "UPSTREAM_CANCELED",
357
- UPSTREAM_FAILED = "UPSTREAM_FAILED",
358
- EXCLUDED = "EXCLUDED",
359
- EVICTED = "EVICTED",
360
- SUCCESS_WITH_FAILURES = "SUCCESS_WITH_FAILURES",
361
- UPSTREAM_EVICTED = "UPSTREAM_EVICTED",
377
+ export declare const CleanRoomTaskRunResultState_CleanRoomTaskRunResultState: {
378
+ readonly RUN_RESULT_STATE_UNSPECIFIED: "RUN_RESULT_STATE_UNSPECIFIED";
379
+ readonly SUCCESS: "SUCCESS";
380
+ readonly FAILED: "FAILED";
381
+ readonly TIMEDOUT: "TIMEDOUT";
382
+ readonly CANCELED: "CANCELED";
383
+ readonly MAXIMUM_CONCURRENT_RUNS_REACHED: "MAXIMUM_CONCURRENT_RUNS_REACHED";
384
+ readonly UPSTREAM_CANCELED: "UPSTREAM_CANCELED";
385
+ readonly UPSTREAM_FAILED: "UPSTREAM_FAILED";
386
+ readonly EXCLUDED: "EXCLUDED";
387
+ readonly EVICTED: "EVICTED";
388
+ readonly SUCCESS_WITH_FAILURES: "SUCCESS_WITH_FAILURES";
389
+ readonly UPSTREAM_EVICTED: "UPSTREAM_EVICTED";
362
390
  /** 12 is reserved for previously used SUCCESS_WITH_SKIPPED_CELLS */
363
- DISABLED = "DISABLED"
364
- }
391
+ readonly DISABLED: "DISABLED";
392
+ };
393
+ export type CleanRoomTaskRunResultState_CleanRoomTaskRunResultState = (typeof CleanRoomTaskRunResultState_CleanRoomTaskRunResultState)[keyof typeof CleanRoomTaskRunResultState_CleanRoomTaskRunResultState] | (string & {});
365
394
  /**
366
395
  * * `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands. This means that `“12.0” == “12”` will evaluate to `false`.
367
396
  * * `GREATER_THAN`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN`, `LESS_THAN_OR_EQUAL` operators perform numeric comparison of their operands. `“12.0” >= “12”` will evaluate to `true`, `“10.0” >= “12”` will evaluate to `false`.
368
397
  *
369
398
  * The boolean comparison to task values can be implemented with operators `EQUAL_TO`, `NOT_EQUAL`. If a task value was set to a boolean value, it will be serialized to `“true”` or `“false”` for the comparison.
370
399
  */
371
- export declare enum ConditionTask_ConditionTaskOperator {
372
- EQUAL_TO = "EQUAL_TO",
373
- GREATER_THAN = "GREATER_THAN",
374
- GREATER_THAN_OR_EQUAL = "GREATER_THAN_OR_EQUAL",
375
- LESS_THAN = "LESS_THAN",
376
- LESS_THAN_OR_EQUAL = "LESS_THAN_OR_EQUAL",
377
- NOT_EQUAL = "NOT_EQUAL"
378
- }
400
+ export declare const ConditionTask_ConditionTaskOperator: {
401
+ readonly EQUAL_TO: "EQUAL_TO";
402
+ readonly GREATER_THAN: "GREATER_THAN";
403
+ readonly GREATER_THAN_OR_EQUAL: "GREATER_THAN_OR_EQUAL";
404
+ readonly LESS_THAN: "LESS_THAN";
405
+ readonly LESS_THAN_OR_EQUAL: "LESS_THAN_OR_EQUAL";
406
+ readonly NOT_EQUAL: "NOT_EQUAL";
407
+ };
408
+ export type ConditionTask_ConditionTaskOperator = (typeof ConditionTask_ConditionTaskOperator)[keyof typeof ConditionTask_ConditionTaskOperator] | (string & {});
379
409
  /**
380
410
  * * `BUNDLE`: The job is managed by Databricks Asset Bundle.
381
411
  * * `SYSTEM_MANAGED`: The job is managed by <Databricks> and is read-only.
382
412
  */
383
- export declare enum JobDeployment_DeploymentKind {
384
- BUNDLE = "BUNDLE",
385
- SYSTEM_MANAGED = "SYSTEM_MANAGED"
386
- }
413
+ export declare const JobDeployment_DeploymentKind: {
414
+ readonly BUNDLE: "BUNDLE";
415
+ readonly SYSTEM_MANAGED: "SYSTEM_MANAGED";
416
+ };
417
+ export type JobDeployment_DeploymentKind = (typeof JobDeployment_DeploymentKind)[keyof typeof JobDeployment_DeploymentKind] | (string & {});
387
418
  /**
388
419
  * Dirty state indicates the job is not fully synced with the job specification
389
420
  * in the remote repository.
@@ -392,43 +423,48 @@ export declare enum JobDeployment_DeploymentKind {
392
423
  * * `NOT_SYNCED`: The job is not yet synced with the remote job specification. Import the remote job specification from UI to make the job fully synced.
393
424
  * * `DISCONNECTED`: The job is temporary disconnected from the remote job specification and is allowed for live edit. Import the remote job specification again from UI to make the job fully synced.
394
425
  */
395
- export declare enum JobSource_DirtyState {
396
- NOT_SYNCED = "NOT_SYNCED",
397
- DISCONNECTED = "DISCONNECTED"
398
- }
399
- export declare enum ModelTriggerConfiguration_ModelTriggerCondition {
400
- CONDITION_UNSPECIFIED = "CONDITION_UNSPECIFIED",
401
- MODEL_CREATED = "MODEL_CREATED",
402
- MODEL_VERSION_READY = "MODEL_VERSION_READY",
403
- MODEL_ALIAS_SET = "MODEL_ALIAS_SET"
404
- }
426
+ export declare const JobSource_DirtyState: {
427
+ readonly NOT_SYNCED: "NOT_SYNCED";
428
+ readonly DISCONNECTED: "DISCONNECTED";
429
+ };
430
+ export type JobSource_DirtyState = (typeof JobSource_DirtyState)[keyof typeof JobSource_DirtyState] | (string & {});
431
+ export declare const ModelTriggerConfiguration_ModelTriggerCondition: {
432
+ readonly CONDITION_UNSPECIFIED: "CONDITION_UNSPECIFIED";
433
+ readonly MODEL_CREATED: "MODEL_CREATED";
434
+ readonly MODEL_VERSION_READY: "MODEL_VERSION_READY";
435
+ readonly MODEL_ALIAS_SET: "MODEL_ALIAS_SET";
436
+ };
437
+ export type ModelTriggerConfiguration_ModelTriggerCondition = (typeof ModelTriggerConfiguration_ModelTriggerCondition)[keyof typeof ModelTriggerConfiguration_ModelTriggerCondition] | (string & {});
405
438
  /**
406
439
  * PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run on serverless compute should be.
407
440
  * The performance mode on the job or pipeline should map to a performance setting that is passed to Cluster Manager
408
441
  * (see cluster-common PerformanceTarget).
409
442
  */
410
- export declare enum PerformanceTarget_PerformanceTarget {
411
- PERFORMANCE_TARGET_UNSPECIFIED = "PERFORMANCE_TARGET_UNSPECIFIED",
412
- PERFORMANCE_OPTIMIZED = "PERFORMANCE_OPTIMIZED",
413
- STANDARD = "STANDARD"
414
- }
415
- export declare enum PeriodicTriggerConfiguration_TimeUnit {
416
- TIME_UNIT_UNSPECIFIED = "TIME_UNIT_UNSPECIFIED",
417
- HOURS = "HOURS",
418
- DAYS = "DAYS",
419
- WEEKS = "WEEKS"
420
- }
443
+ export declare const PerformanceTarget_PerformanceTarget: {
444
+ readonly PERFORMANCE_TARGET_UNSPECIFIED: "PERFORMANCE_TARGET_UNSPECIFIED";
445
+ readonly PERFORMANCE_OPTIMIZED: "PERFORMANCE_OPTIMIZED";
446
+ readonly STANDARD: "STANDARD";
447
+ };
448
+ export type PerformanceTarget_PerformanceTarget = (typeof PerformanceTarget_PerformanceTarget)[keyof typeof PerformanceTarget_PerformanceTarget] | (string & {});
449
+ export declare const PeriodicTriggerConfiguration_TimeUnit: {
450
+ readonly TIME_UNIT_UNSPECIFIED: "TIME_UNIT_UNSPECIFIED";
451
+ readonly HOURS: "HOURS";
452
+ readonly DAYS: "DAYS";
453
+ readonly WEEKS: "WEEKS";
454
+ };
455
+ export type PeriodicTriggerConfiguration_TimeUnit = (typeof PeriodicTriggerConfiguration_TimeUnit)[keyof typeof PeriodicTriggerConfiguration_TimeUnit] | (string & {});
421
456
  /**
422
457
  * The reason for queuing the run.
423
458
  * * `ACTIVE_RUNS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active task runs.
424
459
  * * `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due to reaching the per-job limit of concurrent job runs.
425
460
  * * `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active run job tasks.
426
461
  */
427
- export declare enum QueueDetailsCode_Code {
428
- ACTIVE_RUNS_LIMIT_REACHED = "ACTIVE_RUNS_LIMIT_REACHED",
429
- MAX_CONCURRENT_RUNS_REACHED = "MAX_CONCURRENT_RUNS_REACHED",
430
- ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED = "ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED"
431
- }
462
+ export declare const QueueDetailsCode_Code: {
463
+ readonly ACTIVE_RUNS_LIMIT_REACHED: "ACTIVE_RUNS_LIMIT_REACHED";
464
+ readonly MAX_CONCURRENT_RUNS_REACHED: "MAX_CONCURRENT_RUNS_REACHED";
465
+ readonly ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED: "ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED";
466
+ };
467
+ export type QueueDetailsCode_Code = (typeof QueueDetailsCode_Code)[keyof typeof QueueDetailsCode_Code] | (string & {});
432
468
  /**
433
469
  * A value indicating the run's lifecycle state. The possible values are:
434
470
  * * `QUEUED`: The run is queued.
@@ -441,31 +477,33 @@ export declare enum QueueDetailsCode_Code {
441
477
  * * `BLOCKED`: The run is blocked on an upstream dependency.
442
478
  * * `WAITING_FOR_RETRY`: The run is waiting for a retry.
443
479
  */
444
- export declare enum RunLifeCycleState_RunLifeCycleState {
445
- PENDING = "PENDING",
446
- RUNNING = "RUNNING",
447
- TERMINATING = "TERMINATING",
448
- TERMINATED = "TERMINATED",
449
- SKIPPED = "SKIPPED",
450
- INTERNAL_ERROR = "INTERNAL_ERROR",
451
- BLOCKED = "BLOCKED",
452
- WAITING_FOR_RETRY = "WAITING_FOR_RETRY",
453
- QUEUED = "QUEUED"
454
- }
480
+ export declare const RunLifeCycleState_RunLifeCycleState: {
481
+ readonly PENDING: "PENDING";
482
+ readonly RUNNING: "RUNNING";
483
+ readonly TERMINATING: "TERMINATING";
484
+ readonly TERMINATED: "TERMINATED";
485
+ readonly SKIPPED: "SKIPPED";
486
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
487
+ readonly BLOCKED: "BLOCKED";
488
+ readonly WAITING_FOR_RETRY: "WAITING_FOR_RETRY";
489
+ readonly QUEUED: "QUEUED";
490
+ };
491
+ export type RunLifeCycleState_RunLifeCycleState = (typeof RunLifeCycleState_RunLifeCycleState)[keyof typeof RunLifeCycleState_RunLifeCycleState] | (string & {});
455
492
  /** The current state of the run. */
456
- export declare enum RunLifecycleStateV2_State {
457
- BLOCKED = "BLOCKED",
458
- PENDING = "PENDING",
459
- QUEUED = "QUEUED",
460
- RUNNING = "RUNNING",
461
- TERMINATING = "TERMINATING",
462
- TERMINATED = "TERMINATED",
493
+ export declare const RunLifecycleStateV2_State: {
494
+ readonly BLOCKED: "BLOCKED";
495
+ readonly PENDING: "PENDING";
496
+ readonly QUEUED: "QUEUED";
497
+ readonly RUNNING: "RUNNING";
498
+ readonly TERMINATING: "TERMINATING";
499
+ readonly TERMINATED: "TERMINATED";
463
500
  /**
464
501
  * Runs in the Waiting state (e.g. cost-optimized runs) are intentionally delayed until an
465
502
  * optimal compute scheduling time
466
503
  */
467
- WAITING = "WAITING"
468
- }
504
+ readonly WAITING: "WAITING";
505
+ };
506
+ export type RunLifecycleStateV2_State = (typeof RunLifecycleStateV2_State)[keyof typeof RunLifecycleStateV2_State] | (string & {});
469
507
  /**
470
508
  * A value indicating the run's result. The possible values are:
471
509
  * * `SUCCESS`: The task completed successfully.
@@ -479,18 +517,19 @@ export declare enum RunLifecycleStateV2_State {
479
517
  * * `UPSTREAM_CANCELED`: The run was skipped because an upstream task was canceled.
480
518
  * * `DISABLED`: The run was skipped because it was disabled explicitly by the user.
481
519
  */
482
- export declare enum RunResultState_RunResultState {
483
- SUCCESS = "SUCCESS",
484
- FAILED = "FAILED",
485
- TIMEDOUT = "TIMEDOUT",
486
- CANCELED = "CANCELED",
487
- MAXIMUM_CONCURRENT_RUNS_REACHED = "MAXIMUM_CONCURRENT_RUNS_REACHED",
488
- UPSTREAM_CANCELED = "UPSTREAM_CANCELED",
489
- UPSTREAM_FAILED = "UPSTREAM_FAILED",
490
- EXCLUDED = "EXCLUDED",
491
- SUCCESS_WITH_FAILURES = "SUCCESS_WITH_FAILURES",
492
- DISABLED = "DISABLED"
493
- }
520
+ export declare const RunResultState_RunResultState: {
521
+ readonly SUCCESS: "SUCCESS";
522
+ readonly FAILED: "FAILED";
523
+ readonly TIMEDOUT: "TIMEDOUT";
524
+ readonly CANCELED: "CANCELED";
525
+ readonly MAXIMUM_CONCURRENT_RUNS_REACHED: "MAXIMUM_CONCURRENT_RUNS_REACHED";
526
+ readonly UPSTREAM_CANCELED: "UPSTREAM_CANCELED";
527
+ readonly UPSTREAM_FAILED: "UPSTREAM_FAILED";
528
+ readonly EXCLUDED: "EXCLUDED";
529
+ readonly SUCCESS_WITH_FAILURES: "SUCCESS_WITH_FAILURES";
530
+ readonly DISABLED: "DISABLED";
531
+ };
532
+ export type RunResultState_RunResultState = (typeof RunResultState_RunResultState)[keyof typeof RunResultState_RunResultState] | (string & {});
494
533
  /**
495
534
  * The state of the SQL alert.
496
535
  *
@@ -498,22 +537,25 @@ export declare enum RunResultState_RunResultState {
498
537
  * * OK: alert evaluated and did not fulfill trigger conditions
499
538
  * * TRIGGERED: alert evaluated and fulfilled trigger conditions
500
539
  */
501
- export declare enum SqlAlertState_SqlAlertState {
502
- UNKNOWN = "UNKNOWN",
503
- OK = "OK",
504
- TRIGGERED = "TRIGGERED"
505
- }
506
- export declare enum SqlTask_SqlTaskQueryStatus {
507
- PENDING = "PENDING",
508
- RUNNING = "RUNNING",
509
- SUCCESS = "SUCCESS",
510
- FAILED = "FAILED",
511
- CANCELLED = "CANCELLED"
512
- }
513
- export declare enum TableTriggerConfiguration_Condition {
514
- ANY_UPDATED = "ANY_UPDATED",
515
- ALL_UPDATED = "ALL_UPDATED"
516
- }
540
+ export declare const SqlAlertState_SqlAlertState: {
541
+ readonly UNKNOWN: "UNKNOWN";
542
+ readonly OK: "OK";
543
+ readonly TRIGGERED: "TRIGGERED";
544
+ };
545
+ export type SqlAlertState_SqlAlertState = (typeof SqlAlertState_SqlAlertState)[keyof typeof SqlAlertState_SqlAlertState] | (string & {});
546
+ export declare const SqlTask_SqlTaskQueryStatus: {
547
+ readonly PENDING: "PENDING";
548
+ readonly RUNNING: "RUNNING";
549
+ readonly SUCCESS: "SUCCESS";
550
+ readonly FAILED: "FAILED";
551
+ readonly CANCELLED: "CANCELLED";
552
+ };
553
+ export type SqlTask_SqlTaskQueryStatus = (typeof SqlTask_SqlTaskQueryStatus)[keyof typeof SqlTask_SqlTaskQueryStatus] | (string & {});
554
+ export declare const TableTriggerConfiguration_Condition: {
555
+ readonly ANY_UPDATED: "ANY_UPDATED";
556
+ readonly ALL_UPDATED: "ALL_UPDATED";
557
+ };
558
+ export type TableTriggerConfiguration_Condition = (typeof TableTriggerConfiguration_Condition)[keyof typeof TableTriggerConfiguration_Condition] | (string & {});
517
559
  /**
518
560
  * The code indicates why the run was terminated. Additional codes might be introduced in future releases.
519
561
  * * `SUCCESS`: The run was completed successfully.
@@ -543,25 +585,25 @@ export declare enum TableTriggerConfiguration_Condition {
543
585
  * * `BREAKING_CHANGE`: Run failed because of an intentional breaking change in Spark, but it will be retried with a mitigation config.
544
586
  * * `CLUSTER_TERMINATED_BY_USER`: The run failed because the externally managed cluster entered an unusable state, likely due to the user terminating or restarting it outside the jobs service.
545
587
  */
546
- export declare enum TerminationCode_Code {
547
- SUCCESS = "SUCCESS",
548
- CANCELED = "CANCELED",
588
+ export declare const TerminationCode_Code: {
589
+ readonly SUCCESS: "SUCCESS";
590
+ readonly CANCELED: "CANCELED";
549
591
  /** DriverError represents failures when the driver restarted, or became unhealthy or unreachable during the run. */
550
- DRIVER_ERROR = "DRIVER_ERROR",
592
+ readonly DRIVER_ERROR: "DRIVER_ERROR";
551
593
  /**
552
594
  * ClusterError represents failures due to cluster issues. These include the failures that occur during
553
595
  * creation of a new cluster / starting up an existing cluster, cluster issues and timeouts during the job run
554
596
  */
555
- CLUSTER_ERROR = "CLUSTER_ERROR",
597
+ readonly CLUSTER_ERROR: "CLUSTER_ERROR";
556
598
  /** Returned if [[ProjectCheckoutInternalRepo]] RPC fails */
557
- REPOSITORY_CHECKOUT_FAILED = "REPOSITORY_CHECKOUT_FAILED",
599
+ readonly REPOSITORY_CHECKOUT_FAILED: "REPOSITORY_CHECKOUT_FAILED";
558
600
  /**
559
601
  * *
560
602
  * InvalidClusterRequest represents failures when the user provides invalid input for a cluster
561
603
  * configuration for the run. For example, providing invalid parameter Values in the request/
562
604
  * providing a bad request etc
563
605
  */
564
- INVALID_CLUSTER_REQUEST = "INVALID_CLUSTER_REQUEST",
606
+ readonly INVALID_CLUSTER_REQUEST: "INVALID_CLUSTER_REQUEST";
565
607
  /**
566
608
  * *
567
609
  * Returned if an org set a limit for number of their concurrent active runs and the run couldn't start
@@ -570,24 +612,24 @@ export declare enum TerminationCode_Code {
570
612
  * It should be looked into how we're handling the scenario where a given job exceeds its own internal concurrency
571
613
  * limits.
572
614
  */
573
- WORKSPACE_RUN_LIMIT_EXCEEDED = "WORKSPACE_RUN_LIMIT_EXCEEDED",
574
- FEATURE_DISABLED = "FEATURE_DISABLED",
615
+ readonly WORKSPACE_RUN_LIMIT_EXCEEDED: "WORKSPACE_RUN_LIMIT_EXCEEDED";
616
+ readonly FEATURE_DISABLED: "FEATURE_DISABLED";
575
617
  /**
576
618
  * *
577
619
  * ClusterRequestLimitExceeded represents failures when cluster
578
620
  * creation, start, and upsize requests for a workspace exceeded the rate limit of
579
621
  * [[com.databricks.backend.cluster.ClusterSizeConf.upsizeRefillRatePerMinPerOrg]] nodes per min.
580
622
  */
581
- CLUSTER_REQUEST_LIMIT_EXCEEDED = "CLUSTER_REQUEST_LIMIT_EXCEEDED",
623
+ readonly CLUSTER_REQUEST_LIMIT_EXCEEDED: "CLUSTER_REQUEST_LIMIT_EXCEEDED";
582
624
  /**
583
625
  * *
584
626
  * StorageAccessError represents failures when the access to user's <Databricks> file system fails.
585
627
  * For example, misconfiguration on user's side like deleting AWS S3 bucket without cancelling the workspace,
586
628
  * their Azure account being disabled, the storage buckets not being found etc.
587
629
  */
588
- STORAGE_ACCESS_ERROR = "STORAGE_ACCESS_ERROR",
589
- RUN_EXECUTION_ERROR = "RUN_EXECUTION_ERROR",
590
- UNAUTHORIZED_ERROR = "UNAUTHORIZED_ERROR",
630
+ readonly STORAGE_ACCESS_ERROR: "STORAGE_ACCESS_ERROR";
631
+ readonly RUN_EXECUTION_ERROR: "RUN_EXECUTION_ERROR";
632
+ readonly UNAUTHORIZED_ERROR: "UNAUTHORIZED_ERROR";
591
633
  /**
592
634
  * *
593
635
  * LibraryInstallationError represents failures due to issues related library installation.
@@ -595,38 +637,40 @@ export declare enum TerminationCode_Code {
595
637
  * enough permissions to install the library or any cloud dependency/ infrastructure failures during
596
638
  * library installation etc
597
639
  */
598
- LIBRARY_INSTALLATION_ERROR = "LIBRARY_INSTALLATION_ERROR",
599
- MAX_CONCURRENT_RUNS_EXCEEDED = "MAX_CONCURRENT_RUNS_EXCEEDED",
600
- MAX_SPARK_CONTEXTS_EXCEEDED = "MAX_SPARK_CONTEXTS_EXCEEDED",
601
- RESOURCE_NOT_FOUND = "RESOURCE_NOT_FOUND",
602
- INVALID_RUN_CONFIGURATION = "INVALID_RUN_CONFIGURATION",
603
- INTERNAL_ERROR = "INTERNAL_ERROR",
604
- CLOUD_FAILURE = "CLOUD_FAILURE",
605
- MAX_JOB_QUEUE_SIZE_EXCEEDED = "MAX_JOB_QUEUE_SIZE_EXCEEDED",
606
- SKIPPED = "SKIPPED",
607
- USER_CANCELED = "USER_CANCELED",
608
- BUDGET_POLICY_LIMIT_EXCEEDED = "BUDGET_POLICY_LIMIT_EXCEEDED",
609
- DISABLED = "DISABLED",
640
+ readonly LIBRARY_INSTALLATION_ERROR: "LIBRARY_INSTALLATION_ERROR";
641
+ readonly MAX_CONCURRENT_RUNS_EXCEEDED: "MAX_CONCURRENT_RUNS_EXCEEDED";
642
+ readonly MAX_SPARK_CONTEXTS_EXCEEDED: "MAX_SPARK_CONTEXTS_EXCEEDED";
643
+ readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
644
+ readonly INVALID_RUN_CONFIGURATION: "INVALID_RUN_CONFIGURATION";
645
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
646
+ readonly CLOUD_FAILURE: "CLOUD_FAILURE";
647
+ readonly MAX_JOB_QUEUE_SIZE_EXCEEDED: "MAX_JOB_QUEUE_SIZE_EXCEEDED";
648
+ readonly SKIPPED: "SKIPPED";
649
+ readonly USER_CANCELED: "USER_CANCELED";
650
+ readonly BUDGET_POLICY_LIMIT_EXCEEDED: "BUDGET_POLICY_LIMIT_EXCEEDED";
651
+ readonly DISABLED: "DISABLED";
610
652
  /**
611
653
  * SuccessWithFailures represents that some child runs failed
612
654
  * but the run was ultimately successful.
613
655
  */
614
- SUCCESS_WITH_FAILURES = "SUCCESS_WITH_FAILURES",
656
+ readonly SUCCESS_WITH_FAILURES: "SUCCESS_WITH_FAILURES";
615
657
  /** Run failed because of an intentional breaking change in Spark, but it will be retried with a mitigation config. */
616
- BREAKING_CHANGE = "BREAKING_CHANGE"
617
- }
658
+ readonly BREAKING_CHANGE: "BREAKING_CHANGE";
659
+ };
660
+ export type TerminationCode_Code = (typeof TerminationCode_Code)[keyof typeof TerminationCode_Code] | (string & {});
618
661
  /**
619
662
  * * `SUCCESS`: The run terminated without any issues
620
663
  * * `INTERNAL_ERROR`: An error occurred in the <Databricks> platform. Please look at the [status page](https://status.databricks.com/) or contact support if the issue persists.
621
664
  * * `CLIENT_ERROR`: The run was terminated because of an error caused by user input or the job configuration.
622
665
  * * `CLOUD_FAILURE`: The run was terminated because of an issue with your cloud provider.
623
666
  */
624
- export declare enum TerminationType_Type {
625
- SUCCESS = "SUCCESS",
626
- INTERNAL_ERROR = "INTERNAL_ERROR",
627
- CLIENT_ERROR = "CLIENT_ERROR",
628
- CLOUD_FAILURE = "CLOUD_FAILURE"
629
- }
667
+ export declare const TerminationType_Type: {
668
+ readonly SUCCESS: "SUCCESS";
669
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
670
+ readonly CLIENT_ERROR: "CLIENT_ERROR";
671
+ readonly CLOUD_FAILURE: "CLOUD_FAILURE";
672
+ };
673
+ export type TerminationType_Type = (typeof TerminationType_Type)[keyof typeof TerminationType_Type] | (string & {});
630
674
  export interface AccessControlRequest {
631
675
  principalName?: {
632
676
  $case: 'userName';
@@ -1768,6 +1812,14 @@ export interface GcsStorageInfo {
1768
1812
  /** GCS destination/URI, e.g. `gs://my-bucket/some-prefix` */
1769
1813
  destination?: string | undefined;
1770
1814
  }
1815
+ /**
1816
+ * DEPRECATED — use `AiRuntimeTask` for all new BYOT multi-node GPU
1817
+ * workloads (see ai_runtime_task.proto). `AiRuntimeTask` is the only
1818
+ * supported BYOT task type for new workloads; this proto is retained only
1819
+ * for AIR CLI (fka SGCLI) pywheel backwards compatibility and will be
1820
+ * removed once the pywheel → databricks-cli migration completes (post-
1821
+ * PuPr).
1822
+ */
1771
1823
  export interface GenAiComputeTask {
1772
1824
  /** Runtime image */
1773
1825
  dlRuntimeImage?: string | undefined;