@databricks/sdk-environments 0.34.0 → 0.36.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.
@@ -1,765 +1,755 @@
1
- import { Temporal } from '@js-temporal/polyfill';
2
- import { FieldMask } from '@databricks/sdk-core/wkt';
3
- import { z } from 'zod';
1
+ import { z } from "zod";
2
+ import { Temporal } from "@js-temporal/polyfill";
3
+ import { FieldMask } from "@databricks/sdk-core/wkt";
4
+
5
+ //#region src/v1/model.d.ts
4
6
  /** If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto */
5
- export declare const BaseEnvironmentType: {
6
- readonly BASE_ENVIRONMENT_TYPE_UNSPECIFIED: "BASE_ENVIRONMENT_TYPE_UNSPECIFIED";
7
- readonly CPU: "CPU";
8
- readonly GPU: "GPU";
7
+ declare const BaseEnvironmentType: {
8
+ readonly BASE_ENVIRONMENT_TYPE_UNSPECIFIED: "BASE_ENVIRONMENT_TYPE_UNSPECIFIED";
9
+ readonly CPU: "CPU";
10
+ readonly GPU: "GPU";
9
11
  };
10
- export type BaseEnvironmentType = (typeof BaseEnvironmentType)[keyof typeof BaseEnvironmentType] | (string & {});
12
+ type BaseEnvironmentType = (typeof BaseEnvironmentType)[keyof typeof BaseEnvironmentType] | (string & {});
11
13
  /** Error codes returned by Databricks APIs to indicate specific failure conditions. */
12
- export declare const ErrorCode: {
13
- /**
14
- * Unknown error. This error generally should not be returned explicitly, but will be used
15
- * as a fallback if the error enum is missing from the message for some reason.
16
- *
17
- * It's assigned tag 0 to follow the best practice from
18
- * https://developers.google.com/protocol-buffers/docs/style#enums
19
- *
20
- * TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings.
21
- * Maps to:
22
- * - google.rpc.Code: UNKNOWN = 2;
23
- * - HTTP code: 500 Internal Server Error
24
- */
25
- readonly UNKNOWN: "UNKNOWN";
26
- /**
27
- * Internal error. This means that some invariants expected by the underlying system have been
28
- * broken. This error code is reserved for serious errors, which generally cannot be resolved
29
- * by the user.
30
- *
31
- * Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some
32
- * automation that relies on the custom error code.
33
- *
34
- * Maps to:
35
- * - google.rpc.Code: INTERNAL = 13;
36
- * - HTTP code: 500 Internal Server Error
37
- */
38
- readonly INTERNAL_ERROR: "INTERNAL_ERROR";
39
- /**
40
- * The service is currently unavailable. This is most likely a transient condition, which can be
41
- * corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent
42
- * operations.
43
- *
44
- * Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.
45
- *
46
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
47
- * for guideline on how to pick this vs RESOURCE_EXHAUSTED.
48
- *
49
- * Maps to:
50
- * - google.rpc.Code: UNAVAILABLE = 14;
51
- * - HTTP code: 503 Service Unavailable
52
- */
53
- readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
54
- /**
55
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
56
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
57
- * Indicates that an IOException has been internally thrown.
58
- */
59
- readonly IO_ERROR: "IO_ERROR";
60
- /**
61
- * The request is invalid. Prefer more specific error code whenever possible.
62
- * Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
63
- *
64
- * Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.
65
- *
66
- * Maps to:
67
- * - google.rpc.Code: FAILED_PRECONDITION = 9;
68
- * - HTTP code: 400 Bad Request
69
- */
70
- readonly BAD_REQUEST: "BAD_REQUEST";
71
- /**
72
- * An external service is unavailable temporarily as it is being updated/re-deployed. Indicates
73
- * gateway proxy to safely retry the request.
74
- */
75
- readonly SERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE";
76
- /** A workspace is temporarily unavailable as the workspace is being re-assigned. */
77
- readonly WORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE";
78
- /**
79
- * The deadline expired before the operation could complete. For operations that change the state
80
- * of the system, this error may be returned even if the operation has completed successfully.
81
- * For example, a successful response from a server could have been delayed long enough for
82
- * the deadline to expire. When possible - implementations should make sure further processing of
83
- * the request is aborted, e.g. by throwing an exception instead of making the RPC request,
84
- * making the database query, etc.
85
- *
86
- * Maps to:
87
- * - google.rpc.Code: DEADLINE_EXCEEDED = 4;
88
- * - HTTP code: 504 Gateway Timeout
89
- */
90
- readonly DEADLINE_EXCEEDED: "DEADLINE_EXCEEDED";
91
- /**
92
- * The operation was canceled by the caller. An example - client closed the connection without
93
- * waiting for a response.
94
- *
95
- * Maps to:
96
- * - google.rpc.Code: CANCELLED = 1;
97
- * - HTTP code: 499 Client Closed Request
98
- */
99
- readonly CANCELLED: "CANCELLED";
100
- /**
101
- * The operation is rejected because of either rate limiting or resource quota,
102
- * such as the client has sent too many requests recently or the client has allocated too many
103
- * resources.
104
- *
105
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
106
- * for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
107
- *
108
- * Maps to:
109
- * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
110
- * - HTTP code: 429 Too Many Requests
111
- */
112
- readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED";
113
- /**
114
- * The operation was aborted, typically due to a concurrency issue such as a sequencer
115
- * check failure, transaction abort, or transaction conflict.
116
- *
117
- * Maps to:
118
- * - google.rpc.Code: ABORTED = 10;
119
- * - HTTP code: 409 Conflict
120
- */
121
- readonly ABORTED: "ABORTED";
122
- /**
123
- * Operation was performed on a resource that does not exist,
124
- * e.g. file or directory was not found.
125
- *
126
- * Maps to:
127
- * - google.rpc.Code: NOT_FOUND = 5;
128
- * - HTTP code: 404 Not Found
129
- */
130
- readonly NOT_FOUND: "NOT_FOUND";
131
- /**
132
- * Operation was rejected due a conflict with an existing resource, e.g. attempted to create
133
- * file or directory that already exists.
134
- *
135
- * Prefer this over RESOURCE_CONFLICT.
136
- *
137
- * Maps to:
138
- * - google.rpc.Code: ALREADY_EXISTS = 6;
139
- * - HTTP code: 409 Conflict
140
- */
141
- readonly ALREADY_EXISTS: "ALREADY_EXISTS";
142
- /**
143
- * The request does not have valid authentication (AuthN) credentials for the operation.
144
- *
145
- * Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy
146
- * code.
147
- * For authorization (AuthZ) errors use PERMISSION_DENIED.
148
- *
149
- * Maps to:
150
- * - google.rpc.Code: UNAUTHENTICATED = 16;
151
- * - HTTP code: 401 Unauthorized
152
- */
153
- readonly UNAUTHENTICATED: "UNAUTHENTICATED";
154
- /**
155
- * The service is currently unavailable. Please note that the unavailability may or may not be transient.
156
- * That means if this is a non-transient condition, retrying it does not work. If the unavailability
157
- * is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
158
- * nature explicitly.
159
- * An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does
160
- * not know whether it is because the domain name is completely wrong (non-transient situation) or
161
- * the domain name is valid but the DNS server does not have an entry for this domain name yet (transient
162
- * situation). Hence, `UNAVAILABLE` is suitable for this case.
163
- *
164
- * Maps to:
165
- * - google.rpc.Code: UNAVAILABLE = 14;
166
- * - HTTP code: 503 Service Unavailable
167
- */
168
- readonly UNAVAILABLE: "UNAVAILABLE";
169
- /**
170
- * Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).
171
- *
172
- * Maps to:
173
- * - google.rpc.Code: INVALID_ARGUMENT = 3;
174
- * - HTTP code: 400 Bad Request
175
- */
176
- readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
177
- /**
178
- * Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED
179
- * should be used instead to indicate that API doesn't exist.
180
- *
181
- * Maps to:
182
- * - google.rpc.Code: NOT_FOUND = 5;
183
- * - HTTP code: 404 Not Found
184
- */
185
- readonly ENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND";
186
- /** Indicates that the given API request was malformed. */
187
- readonly MALFORMED_REQUEST: "MALFORMED_REQUEST";
188
- /**
189
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
190
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
191
- * If one or more of the inputs to a given RPC are not in a valid state for the action.
192
- */
193
- readonly INVALID_STATE: "INVALID_STATE";
194
- /**
195
- * The caller does not have permission to execute the specified operation.
196
- * PERMISSION_DENIED must not be used for rejections caused by exhausting some resource,
197
- * use RESOURCE_EXHAUSTED instead for those errors.
198
- * PERMISSION_DENIED must not be used if the caller can not be identified,
199
- * use CUSTOMER_UNAUTHORIZED instead for those errors.
200
- * This error code does not imply the request is valid or the requested entity exists or
201
- * satisfies other pre-conditions.
202
- *
203
- * Maps to:
204
- * - google.rpc.Code: PERMISSION_DENIED = 7;
205
- * - HTTP code: 403 Forbidden
206
- */
207
- readonly PERMISSION_DENIED: "PERMISSION_DENIED";
208
- /**
209
- * NOTE: Deprecated due to inconsistent mapping in legacy code, see
210
- * https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
211
- * Prefer using NOT_FOUND or PERMISSION_DENIED.
212
- *
213
- * If a given user/entity is trying to use a feature which has been disabled.
214
- *
215
- * Maps to:
216
- * - google.rpc.Code: NOT_FOUND = 5;
217
- * - HTTP code: 404 Not Found
218
- */
219
- readonly FEATURE_DISABLED: "FEATURE_DISABLED";
220
- /**
221
- * The request does not have valid authentication (AuthN) credentials for the operation.
222
- *
223
- * For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep
224
- * consistent behavior with legacy code.
225
- * For authorization (AuthZ) errors use PERMISSION_DENIED.
226
- *
227
- * Important: name is confusing, this error code is for authentication (AuthN) errors, not
228
- * authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing
229
- * naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code
230
- * indicates that the request has not been applied because it lacks valid authentication
231
- * credentials for the target resource. [...] If the request included authentication credentials,
232
- * then the 401 response indicates that authorization has been refused for those credentials."
233
- *
234
- * Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.
235
- *
236
- * Maps to:
237
- * - google.rpc.Code: UNAUTHENTICATED = 16;
238
- * - HTTP code: 401 Unauthorized
239
- */
240
- readonly CUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED";
241
- /**
242
- * The operation is rejected because of request rate limit, for example rate limiting applied to
243
- * users, workspaces, IP addresses, etc.
244
- *
245
- * Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
246
- *
247
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
248
- * for guideline on the rate limiting vs throttling.
249
- *
250
- * Maps to:
251
- * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
252
- * - HTTP code: 429 Too Many Requests
253
- */
254
- readonly REQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED";
255
- /** Indicates API request was rejected due a conflict with an existing resource. */
256
- readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT";
257
- /**
258
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
259
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
260
- * Indicates that the HTTP response cannot be correctly deserialized.
261
- * This currently is only used in DUST test clients, and not by any real service code.
262
- */
263
- readonly UNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR";
264
- /**
265
- * The operation is not implemented or is not supported/enabled in this service.
266
- *
267
- * Maps to:
268
- * - google.rpc.Code: UNIMPLEMENTED = 12;
269
- * - HTTP code: 501 Not Implemented
270
- */
271
- readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED";
272
- /**
273
- * Unrecoverable data loss or corruption.
274
- *
275
- * One of the major use cases is to indicate that server failed to validate the integrity of
276
- * the request. This error can occur when the checksum specified in the `X-Databricks-Checksum`
277
- * request header (or trailer) doesn't match the actual request content checksum.
278
- *
279
- * Note, in case of the severe corruption that results in a malformed request, the server may
280
- * send a generic `400 Bad Request` response rather than sending this error code.
281
- *
282
- * Maps to:
283
- * - google.rpc.Code: DATA_LOSS = 15;
284
- * - HTTP code: 500 Internal Server Error
285
- */
286
- readonly DATA_LOSS: "DATA_LOSS";
287
- /** If the user attempts to perform an invalid state transition on a shard. */
288
- readonly INVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION";
289
- /**
290
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
291
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
292
- * Unable to perform the operation because the shard was locked by some other operation.
293
- */
294
- readonly COULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK";
295
- /**
296
- * NOTE: Deprecated, prefer using ALREADY_EXISTS.
297
- * Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons,
298
- * remapping will be a backwards incompatible change.
299
- *
300
- * Operation was performed on a resource that already exists.
301
- */
302
- readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS";
303
- /**
304
- * NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS,
305
- * because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP
306
- * codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
307
- *
308
- * Operation was performed on a resource that does not exist.
309
- */
310
- readonly RESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST";
311
- /**
312
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
313
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
314
- */
315
- readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
316
- /**
317
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
318
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
319
- */
320
- readonly MAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED";
321
- /**
322
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
323
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
324
- */
325
- readonly MAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED";
326
- readonly PARTIAL_DELETE: "PARTIAL_DELETE";
327
- readonly MAX_LIST_SIZE_EXCEEDED: "MAX_LIST_SIZE_EXCEEDED";
328
- /**
329
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
330
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
331
- */
332
- readonly DRY_RUN_FAILED: "DRY_RUN_FAILED";
333
- /**
334
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
335
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
336
- * Cluster request was rejected because it would exceed a resource limit.
337
- */
338
- readonly RESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED";
339
- /**
340
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
341
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
342
- */
343
- readonly DIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY";
344
- /**
345
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
346
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
347
- */
348
- readonly DIRECTORY_PROTECTED: "DIRECTORY_PROTECTED";
349
- /**
350
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
351
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
352
- */
353
- readonly MAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED";
354
- readonly MAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED";
355
- /**
356
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
357
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
358
- */
359
- readonly SEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG";
360
- /**
361
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
362
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
363
- */
364
- readonly SEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT";
365
- /**
366
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
367
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
368
- */
369
- readonly MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST";
370
- /**
371
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
372
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
373
- */
374
- readonly PERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED";
375
- /**
376
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
377
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
378
- */
379
- readonly DEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT";
380
- /**
381
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
382
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
383
- */
384
- readonly GIT_CONFLICT: "GIT_CONFLICT";
385
- /**
386
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
387
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
388
- */
389
- readonly GIT_UNKNOWN_REF: "GIT_UNKNOWN_REF";
390
- /**
391
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
392
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
393
- */
394
- readonly GIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED";
395
- /**
396
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
397
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
398
- */
399
- readonly GIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST";
400
- /**
401
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
402
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
403
- */
404
- readonly GIT_REMOTE_ERROR: "GIT_REMOTE_ERROR";
405
- /**
406
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
407
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
408
- */
409
- readonly PROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT";
410
- /**
411
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
412
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
413
- */
414
- readonly IPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO";
415
- /**
416
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
417
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
418
- */
419
- readonly INSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE";
420
- /**
421
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
422
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
423
- */
424
- readonly MALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE";
425
- readonly METASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST";
426
- /**
427
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
428
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
429
- */
430
- readonly DAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST";
431
- readonly CATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST";
432
- readonly SCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST";
433
- readonly TABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST";
434
- readonly SHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST";
435
- readonly RECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST";
436
- readonly STORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST";
437
- readonly EXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST";
438
- readonly PRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST";
439
- readonly PROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST";
440
- /**
441
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
442
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
443
- */
444
- readonly METASTORE_ALREADY_EXISTS: "METASTORE_ALREADY_EXISTS";
445
- /**
446
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
447
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
448
- */
449
- readonly DAC_ALREADY_EXISTS: "DAC_ALREADY_EXISTS";
450
- /**
451
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
452
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
453
- */
454
- readonly CATALOG_ALREADY_EXISTS: "CATALOG_ALREADY_EXISTS";
455
- /**
456
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
457
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
458
- */
459
- readonly SCHEMA_ALREADY_EXISTS: "SCHEMA_ALREADY_EXISTS";
460
- /**
461
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
462
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
463
- */
464
- readonly TABLE_ALREADY_EXISTS: "TABLE_ALREADY_EXISTS";
465
- /**
466
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
467
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
468
- */
469
- readonly SHARE_ALREADY_EXISTS: "SHARE_ALREADY_EXISTS";
470
- /**
471
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
472
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
473
- */
474
- readonly RECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS";
475
- /**
476
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
477
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
478
- */
479
- readonly STORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS";
480
- /**
481
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
482
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
483
- */
484
- readonly EXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS";
485
- /**
486
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
487
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
488
- */
489
- readonly PROVIDER_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS";
490
- /**
491
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
492
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
493
- */
494
- readonly CATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY";
495
- /**
496
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
497
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
498
- */
499
- readonly SCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY";
500
- /**
501
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
502
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
503
- */
504
- readonly METASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY";
505
- /**
506
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
507
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
508
- */
509
- readonly PROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE";
14
+ declare const ErrorCode: {
15
+ /**
16
+ * Unknown error. This error generally should not be returned explicitly, but will be used
17
+ * as a fallback if the error enum is missing from the message for some reason.
18
+ *
19
+ * It's assigned tag 0 to follow the best practice from
20
+ * https://developers.google.com/protocol-buffers/docs/style#enums
21
+ *
22
+ * TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings.
23
+ * Maps to:
24
+ * - google.rpc.Code: UNKNOWN = 2;
25
+ * - HTTP code: 500 Internal Server Error
26
+ */
27
+ readonly UNKNOWN: "UNKNOWN";
28
+ /**
29
+ * Internal error. This means that some invariants expected by the underlying system have been
30
+ * broken. This error code is reserved for serious errors, which generally cannot be resolved
31
+ * by the user.
32
+ *
33
+ * Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some
34
+ * automation that relies on the custom error code.
35
+ *
36
+ * Maps to:
37
+ * - google.rpc.Code: INTERNAL = 13;
38
+ * - HTTP code: 500 Internal Server Error
39
+ */
40
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
41
+ /**
42
+ * The service is currently unavailable. This is most likely a transient condition, which can be
43
+ * corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent
44
+ * operations.
45
+ *
46
+ * Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.
47
+ *
48
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
49
+ * for guideline on how to pick this vs RESOURCE_EXHAUSTED.
50
+ *
51
+ * Maps to:
52
+ * - google.rpc.Code: UNAVAILABLE = 14;
53
+ * - HTTP code: 503 Service Unavailable
54
+ */
55
+ readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
56
+ /**
57
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
58
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
59
+ * Indicates that an IOException has been internally thrown.
60
+ */
61
+ readonly IO_ERROR: "IO_ERROR";
62
+ /**
63
+ * The request is invalid. Prefer more specific error code whenever possible.
64
+ * Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
65
+ *
66
+ * Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.
67
+ *
68
+ * Maps to:
69
+ * - google.rpc.Code: FAILED_PRECONDITION = 9;
70
+ * - HTTP code: 400 Bad Request
71
+ */
72
+ readonly BAD_REQUEST: "BAD_REQUEST";
73
+ /**
74
+ * An external service is unavailable temporarily as it is being updated/re-deployed. Indicates
75
+ * gateway proxy to safely retry the request.
76
+ */
77
+ readonly SERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE"; /** A workspace is temporarily unavailable as the workspace is being re-assigned. */
78
+ readonly WORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE";
79
+ /**
80
+ * The deadline expired before the operation could complete. For operations that change the state
81
+ * of the system, this error may be returned even if the operation has completed successfully.
82
+ * For example, a successful response from a server could have been delayed long enough for
83
+ * the deadline to expire. When possible - implementations should make sure further processing of
84
+ * the request is aborted, e.g. by throwing an exception instead of making the RPC request,
85
+ * making the database query, etc.
86
+ *
87
+ * Maps to:
88
+ * - google.rpc.Code: DEADLINE_EXCEEDED = 4;
89
+ * - HTTP code: 504 Gateway Timeout
90
+ */
91
+ readonly DEADLINE_EXCEEDED: "DEADLINE_EXCEEDED";
92
+ /**
93
+ * The operation was canceled by the caller. An example - client closed the connection without
94
+ * waiting for a response.
95
+ *
96
+ * Maps to:
97
+ * - google.rpc.Code: CANCELLED = 1;
98
+ * - HTTP code: 499 Client Closed Request
99
+ */
100
+ readonly CANCELLED: "CANCELLED";
101
+ /**
102
+ * The operation is rejected because of either rate limiting or resource quota,
103
+ * such as the client has sent too many requests recently or the client has allocated too many
104
+ * resources.
105
+ *
106
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
107
+ * for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
108
+ *
109
+ * Maps to:
110
+ * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
111
+ * - HTTP code: 429 Too Many Requests
112
+ */
113
+ readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED";
114
+ /**
115
+ * The operation was aborted, typically due to a concurrency issue such as a sequencer
116
+ * check failure, transaction abort, or transaction conflict.
117
+ *
118
+ * Maps to:
119
+ * - google.rpc.Code: ABORTED = 10;
120
+ * - HTTP code: 409 Conflict
121
+ */
122
+ readonly ABORTED: "ABORTED";
123
+ /**
124
+ * Operation was performed on a resource that does not exist,
125
+ * e.g. file or directory was not found.
126
+ *
127
+ * Maps to:
128
+ * - google.rpc.Code: NOT_FOUND = 5;
129
+ * - HTTP code: 404 Not Found
130
+ */
131
+ readonly NOT_FOUND: "NOT_FOUND";
132
+ /**
133
+ * Operation was rejected due a conflict with an existing resource, e.g. attempted to create
134
+ * file or directory that already exists.
135
+ *
136
+ * Prefer this over RESOURCE_CONFLICT.
137
+ *
138
+ * Maps to:
139
+ * - google.rpc.Code: ALREADY_EXISTS = 6;
140
+ * - HTTP code: 409 Conflict
141
+ */
142
+ readonly ALREADY_EXISTS: "ALREADY_EXISTS";
143
+ /**
144
+ * The request does not have valid authentication (AuthN) credentials for the operation.
145
+ *
146
+ * Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy
147
+ * code.
148
+ * For authorization (AuthZ) errors use PERMISSION_DENIED.
149
+ *
150
+ * Maps to:
151
+ * - google.rpc.Code: UNAUTHENTICATED = 16;
152
+ * - HTTP code: 401 Unauthorized
153
+ */
154
+ readonly UNAUTHENTICATED: "UNAUTHENTICATED";
155
+ /**
156
+ * The service is currently unavailable. Please note that the unavailability may or may not be transient.
157
+ * That means if this is a non-transient condition, retrying it does not work. If the unavailability
158
+ * is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
159
+ * nature explicitly.
160
+ * An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does
161
+ * not know whether it is because the domain name is completely wrong (non-transient situation) or
162
+ * the domain name is valid but the DNS server does not have an entry for this domain name yet (transient
163
+ * situation). Hence, `UNAVAILABLE` is suitable for this case.
164
+ *
165
+ * Maps to:
166
+ * - google.rpc.Code: UNAVAILABLE = 14;
167
+ * - HTTP code: 503 Service Unavailable
168
+ */
169
+ readonly UNAVAILABLE: "UNAVAILABLE";
170
+ /**
171
+ * Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).
172
+ *
173
+ * Maps to:
174
+ * - google.rpc.Code: INVALID_ARGUMENT = 3;
175
+ * - HTTP code: 400 Bad Request
176
+ */
177
+ readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
178
+ /**
179
+ * Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED
180
+ * should be used instead to indicate that API doesn't exist.
181
+ *
182
+ * Maps to:
183
+ * - google.rpc.Code: NOT_FOUND = 5;
184
+ * - HTTP code: 404 Not Found
185
+ */
186
+ readonly ENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND"; /** Indicates that the given API request was malformed. */
187
+ readonly MALFORMED_REQUEST: "MALFORMED_REQUEST";
188
+ /**
189
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
190
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
191
+ * If one or more of the inputs to a given RPC are not in a valid state for the action.
192
+ */
193
+ readonly INVALID_STATE: "INVALID_STATE";
194
+ /**
195
+ * The caller does not have permission to execute the specified operation.
196
+ * PERMISSION_DENIED must not be used for rejections caused by exhausting some resource,
197
+ * use RESOURCE_EXHAUSTED instead for those errors.
198
+ * PERMISSION_DENIED must not be used if the caller can not be identified,
199
+ * use CUSTOMER_UNAUTHORIZED instead for those errors.
200
+ * This error code does not imply the request is valid or the requested entity exists or
201
+ * satisfies other pre-conditions.
202
+ *
203
+ * Maps to:
204
+ * - google.rpc.Code: PERMISSION_DENIED = 7;
205
+ * - HTTP code: 403 Forbidden
206
+ */
207
+ readonly PERMISSION_DENIED: "PERMISSION_DENIED";
208
+ /**
209
+ * NOTE: Deprecated due to inconsistent mapping in legacy code, see
210
+ * https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
211
+ * Prefer using NOT_FOUND or PERMISSION_DENIED.
212
+ *
213
+ * If a given user/entity is trying to use a feature which has been disabled.
214
+ *
215
+ * Maps to:
216
+ * - google.rpc.Code: NOT_FOUND = 5;
217
+ * - HTTP code: 404 Not Found
218
+ */
219
+ readonly FEATURE_DISABLED: "FEATURE_DISABLED";
220
+ /**
221
+ * The request does not have valid authentication (AuthN) credentials for the operation.
222
+ *
223
+ * For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep
224
+ * consistent behavior with legacy code.
225
+ * For authorization (AuthZ) errors use PERMISSION_DENIED.
226
+ *
227
+ * Important: name is confusing, this error code is for authentication (AuthN) errors, not
228
+ * authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing
229
+ * naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code
230
+ * indicates that the request has not been applied because it lacks valid authentication
231
+ * credentials for the target resource. [...] If the request included authentication credentials,
232
+ * then the 401 response indicates that authorization has been refused for those credentials."
233
+ *
234
+ * Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.
235
+ *
236
+ * Maps to:
237
+ * - google.rpc.Code: UNAUTHENTICATED = 16;
238
+ * - HTTP code: 401 Unauthorized
239
+ */
240
+ readonly CUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED";
241
+ /**
242
+ * The operation is rejected because of request rate limit, for example rate limiting applied to
243
+ * users, workspaces, IP addresses, etc.
244
+ *
245
+ * Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
246
+ *
247
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
248
+ * for guideline on the rate limiting vs throttling.
249
+ *
250
+ * Maps to:
251
+ * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
252
+ * - HTTP code: 429 Too Many Requests
253
+ */
254
+ readonly REQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED"; /** Indicates API request was rejected due a conflict with an existing resource. */
255
+ readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT";
256
+ /**
257
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
258
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
259
+ * Indicates that the HTTP response cannot be correctly deserialized.
260
+ * This currently is only used in DUST test clients, and not by any real service code.
261
+ */
262
+ readonly UNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR";
263
+ /**
264
+ * The operation is not implemented or is not supported/enabled in this service.
265
+ *
266
+ * Maps to:
267
+ * - google.rpc.Code: UNIMPLEMENTED = 12;
268
+ * - HTTP code: 501 Not Implemented
269
+ */
270
+ readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED";
271
+ /**
272
+ * Unrecoverable data loss or corruption.
273
+ *
274
+ * One of the major use cases is to indicate that server failed to validate the integrity of
275
+ * the request. This error can occur when the checksum specified in the `X-Databricks-Checksum`
276
+ * request header (or trailer) doesn't match the actual request content checksum.
277
+ *
278
+ * Note, in case of the severe corruption that results in a malformed request, the server may
279
+ * send a generic `400 Bad Request` response rather than sending this error code.
280
+ *
281
+ * Maps to:
282
+ * - google.rpc.Code: DATA_LOSS = 15;
283
+ * - HTTP code: 500 Internal Server Error
284
+ */
285
+ readonly DATA_LOSS: "DATA_LOSS"; /** If the user attempts to perform an invalid state transition on a shard. */
286
+ readonly INVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION";
287
+ /**
288
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
289
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
290
+ * Unable to perform the operation because the shard was locked by some other operation.
291
+ */
292
+ readonly COULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK";
293
+ /**
294
+ * NOTE: Deprecated, prefer using ALREADY_EXISTS.
295
+ * Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons,
296
+ * remapping will be a backwards incompatible change.
297
+ *
298
+ * Operation was performed on a resource that already exists.
299
+ */
300
+ readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS";
301
+ /**
302
+ * NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS,
303
+ * because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP
304
+ * codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
305
+ *
306
+ * Operation was performed on a resource that does not exist.
307
+ */
308
+ readonly RESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST";
309
+ /**
310
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
311
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
312
+ */
313
+ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
314
+ /**
315
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
316
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
317
+ */
318
+ readonly MAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED";
319
+ /**
320
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
321
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
322
+ */
323
+ readonly MAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED";
324
+ readonly PARTIAL_DELETE: "PARTIAL_DELETE";
325
+ readonly MAX_LIST_SIZE_EXCEEDED: "MAX_LIST_SIZE_EXCEEDED";
326
+ /**
327
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
328
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
329
+ */
330
+ readonly DRY_RUN_FAILED: "DRY_RUN_FAILED";
331
+ /**
332
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
333
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
334
+ * Cluster request was rejected because it would exceed a resource limit.
335
+ */
336
+ readonly RESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED";
337
+ /**
338
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
339
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
340
+ */
341
+ readonly DIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY";
342
+ /**
343
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
344
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
345
+ */
346
+ readonly DIRECTORY_PROTECTED: "DIRECTORY_PROTECTED";
347
+ /**
348
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
349
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
350
+ */
351
+ readonly MAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED";
352
+ readonly MAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED";
353
+ /**
354
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
355
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
356
+ */
357
+ readonly SEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG";
358
+ /**
359
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
360
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
361
+ */
362
+ readonly SEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT";
363
+ /**
364
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
365
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
366
+ */
367
+ readonly MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST";
368
+ /**
369
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
370
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
371
+ */
372
+ readonly PERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED";
373
+ /**
374
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
375
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
376
+ */
377
+ readonly DEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT";
378
+ /**
379
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
380
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
381
+ */
382
+ readonly GIT_CONFLICT: "GIT_CONFLICT";
383
+ /**
384
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
385
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
386
+ */
387
+ readonly GIT_UNKNOWN_REF: "GIT_UNKNOWN_REF";
388
+ /**
389
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
390
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
391
+ */
392
+ readonly GIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED";
393
+ /**
394
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
395
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
396
+ */
397
+ readonly GIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST";
398
+ /**
399
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
400
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
401
+ */
402
+ readonly GIT_REMOTE_ERROR: "GIT_REMOTE_ERROR";
403
+ /**
404
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
405
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
406
+ */
407
+ readonly PROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT";
408
+ /**
409
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
410
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
411
+ */
412
+ readonly IPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO";
413
+ /**
414
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
415
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
416
+ */
417
+ readonly INSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE";
418
+ /**
419
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
420
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
421
+ */
422
+ readonly MALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE";
423
+ readonly METASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST";
424
+ /**
425
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
426
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
427
+ */
428
+ readonly DAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST";
429
+ readonly CATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST";
430
+ readonly SCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST";
431
+ readonly TABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST";
432
+ readonly SHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST";
433
+ readonly RECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST";
434
+ readonly STORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST";
435
+ readonly EXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST";
436
+ readonly PRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST";
437
+ readonly PROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST";
438
+ /**
439
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
440
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
441
+ */
442
+ readonly METASTORE_ALREADY_EXISTS: "METASTORE_ALREADY_EXISTS";
443
+ /**
444
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
445
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
446
+ */
447
+ readonly DAC_ALREADY_EXISTS: "DAC_ALREADY_EXISTS";
448
+ /**
449
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
450
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
451
+ */
452
+ readonly CATALOG_ALREADY_EXISTS: "CATALOG_ALREADY_EXISTS";
453
+ /**
454
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
455
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
456
+ */
457
+ readonly SCHEMA_ALREADY_EXISTS: "SCHEMA_ALREADY_EXISTS";
458
+ /**
459
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
460
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
461
+ */
462
+ readonly TABLE_ALREADY_EXISTS: "TABLE_ALREADY_EXISTS";
463
+ /**
464
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
465
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
466
+ */
467
+ readonly SHARE_ALREADY_EXISTS: "SHARE_ALREADY_EXISTS";
468
+ /**
469
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
470
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
471
+ */
472
+ readonly RECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS";
473
+ /**
474
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
475
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
476
+ */
477
+ readonly STORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS";
478
+ /**
479
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
480
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
481
+ */
482
+ readonly EXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS";
483
+ /**
484
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
485
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
486
+ */
487
+ readonly PROVIDER_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS";
488
+ /**
489
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
490
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
491
+ */
492
+ readonly CATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY";
493
+ /**
494
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
495
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
496
+ */
497
+ readonly SCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY";
498
+ /**
499
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
500
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
501
+ */
502
+ readonly METASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY";
503
+ /**
504
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
505
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
506
+ */
507
+ readonly PROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE";
510
508
  };
511
- export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode] | (string & {});
509
+ type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode] | (string & {});
512
510
  /** Status of the environment materialization. */
513
- export declare const WorkspaceBaseEnvironmentCache_Status: {
514
- readonly STATUS_UNSPECIFIED: "STATUS_UNSPECIFIED";
515
- /** Materialized environment creation is pending. */
516
- readonly PENDING: "PENDING";
517
- /** Materialized environment has been successfully created. */
518
- readonly CREATED: "CREATED";
519
- /** Materialized environment creation failed. */
520
- readonly FAILED: "FAILED";
521
- /** Materialized environment has expired. */
522
- readonly EXPIRED: "EXPIRED";
523
- /** Materialized environment is invalid. */
524
- readonly INVALID: "INVALID";
525
- /** Materialized environment is being refreshed. */
526
- readonly REFRESHING: "REFRESHING";
511
+ declare const WorkspaceBaseEnvironmentCache_Status: {
512
+ readonly STATUS_UNSPECIFIED: "STATUS_UNSPECIFIED"; /** Materialized environment creation is pending. */
513
+ readonly PENDING: "PENDING"; /** Materialized environment has been successfully created. */
514
+ readonly CREATED: "CREATED"; /** Materialized environment creation failed. */
515
+ readonly FAILED: "FAILED"; /** Materialized environment has expired. */
516
+ readonly EXPIRED: "EXPIRED"; /** Materialized environment is invalid. */
517
+ readonly INVALID: "INVALID"; /** Materialized environment is being refreshed. */
518
+ readonly REFRESHING: "REFRESHING";
527
519
  };
528
- export type WorkspaceBaseEnvironmentCache_Status = (typeof WorkspaceBaseEnvironmentCache_Status)[keyof typeof WorkspaceBaseEnvironmentCache_Status] | (string & {});
520
+ type WorkspaceBaseEnvironmentCache_Status = (typeof WorkspaceBaseEnvironmentCache_Status)[keyof typeof WorkspaceBaseEnvironmentCache_Status] | (string & {});
529
521
  /** Databricks Error that is returned by all Databricks APIs. */
530
- export interface ApiError {
531
- errorCode?: ErrorCode | undefined;
532
- message?: string | undefined;
533
- stackTrace?: string | undefined;
534
- details?: Record<string, unknown>[] | undefined;
522
+ interface ApiError {
523
+ errorCode?: ErrorCode | undefined;
524
+ message?: string | undefined;
525
+ stackTrace?: string | undefined;
526
+ details?: Record<string, unknown>[] | undefined;
535
527
  }
536
528
  /** Request message for CreateWorkspaceBaseEnvironment. */
537
- export interface CreateWorkspaceBaseEnvironmentRequest {
538
- /** Required. The workspace base environment to create. */
539
- workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined;
540
- /**
541
- * The ID to use for the workspace base environment, which will become the final component of
542
- * the resource name.
543
- * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
544
- */
545
- workspaceBaseEnvironmentId?: string | undefined;
546
- /**
547
- * A unique identifier for this request. A random UUID is recommended.
548
- * This request is only idempotent if a request_id is provided.
549
- */
550
- requestId?: string | undefined;
529
+ interface CreateWorkspaceBaseEnvironmentRequest {
530
+ /** Required. The workspace base environment to create. */
531
+ workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined;
532
+ /**
533
+ * The ID to use for the workspace base environment, which will become the final component of
534
+ * the resource name.
535
+ * This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
536
+ */
537
+ workspaceBaseEnvironmentId?: string | undefined;
538
+ /**
539
+ * A unique identifier for this request. A random UUID is recommended.
540
+ * This request is only idempotent if a request_id is provided.
541
+ */
542
+ requestId?: string | undefined;
551
543
  }
552
544
  /**
553
545
  * A singleton resource representing the default workspace base environment configuration.
554
546
  * This resource contains the workspace base environments that are used as defaults
555
547
  * for serverless notebooks and jobs in the workspace, for both CPU and GPU compute types.
556
548
  */
557
- export interface DefaultWorkspaceBaseEnvironment {
558
- /**
559
- * The resource name of this singleton resource.
560
- * Format: default-workspace-base-environment
561
- */
562
- name?: string | undefined;
563
- /**
564
- * The default workspace base environment for CPU compute.
565
- * Format: workspace-base-environments/{workspace_base_environment}
566
- */
567
- cpuWorkspaceBaseEnvironment?: string | undefined;
568
- /**
569
- * The default workspace base environment for GPU compute.
570
- * Format: workspace-base-environments/{workspace_base_environment}
571
- */
572
- gpuWorkspaceBaseEnvironment?: string | undefined;
549
+ interface DefaultWorkspaceBaseEnvironment {
550
+ /**
551
+ * The resource name of this singleton resource.
552
+ * Format: default-workspace-base-environment
553
+ */
554
+ name?: string | undefined;
555
+ /**
556
+ * The default workspace base environment for CPU compute.
557
+ * Format: workspace-base-environments/{workspace_base_environment}
558
+ */
559
+ cpuWorkspaceBaseEnvironment?: string | undefined;
560
+ /**
561
+ * The default workspace base environment for GPU compute.
562
+ * Format: workspace-base-environments/{workspace_base_environment}
563
+ */
564
+ gpuWorkspaceBaseEnvironment?: string | undefined;
573
565
  }
574
566
  /** Request message for DeleteWorkspaceBaseEnvironment. */
575
- export interface DeleteWorkspaceBaseEnvironmentRequest {
576
- /**
577
- * Required. The resource name of the workspace base environment to delete.
578
- * Format: workspace-base-environments/{workspace_base_environment}
579
- */
580
- name?: string | undefined;
567
+ interface DeleteWorkspaceBaseEnvironmentRequest {
568
+ /**
569
+ * Required. The resource name of the workspace base environment to delete.
570
+ * Format: workspace-base-environments/{workspace_base_environment}
571
+ */
572
+ name?: string | undefined;
581
573
  }
582
574
  /**
583
575
  * Environment specification for a WorkspaceBaseEnvironment.
584
576
  * Contains the environment version and dependencies configuration.
585
577
  */
586
- export interface EnvironmentSpec {
587
- /**
588
- * List of pip dependencies, as supported by the version of pip in this environment.
589
- * Each dependency is a valid pip requirements file line per https://pip.pypa.io/en/stable/reference/requirements-file-format/.
590
- * Allowed dependencies include a requirement specifier, an archive URL, a local project path (such as WSFS or UC Volumes in <Databricks>), or a VCS project URL.
591
- */
592
- dependencies?: string[] | undefined;
593
- /**
594
- * Environment version used by the environment.
595
- * Each version comes with a specific Python version and a set of Python packages.
596
- * The version is a string, consisting of an integer.
597
- */
598
- environmentVersion?: string | undefined;
578
+ interface EnvironmentSpec {
579
+ /**
580
+ * List of pip dependencies, as supported by the version of pip in this environment.
581
+ * Each dependency is a valid pip requirements file line per https://pip.pypa.io/en/stable/reference/requirements-file-format/.
582
+ * Allowed dependencies include a requirement specifier, an archive URL, a local project path (such as WSFS or UC Volumes in <Databricks>), or a VCS project URL.
583
+ */
584
+ dependencies?: string[] | undefined;
585
+ /**
586
+ * Environment version used by the environment.
587
+ * Each version comes with a specific Python version and a set of Python packages.
588
+ * The version is a string, consisting of an integer.
589
+ */
590
+ environmentVersion?: string | undefined;
599
591
  }
600
592
  /** Request message for GetDefaultWorkspaceBaseEnvironment. */
601
- export interface GetDefaultWorkspaceBaseEnvironmentRequest {
602
- /**
603
- * A static resource name of the default workspace base environment.
604
- * Format: default-workspace-base-environment
605
- */
606
- name?: string | undefined;
593
+ interface GetDefaultWorkspaceBaseEnvironmentRequest {
594
+ /**
595
+ * A static resource name of the default workspace base environment.
596
+ * Format: default-workspace-base-environment
597
+ */
598
+ name?: string | undefined;
607
599
  }
608
600
  /** The request message for `GetOperation` method. */
609
- export interface GetOperationRequest {
610
- /** The name of the operation resource. */
611
- name?: string | undefined;
601
+ interface GetOperationRequest {
602
+ /** The name of the operation resource. */
603
+ name?: string | undefined;
612
604
  }
613
605
  /** Request message for GetWorkspaceBaseEnvironment. */
614
- export interface GetWorkspaceBaseEnvironmentRequest {
615
- /**
616
- * Required. The resource name of the workspace base environment to retrieve.
617
- * Format: workspace-base-environments/{workspace_base_environment}
618
- */
619
- name?: string | undefined;
606
+ interface GetWorkspaceBaseEnvironmentRequest {
607
+ /**
608
+ * Required. The resource name of the workspace base environment to retrieve.
609
+ * Format: workspace-base-environments/{workspace_base_environment}
610
+ */
611
+ name?: string | undefined;
620
612
  }
621
613
  /** Request message for ListWorkspaceBaseEnvironments. */
622
- export interface ListWorkspaceBaseEnvironmentsRequest {
623
- /**
624
- * The maximum number of environments to return per page.
625
- * Default is 1000.
626
- */
627
- pageSize?: number | undefined;
628
- /** Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call. */
629
- pageToken?: string | undefined;
614
+ interface ListWorkspaceBaseEnvironmentsRequest {
615
+ /**
616
+ * The maximum number of environments to return per page.
617
+ * Default is 1000.
618
+ */
619
+ pageSize?: number | undefined;
620
+ /** Page token for pagination. Received from a previous ListWorkspaceBaseEnvironments call. */
621
+ pageToken?: string | undefined;
630
622
  }
631
623
  /** Response message for ListWorkspaceBaseEnvironments. */
632
- export interface ListWorkspaceBaseEnvironmentsResponse {
633
- /** The list of workspace base environments. */
634
- workspaceBaseEnvironments?: WorkspaceBaseEnvironment[] | undefined;
635
- /**
636
- * Token to retrieve the next page of results.
637
- * Empty if there are no more results.
638
- */
639
- nextPageToken?: string | undefined;
624
+ interface ListWorkspaceBaseEnvironmentsResponse {
625
+ /** The list of workspace base environments. */
626
+ workspaceBaseEnvironments?: WorkspaceBaseEnvironment[] | undefined;
627
+ /**
628
+ * Token to retrieve the next page of results.
629
+ * Empty if there are no more results.
630
+ */
631
+ nextPageToken?: string | undefined;
640
632
  }
641
633
  /**
642
634
  * This resource represents a long-running operation that is the result of a
643
635
  * network API call.
644
636
  */
645
- export interface Operation {
646
- /**
647
- * The server-assigned name, which is only unique within the same service that
648
- * originally returns it. If you use the default HTTP mapping, the
649
- * `name` should be a resource name ending with `operations/{unique_id}`.
650
- */
651
- name?: string | undefined;
652
- /**
653
- * Service-specific metadata associated with the operation. It typically
654
- * contains progress information and common metadata such as create time.
655
- * Some services might not provide such metadata.
656
- */
657
- metadata?: Record<string, unknown> | undefined;
658
- /**
659
- * If the value is `false`, it means the operation is still in progress.
660
- * If `true`, the operation is completed, and either `error` or `response` is
661
- * available.
662
- */
663
- done?: boolean | undefined;
664
- /**
665
- * The operation result, which can be either an `error` or a valid `response`.
666
- * If `done` == `false`, neither `error` nor `response` is set.
667
- * If `done` == `true`, exactly one of `error` or `response` can be set.
668
- * Some services might not provide the result.
669
- */
670
- result?: {
671
- $case: 'error';
672
- /** The error result of the operation in case of failure or cancellation. */
673
- error: ApiError;
674
- } | {
675
- $case: 'response';
676
- /** The normal, successful response of the operation. */
677
- response: Record<string, unknown>;
678
- } | undefined;
637
+ interface Operation {
638
+ /**
639
+ * The server-assigned name, which is only unique within the same service that
640
+ * originally returns it. If you use the default HTTP mapping, the
641
+ * `name` should be a resource name ending with `operations/{unique_id}`.
642
+ */
643
+ name?: string | undefined;
644
+ /**
645
+ * Service-specific metadata associated with the operation. It typically
646
+ * contains progress information and common metadata such as create time.
647
+ * Some services might not provide such metadata.
648
+ */
649
+ metadata?: Record<string, unknown> | undefined;
650
+ /**
651
+ * If the value is `false`, it means the operation is still in progress.
652
+ * If `true`, the operation is completed, and either `error` or `response` is
653
+ * available.
654
+ */
655
+ done?: boolean | undefined;
656
+ /**
657
+ * The operation result, which can be either an `error` or a valid `response`.
658
+ * If `done` == `false`, neither `error` nor `response` is set.
659
+ * If `done` == `true`, exactly one of `error` or `response` can be set.
660
+ * Some services might not provide the result.
661
+ */
662
+ result?: {
663
+ $case: 'error'; /** The error result of the operation in case of failure or cancellation. */
664
+ error: ApiError;
665
+ } | {
666
+ $case: 'response'; /** The normal, successful response of the operation. */
667
+ response: Record<string, unknown>;
668
+ } | undefined;
679
669
  }
680
670
  /** Request message for RefreshWorkspaceBaseEnvironments. */
681
- export interface RefreshWorkspaceBaseEnvironmentRequest {
682
- /**
683
- * Required. The resource name of the workspace base environment to delete.
684
- * Format: workspace-base-environments/{workspace_base_environment}
685
- */
686
- name?: string | undefined;
671
+ interface RefreshWorkspaceBaseEnvironmentRequest {
672
+ /**
673
+ * Required. The resource name of the workspace base environment to delete.
674
+ * Format: workspace-base-environments/{workspace_base_environment}
675
+ */
676
+ name?: string | undefined;
687
677
  }
688
678
  /** Request message for UpdateDefaultWorkspaceBaseEnvironment. */
689
- export interface UpdateDefaultWorkspaceBaseEnvironmentRequest {
690
- /** Required. The default workspace base environment configuration to update. */
691
- defaultWorkspaceBaseEnvironment?: DefaultWorkspaceBaseEnvironment | undefined;
692
- /**
693
- * Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).
694
- * The special value '*' indicates that all fields should be updated (full replacement).
695
- * Valid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment
696
- *
697
- * To unset one or both defaults, include the field path(s) in the mask and omit them from the request body.
698
- * To unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.
699
- */
700
- updateMask?: FieldMask<DefaultWorkspaceBaseEnvironment> | undefined;
679
+ interface UpdateDefaultWorkspaceBaseEnvironmentRequest {
680
+ /** Required. The default workspace base environment configuration to update. */
681
+ defaultWorkspaceBaseEnvironment?: DefaultWorkspaceBaseEnvironment | undefined;
682
+ /**
683
+ * Field mask specifying which fields to update. Use comma as the separator for multiple fields (no space).
684
+ * The special value '*' indicates that all fields should be updated (full replacement).
685
+ * Valid field paths: cpu_workspace_base_environment, gpu_workspace_base_environment
686
+ *
687
+ * To unset one or both defaults, include the field path(s) in the mask and omit them from the request body.
688
+ * To unset both, you must list both paths explicitly — the wildcard '*' cannot be used to unset fields.
689
+ */
690
+ updateMask?: FieldMask<DefaultWorkspaceBaseEnvironment> | undefined;
701
691
  }
702
692
  /** Request message for UpdateWorkspaceBaseEnvironment. */
703
- export interface UpdateWorkspaceBaseEnvironmentRequest {
704
- name?: string | undefined;
705
- /**
706
- * Required. The workspace base environment with updated fields.
707
- * The name field is used to identify the environment to update.
708
- */
709
- workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined;
693
+ interface UpdateWorkspaceBaseEnvironmentRequest {
694
+ name?: string | undefined;
695
+ /**
696
+ * Required. The workspace base environment with updated fields.
697
+ * The name field is used to identify the environment to update.
698
+ */
699
+ workspaceBaseEnvironment?: WorkspaceBaseEnvironment | undefined;
710
700
  }
711
701
  /**
712
702
  * A WorkspaceBaseEnvironment defines a workspace-level environment configuration
713
703
  * consisting of an environment version and a list of dependencies.
714
704
  */
715
- export interface WorkspaceBaseEnvironment {
716
- /**
717
- * The resource name of the workspace base environment.
718
- * Format: workspace-base-environments/{workspace-base-environment}
719
- */
720
- name?: string | undefined;
721
- /** Human-readable display name for the workspace base environment. */
722
- displayName?: string | undefined;
723
- /** The WSFS or UC Volumes path to the environment YAML file. */
724
- filepath?: string | undefined;
725
- /** User ID of the creator. */
726
- creatorUserId?: string | undefined;
727
- /** Timestamp when the environment was created. */
728
- createTime?: Temporal.Instant | undefined;
729
- /** User ID of the last user who updated the environment. */
730
- lastUpdatedUserId?: string | undefined;
731
- /** Timestamp when the environment was last updated. */
732
- updateTime?: Temporal.Instant | undefined;
733
- /** The status of the materialized workspace base environment. */
734
- status?: WorkspaceBaseEnvironmentCache_Status | undefined;
735
- /** Status message providing additional details about the environment status. */
736
- message?: string | undefined;
737
- /** Whether this is the default environment for the workspace. */
738
- isDefault?: boolean | undefined;
739
- /** The type of base environment (CPU or GPU). */
740
- baseEnvironmentType?: BaseEnvironmentType | undefined;
741
- /** The environment specification containing version and dependencies. */
742
- spec?: EnvironmentSpec | undefined;
705
+ interface WorkspaceBaseEnvironment {
706
+ /**
707
+ * The resource name of the workspace base environment.
708
+ * Format: workspace-base-environments/{workspace-base-environment}
709
+ */
710
+ name?: string | undefined;
711
+ /** Human-readable display name for the workspace base environment. */
712
+ displayName?: string | undefined;
713
+ /** The WSFS or UC Volumes path to the environment YAML file. */
714
+ filepath?: string | undefined;
715
+ /** User ID of the creator. */
716
+ creatorUserId?: string | undefined;
717
+ /** Timestamp when the environment was created. */
718
+ createTime?: Temporal.Instant | undefined;
719
+ /** User ID of the last user who updated the environment. */
720
+ lastUpdatedUserId?: string | undefined;
721
+ /** Timestamp when the environment was last updated. */
722
+ updateTime?: Temporal.Instant | undefined;
723
+ /** The status of the materialized workspace base environment. */
724
+ status?: WorkspaceBaseEnvironmentCache_Status | undefined;
725
+ /** Status message providing additional details about the environment status. */
726
+ message?: string | undefined;
727
+ /** Whether this is the default environment for the workspace. */
728
+ isDefault?: boolean | undefined;
729
+ /** The type of base environment (CPU or GPU). */
730
+ baseEnvironmentType?: BaseEnvironmentType | undefined;
731
+ /** The environment specification containing version and dependencies. */
732
+ spec?: EnvironmentSpec | undefined;
743
733
  }
744
734
  /** Materialized environment information for a WorkspaceBaseEnvironment. */
745
- export interface WorkspaceBaseEnvironmentCache {
746
- }
735
+ interface WorkspaceBaseEnvironmentCache {}
747
736
  /**
748
737
  * Metadata for the WorkspaceBaseEnvironment long-running operations.
749
738
  * This message tracks the progress of the workspace base environment long-running process.
750
739
  */
751
- export interface WorkspaceBaseEnvironmentOperationMetadata {
752
- }
753
- export declare const unmarshalApiErrorSchema: z.ZodType<ApiError>;
754
- export declare const unmarshalDefaultWorkspaceBaseEnvironmentSchema: z.ZodType<DefaultWorkspaceBaseEnvironment>;
755
- export declare const unmarshalEnvironmentSpecSchema: z.ZodType<EnvironmentSpec>;
756
- export declare const unmarshalListWorkspaceBaseEnvironmentsResponseSchema: z.ZodType<ListWorkspaceBaseEnvironmentsResponse>;
757
- export declare const unmarshalOperationSchema: z.ZodType<Operation>;
758
- export declare const unmarshalWorkspaceBaseEnvironmentSchema: z.ZodType<WorkspaceBaseEnvironment>;
759
- export declare const unmarshalWorkspaceBaseEnvironmentOperationMetadataSchema: z.ZodType<WorkspaceBaseEnvironmentOperationMetadata>;
760
- export declare const marshalDefaultWorkspaceBaseEnvironmentSchema: z.ZodType;
761
- export declare const marshalEnvironmentSpecSchema: z.ZodType;
762
- export declare const marshalRefreshWorkspaceBaseEnvironmentRequestSchema: z.ZodType;
763
- export declare const marshalWorkspaceBaseEnvironmentSchema: z.ZodType;
764
- export declare function defaultWorkspaceBaseEnvironmentFieldMask(...paths: string[]): FieldMask<DefaultWorkspaceBaseEnvironment>;
740
+ interface WorkspaceBaseEnvironmentOperationMetadata {}
741
+ declare const unmarshalApiErrorSchema: z.ZodType<ApiError>;
742
+ declare const unmarshalDefaultWorkspaceBaseEnvironmentSchema: z.ZodType<DefaultWorkspaceBaseEnvironment>;
743
+ declare const unmarshalEnvironmentSpecSchema: z.ZodType<EnvironmentSpec>;
744
+ declare const unmarshalListWorkspaceBaseEnvironmentsResponseSchema: z.ZodType<ListWorkspaceBaseEnvironmentsResponse>;
745
+ declare const unmarshalOperationSchema: z.ZodType<Operation>;
746
+ declare const unmarshalWorkspaceBaseEnvironmentSchema: z.ZodType<WorkspaceBaseEnvironment>;
747
+ declare const unmarshalWorkspaceBaseEnvironmentOperationMetadataSchema: z.ZodType<WorkspaceBaseEnvironmentOperationMetadata>;
748
+ declare const marshalDefaultWorkspaceBaseEnvironmentSchema: z.ZodType;
749
+ declare const marshalEnvironmentSpecSchema: z.ZodType;
750
+ declare const marshalRefreshWorkspaceBaseEnvironmentRequestSchema: z.ZodType;
751
+ declare const marshalWorkspaceBaseEnvironmentSchema: z.ZodType;
752
+ declare function defaultWorkspaceBaseEnvironmentFieldMask(...paths: string[]): FieldMask<DefaultWorkspaceBaseEnvironment>;
753
+ //#endregion
754
+ export { ApiError, BaseEnvironmentType, CreateWorkspaceBaseEnvironmentRequest, DefaultWorkspaceBaseEnvironment, DeleteWorkspaceBaseEnvironmentRequest, EnvironmentSpec, ErrorCode, GetDefaultWorkspaceBaseEnvironmentRequest, GetOperationRequest, GetWorkspaceBaseEnvironmentRequest, ListWorkspaceBaseEnvironmentsRequest, ListWorkspaceBaseEnvironmentsResponse, Operation, RefreshWorkspaceBaseEnvironmentRequest, UpdateDefaultWorkspaceBaseEnvironmentRequest, UpdateWorkspaceBaseEnvironmentRequest, WorkspaceBaseEnvironment, WorkspaceBaseEnvironmentCache, WorkspaceBaseEnvironmentCache_Status, WorkspaceBaseEnvironmentOperationMetadata, defaultWorkspaceBaseEnvironmentFieldMask, marshalDefaultWorkspaceBaseEnvironmentSchema, marshalEnvironmentSpecSchema, marshalRefreshWorkspaceBaseEnvironmentRequestSchema, marshalWorkspaceBaseEnvironmentSchema, unmarshalApiErrorSchema, unmarshalDefaultWorkspaceBaseEnvironmentSchema, unmarshalEnvironmentSpecSchema, unmarshalListWorkspaceBaseEnvironmentsResponseSchema, unmarshalOperationSchema, unmarshalWorkspaceBaseEnvironmentOperationMetadataSchema, unmarshalWorkspaceBaseEnvironmentSchema };
765
755
  //# sourceMappingURL=model.d.ts.map