@databricks/sdk-postgres 0.33.0 → 0.35.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,2056 +1,2008 @@
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
  /** The replication state of a single replicated table (CdfStatus). */
5
- export declare const CdfState: {
6
- /** Default value. Returned when the replication state is unknown or not set. */
7
- readonly CDF_STATE_UNSPECIFIED: "CDF_STATE_UNSPECIFIED";
8
- /**
9
- * Taking the initial snapshot: the table's existing rows are being written
10
- * to the Delta table.
11
- */
12
- readonly CDF_STATE_SNAPSHOTTING: "CDF_STATE_SNAPSHOTTING";
13
- /** Continuously streaming WAL changes to the Delta table. */
14
- readonly CDF_STATE_STREAMING: "CDF_STATE_STREAMING";
15
- /**
16
- * Reserved: replication for this table was superseded by a newer one.
17
- * Not currently returned by the API.
18
- */
19
- readonly CDF_STATE_TERMINATED: "CDF_STATE_TERMINATED";
20
- /**
21
- * The table is not being replicated: it was skipped because it is not
22
- * eligible for replication, or replication errored. See status_detail for
23
- * the specific reason.
24
- */
25
- readonly CDF_STATE_SKIPPED: "CDF_STATE_SKIPPED";
7
+ declare const CdfState: {
8
+ /** Default value. Returned when the replication state is unknown or not set. */readonly CDF_STATE_UNSPECIFIED: "CDF_STATE_UNSPECIFIED";
9
+ /**
10
+ * Taking the initial snapshot: the table's existing rows are being written
11
+ * to the Delta table.
12
+ */
13
+ readonly CDF_STATE_SNAPSHOTTING: "CDF_STATE_SNAPSHOTTING"; /** Continuously streaming WAL changes to the Delta table. */
14
+ readonly CDF_STATE_STREAMING: "CDF_STATE_STREAMING";
15
+ /**
16
+ * Reserved: replication for this table was superseded by a newer one.
17
+ * Not currently returned by the API.
18
+ */
19
+ readonly CDF_STATE_TERMINATED: "CDF_STATE_TERMINATED";
20
+ /**
21
+ * The table is not being replicated: it was skipped because it is not
22
+ * eligible for replication, or replication errored. See status_detail for
23
+ * the specific reason.
24
+ */
25
+ readonly CDF_STATE_SKIPPED: "CDF_STATE_SKIPPED";
26
26
  };
27
- export type CdfState = (typeof CdfState)[keyof typeof CdfState] | (string & {});
27
+ type CdfState = (typeof CdfState)[keyof typeof CdfState] | (string & {});
28
28
  /** The compute endpoint type. Either `read_write` or `read_only`. */
29
- export declare const EndpointType: {
30
- /** Default value, not used */
31
- readonly ENDPOINT_TYPE_UNSPECIFIED: "ENDPOINT_TYPE_UNSPECIFIED";
32
- readonly ENDPOINT_TYPE_READ_WRITE: "ENDPOINT_TYPE_READ_WRITE";
33
- readonly ENDPOINT_TYPE_READ_ONLY: "ENDPOINT_TYPE_READ_ONLY";
29
+ declare const EndpointType: {
30
+ /** Default value, not used */readonly ENDPOINT_TYPE_UNSPECIFIED: "ENDPOINT_TYPE_UNSPECIFIED";
31
+ readonly ENDPOINT_TYPE_READ_WRITE: "ENDPOINT_TYPE_READ_WRITE";
32
+ readonly ENDPOINT_TYPE_READ_ONLY: "ENDPOINT_TYPE_READ_ONLY";
34
33
  };
35
- export type EndpointType = (typeof EndpointType)[keyof typeof EndpointType] | (string & {});
34
+ type EndpointType = (typeof EndpointType)[keyof typeof EndpointType] | (string & {});
36
35
  /** Error codes returned by Databricks APIs to indicate specific failure conditions. */
37
- export declare const ErrorCode: {
38
- /**
39
- * Unknown error. This error generally should not be returned explicitly, but will be used
40
- * as a fallback if the error enum is missing from the message for some reason.
41
- *
42
- * It's assigned tag 0 to follow the best practice from
43
- * https://developers.google.com/protocol-buffers/docs/style#enums
44
- *
45
- * TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings.
46
- * Maps to:
47
- * - google.rpc.Code: UNKNOWN = 2;
48
- * - HTTP code: 500 Internal Server Error
49
- */
50
- readonly UNKNOWN: "UNKNOWN";
51
- /**
52
- * Internal error. This means that some invariants expected by the underlying system have been
53
- * broken. This error code is reserved for serious errors, which generally cannot be resolved
54
- * by the user.
55
- *
56
- * Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some
57
- * automation that relies on the custom error code.
58
- *
59
- * Maps to:
60
- * - google.rpc.Code: INTERNAL = 13;
61
- * - HTTP code: 500 Internal Server Error
62
- */
63
- readonly INTERNAL_ERROR: "INTERNAL_ERROR";
64
- /**
65
- * The service is currently unavailable. This is most likely a transient condition, which can be
66
- * corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent
67
- * operations.
68
- *
69
- * Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.
70
- *
71
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
72
- * for guideline on how to pick this vs RESOURCE_EXHAUSTED.
73
- *
74
- * Maps to:
75
- * - google.rpc.Code: UNAVAILABLE = 14;
76
- * - HTTP code: 503 Service Unavailable
77
- */
78
- readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
79
- /**
80
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
81
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
82
- * Indicates that an IOException has been internally thrown.
83
- */
84
- readonly IO_ERROR: "IO_ERROR";
85
- /**
86
- * The request is invalid. Prefer more specific error code whenever possible.
87
- * Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
88
- *
89
- * Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.
90
- *
91
- * Maps to:
92
- * - google.rpc.Code: FAILED_PRECONDITION = 9;
93
- * - HTTP code: 400 Bad Request
94
- */
95
- readonly BAD_REQUEST: "BAD_REQUEST";
96
- /**
97
- * An external service is unavailable temporarily as it is being updated/re-deployed. Indicates
98
- * gateway proxy to safely retry the request.
99
- */
100
- readonly SERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE";
101
- /** A workspace is temporarily unavailable as the workspace is being re-assigned. */
102
- readonly WORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE";
103
- /**
104
- * The deadline expired before the operation could complete. For operations that change the state
105
- * of the system, this error may be returned even if the operation has completed successfully.
106
- * For example, a successful response from a server could have been delayed long enough for
107
- * the deadline to expire. When possible - implementations should make sure further processing of
108
- * the request is aborted, e.g. by throwing an exception instead of making the RPC request,
109
- * making the database query, etc.
110
- *
111
- * Maps to:
112
- * - google.rpc.Code: DEADLINE_EXCEEDED = 4;
113
- * - HTTP code: 504 Gateway Timeout
114
- */
115
- readonly DEADLINE_EXCEEDED: "DEADLINE_EXCEEDED";
116
- /**
117
- * The operation was canceled by the caller. An example - client closed the connection without
118
- * waiting for a response.
119
- *
120
- * Maps to:
121
- * - google.rpc.Code: CANCELLED = 1;
122
- * - HTTP code: 499 Client Closed Request
123
- */
124
- readonly CANCELLED: "CANCELLED";
125
- /**
126
- * The operation is rejected because of either rate limiting or resource quota,
127
- * such as the client has sent too many requests recently or the client has allocated too many
128
- * resources.
129
- *
130
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
131
- * for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
132
- *
133
- * Maps to:
134
- * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
135
- * - HTTP code: 429 Too Many Requests
136
- */
137
- readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED";
138
- /**
139
- * The operation was aborted, typically due to a concurrency issue such as a sequencer
140
- * check failure, transaction abort, or transaction conflict.
141
- *
142
- * Maps to:
143
- * - google.rpc.Code: ABORTED = 10;
144
- * - HTTP code: 409 Conflict
145
- */
146
- readonly ABORTED: "ABORTED";
147
- /**
148
- * Operation was performed on a resource that does not exist,
149
- * e.g. file or directory was not found.
150
- *
151
- * Maps to:
152
- * - google.rpc.Code: NOT_FOUND = 5;
153
- * - HTTP code: 404 Not Found
154
- */
155
- readonly NOT_FOUND: "NOT_FOUND";
156
- /**
157
- * Operation was rejected due a conflict with an existing resource, e.g. attempted to create
158
- * file or directory that already exists.
159
- *
160
- * Prefer this over RESOURCE_CONFLICT.
161
- *
162
- * Maps to:
163
- * - google.rpc.Code: ALREADY_EXISTS = 6;
164
- * - HTTP code: 409 Conflict
165
- */
166
- readonly ALREADY_EXISTS: "ALREADY_EXISTS";
167
- /**
168
- * The request does not have valid authentication (AuthN) credentials for the operation.
169
- *
170
- * Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy
171
- * code.
172
- * For authorization (AuthZ) errors use PERMISSION_DENIED.
173
- *
174
- * Maps to:
175
- * - google.rpc.Code: UNAUTHENTICATED = 16;
176
- * - HTTP code: 401 Unauthorized
177
- */
178
- readonly UNAUTHENTICATED: "UNAUTHENTICATED";
179
- /**
180
- * The service is currently unavailable. Please note that the unavailability may or may not be transient.
181
- * That means if this is a non-transient condition, retrying it does not work. If the unavailability
182
- * is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
183
- * nature explicitly.
184
- * An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does
185
- * not know whether it is because the domain name is completely wrong (non-transient situation) or
186
- * the domain name is valid but the DNS server does not have an entry for this domain name yet (transient
187
- * situation). Hence, `UNAVAILABLE` is suitable for this case.
188
- *
189
- * Maps to:
190
- * - google.rpc.Code: UNAVAILABLE = 14;
191
- * - HTTP code: 503 Service Unavailable
192
- */
193
- readonly UNAVAILABLE: "UNAVAILABLE";
194
- /**
195
- * Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).
196
- *
197
- * Maps to:
198
- * - google.rpc.Code: INVALID_ARGUMENT = 3;
199
- * - HTTP code: 400 Bad Request
200
- */
201
- readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
202
- /**
203
- * Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED
204
- * should be used instead to indicate that API doesn't exist.
205
- *
206
- * Maps to:
207
- * - google.rpc.Code: NOT_FOUND = 5;
208
- * - HTTP code: 404 Not Found
209
- */
210
- readonly ENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND";
211
- /** Indicates that the given API request was malformed. */
212
- readonly MALFORMED_REQUEST: "MALFORMED_REQUEST";
213
- /**
214
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
215
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
216
- * If one or more of the inputs to a given RPC are not in a valid state for the action.
217
- */
218
- readonly INVALID_STATE: "INVALID_STATE";
219
- /**
220
- * The caller does not have permission to execute the specified operation.
221
- * PERMISSION_DENIED must not be used for rejections caused by exhausting some resource,
222
- * use RESOURCE_EXHAUSTED instead for those errors.
223
- * PERMISSION_DENIED must not be used if the caller can not be identified,
224
- * use CUSTOMER_UNAUTHORIZED instead for those errors.
225
- * This error code does not imply the request is valid or the requested entity exists or
226
- * satisfies other pre-conditions.
227
- *
228
- * Maps to:
229
- * - google.rpc.Code: PERMISSION_DENIED = 7;
230
- * - HTTP code: 403 Forbidden
231
- */
232
- readonly PERMISSION_DENIED: "PERMISSION_DENIED";
233
- /**
234
- * NOTE: Deprecated due to inconsistent mapping in legacy code, see
235
- * https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
236
- * Prefer using NOT_FOUND or PERMISSION_DENIED.
237
- *
238
- * If a given user/entity is trying to use a feature which has been disabled.
239
- *
240
- * Maps to:
241
- * - google.rpc.Code: NOT_FOUND = 5;
242
- * - HTTP code: 404 Not Found
243
- */
244
- readonly FEATURE_DISABLED: "FEATURE_DISABLED";
245
- /**
246
- * The request does not have valid authentication (AuthN) credentials for the operation.
247
- *
248
- * For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep
249
- * consistent behavior with legacy code.
250
- * For authorization (AuthZ) errors use PERMISSION_DENIED.
251
- *
252
- * Important: name is confusing, this error code is for authentication (AuthN) errors, not
253
- * authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing
254
- * naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code
255
- * indicates that the request has not been applied because it lacks valid authentication
256
- * credentials for the target resource. [...] If the request included authentication credentials,
257
- * then the 401 response indicates that authorization has been refused for those credentials."
258
- *
259
- * Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.
260
- *
261
- * Maps to:
262
- * - google.rpc.Code: UNAUTHENTICATED = 16;
263
- * - HTTP code: 401 Unauthorized
264
- */
265
- readonly CUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED";
266
- /**
267
- * The operation is rejected because of request rate limit, for example rate limiting applied to
268
- * users, workspaces, IP addresses, etc.
269
- *
270
- * Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
271
- *
272
- * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
273
- * for guideline on the rate limiting vs throttling.
274
- *
275
- * Maps to:
276
- * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
277
- * - HTTP code: 429 Too Many Requests
278
- */
279
- readonly REQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED";
280
- /** Indicates API request was rejected due a conflict with an existing resource. */
281
- readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT";
282
- /**
283
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
284
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
285
- * Indicates that the HTTP response cannot be correctly deserialized.
286
- * This currently is only used in DUST test clients, and not by any real service code.
287
- */
288
- readonly UNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR";
289
- /**
290
- * The operation is not implemented or is not supported/enabled in this service.
291
- *
292
- * Maps to:
293
- * - google.rpc.Code: UNIMPLEMENTED = 12;
294
- * - HTTP code: 501 Not Implemented
295
- */
296
- readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED";
297
- /**
298
- * Unrecoverable data loss or corruption.
299
- *
300
- * One of the major use cases is to indicate that server failed to validate the integrity of
301
- * the request. This error can occur when the checksum specified in the `X-Databricks-Checksum`
302
- * request header (or trailer) doesn't match the actual request content checksum.
303
- *
304
- * Note, in case of the severe corruption that results in a malformed request, the server may
305
- * send a generic `400 Bad Request` response rather than sending this error code.
306
- *
307
- * Maps to:
308
- * - google.rpc.Code: DATA_LOSS = 15;
309
- * - HTTP code: 500 Internal Server Error
310
- */
311
- readonly DATA_LOSS: "DATA_LOSS";
312
- /** If the user attempts to perform an invalid state transition on a shard. */
313
- readonly INVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION";
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
- * Unable to perform the operation because the shard was locked by some other operation.
318
- */
319
- readonly COULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK";
320
- /**
321
- * NOTE: Deprecated, prefer using ALREADY_EXISTS.
322
- * Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons,
323
- * remapping will be a backwards incompatible change.
324
- *
325
- * Operation was performed on a resource that already exists.
326
- */
327
- readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS";
328
- /**
329
- * NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS,
330
- * because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP
331
- * codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
332
- *
333
- * Operation was performed on a resource that does not exist.
334
- */
335
- readonly RESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST";
336
- /**
337
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
338
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
339
- */
340
- readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
341
- /**
342
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
343
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
344
- */
345
- readonly MAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED";
346
- /**
347
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
348
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
349
- */
350
- readonly MAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED";
351
- readonly PARTIAL_DELETE: "PARTIAL_DELETE";
352
- readonly MAX_LIST_SIZE_EXCEEDED: "MAX_LIST_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 DRY_RUN_FAILED: "DRY_RUN_FAILED";
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
- * Cluster request was rejected because it would exceed a resource limit.
362
- */
363
- readonly RESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED";
364
- /**
365
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
366
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
367
- */
368
- readonly DIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY";
369
- /**
370
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
371
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
372
- */
373
- readonly DIRECTORY_PROTECTED: "DIRECTORY_PROTECTED";
374
- /**
375
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
376
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
377
- */
378
- readonly MAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED";
379
- readonly MAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED";
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 SEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG";
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 SEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT";
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 MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST";
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 PERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED";
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 DEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT";
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 GIT_CONFLICT: "GIT_CONFLICT";
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 GIT_UNKNOWN_REF: "GIT_UNKNOWN_REF";
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 GIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED";
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 GIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST";
425
- /**
426
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
427
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
428
- */
429
- readonly GIT_REMOTE_ERROR: "GIT_REMOTE_ERROR";
430
- /**
431
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
432
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
433
- */
434
- readonly PROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT";
435
- /**
436
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
437
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
438
- */
439
- readonly IPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO";
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 INSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE";
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 MALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE";
450
- readonly METASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST";
451
- /**
452
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
453
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
454
- */
455
- readonly DAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST";
456
- readonly CATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST";
457
- readonly SCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST";
458
- readonly TABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST";
459
- readonly SHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST";
460
- readonly RECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST";
461
- readonly STORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST";
462
- readonly EXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST";
463
- readonly PRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST";
464
- readonly PROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST";
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 METASTORE_ALREADY_EXISTS: "METASTORE_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 DAC_ALREADY_EXISTS: "DAC_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 CATALOG_ALREADY_EXISTS: "CATALOG_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 SCHEMA_ALREADY_EXISTS: "SCHEMA_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 TABLE_ALREADY_EXISTS: "TABLE_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 SHARE_ALREADY_EXISTS: "SHARE_ALREADY_EXISTS";
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 RECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS";
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 STORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS";
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 EXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS";
510
- /**
511
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
512
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
513
- */
514
- readonly PROVIDER_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS";
515
- /**
516
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
517
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
518
- */
519
- readonly CATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY";
520
- /**
521
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
522
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
523
- */
524
- readonly SCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY";
525
- /**
526
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
527
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
528
- */
529
- readonly METASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY";
530
- /**
531
- * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
532
- * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
533
- */
534
- readonly PROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE";
36
+ declare const ErrorCode: {
37
+ /**
38
+ * Unknown error. This error generally should not be returned explicitly, but will be used
39
+ * as a fallback if the error enum is missing from the message for some reason.
40
+ *
41
+ * It's assigned tag 0 to follow the best practice from
42
+ * https://developers.google.com/protocol-buffers/docs/style#enums
43
+ *
44
+ * TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings.
45
+ * Maps to:
46
+ * - google.rpc.Code: UNKNOWN = 2;
47
+ * - HTTP code: 500 Internal Server Error
48
+ */
49
+ readonly UNKNOWN: "UNKNOWN";
50
+ /**
51
+ * Internal error. This means that some invariants expected by the underlying system have been
52
+ * broken. This error code is reserved for serious errors, which generally cannot be resolved
53
+ * by the user.
54
+ *
55
+ * Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some
56
+ * automation that relies on the custom error code.
57
+ *
58
+ * Maps to:
59
+ * - google.rpc.Code: INTERNAL = 13;
60
+ * - HTTP code: 500 Internal Server Error
61
+ */
62
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
63
+ /**
64
+ * The service is currently unavailable. This is most likely a transient condition, which can be
65
+ * corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent
66
+ * operations.
67
+ *
68
+ * Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.
69
+ *
70
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
71
+ * for guideline on how to pick this vs RESOURCE_EXHAUSTED.
72
+ *
73
+ * Maps to:
74
+ * - google.rpc.Code: UNAVAILABLE = 14;
75
+ * - HTTP code: 503 Service Unavailable
76
+ */
77
+ readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
78
+ /**
79
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
80
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
81
+ * Indicates that an IOException has been internally thrown.
82
+ */
83
+ readonly IO_ERROR: "IO_ERROR";
84
+ /**
85
+ * The request is invalid. Prefer more specific error code whenever possible.
86
+ * Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
87
+ *
88
+ * Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.
89
+ *
90
+ * Maps to:
91
+ * - google.rpc.Code: FAILED_PRECONDITION = 9;
92
+ * - HTTP code: 400 Bad Request
93
+ */
94
+ readonly BAD_REQUEST: "BAD_REQUEST";
95
+ /**
96
+ * An external service is unavailable temporarily as it is being updated/re-deployed. Indicates
97
+ * gateway proxy to safely retry the request.
98
+ */
99
+ readonly SERVICE_UNDER_MAINTENANCE: "SERVICE_UNDER_MAINTENANCE"; /** A workspace is temporarily unavailable as the workspace is being re-assigned. */
100
+ readonly WORKSPACE_TEMPORARILY_UNAVAILABLE: "WORKSPACE_TEMPORARILY_UNAVAILABLE";
101
+ /**
102
+ * The deadline expired before the operation could complete. For operations that change the state
103
+ * of the system, this error may be returned even if the operation has completed successfully.
104
+ * For example, a successful response from a server could have been delayed long enough for
105
+ * the deadline to expire. When possible - implementations should make sure further processing of
106
+ * the request is aborted, e.g. by throwing an exception instead of making the RPC request,
107
+ * making the database query, etc.
108
+ *
109
+ * Maps to:
110
+ * - google.rpc.Code: DEADLINE_EXCEEDED = 4;
111
+ * - HTTP code: 504 Gateway Timeout
112
+ */
113
+ readonly DEADLINE_EXCEEDED: "DEADLINE_EXCEEDED";
114
+ /**
115
+ * The operation was canceled by the caller. An example - client closed the connection without
116
+ * waiting for a response.
117
+ *
118
+ * Maps to:
119
+ * - google.rpc.Code: CANCELLED = 1;
120
+ * - HTTP code: 499 Client Closed Request
121
+ */
122
+ readonly CANCELLED: "CANCELLED";
123
+ /**
124
+ * The operation is rejected because of either rate limiting or resource quota,
125
+ * such as the client has sent too many requests recently or the client has allocated too many
126
+ * resources.
127
+ *
128
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
129
+ * for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
130
+ *
131
+ * Maps to:
132
+ * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
133
+ * - HTTP code: 429 Too Many Requests
134
+ */
135
+ readonly RESOURCE_EXHAUSTED: "RESOURCE_EXHAUSTED";
136
+ /**
137
+ * The operation was aborted, typically due to a concurrency issue such as a sequencer
138
+ * check failure, transaction abort, or transaction conflict.
139
+ *
140
+ * Maps to:
141
+ * - google.rpc.Code: ABORTED = 10;
142
+ * - HTTP code: 409 Conflict
143
+ */
144
+ readonly ABORTED: "ABORTED";
145
+ /**
146
+ * Operation was performed on a resource that does not exist,
147
+ * e.g. file or directory was not found.
148
+ *
149
+ * Maps to:
150
+ * - google.rpc.Code: NOT_FOUND = 5;
151
+ * - HTTP code: 404 Not Found
152
+ */
153
+ readonly NOT_FOUND: "NOT_FOUND";
154
+ /**
155
+ * Operation was rejected due a conflict with an existing resource, e.g. attempted to create
156
+ * file or directory that already exists.
157
+ *
158
+ * Prefer this over RESOURCE_CONFLICT.
159
+ *
160
+ * Maps to:
161
+ * - google.rpc.Code: ALREADY_EXISTS = 6;
162
+ * - HTTP code: 409 Conflict
163
+ */
164
+ readonly ALREADY_EXISTS: "ALREADY_EXISTS";
165
+ /**
166
+ * The request does not have valid authentication (AuthN) credentials for the operation.
167
+ *
168
+ * Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy
169
+ * code.
170
+ * For authorization (AuthZ) errors use PERMISSION_DENIED.
171
+ *
172
+ * Maps to:
173
+ * - google.rpc.Code: UNAUTHENTICATED = 16;
174
+ * - HTTP code: 401 Unauthorized
175
+ */
176
+ readonly UNAUTHENTICATED: "UNAUTHENTICATED";
177
+ /**
178
+ * The service is currently unavailable. Please note that the unavailability may or may not be transient.
179
+ * That means if this is a non-transient condition, retrying it does not work. If the unavailability
180
+ * is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
181
+ * nature explicitly.
182
+ * An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does
183
+ * not know whether it is because the domain name is completely wrong (non-transient situation) or
184
+ * the domain name is valid but the DNS server does not have an entry for this domain name yet (transient
185
+ * situation). Hence, `UNAVAILABLE` is suitable for this case.
186
+ *
187
+ * Maps to:
188
+ * - google.rpc.Code: UNAVAILABLE = 14;
189
+ * - HTTP code: 503 Service Unavailable
190
+ */
191
+ readonly UNAVAILABLE: "UNAVAILABLE";
192
+ /**
193
+ * Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).
194
+ *
195
+ * Maps to:
196
+ * - google.rpc.Code: INVALID_ARGUMENT = 3;
197
+ * - HTTP code: 400 Bad Request
198
+ */
199
+ readonly INVALID_PARAMETER_VALUE: "INVALID_PARAMETER_VALUE";
200
+ /**
201
+ * Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED
202
+ * should be used instead to indicate that API doesn't exist.
203
+ *
204
+ * Maps to:
205
+ * - google.rpc.Code: NOT_FOUND = 5;
206
+ * - HTTP code: 404 Not Found
207
+ */
208
+ readonly ENDPOINT_NOT_FOUND: "ENDPOINT_NOT_FOUND"; /** Indicates that the given API request was malformed. */
209
+ readonly MALFORMED_REQUEST: "MALFORMED_REQUEST";
210
+ /**
211
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
212
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
213
+ * If one or more of the inputs to a given RPC are not in a valid state for the action.
214
+ */
215
+ readonly INVALID_STATE: "INVALID_STATE";
216
+ /**
217
+ * The caller does not have permission to execute the specified operation.
218
+ * PERMISSION_DENIED must not be used for rejections caused by exhausting some resource,
219
+ * use RESOURCE_EXHAUSTED instead for those errors.
220
+ * PERMISSION_DENIED must not be used if the caller can not be identified,
221
+ * use CUSTOMER_UNAUTHORIZED instead for those errors.
222
+ * This error code does not imply the request is valid or the requested entity exists or
223
+ * satisfies other pre-conditions.
224
+ *
225
+ * Maps to:
226
+ * - google.rpc.Code: PERMISSION_DENIED = 7;
227
+ * - HTTP code: 403 Forbidden
228
+ */
229
+ readonly PERMISSION_DENIED: "PERMISSION_DENIED";
230
+ /**
231
+ * NOTE: Deprecated due to inconsistent mapping in legacy code, see
232
+ * https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
233
+ * Prefer using NOT_FOUND or PERMISSION_DENIED.
234
+ *
235
+ * If a given user/entity is trying to use a feature which has been disabled.
236
+ *
237
+ * Maps to:
238
+ * - google.rpc.Code: NOT_FOUND = 5;
239
+ * - HTTP code: 404 Not Found
240
+ */
241
+ readonly FEATURE_DISABLED: "FEATURE_DISABLED";
242
+ /**
243
+ * The request does not have valid authentication (AuthN) credentials for the operation.
244
+ *
245
+ * For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep
246
+ * consistent behavior with legacy code.
247
+ * For authorization (AuthZ) errors use PERMISSION_DENIED.
248
+ *
249
+ * Important: name is confusing, this error code is for authentication (AuthN) errors, not
250
+ * authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing
251
+ * naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code
252
+ * indicates that the request has not been applied because it lacks valid authentication
253
+ * credentials for the target resource. [...] If the request included authentication credentials,
254
+ * then the 401 response indicates that authorization has been refused for those credentials."
255
+ *
256
+ * Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.
257
+ *
258
+ * Maps to:
259
+ * - google.rpc.Code: UNAUTHENTICATED = 16;
260
+ * - HTTP code: 401 Unauthorized
261
+ */
262
+ readonly CUSTOMER_UNAUTHORIZED: "CUSTOMER_UNAUTHORIZED";
263
+ /**
264
+ * The operation is rejected because of request rate limit, for example rate limiting applied to
265
+ * users, workspaces, IP addresses, etc.
266
+ *
267
+ * Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
268
+ *
269
+ * See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
270
+ * for guideline on the rate limiting vs throttling.
271
+ *
272
+ * Maps to:
273
+ * - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
274
+ * - HTTP code: 429 Too Many Requests
275
+ */
276
+ readonly REQUEST_LIMIT_EXCEEDED: "REQUEST_LIMIT_EXCEEDED"; /** Indicates API request was rejected due a conflict with an existing resource. */
277
+ readonly RESOURCE_CONFLICT: "RESOURCE_CONFLICT";
278
+ /**
279
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
280
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
281
+ * Indicates that the HTTP response cannot be correctly deserialized.
282
+ * This currently is only used in DUST test clients, and not by any real service code.
283
+ */
284
+ readonly UNPARSEABLE_HTTP_ERROR: "UNPARSEABLE_HTTP_ERROR";
285
+ /**
286
+ * The operation is not implemented or is not supported/enabled in this service.
287
+ *
288
+ * Maps to:
289
+ * - google.rpc.Code: UNIMPLEMENTED = 12;
290
+ * - HTTP code: 501 Not Implemented
291
+ */
292
+ readonly NOT_IMPLEMENTED: "NOT_IMPLEMENTED";
293
+ /**
294
+ * Unrecoverable data loss or corruption.
295
+ *
296
+ * One of the major use cases is to indicate that server failed to validate the integrity of
297
+ * the request. This error can occur when the checksum specified in the `X-Databricks-Checksum`
298
+ * request header (or trailer) doesn't match the actual request content checksum.
299
+ *
300
+ * Note, in case of the severe corruption that results in a malformed request, the server may
301
+ * send a generic `400 Bad Request` response rather than sending this error code.
302
+ *
303
+ * Maps to:
304
+ * - google.rpc.Code: DATA_LOSS = 15;
305
+ * - HTTP code: 500 Internal Server Error
306
+ */
307
+ readonly DATA_LOSS: "DATA_LOSS"; /** If the user attempts to perform an invalid state transition on a shard. */
308
+ readonly INVALID_STATE_TRANSITION: "INVALID_STATE_TRANSITION";
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
+ * Unable to perform the operation because the shard was locked by some other operation.
313
+ */
314
+ readonly COULD_NOT_ACQUIRE_LOCK: "COULD_NOT_ACQUIRE_LOCK";
315
+ /**
316
+ * NOTE: Deprecated, prefer using ALREADY_EXISTS.
317
+ * Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons,
318
+ * remapping will be a backwards incompatible change.
319
+ *
320
+ * Operation was performed on a resource that already exists.
321
+ */
322
+ readonly RESOURCE_ALREADY_EXISTS: "RESOURCE_ALREADY_EXISTS";
323
+ /**
324
+ * NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS,
325
+ * because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP
326
+ * codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
327
+ *
328
+ * Operation was performed on a resource that does not exist.
329
+ */
330
+ readonly RESOURCE_DOES_NOT_EXIST: "RESOURCE_DOES_NOT_EXIST";
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
+ */
335
+ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
336
+ /**
337
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
338
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
339
+ */
340
+ readonly MAX_BLOCK_SIZE_EXCEEDED: "MAX_BLOCK_SIZE_EXCEEDED";
341
+ /**
342
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
343
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
344
+ */
345
+ readonly MAX_READ_SIZE_EXCEEDED: "MAX_READ_SIZE_EXCEEDED";
346
+ readonly PARTIAL_DELETE: "PARTIAL_DELETE";
347
+ readonly MAX_LIST_SIZE_EXCEEDED: "MAX_LIST_SIZE_EXCEEDED";
348
+ /**
349
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
350
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
351
+ */
352
+ readonly DRY_RUN_FAILED: "DRY_RUN_FAILED";
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
+ * Cluster request was rejected because it would exceed a resource limit.
357
+ */
358
+ readonly RESOURCE_LIMIT_EXCEEDED: "RESOURCE_LIMIT_EXCEEDED";
359
+ /**
360
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
361
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
362
+ */
363
+ readonly DIRECTORY_NOT_EMPTY: "DIRECTORY_NOT_EMPTY";
364
+ /**
365
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
366
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
367
+ */
368
+ readonly DIRECTORY_PROTECTED: "DIRECTORY_PROTECTED";
369
+ /**
370
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
371
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
372
+ */
373
+ readonly MAX_NOTEBOOK_SIZE_EXCEEDED: "MAX_NOTEBOOK_SIZE_EXCEEDED";
374
+ readonly MAX_CHILD_NODE_SIZE_EXCEEDED: "MAX_CHILD_NODE_SIZE_EXCEEDED";
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 SEARCH_QUERY_TOO_LONG: "SEARCH_QUERY_TOO_LONG";
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 SEARCH_QUERY_TOO_SHORT: "SEARCH_QUERY_TOO_SHORT";
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 MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST: "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST";
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 PERMISSION_NOT_PROPAGATED: "PERMISSION_NOT_PROPAGATED";
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 DEPLOYMENT_TIMEOUT: "DEPLOYMENT_TIMEOUT";
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_CONFLICT: "GIT_CONFLICT";
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 GIT_UNKNOWN_REF: "GIT_UNKNOWN_REF";
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 GIT_SENSITIVE_TOKEN_DETECTED: "GIT_SENSITIVE_TOKEN_DETECTED";
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 GIT_URL_NOT_ON_ALLOW_LIST: "GIT_URL_NOT_ON_ALLOW_LIST";
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 GIT_REMOTE_ERROR: "GIT_REMOTE_ERROR";
425
+ /**
426
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
427
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
428
+ */
429
+ readonly PROJECTS_OPERATION_TIMEOUT: "PROJECTS_OPERATION_TIMEOUT";
430
+ /**
431
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
432
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
433
+ */
434
+ readonly IPYNB_FILE_IN_REPO: "IPYNB_FILE_IN_REPO";
435
+ /**
436
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
437
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
438
+ */
439
+ readonly INSECURE_PARTNER_RESPONSE: "INSECURE_PARTNER_RESPONSE";
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 MALFORMED_PARTNER_RESPONSE: "MALFORMED_PARTNER_RESPONSE";
445
+ readonly METASTORE_DOES_NOT_EXIST: "METASTORE_DOES_NOT_EXIST";
446
+ /**
447
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
448
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
449
+ */
450
+ readonly DAC_DOES_NOT_EXIST: "DAC_DOES_NOT_EXIST";
451
+ readonly CATALOG_DOES_NOT_EXIST: "CATALOG_DOES_NOT_EXIST";
452
+ readonly SCHEMA_DOES_NOT_EXIST: "SCHEMA_DOES_NOT_EXIST";
453
+ readonly TABLE_DOES_NOT_EXIST: "TABLE_DOES_NOT_EXIST";
454
+ readonly SHARE_DOES_NOT_EXIST: "SHARE_DOES_NOT_EXIST";
455
+ readonly RECIPIENT_DOES_NOT_EXIST: "RECIPIENT_DOES_NOT_EXIST";
456
+ readonly STORAGE_CREDENTIAL_DOES_NOT_EXIST: "STORAGE_CREDENTIAL_DOES_NOT_EXIST";
457
+ readonly EXTERNAL_LOCATION_DOES_NOT_EXIST: "EXTERNAL_LOCATION_DOES_NOT_EXIST";
458
+ readonly PRINCIPAL_DOES_NOT_EXIST: "PRINCIPAL_DOES_NOT_EXIST";
459
+ readonly PROVIDER_DOES_NOT_EXIST: "PROVIDER_DOES_NOT_EXIST";
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 METASTORE_ALREADY_EXISTS: "METASTORE_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 DAC_ALREADY_EXISTS: "DAC_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 CATALOG_ALREADY_EXISTS: "CATALOG_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 SCHEMA_ALREADY_EXISTS: "SCHEMA_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 TABLE_ALREADY_EXISTS: "TABLE_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 SHARE_ALREADY_EXISTS: "SHARE_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 RECIPIENT_ALREADY_EXISTS: "RECIPIENT_ALREADY_EXISTS";
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 STORAGE_CREDENTIAL_ALREADY_EXISTS: "STORAGE_CREDENTIAL_ALREADY_EXISTS";
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 EXTERNAL_LOCATION_ALREADY_EXISTS: "EXTERNAL_LOCATION_ALREADY_EXISTS";
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_ALREADY_EXISTS: "PROVIDER_ALREADY_EXISTS";
510
+ /**
511
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
512
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
513
+ */
514
+ readonly CATALOG_NOT_EMPTY: "CATALOG_NOT_EMPTY";
515
+ /**
516
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
517
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
518
+ */
519
+ readonly SCHEMA_NOT_EMPTY: "SCHEMA_NOT_EMPTY";
520
+ /**
521
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
522
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
523
+ */
524
+ readonly METASTORE_NOT_EMPTY: "METASTORE_NOT_EMPTY";
525
+ /**
526
+ * NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
527
+ * avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
528
+ */
529
+ readonly PROVIDER_SHARE_NOT_ACCESSIBLE: "PROVIDER_SHARE_NOT_ACCESSIBLE";
535
530
  };
536
- export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode] | (string & {});
531
+ type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode] | (string & {});
537
532
  /**
538
533
  * Controls how the Data API exposes the OpenAPI documentation endpoint.
539
534
  * Only IGNORE_PRIVILEGES and DISABLED are supported today; "follow-privileges"
540
535
  * is not implemented yet (it may be added later as value 3 — adding new enum
541
536
  * values is backward-compatible).
542
537
  */
543
- export declare const OpenApiMode: {
544
- /** Unspecified; the server applies its default mode. */
545
- readonly OPEN_API_MODE_UNSPECIFIED: "OPEN_API_MODE_UNSPECIFIED";
546
- /** Generate OpenAPI output ignoring the privileges of the requesting role. */
547
- readonly OPEN_API_MODE_IGNORE_PRIVILEGES: "OPEN_API_MODE_IGNORE_PRIVILEGES";
548
- /** Disable the OpenAPI documentation endpoint entirely. */
549
- readonly OPEN_API_MODE_DISABLED: "OPEN_API_MODE_DISABLED";
538
+ declare const OpenApiMode: {
539
+ /** Unspecified; the server applies its default mode. */readonly OPEN_API_MODE_UNSPECIFIED: "OPEN_API_MODE_UNSPECIFIED"; /** Generate OpenAPI output ignoring the privileges of the requesting role. */
540
+ readonly OPEN_API_MODE_IGNORE_PRIVILEGES: "OPEN_API_MODE_IGNORE_PRIVILEGES"; /** Disable the OpenAPI documentation endpoint entirely. */
541
+ readonly OPEN_API_MODE_DISABLED: "OPEN_API_MODE_DISABLED";
550
542
  };
551
- export type OpenApiMode = (typeof OpenApiMode)[keyof typeof OpenApiMode] | (string & {});
543
+ type OpenApiMode = (typeof OpenApiMode)[keyof typeof OpenApiMode] | (string & {});
552
544
  /** The current phase of the data synchronization pipeline. */
553
- export declare const ProvisioningPhase: {
554
- /** The default phase. It should not be reported by any synced tables. */
555
- readonly PROVISIONING_PHASE_UNSPECIFIED: "PROVISIONING_PHASE_UNSPECIFIED";
556
- /** Ingestion phase of the synced table. This is when the synced table is ingesting data from the delta table. */
557
- readonly PROVISIONING_PHASE_MAIN: "PROVISIONING_PHASE_MAIN";
558
- /** Index scan phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
559
- readonly PROVISIONING_PHASE_INDEX_SCAN: "PROVISIONING_PHASE_INDEX_SCAN";
560
- /** Index sort phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
561
- readonly PROVISIONING_PHASE_INDEX_SORT: "PROVISIONING_PHASE_INDEX_SORT";
545
+ declare const ProvisioningPhase: {
546
+ /** The default phase. It should not be reported by any synced tables. */readonly PROVISIONING_PHASE_UNSPECIFIED: "PROVISIONING_PHASE_UNSPECIFIED"; /** Ingestion phase of the synced table. This is when the synced table is ingesting data from the delta table. */
547
+ readonly PROVISIONING_PHASE_MAIN: "PROVISIONING_PHASE_MAIN"; /** Index scan phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
548
+ readonly PROVISIONING_PHASE_INDEX_SCAN: "PROVISIONING_PHASE_INDEX_SCAN"; /** Index sort phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
549
+ readonly PROVISIONING_PHASE_INDEX_SORT: "PROVISIONING_PHASE_INDEX_SORT";
562
550
  };
563
- export type ProvisioningPhase = (typeof ProvisioningPhase)[keyof typeof ProvisioningPhase] | (string & {});
551
+ type ProvisioningPhase = (typeof ProvisioningPhase)[keyof typeof ProvisioningPhase] | (string & {});
564
552
  /** The state of a synced table. */
565
- export declare const SyncedTableState: {
566
- /** The default state. It should not be reported by any synced tables. */
567
- readonly SYNCED_TABLE_STATE_UNSPECIFIED: "SYNCED_TABLE_STATE_UNSPECIFIED";
568
- /**
569
- * The synced table has just been created and resources are being provisioned. This is also the
570
- * catch-all state if there is not a more suitable state to report for the synced table.
571
- */
572
- readonly SYNCED_TABLE_PROVISIONING: "SYNCED_TABLE_PROVISIONING";
573
- /** The synced table is provisioning resources for the data synchronization pipeline. */
574
- readonly SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES: "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES";
575
- /** The synced table is executing the initial data synchronization. */
576
- readonly SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT: "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT";
577
- /** The synced table is ready to serve data. */
578
- readonly SYNCED_TABLE_ONLINE: "SYNCED_TABLE_ONLINE";
579
- /**
580
- * The synced table is ready to serve data and is continuously updating. Only shown for synced
581
- * tables using the "Continuous" sync mode.
582
- */
583
- readonly SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE: "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE";
584
- /**
585
- * The synced table is ready to serve data and an active update is in progress. Only shown for
586
- * synced tables using the "Triggered" sync mode.
587
- */
588
- readonly SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE: "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE";
589
- /**
590
- * The synced table is ready to serve data and there are no active updates. Only shown for synced
591
- * tables using the "Triggered" sync mode.
592
- */
593
- readonly SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE: "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE";
594
- /** The synced table has encountered an internal error and is not available for serving. */
595
- readonly SYNCED_TABLE_OFFLINE: "SYNCED_TABLE_OFFLINE";
596
- /**
597
- * The synced table is not available for serving because the data synchronization pipeline has
598
- * failed. Please review the pipeline event logs to troubleshoot.
599
- */
600
- readonly SYNCED_TABLE_OFFLINE_FAILED: "SYNCED_TABLE_OFFLINE_FAILED";
601
- /**
602
- * The data synchronization pipeline has encountered an error but the synced table is still
603
- * available for serving (potentially stale) data. Please review the pipeline event logs to
604
- * troubleshoot.
605
- */
606
- readonly SYNCED_TABLE_ONLINE_PIPELINE_FAILED: "SYNCED_TABLE_ONLINE_PIPELINE_FAILED";
607
- /**
608
- * The synced table is available for serving, and is provisioning resources for a newly started
609
- * data synchronization pipeline.
610
- */
611
- readonly SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES: "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES";
553
+ declare const SyncedTableState: {
554
+ /** The default state. It should not be reported by any synced tables. */readonly SYNCED_TABLE_STATE_UNSPECIFIED: "SYNCED_TABLE_STATE_UNSPECIFIED";
555
+ /**
556
+ * The synced table has just been created and resources are being provisioned. This is also the
557
+ * catch-all state if there is not a more suitable state to report for the synced table.
558
+ */
559
+ readonly SYNCED_TABLE_PROVISIONING: "SYNCED_TABLE_PROVISIONING"; /** The synced table is provisioning resources for the data synchronization pipeline. */
560
+ readonly SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES: "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES"; /** The synced table is executing the initial data synchronization. */
561
+ readonly SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT: "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT"; /** The synced table is ready to serve data. */
562
+ readonly SYNCED_TABLE_ONLINE: "SYNCED_TABLE_ONLINE";
563
+ /**
564
+ * The synced table is ready to serve data and is continuously updating. Only shown for synced
565
+ * tables using the "Continuous" sync mode.
566
+ */
567
+ readonly SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE: "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE";
568
+ /**
569
+ * The synced table is ready to serve data and an active update is in progress. Only shown for
570
+ * synced tables using the "Triggered" sync mode.
571
+ */
572
+ readonly SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE: "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE";
573
+ /**
574
+ * The synced table is ready to serve data and there are no active updates. Only shown for synced
575
+ * tables using the "Triggered" sync mode.
576
+ */
577
+ readonly SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE: "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE"; /** The synced table has encountered an internal error and is not available for serving. */
578
+ readonly SYNCED_TABLE_OFFLINE: "SYNCED_TABLE_OFFLINE";
579
+ /**
580
+ * The synced table is not available for serving because the data synchronization pipeline has
581
+ * failed. Please review the pipeline event logs to troubleshoot.
582
+ */
583
+ readonly SYNCED_TABLE_OFFLINE_FAILED: "SYNCED_TABLE_OFFLINE_FAILED";
584
+ /**
585
+ * The data synchronization pipeline has encountered an error but the synced table is still
586
+ * available for serving (potentially stale) data. Please review the pipeline event logs to
587
+ * troubleshoot.
588
+ */
589
+ readonly SYNCED_TABLE_ONLINE_PIPELINE_FAILED: "SYNCED_TABLE_ONLINE_PIPELINE_FAILED";
590
+ /**
591
+ * The synced table is available for serving, and is provisioning resources for a newly started
592
+ * data synchronization pipeline.
593
+ */
594
+ readonly SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES: "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES";
612
595
  };
613
- export type SyncedTableState = (typeof SyncedTableState)[keyof typeof SyncedTableState] | (string & {});
596
+ type SyncedTableState = (typeof SyncedTableState)[keyof typeof SyncedTableState] | (string & {});
614
597
  /** The state of the branch. */
615
- export declare const BranchStatus_State: {
616
- /** Default value, not used. */
617
- readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
618
- /** The branch is being created but is not yet available for querying. */
619
- readonly INIT: "INIT";
620
- /** The branch is being imported and is not yet available for querying. */
621
- readonly IMPORTING: "IMPORTING";
622
- /** The branch is being reset to a specific point in time or LSN and is not yet available for querying. */
623
- readonly RESETTING: "RESETTING";
624
- /** The branch is fully operational and ready for querying. */
625
- readonly READY: "READY";
626
- /** The branch is stored in cost-effective archival storage. Expect slow query response times. */
627
- readonly ARCHIVED: "ARCHIVED";
628
- /** The branch is deleted and is not available for querying, but can be undeleted. */
629
- readonly DELETED: "DELETED";
598
+ declare const BranchStatus_State: {
599
+ /** Default value, not used. */readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED"; /** The branch is being created but is not yet available for querying. */
600
+ readonly INIT: "INIT"; /** The branch is being imported and is not yet available for querying. */
601
+ readonly IMPORTING: "IMPORTING"; /** The branch is being reset to a specific point in time or LSN and is not yet available for querying. */
602
+ readonly RESETTING: "RESETTING"; /** The branch is fully operational and ready for querying. */
603
+ readonly READY: "READY"; /** The branch is stored in cost-effective archival storage. Expect slow query response times. */
604
+ readonly ARCHIVED: "ARCHIVED"; /** The branch is deleted and is not available for querying, but can be undeleted. */
605
+ readonly DELETED: "DELETED";
630
606
  };
631
- export type BranchStatus_State = (typeof BranchStatus_State)[keyof typeof BranchStatus_State] | (string & {});
607
+ type BranchStatus_State = (typeof BranchStatus_State)[keyof typeof BranchStatus_State] | (string & {});
632
608
  /** The state of the compute endpoint. */
633
- export declare const EndpointStatus_State: {
634
- /** Default value, not used */
635
- readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
636
- readonly INIT: "INIT";
637
- readonly ACTIVE: "ACTIVE";
638
- readonly IDLE: "IDLE";
639
- readonly DEGRADED: "DEGRADED";
609
+ declare const EndpointStatus_State: {
610
+ /** Default value, not used */readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
611
+ readonly INIT: "INIT";
612
+ readonly ACTIVE: "ACTIVE";
613
+ readonly IDLE: "IDLE";
614
+ readonly DEGRADED: "DEGRADED";
640
615
  };
641
- export type EndpointStatus_State = (typeof EndpointStatus_State)[keyof typeof EndpointStatus_State] | (string & {});
642
- export declare const ProvisioningInfo_State: {
643
- readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
644
- readonly PROVISIONING: "PROVISIONING";
645
- readonly ACTIVE: "ACTIVE";
646
- readonly FAILED: "FAILED";
647
- readonly DELETING: "DELETING";
648
- readonly UPDATING: "UPDATING";
649
- readonly DEGRADED: "DEGRADED";
616
+ type EndpointStatus_State = (typeof EndpointStatus_State)[keyof typeof EndpointStatus_State] | (string & {});
617
+ declare const ProvisioningInfo_State: {
618
+ readonly STATE_UNSPECIFIED: "STATE_UNSPECIFIED";
619
+ readonly PROVISIONING: "PROVISIONING";
620
+ readonly ACTIVE: "ACTIVE";
621
+ readonly FAILED: "FAILED";
622
+ readonly DELETING: "DELETING";
623
+ readonly UPDATING: "UPDATING";
624
+ readonly DEGRADED: "DEGRADED";
650
625
  };
651
- export type ProvisioningInfo_State = (typeof ProvisioningInfo_State)[keyof typeof ProvisioningInfo_State] | (string & {});
652
- export declare const RequestedClaims_PermissionSet: {
653
- readonly PERMISSION_SET_UNSPECIFIED: "PERMISSION_SET_UNSPECIFIED";
654
- readonly READ_ONLY: "READ_ONLY";
626
+ type ProvisioningInfo_State = (typeof ProvisioningInfo_State)[keyof typeof ProvisioningInfo_State] | (string & {});
627
+ declare const RequestedClaims_PermissionSet: {
628
+ readonly PERMISSION_SET_UNSPECIFIED: "PERMISSION_SET_UNSPECIFIED";
629
+ readonly READ_ONLY: "READ_ONLY";
655
630
  };
656
- export type RequestedClaims_PermissionSet = (typeof RequestedClaims_PermissionSet)[keyof typeof RequestedClaims_PermissionSet] | (string & {});
631
+ type RequestedClaims_PermissionSet = (typeof RequestedClaims_PermissionSet)[keyof typeof RequestedClaims_PermissionSet] | (string & {});
657
632
  /** How the role is authenticated when connecting to Postgres. */
658
- export declare const Role_AuthMethod: {
659
- readonly AUTH_METHOD_UNSPECIFIED: "AUTH_METHOD_UNSPECIFIED";
660
- /** NO_LOGIN means this role cannot be used for interactive access */
661
- readonly NO_LOGIN: "NO_LOGIN";
662
- /** PG_PASSWORD_SCRAM_SHA_256 is a password-based authentication */
663
- readonly PG_PASSWORD_SCRAM_SHA_256: "PG_PASSWORD_SCRAM_SHA_256";
664
- /**
665
- * LAKEBASE_OAUTH_V1 is for logging in with the managed identities like
666
- * the <Databricks> service principal, <Databricks> Group or <Databricks> user.
667
- */
668
- readonly LAKEBASE_OAUTH_V1: "LAKEBASE_OAUTH_V1";
633
+ declare const Role_AuthMethod: {
634
+ readonly AUTH_METHOD_UNSPECIFIED: "AUTH_METHOD_UNSPECIFIED"; /** NO_LOGIN means this role cannot be used for interactive access */
635
+ readonly NO_LOGIN: "NO_LOGIN"; /** PG_PASSWORD_SCRAM_SHA_256 is a password-based authentication */
636
+ readonly PG_PASSWORD_SCRAM_SHA_256: "PG_PASSWORD_SCRAM_SHA_256";
637
+ /**
638
+ * LAKEBASE_OAUTH_V1 is for logging in with the managed identities like
639
+ * the <Databricks> service principal, <Databricks> Group or <Databricks> user.
640
+ */
641
+ readonly LAKEBASE_OAUTH_V1: "LAKEBASE_OAUTH_V1";
669
642
  };
670
- export type Role_AuthMethod = (typeof Role_AuthMethod)[keyof typeof Role_AuthMethod] | (string & {});
643
+ type Role_AuthMethod = (typeof Role_AuthMethod)[keyof typeof Role_AuthMethod] | (string & {});
671
644
  /**
672
645
  * The type of the <Databricks> managed identity that this Role represents.
673
646
  * Leave empty if you wish to create a regular Postgres role not associated with a <Databricks> identity.
674
647
  */
675
- export declare const Role_IdentityType: {
676
- /** Default value, not used */
677
- readonly IDENTITY_TYPE_UNSPECIFIED: "IDENTITY_TYPE_UNSPECIFIED";
678
- /** A user in a <Databricks> workspace. */
679
- readonly USER: "USER";
680
- /** A service principal in a <Databricks> workspace. */
681
- readonly SERVICE_PRINCIPAL: "SERVICE_PRINCIPAL";
682
- /** A group in a <Databricks> workspace. */
683
- readonly GROUP: "GROUP";
648
+ declare const Role_IdentityType: {
649
+ /** Default value, not used */readonly IDENTITY_TYPE_UNSPECIFIED: "IDENTITY_TYPE_UNSPECIFIED"; /** A user in a <Databricks> workspace. */
650
+ readonly USER: "USER"; /** A service principal in a <Databricks> workspace. */
651
+ readonly SERVICE_PRINCIPAL: "SERVICE_PRINCIPAL"; /** A group in a <Databricks> workspace. */
652
+ readonly GROUP: "GROUP";
684
653
  };
685
- export type Role_IdentityType = (typeof Role_IdentityType)[keyof typeof Role_IdentityType] | (string & {});
654
+ type Role_IdentityType = (typeof Role_IdentityType)[keyof typeof Role_IdentityType] | (string & {});
686
655
  /** Roles that the DatabaseInstanceRole can be a member of. */
687
- export declare const Role_MembershipRole: {
688
- /** Indicates that the DatabaseInstanceRole is not a member of any standard, managed roles. */
689
- readonly MEMBERSHIP_ROLE_UNSPECIFIED: "MEMBERSHIP_ROLE_UNSPECIFIED";
690
- /** Indicates membership in DATABRICKS_SUPERUSER, the highest set of privileges exposed to customers. */
691
- readonly DATABRICKS_SUPERUSER: "DATABRICKS_SUPERUSER";
656
+ declare const Role_MembershipRole: {
657
+ /** Indicates that the DatabaseInstanceRole is not a member of any standard, managed roles. */readonly MEMBERSHIP_ROLE_UNSPECIFIED: "MEMBERSHIP_ROLE_UNSPECIFIED"; /** Indicates membership in DATABRICKS_SUPERUSER, the highest set of privileges exposed to customers. */
658
+ readonly DATABRICKS_SUPERUSER: "DATABRICKS_SUPERUSER";
692
659
  };
693
- export type Role_MembershipRole = (typeof Role_MembershipRole)[keyof typeof Role_MembershipRole] | (string & {});
660
+ type Role_MembershipRole = (typeof Role_MembershipRole)[keyof typeof Role_MembershipRole] | (string & {});
694
661
  /** How the column's value is populated and kept up to date. */
695
- export declare const SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance: {
696
- /** A plain column with no computed value. */
697
- readonly MAINTENANCE_UNSPECIFIED: "MAINTENANCE_UNSPECIFIED";
698
- /** The value is computed by PostgreSQL and stored. */
699
- readonly STORED_GENERATED: "STORED_GENERATED";
662
+ declare const SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance: {
663
+ /** A plain column with no computed value. */readonly MAINTENANCE_UNSPECIFIED: "MAINTENANCE_UNSPECIFIED"; /** The value is computed by PostgreSQL and stored. */
664
+ readonly STORED_GENERATED: "STORED_GENERATED";
700
665
  };
701
- export type SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance = (typeof SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance)[keyof typeof SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance] | (string & {});
666
+ type SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance = (typeof SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance)[keyof typeof SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance] | (string & {});
702
667
  /** PostgreSQL-specific target types that can override the default Delta-to-PG mapping. */
703
- export declare const SyncedTable_SyncedTableSpec_PgSpecificType: {
704
- /** Default value. Indicates that no type override was selected. */
705
- readonly PG_SPECIFIC_TYPE_UNSPECIFIED: "PG_SPECIFIC_TYPE_UNSPECIFIED";
706
- /** Maps the column to the pgvector vector type. */
707
- readonly PG_SPECIFIC_TYPE_VECTOR: "PG_SPECIFIC_TYPE_VECTOR";
668
+ declare const SyncedTable_SyncedTableSpec_PgSpecificType: {
669
+ /** Default value. Indicates that no type override was selected. */readonly PG_SPECIFIC_TYPE_UNSPECIFIED: "PG_SPECIFIC_TYPE_UNSPECIFIED"; /** Maps the column to the pgvector vector type. */
670
+ readonly PG_SPECIFIC_TYPE_VECTOR: "PG_SPECIFIC_TYPE_VECTOR";
708
671
  };
709
- export type SyncedTable_SyncedTableSpec_PgSpecificType = (typeof SyncedTable_SyncedTableSpec_PgSpecificType)[keyof typeof SyncedTable_SyncedTableSpec_PgSpecificType] | (string & {});
672
+ type SyncedTable_SyncedTableSpec_PgSpecificType = (typeof SyncedTable_SyncedTableSpec_PgSpecificType)[keyof typeof SyncedTable_SyncedTableSpec_PgSpecificType] | (string & {});
710
673
  /** Scheduling policy of the synced table's underlying pipeline. */
711
- export declare const SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy: {
712
- readonly SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED: "SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED";
713
- /**
714
- * Pipeline runs continuously after generating the initial data.
715
- * Requires the source table to have Change Data Feed (CDF) enabled.
716
- */
717
- readonly CONTINUOUS: "CONTINUOUS";
718
- /**
719
- * Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
720
- * Requires the source table to have Change Data Feed (CDF) enabled.
721
- */
722
- readonly TRIGGERED: "TRIGGERED";
723
- /**
724
- * Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
725
- * Successive updates always perform a full copy of the source table data (no incremental updates).
726
- * Does not require the source table to have Change Data Feed (CDF) enabled.
727
- */
728
- readonly SNAPSHOT: "SNAPSHOT";
674
+ declare const SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy: {
675
+ readonly SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED: "SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED";
676
+ /**
677
+ * Pipeline runs continuously after generating the initial data.
678
+ * Requires the source table to have Change Data Feed (CDF) enabled.
679
+ */
680
+ readonly CONTINUOUS: "CONTINUOUS";
681
+ /**
682
+ * Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
683
+ * Requires the source table to have Change Data Feed (CDF) enabled.
684
+ */
685
+ readonly TRIGGERED: "TRIGGERED";
686
+ /**
687
+ * Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
688
+ * Successive updates always perform a full copy of the source table data (no incremental updates).
689
+ * Does not require the source table to have Change Data Feed (CDF) enabled.
690
+ */
691
+ readonly SNAPSHOT: "SNAPSHOT";
729
692
  };
730
- export type SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = (typeof SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy)[keyof typeof SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy] | (string & {});
693
+ type SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = (typeof SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy)[keyof typeof SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy] | (string & {});
731
694
  /** Databricks Error that is returned by all Databricks APIs. */
732
- export interface ApiError {
733
- errorCode?: ErrorCode | undefined;
734
- message?: string | undefined;
735
- stackTrace?: string | undefined;
736
- details?: Record<string, unknown>[] | undefined;
737
- }
738
- export interface Branch {
739
- /**
740
- * Output only. The full resource path of the branch.
741
- * Format: projects/{project_id}/branches/{branch_id}
742
- */
743
- name?: string | undefined;
744
- /** System-generated unique ID for the branch. */
745
- uid?: string | undefined;
746
- /**
747
- * The project containing this branch (API resource hierarchy).
748
- * Format: projects/{project_id}
749
- *
750
- * Note: This field indicates where the branch exists in the resource hierarchy.
751
- * For point-in-time branching from another branch, see `status.source_branch`.
752
- */
753
- parent?: string | undefined;
754
- /** A timestamp indicating when the branch was created. */
755
- createTime?: Temporal.Instant | undefined;
756
- /** A timestamp indicating when the branch was last updated. */
757
- updateTime?: Temporal.Instant | undefined;
758
- /** The spec contains the branch configuration. */
759
- spec?: BranchSpec | undefined;
760
- /** The current status of a Branch. */
761
- status?: BranchStatus | undefined;
762
- /** The part of the name, chosen by the user when the resource was created. */
763
- branchId?: string | undefined;
764
- }
765
- export interface BranchOperationMetadata {
766
- }
767
- export interface BranchSpec {
768
- /**
769
- * The name of the source branch from which this branch was created (data lineage for point-in-time recovery).
770
- * If not specified, defaults to the project's default branch.
771
- * Format: projects/{project_id}/branches/{branch_id}
772
- */
773
- sourceBranch?: string | undefined;
774
- /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
775
- sourceBranchLsn?: string | undefined;
776
- /** The point in time on the source branch from which this branch was created. */
777
- sourceBranchTime?: Temporal.Instant | undefined;
778
- /** When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected. */
779
- isProtected?: boolean | undefined;
780
- /**
781
- * Expiration configuration for the branch. One of expire_time, ttl, or no_expiry must be provided.
782
- * To disable expiration, set no_expiry to true.
783
- *
784
- * When updating this field, use "spec.expiration" in the update_mask.
785
- */
786
- expiration?: {
787
- $case: 'expireTime';
788
- /**
789
- * Absolute expiration timestamp. When set, the branch will expire at this time.
790
- * Mutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
791
- */
792
- expireTime: Temporal.Instant;
793
- } | {
794
- $case: 'ttl';
795
- /**
796
- * Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.
797
- * Mutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
798
- */
799
- ttl: Temporal.Duration;
800
- } | {
801
- $case: 'noExpiry';
802
- /**
803
- * Explicitly disable expiration. When set to true, the branch will not expire.
804
- * If set to false, the request is invalid; provide either ttl or expire_time instead.
805
- * Mutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.
806
- */
807
- noExpiry: boolean;
808
- } | undefined;
809
- }
810
- export interface BranchStatus {
811
- /**
812
- * The name of the source branch from which this branch was created.
813
- * Format: projects/{project_id}/branches/{branch_id}
814
- */
815
- sourceBranch?: string | undefined;
816
- /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
817
- sourceBranchLsn?: string | undefined;
818
- /** The point in time on the source branch from which this branch was created. */
819
- sourceBranchTime?: Temporal.Instant | undefined;
820
- /** Whether the branch is the project's default branch. */
821
- default?: boolean | undefined;
822
- /** Whether the branch is protected. */
823
- isProtected?: boolean | undefined;
824
- /** The branch's state, indicating if it is initializing, ready for use, or archived. */
825
- currentState?: BranchStatus_State | undefined;
826
- /** The pending state of the branch, if a state transition is in progress. */
827
- pendingState?: BranchStatus_State | undefined;
828
- /** A timestamp indicating when the `current_state` began. */
829
- stateChangeTime?: Temporal.Instant | undefined;
830
- /** The logical size of the branch. */
831
- logicalSizeBytes?: bigint | undefined;
832
- /** Absolute expiration time for the branch. Empty if expiration is disabled. */
833
- expireTime?: Temporal.Instant | undefined;
834
- /** Part of the resource name. */
835
- branchId?: string | undefined;
836
- /**
837
- * A timestamp indicating when the branch was deleted.
838
- * Empty if the branch is not deleted.
839
- */
840
- deleteTime?: Temporal.Instant | undefined;
841
- /**
842
- * A timestamp indicating when the branch is scheduled to be purged.
843
- * Empty if the branch is not deleted, otherwise set to a timestamp in the future.
844
- */
845
- purgeTime?: Temporal.Instant | undefined;
846
- }
847
- export interface Catalog {
848
- /**
849
- * Output only. The full resource path of the catalog.
850
- *
851
- * Format: "catalogs/{catalog_id}".
852
- */
853
- name?: string | undefined;
854
- /** System-generated unique identifier for the catalog. */
855
- uid?: string | undefined;
856
- /** The desired state of the Catalog. */
857
- spec?: Catalog_CatalogSpec | undefined;
858
- /** The observed state of the Catalog. */
859
- status?: Catalog_CatalogStatus | undefined;
860
- /** A timestamp indicating when the catalog was created. */
861
- createTime?: Temporal.Instant | undefined;
862
- /** A timestamp indicating when the catalog was last updated. */
863
- updateTime?: Temporal.Instant | undefined;
864
- /** The part of the name, chosen by the user when the resource was created. */
865
- catalogId?: string | undefined;
695
+ interface ApiError {
696
+ errorCode?: ErrorCode | undefined;
697
+ message?: string | undefined;
698
+ stackTrace?: string | undefined;
699
+ details?: Record<string, unknown>[] | undefined;
700
+ }
701
+ interface Branch {
702
+ /**
703
+ * Output only. The full resource path of the branch.
704
+ * Format: projects/{project_id}/branches/{branch_id}
705
+ */
706
+ name?: string | undefined;
707
+ /** System-generated unique ID for the branch. */
708
+ uid?: string | undefined;
709
+ /**
710
+ * The project containing this branch (API resource hierarchy).
711
+ * Format: projects/{project_id}
712
+ *
713
+ * Note: This field indicates where the branch exists in the resource hierarchy.
714
+ * For point-in-time branching from another branch, see `status.source_branch`.
715
+ */
716
+ parent?: string | undefined;
717
+ /** A timestamp indicating when the branch was created. */
718
+ createTime?: Temporal.Instant | undefined;
719
+ /** A timestamp indicating when the branch was last updated. */
720
+ updateTime?: Temporal.Instant | undefined;
721
+ /** The spec contains the branch configuration. */
722
+ spec?: BranchSpec | undefined;
723
+ /** The current status of a Branch. */
724
+ status?: BranchStatus | undefined;
725
+ /** The part of the name, chosen by the user when the resource was created. */
726
+ branchId?: string | undefined;
727
+ }
728
+ interface BranchOperationMetadata {}
729
+ interface BranchSpec {
730
+ /**
731
+ * The name of the source branch from which this branch was created (data lineage for point-in-time recovery).
732
+ * If not specified, defaults to the project's default branch.
733
+ * Format: projects/{project_id}/branches/{branch_id}
734
+ */
735
+ sourceBranch?: string | undefined;
736
+ /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
737
+ sourceBranchLsn?: string | undefined;
738
+ /** The point in time on the source branch from which this branch was created. */
739
+ sourceBranchTime?: Temporal.Instant | undefined;
740
+ /** When set to true, protects the branch from deletion and reset. Associated compute endpoints and the project cannot be deleted while the branch is protected. */
741
+ isProtected?: boolean | undefined;
742
+ /**
743
+ * Expiration configuration for the branch. One of expire_time, ttl, or no_expiry must be provided.
744
+ * To disable expiration, set no_expiry to true.
745
+ *
746
+ * When updating this field, use "spec.expiration" in the update_mask.
747
+ */
748
+ expiration?: {
749
+ $case: 'expireTime';
750
+ /**
751
+ * Absolute expiration timestamp. When set, the branch will expire at this time.
752
+ * Mutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
753
+ */
754
+ expireTime: Temporal.Instant;
755
+ } | {
756
+ $case: 'ttl';
757
+ /**
758
+ * Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.
759
+ * Mutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
760
+ */
761
+ ttl: Temporal.Duration;
762
+ } | {
763
+ $case: 'noExpiry';
764
+ /**
765
+ * Explicitly disable expiration. When set to true, the branch will not expire.
766
+ * If set to false, the request is invalid; provide either ttl or expire_time instead.
767
+ * Mutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.
768
+ */
769
+ noExpiry: boolean;
770
+ } | undefined;
771
+ }
772
+ interface BranchStatus {
773
+ /**
774
+ * The name of the source branch from which this branch was created.
775
+ * Format: projects/{project_id}/branches/{branch_id}
776
+ */
777
+ sourceBranch?: string | undefined;
778
+ /** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
779
+ sourceBranchLsn?: string | undefined;
780
+ /** The point in time on the source branch from which this branch was created. */
781
+ sourceBranchTime?: Temporal.Instant | undefined;
782
+ /** Whether the branch is the project's default branch. */
783
+ default?: boolean | undefined;
784
+ /** Whether the branch is protected. */
785
+ isProtected?: boolean | undefined;
786
+ /** The branch's state, indicating if it is initializing, ready for use, or archived. */
787
+ currentState?: BranchStatus_State | undefined;
788
+ /** The pending state of the branch, if a state transition is in progress. */
789
+ pendingState?: BranchStatus_State | undefined;
790
+ /** A timestamp indicating when the `current_state` began. */
791
+ stateChangeTime?: Temporal.Instant | undefined;
792
+ /** The logical size of the branch. */
793
+ logicalSizeBytes?: bigint | undefined;
794
+ /** Absolute expiration time for the branch. Empty if expiration is disabled. */
795
+ expireTime?: Temporal.Instant | undefined;
796
+ /** Part of the resource name. */
797
+ branchId?: string | undefined;
798
+ /**
799
+ * A timestamp indicating when the branch was deleted.
800
+ * Empty if the branch is not deleted.
801
+ */
802
+ deleteTime?: Temporal.Instant | undefined;
803
+ /**
804
+ * A timestamp indicating when the branch is scheduled to be purged.
805
+ * Empty if the branch is not deleted, otherwise set to a timestamp in the future.
806
+ */
807
+ purgeTime?: Temporal.Instant | undefined;
808
+ }
809
+ interface Catalog {
810
+ /**
811
+ * Output only. The full resource path of the catalog.
812
+ *
813
+ * Format: "catalogs/{catalog_id}".
814
+ */
815
+ name?: string | undefined;
816
+ /** System-generated unique identifier for the catalog. */
817
+ uid?: string | undefined;
818
+ /** The desired state of the Catalog. */
819
+ spec?: Catalog_CatalogSpec | undefined;
820
+ /** The observed state of the Catalog. */
821
+ status?: Catalog_CatalogStatus | undefined;
822
+ /** A timestamp indicating when the catalog was created. */
823
+ createTime?: Temporal.Instant | undefined;
824
+ /** A timestamp indicating when the catalog was last updated. */
825
+ updateTime?: Temporal.Instant | undefined;
826
+ /** The part of the name, chosen by the user when the resource was created. */
827
+ catalogId?: string | undefined;
866
828
  }
867
829
  /** The desired state of the Catalog. */
868
- export interface Catalog_CatalogSpec {
869
- /**
870
- * The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.
871
- * This database must already exist, unless create_database_if_missing is set to true on creation.
872
- *
873
- * A database can only be registered with one UC catalog at a time.
874
- * To re-register a database with a different catalog, the existing catalog must be deleted first.
875
- *
876
- * A child branch inherits the fact of parent's registration. This means the same-named database
877
- * in a child branch cannot be registered with a second catalog
878
- * while the parent's registration exists. To allow registering the database of a child branch,
879
- * drop and recreate the database on the child branch.
880
- * This removes the fact of parent's registration from this branch only.
881
- *
882
- * Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered
883
- * in the Catalog drops the fact of registration of the database. So the user should avoid doing so.
884
- */
885
- postgresDatabase?: string | undefined;
886
- /**
887
- * If set to true, the specified postgres_database is created on behalf of the calling user
888
- * if it does not already exist. In this case, the calling user has a role created for
889
- * them in Postgres if they do not already have one.
890
- *
891
- * Defaults to false, meaning that the request fails if the specified postgres_database does not already exist.
892
- */
893
- createDatabaseIfMissing?: boolean | undefined;
894
- /**
895
- * The resource path of the branch associated with the catalog.
896
- *
897
- * Format: projects/{project_id}/branches/{branch_id}.
898
- */
899
- branch?: string | undefined;
830
+ interface Catalog_CatalogSpec {
831
+ /**
832
+ * The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.
833
+ * This database must already exist, unless create_database_if_missing is set to true on creation.
834
+ *
835
+ * A database can only be registered with one UC catalog at a time.
836
+ * To re-register a database with a different catalog, the existing catalog must be deleted first.
837
+ *
838
+ * A child branch inherits the fact of parent's registration. This means the same-named database
839
+ * in a child branch cannot be registered with a second catalog
840
+ * while the parent's registration exists. To allow registering the database of a child branch,
841
+ * drop and recreate the database on the child branch.
842
+ * This removes the fact of parent's registration from this branch only.
843
+ *
844
+ * Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered
845
+ * in the Catalog drops the fact of registration of the database. So the user should avoid doing so.
846
+ */
847
+ postgresDatabase?: string | undefined;
848
+ /**
849
+ * If set to true, the specified postgres_database is created on behalf of the calling user
850
+ * if it does not already exist. In this case, the calling user has a role created for
851
+ * them in Postgres if they do not already have one.
852
+ *
853
+ * Defaults to false, meaning that the request fails if the specified postgres_database does not already exist.
854
+ */
855
+ createDatabaseIfMissing?: boolean | undefined;
856
+ /**
857
+ * The resource path of the branch associated with the catalog.
858
+ *
859
+ * Format: projects/{project_id}/branches/{branch_id}.
860
+ */
861
+ branch?: string | undefined;
900
862
  }
901
863
  /** The observed state of the Catalog. */
902
- export interface Catalog_CatalogStatus {
903
- /** The name of the Postgres database associated with the catalog. */
904
- postgresDatabase?: string | undefined;
905
- /**
906
- * The resource path of the project associated with the catalog.
907
- *
908
- * Format: projects/{project_id}.
909
- */
910
- project?: string | undefined;
911
- /**
912
- * The resource path of the branch associated with the catalog.
913
- *
914
- * Format: projects/{project_id}/branches/{branch_id}.
915
- */
916
- branch?: string | undefined;
917
- }
918
- export interface CatalogOperationMetadata {
919
- }
864
+ interface Catalog_CatalogStatus {
865
+ /** The name of the Postgres database associated with the catalog. */
866
+ postgresDatabase?: string | undefined;
867
+ /**
868
+ * The resource path of the project associated with the catalog.
869
+ *
870
+ * Format: projects/{project_id}.
871
+ */
872
+ project?: string | undefined;
873
+ /**
874
+ * The resource path of the branch associated with the catalog.
875
+ *
876
+ * Format: projects/{project_id}/branches/{branch_id}.
877
+ */
878
+ branch?: string | undefined;
879
+ }
880
+ interface CatalogOperationMetadata {}
920
881
  /**
921
882
  * A Lakebase CDF configuration (CdfConfig): one per Postgres schema per
922
883
  * database, replicating that schema's tables into a Unity Catalog schema.
923
884
  * Immutable once created.
924
885
  */
925
- export interface CdfConfig {
926
- /**
927
- * Output only. The full resource name of the CdfConfig.
928
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
929
- */
930
- name?: string | undefined;
931
- /**
932
- * The Unity Catalog catalog that replicated tables are written into.
933
- * Set at creation; the CdfConfig is immutable.
934
- */
935
- catalog?: string | undefined;
936
- /**
937
- * The Unity Catalog schema that replicated tables are written into.
938
- * Set at creation; the CdfConfig is immutable.
939
- */
940
- schema?: string | undefined;
941
- /** When the CdfConfig was created. */
942
- createTime?: Temporal.Instant | undefined;
943
- /**
944
- * The user-specified id; equals the final segment of `name`. Defaults to the
945
- * Postgres schema name for configs without an explicit id.
946
- */
947
- cdfConfigId?: string | undefined;
948
- /**
949
- * The Postgres schema this CdfConfig replicates from. Unique within the
950
- * parent database. Set at creation; the CdfConfig is immutable.
951
- */
952
- postgresSchema?: string | undefined;
886
+ interface CdfConfig {
887
+ /**
888
+ * Output only. The full resource name of the CdfConfig.
889
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
890
+ */
891
+ name?: string | undefined;
892
+ /**
893
+ * The Unity Catalog catalog that replicated tables are written into.
894
+ * Set at creation; the CdfConfig is immutable.
895
+ */
896
+ catalog?: string | undefined;
897
+ /**
898
+ * The Unity Catalog schema that replicated tables are written into.
899
+ * Set at creation; the CdfConfig is immutable.
900
+ */
901
+ schema?: string | undefined;
902
+ /** When the CdfConfig was created. */
903
+ createTime?: Temporal.Instant | undefined;
904
+ /**
905
+ * The user-specified id; equals the final segment of `name`. Defaults to the
906
+ * Postgres schema name for configs without an explicit id.
907
+ */
908
+ cdfConfigId?: string | undefined;
909
+ /**
910
+ * The Postgres schema this CdfConfig replicates from. Unique within the
911
+ * parent database. Set at creation; the CdfConfig is immutable.
912
+ */
913
+ postgresSchema?: string | undefined;
953
914
  }
954
915
  /**
955
916
  * Metadata for CdfConfig long-running operations. Intentionally empty today;
956
917
  * fields (e.g. progress) may be added as the operation contract grows.
957
918
  */
958
- export interface CdfConfigOperationMetadata {
959
- }
919
+ interface CdfConfigOperationMetadata {}
960
920
  /**
961
921
  * The read-only replication status of a single Postgres table replicated
962
922
  * under a CdfConfig. One status exists per replicated table.
963
923
  * It is created automatically and cannot be modified.
964
924
  */
965
- export interface CdfStatus {
966
- /**
967
- * Output only. The full resource name of the CdfStatus.
968
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
969
- * The {cdf_status} segment is the Postgres table name.
970
- */
971
- name?: string | undefined;
972
- /** The Postgres table being replicated. */
973
- postgresTable?: string | undefined;
974
- /** The Unity Catalog table receiving replicated data. */
975
- ucTable?: string | undefined;
976
- /** The current replication state of this table. */
977
- state?: CdfState | undefined;
978
- /** The high-watermark Log Sequence Number (LSN) committed to Delta Lake. */
979
- committedLsn?: string | undefined;
980
- /** The last time changes for this table were written to Delta Lake. */
981
- lastSyncTime?: Temporal.Instant | undefined;
982
- /** When replication for this table was first established. */
983
- createTime?: Temporal.Instant | undefined;
984
- /**
985
- * Human-readable detail for the current state (e.g. the skip/error reason).
986
- * Empty for healthy states.
987
- */
988
- statusDetail?: string | undefined;
989
- }
990
- export interface CreateBranchRequest {
991
- /**
992
- * The Project where this Branch will be created.
993
- * Format: projects/{project_id}
994
- */
995
- parent?: string | undefined;
996
- /**
997
- * The ID to use for the Branch. This becomes the final component of the branch's resource name.
998
- * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
999
- * For example, `development` becomes `projects/my-app/branches/development`.
1000
- */
1001
- branchId?: string | undefined;
1002
- /** The Branch to create. */
1003
- branch?: Branch | undefined;
1004
- /** If true, update the branch if it already exists instead of returning an error. */
1005
- replaceExisting?: boolean | undefined;
1006
- }
1007
- export interface CreateCatalogRequest {
1008
- /**
1009
- * The ID in the Unity Catalog.
1010
- * It becomes the full resource name, for example "my_catalog" becomes "catalogs/my_catalog".
1011
- */
1012
- catalogId?: string | undefined;
1013
- catalog?: Catalog | undefined;
925
+ interface CdfStatus {
926
+ /**
927
+ * Output only. The full resource name of the CdfStatus.
928
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
929
+ * The {cdf_status} segment is the Postgres table name.
930
+ */
931
+ name?: string | undefined;
932
+ /** The Postgres table being replicated. */
933
+ postgresTable?: string | undefined;
934
+ /** The Unity Catalog table receiving replicated data. */
935
+ ucTable?: string | undefined;
936
+ /** The current replication state of this table. */
937
+ state?: CdfState | undefined;
938
+ /** The high-watermark Log Sequence Number (LSN) committed to Delta Lake. */
939
+ committedLsn?: string | undefined;
940
+ /** The last time changes for this table were written to Delta Lake. */
941
+ lastSyncTime?: Temporal.Instant | undefined;
942
+ /** When replication for this table was first established. */
943
+ createTime?: Temporal.Instant | undefined;
944
+ /**
945
+ * Human-readable detail for the current state (e.g. the skip/error reason).
946
+ * Empty for healthy states.
947
+ */
948
+ statusDetail?: string | undefined;
949
+ }
950
+ interface CreateBranchRequest {
951
+ /**
952
+ * The Project where this Branch will be created.
953
+ * Format: projects/{project_id}
954
+ */
955
+ parent?: string | undefined;
956
+ /**
957
+ * The ID to use for the Branch. This becomes the final component of the branch's resource name.
958
+ * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
959
+ * For example, `development` becomes `projects/my-app/branches/development`.
960
+ */
961
+ branchId?: string | undefined;
962
+ /** The Branch to create. */
963
+ branch?: Branch | undefined;
964
+ /** If true, update the branch if it already exists instead of returning an error. */
965
+ replaceExisting?: boolean | undefined;
966
+ }
967
+ interface CreateCatalogRequest {
968
+ /**
969
+ * The ID in the Unity Catalog.
970
+ * It becomes the full resource name, for example "my_catalog" becomes "catalogs/my_catalog".
971
+ */
972
+ catalogId?: string | undefined;
973
+ catalog?: Catalog | undefined;
1014
974
  }
1015
975
  /** Request to create a Lakebase CDF configuration (CdfConfig). */
1016
- export interface CreateCdfConfigRequest {
1017
- /**
1018
- * The parent database under which to create the CdfConfig.
1019
- * Format: projects/{project}/branches/{branch}/databases/{database}
1020
- */
1021
- parent?: string | undefined;
1022
- /**
1023
- * The CdfConfig to create. The catalog, schema, and postgres_schema fields are
1024
- * required; all other fields are output only and ignored on input.
1025
- */
1026
- cdfConfig?: CdfConfig | undefined;
1027
- /**
1028
- * The user-specified id for the CdfConfig, forming the final segment of its
1029
- * resource name. Must match the pattern `[a-z][a-z0-9_]{0,62}`. Defaults to
1030
- * the Postgres schema name when omitted.
1031
- */
1032
- cdfConfigId?: string | undefined;
976
+ interface CreateCdfConfigRequest {
977
+ /**
978
+ * The parent database under which to create the CdfConfig.
979
+ * Format: projects/{project}/branches/{branch}/databases/{database}
980
+ */
981
+ parent?: string | undefined;
982
+ /**
983
+ * The CdfConfig to create. The catalog, schema, and postgres_schema fields are
984
+ * required; all other fields are output only and ignored on input.
985
+ */
986
+ cdfConfig?: CdfConfig | undefined;
987
+ /**
988
+ * The user-specified id for the CdfConfig, forming the final segment of its
989
+ * resource name. Must match the pattern `[a-z][a-z0-9_]{0,62}`. Defaults to
990
+ * the Postgres schema name when omitted.
991
+ */
992
+ cdfConfigId?: string | undefined;
1033
993
  }
1034
994
  /** Enable Data API for a database. */
1035
- export interface CreateDataApiRequest {
1036
- /** Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id} */
1037
- parent?: string | undefined;
1038
- /** The Data API configuration to create. */
1039
- dataApi?: DataApi | undefined;
1040
- }
1041
- export interface CreateDatabaseRequest {
1042
- /**
1043
- * The Branch where this Database will be created.
1044
- * Format: projects/{project_id}/branches/{branch_id}
1045
- */
1046
- parent?: string | undefined;
1047
- /**
1048
- * The ID to use for the Database, which will become the final component of
1049
- * the database's resource name.
1050
- * This ID becomes the database name in postgres.
1051
- *
1052
- * This value should be 4-63 characters, and only use characters available in DNS names,
1053
- * as defined by RFC-1123
1054
- *
1055
- * If database_id is not specified in the request, it is generated automatically.
1056
- */
1057
- databaseId?: string | undefined;
1058
- /** The desired specification of a Database. */
1059
- database?: Database | undefined;
1060
- /**
1061
- * If true, update the database if it already exists instead of returning an
1062
- * error.
1063
- */
1064
- replaceExisting?: boolean | undefined;
1065
- }
1066
- export interface CreateEndpointRequest {
1067
- /**
1068
- * The Branch where this Endpoint will be created.
1069
- * Format: projects/{project_id}/branches/{branch_id}
1070
- */
1071
- parent?: string | undefined;
1072
- /**
1073
- * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
1074
- * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
1075
- * For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.
1076
- */
1077
- endpointId?: string | undefined;
1078
- /** The Endpoint to create. */
1079
- endpoint?: Endpoint | undefined;
1080
- /** If true, update the endpoint if it already exists instead of returning an error. */
1081
- replaceExisting?: boolean | undefined;
1082
- }
1083
- export interface CreateProjectRequest {
1084
- /**
1085
- * The ID to use for the Project. This becomes the final component of the project's resource name.
1086
- * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
1087
- * For example, `my-app` becomes `projects/my-app`.
1088
- */
1089
- projectId?: string | undefined;
1090
- /** The Project to create. */
1091
- project?: Project | undefined;
1092
- }
1093
- export interface CreateRoleRequest {
1094
- /**
1095
- * The Branch where this Role is created.
1096
- * Format: projects/{project_id}/branches/{branch_id}
1097
- */
1098
- parent?: string | undefined;
1099
- /**
1100
- * The ID to use for the Role, which will become the final component of
1101
- * the role's resource name.
1102
- * This ID becomes the role in Postgres.
1103
- *
1104
- * This value should be 4-63 characters, and valid characters
1105
- * are lowercase letters, numbers, and hyphens, as defined by RFC 1123.
1106
- *
1107
- * If role_id is not specified in the request, it is generated automatically.
1108
- */
1109
- roleId?: string | undefined;
1110
- /** The desired specification of a Role. */
1111
- role?: Role | undefined;
1112
- /**
1113
- * If true, update the role if it already exists instead of returning an
1114
- * error.
1115
- *
1116
- * When the role already exists, the provided `role` spec fully replaces the
1117
- * existing one: `membership_roles` is overwritten, not merged. Leaving
1118
- * `membership_roles` empty clears all of the role's existing memberships,
1119
- * including `DATABRICKS_SUPERUSER`. Always send the complete desired list of
1120
- * memberships when using this field.
1121
- */
1122
- replaceExisting?: boolean | undefined;
995
+ interface CreateDataApiRequest {
996
+ /** Parent database: projects/{project_id}/branches/{branch_id}/databases/{database_id} */
997
+ parent?: string | undefined;
998
+ /** The Data API configuration to create. */
999
+ dataApi?: DataApi | undefined;
1000
+ }
1001
+ interface CreateDatabaseRequest {
1002
+ /**
1003
+ * The Branch where this Database will be created.
1004
+ * Format: projects/{project_id}/branches/{branch_id}
1005
+ */
1006
+ parent?: string | undefined;
1007
+ /**
1008
+ * The ID to use for the Database, which will become the final component of
1009
+ * the database's resource name.
1010
+ * This ID becomes the database name in postgres.
1011
+ *
1012
+ * This value should be 4-63 characters, and only use characters available in DNS names,
1013
+ * as defined by RFC-1123
1014
+ *
1015
+ * If database_id is not specified in the request, it is generated automatically.
1016
+ */
1017
+ databaseId?: string | undefined;
1018
+ /** The desired specification of a Database. */
1019
+ database?: Database | undefined;
1020
+ /**
1021
+ * If true, update the database if it already exists instead of returning an
1022
+ * error.
1023
+ */
1024
+ replaceExisting?: boolean | undefined;
1025
+ }
1026
+ interface CreateEndpointRequest {
1027
+ /**
1028
+ * The Branch where this Endpoint will be created.
1029
+ * Format: projects/{project_id}/branches/{branch_id}
1030
+ */
1031
+ parent?: string | undefined;
1032
+ /**
1033
+ * The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
1034
+ * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
1035
+ * For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.
1036
+ */
1037
+ endpointId?: string | undefined;
1038
+ /** The Endpoint to create. */
1039
+ endpoint?: Endpoint | undefined;
1040
+ /** If true, update the endpoint if it already exists instead of returning an error. */
1041
+ replaceExisting?: boolean | undefined;
1042
+ }
1043
+ interface CreateProjectRequest {
1044
+ /**
1045
+ * The ID to use for the Project. This becomes the final component of the project's resource name.
1046
+ * The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
1047
+ * For example, `my-app` becomes `projects/my-app`.
1048
+ */
1049
+ projectId?: string | undefined;
1050
+ /** The Project to create. */
1051
+ project?: Project | undefined;
1052
+ }
1053
+ interface CreateRoleRequest {
1054
+ /**
1055
+ * The Branch where this Role is created.
1056
+ * Format: projects/{project_id}/branches/{branch_id}
1057
+ */
1058
+ parent?: string | undefined;
1059
+ /**
1060
+ * The ID to use for the Role, which will become the final component of
1061
+ * the role's resource name.
1062
+ * This ID becomes the role in Postgres.
1063
+ *
1064
+ * This value should be 4-63 characters, and valid characters
1065
+ * are lowercase letters, numbers, and hyphens, as defined by RFC 1123.
1066
+ *
1067
+ * If role_id is not specified in the request, it is generated automatically.
1068
+ */
1069
+ roleId?: string | undefined;
1070
+ /** The desired specification of a Role. */
1071
+ role?: Role | undefined;
1072
+ /**
1073
+ * If true, update the role if it already exists instead of returning an
1074
+ * error.
1075
+ *
1076
+ * When the role already exists, the provided `role` spec fully replaces the
1077
+ * existing one: `membership_roles` is overwritten, not merged. Leaving
1078
+ * `membership_roles` empty clears all of the role's existing memberships,
1079
+ * including `DATABRICKS_SUPERUSER`. Always send the complete desired list of
1080
+ * memberships when using this field.
1081
+ */
1082
+ replaceExisting?: boolean | undefined;
1123
1083
  }
1124
1084
  /** Establish a synchronisation to the Postgres database for Reverse ETL for the source table selected from the Unity Catalog. */
1125
- export interface CreateSyncedTableRequest {
1126
- /**
1127
- * The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.
1128
- * ID is required and is the synced table name, containing (catalog, schema, table) tuple.
1129
- * Elements of the tuple are the UC entity names.
1130
- *
1131
- * Example: "{catalog}.{schema}.{table}"
1132
- *
1133
- * synced_table_id represents both of the following:
1134
- *
1135
- * 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.
1136
- * 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database
1137
- */
1138
- syncedTableId?: string | undefined;
1139
- syncedTable?: SyncedTable | undefined;
1085
+ interface CreateSyncedTableRequest {
1086
+ /**
1087
+ * The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.
1088
+ * ID is required and is the synced table name, containing (catalog, schema, table) tuple.
1089
+ * Elements of the tuple are the UC entity names.
1090
+ *
1091
+ * Example: "{catalog}.{schema}.{table}"
1092
+ *
1093
+ * synced_table_id represents both of the following:
1094
+ *
1095
+ * 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.
1096
+ * 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database
1097
+ */
1098
+ syncedTableId?: string | undefined;
1099
+ syncedTable?: SyncedTable | undefined;
1140
1100
  }
1141
1101
  /**
1142
1102
  * DataApi represents the Data API (PostgREST) configuration for a Database.
1143
1103
  * At most one DataApi per database. Create enables Data API, Delete disables it.
1144
1104
  */
1145
- export interface DataApi {
1146
- /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1147
- name?: string | undefined;
1148
- /**
1149
- * The database containing this Data API configuration.
1150
- * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1151
- */
1152
- parent?: string | undefined;
1153
- /** A timestamp indicating when the Data API was first enabled. */
1154
- createTime?: Temporal.Instant | undefined;
1155
- /** A timestamp indicating when the Data API configuration was last updated. */
1156
- updateTime?: Temporal.Instant | undefined;
1157
- /** The desired Data API configuration. */
1158
- spec?: DataApi_DataApiSpec | undefined;
1159
- /** The observed Data API state (read-only). */
1160
- status?: DataApi_DataApiStatus | undefined;
1105
+ interface DataApi {
1106
+ /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1107
+ name?: string | undefined;
1108
+ /**
1109
+ * The database containing this Data API configuration.
1110
+ * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1111
+ */
1112
+ parent?: string | undefined;
1113
+ /** A timestamp indicating when the Data API was first enabled. */
1114
+ createTime?: Temporal.Instant | undefined;
1115
+ /** A timestamp indicating when the Data API configuration was last updated. */
1116
+ updateTime?: Temporal.Instant | undefined;
1117
+ /** The desired Data API configuration. */
1118
+ spec?: DataApi_DataApiSpec | undefined;
1119
+ /** The observed Data API state (read-only). */
1120
+ status?: DataApi_DataApiStatus | undefined;
1161
1121
  }
1162
1122
  /** Desired PostgREST configuration (input). */
1163
- export interface DataApi_DataApiSpec {
1164
- /**
1165
- * Enable aggregate functions (count, sum, avg, etc.) in Data API responses.
1166
- * Default: true.
1167
- */
1168
- dbAggregatesEnabled?: boolean | undefined;
1169
- /**
1170
- * Additional schemas to include in the PostgreSQL search path.
1171
- * Each entry must be a valid PostgreSQL schema name.
1172
- */
1173
- dbExtraSearchPath?: string[] | undefined;
1174
- /**
1175
- * Maximum number of rows returned in a single Data API response.
1176
- * Must be a positive integer.
1177
- */
1178
- dbMaxRows?: number | undefined;
1179
- /**
1180
- * Database schemas exposed through the Data API.
1181
- * Each entry must be a valid PostgreSQL schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*).
1182
- * Maximum 100 entries. Default: ["public"].
1183
- */
1184
- dbSchemas?: string[] | undefined;
1185
- /**
1186
- * JSON path to the role claim in JWT tokens (e.g., ".sub").
1187
- * Default: ".sub".
1188
- */
1189
- jwtRoleClaimKey?: string | undefined;
1190
- /** Maximum lifetime for cached JWT tokens. Zero duration disables caching. */
1191
- jwtCacheMaxLifetime?: Temporal.Duration | undefined;
1192
- /** OpenAPI documentation mode for the Data API endpoint. */
1193
- openapiMode?: OpenApiMode | undefined;
1194
- /**
1195
- * Allowed origins for CORS requests.
1196
- * Each entry should be a valid origin URL, or use "*" to allow all origins.
1197
- */
1198
- serverCorsAllowedOrigins?: string[] | undefined;
1199
- /** Enable the Server-Timing header in Data API responses. */
1200
- serverTimingEnabled?: boolean | undefined;
1123
+ interface DataApi_DataApiSpec {
1124
+ /**
1125
+ * Enable aggregate functions (count, sum, avg, etc.) in Data API responses.
1126
+ * Default: true.
1127
+ */
1128
+ dbAggregatesEnabled?: boolean | undefined;
1129
+ /**
1130
+ * Additional schemas to include in the PostgreSQL search path.
1131
+ * Each entry must be a valid PostgreSQL schema name.
1132
+ */
1133
+ dbExtraSearchPath?: string[] | undefined;
1134
+ /**
1135
+ * Maximum number of rows returned in a single Data API response.
1136
+ * Must be a positive integer.
1137
+ */
1138
+ dbMaxRows?: number | undefined;
1139
+ /**
1140
+ * Database schemas exposed through the Data API.
1141
+ * Each entry must be a valid PostgreSQL schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*).
1142
+ * Maximum 100 entries. Default: ["public"].
1143
+ */
1144
+ dbSchemas?: string[] | undefined;
1145
+ /**
1146
+ * JSON path to the role claim in JWT tokens (e.g., ".sub").
1147
+ * Default: ".sub".
1148
+ */
1149
+ jwtRoleClaimKey?: string | undefined;
1150
+ /** Maximum lifetime for cached JWT tokens. Zero duration disables caching. */
1151
+ jwtCacheMaxLifetime?: Temporal.Duration | undefined;
1152
+ /** OpenAPI documentation mode for the Data API endpoint. */
1153
+ openapiMode?: OpenApiMode | undefined;
1154
+ /**
1155
+ * Allowed origins for CORS requests.
1156
+ * Each entry should be a valid origin URL, or use "*" to allow all origins.
1157
+ */
1158
+ serverCorsAllowedOrigins?: string[] | undefined;
1159
+ /** Enable the Server-Timing header in Data API responses. */
1160
+ serverTimingEnabled?: boolean | undefined;
1201
1161
  }
1202
1162
  /** Observed state (output-only). */
1203
- export interface DataApi_DataApiStatus {
1204
- /** Actual aggregate function setting read from the database. */
1205
- dbAggregatesEnabled?: boolean | undefined;
1206
- /** Actual extra search path schemas read from the database. */
1207
- dbExtraSearchPath?: string[] | undefined;
1208
- /** Actual max rows setting read from the database. */
1209
- dbMaxRows?: number | undefined;
1210
- /** Actual exposed schemas read from the database. */
1211
- dbSchemas?: string[] | undefined;
1212
- /** Actual JWT role claim key read from the database. */
1213
- jwtRoleClaimKey?: string | undefined;
1214
- /** Actual JWT cache max lifetime read from the database. */
1215
- jwtCacheMaxLifetime?: Temporal.Duration | undefined;
1216
- /** Actual OpenAPI mode read from the database. */
1217
- openapiMode?: OpenApiMode | undefined;
1218
- /** Actual CORS allowed origins read from the database. */
1219
- serverCorsAllowedOrigins?: string[] | undefined;
1220
- /** Actual Server-Timing header setting read from the database. */
1221
- serverTimingEnabled?: boolean | undefined;
1222
- /** Data API endpoint URL. */
1223
- url?: string | undefined;
1224
- /** Schemas available in the database (for reference when configuring db_schemas). */
1225
- availableSchemas?: string[] | undefined;
1226
- }
1227
- export interface DataApiOperationMetadata {
1228
- }
1163
+ interface DataApi_DataApiStatus {
1164
+ /** Actual aggregate function setting read from the database. */
1165
+ dbAggregatesEnabled?: boolean | undefined;
1166
+ /** Actual extra search path schemas read from the database. */
1167
+ dbExtraSearchPath?: string[] | undefined;
1168
+ /** Actual max rows setting read from the database. */
1169
+ dbMaxRows?: number | undefined;
1170
+ /** Actual exposed schemas read from the database. */
1171
+ dbSchemas?: string[] | undefined;
1172
+ /** Actual JWT role claim key read from the database. */
1173
+ jwtRoleClaimKey?: string | undefined;
1174
+ /** Actual JWT cache max lifetime read from the database. */
1175
+ jwtCacheMaxLifetime?: Temporal.Duration | undefined;
1176
+ /** Actual OpenAPI mode read from the database. */
1177
+ openapiMode?: OpenApiMode | undefined;
1178
+ /** Actual CORS allowed origins read from the database. */
1179
+ serverCorsAllowedOrigins?: string[] | undefined;
1180
+ /** Actual Server-Timing header setting read from the database. */
1181
+ serverTimingEnabled?: boolean | undefined;
1182
+ /** Data API endpoint URL. */
1183
+ url?: string | undefined;
1184
+ /** Schemas available in the database (for reference when configuring db_schemas). */
1185
+ availableSchemas?: string[] | undefined;
1186
+ }
1187
+ interface DataApiOperationMetadata {}
1229
1188
  /** Database represents a Postgres database within a Branch. */
1230
- export interface Database {
1231
- /**
1232
- * The resource name of the database.
1233
- * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1234
- */
1235
- name?: string | undefined;
1236
- /**
1237
- * The branch containing this database.
1238
- * Format: projects/{project_id}/branches/{branch_id}
1239
- */
1240
- parent?: string | undefined;
1241
- /** A timestamp indicating when the database was created. */
1242
- createTime?: Temporal.Instant | undefined;
1243
- /** A timestamp indicating when the database was last updated. */
1244
- updateTime?: Temporal.Instant | undefined;
1245
- /** The desired state of the Database. */
1246
- spec?: Database_DatabaseSpec | undefined;
1247
- /** The observed state of the Database. */
1248
- status?: Database_DatabaseStatus | undefined;
1249
- /** The part of the name, chosen by the user when the resource was created. */
1250
- databaseId?: string | undefined;
1251
- }
1252
- export interface Database_DatabaseSpec {
1253
- /**
1254
- * The name of the role that owns the database.
1255
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1256
- *
1257
- * To change the owner, pass valid existing Role name when updating the Database
1258
- *
1259
- * A database always has an owner.
1260
- */
1261
- role?: string | undefined;
1262
- /**
1263
- * The name of the Postgres database.
1264
- *
1265
- * This expects a valid Postgres identifier as specified in the link below.
1266
- * https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
1267
- * Required when creating the Database.
1268
- *
1269
- * To rename, pass a valid postgres identifier when updating the Database.
1270
- */
1271
- postgresDatabase?: string | undefined;
1272
- }
1273
- export interface Database_DatabaseStatus {
1274
- /**
1275
- * The name of the role that owns the database.
1276
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1277
- */
1278
- role?: string | undefined;
1279
- /** The name of the Postgres database. */
1280
- postgresDatabase?: string | undefined;
1281
- /** Part of the resource name. */
1282
- databaseId?: string | undefined;
1283
- }
1284
- export interface DatabaseCredential {
1285
- /** The OAuth token that can be used as a password when connecting to a database. */
1286
- token?: string | undefined;
1287
- /** Timestamp in UTC of when this credential expires. */
1288
- expireTime?: Temporal.Instant | undefined;
1289
- }
1290
- export interface DatabaseOperationMetadata {
1291
- }
1292
- export interface DeleteBranchRequest {
1293
- /**
1294
- * The full resource path of the branch to delete.
1295
- * Format: projects/{project_id}/branches/{branch_id}
1296
- */
1297
- name?: string | undefined;
1298
- /** If true, permanently delete the branch; if false, soft delete. */
1299
- purge?: boolean | undefined;
1300
- }
1301
- export interface DeleteCatalogRequest {
1302
- /**
1303
- * The full resource path of the catalog to delete.
1304
- *
1305
- * Format: "catalogs/{catalog_id}".
1306
- */
1307
- name?: string | undefined;
1189
+ interface Database {
1190
+ /**
1191
+ * The resource name of the database.
1192
+ * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1193
+ */
1194
+ name?: string | undefined;
1195
+ /**
1196
+ * The branch containing this database.
1197
+ * Format: projects/{project_id}/branches/{branch_id}
1198
+ */
1199
+ parent?: string | undefined;
1200
+ /** A timestamp indicating when the database was created. */
1201
+ createTime?: Temporal.Instant | undefined;
1202
+ /** A timestamp indicating when the database was last updated. */
1203
+ updateTime?: Temporal.Instant | undefined;
1204
+ /** The desired state of the Database. */
1205
+ spec?: Database_DatabaseSpec | undefined;
1206
+ /** The observed state of the Database. */
1207
+ status?: Database_DatabaseStatus | undefined;
1208
+ /** The part of the name, chosen by the user when the resource was created. */
1209
+ databaseId?: string | undefined;
1210
+ }
1211
+ interface Database_DatabaseSpec {
1212
+ /**
1213
+ * The name of the role that owns the database.
1214
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1215
+ *
1216
+ * To change the owner, pass valid existing Role name when updating the Database
1217
+ *
1218
+ * A database always has an owner.
1219
+ */
1220
+ role?: string | undefined;
1221
+ /**
1222
+ * The name of the Postgres database.
1223
+ *
1224
+ * This expects a valid Postgres identifier as specified in the link below.
1225
+ * https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
1226
+ * Required when creating the Database.
1227
+ *
1228
+ * To rename, pass a valid postgres identifier when updating the Database.
1229
+ */
1230
+ postgresDatabase?: string | undefined;
1231
+ }
1232
+ interface Database_DatabaseStatus {
1233
+ /**
1234
+ * The name of the role that owns the database.
1235
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1236
+ */
1237
+ role?: string | undefined;
1238
+ /** The name of the Postgres database. */
1239
+ postgresDatabase?: string | undefined;
1240
+ /** Part of the resource name. */
1241
+ databaseId?: string | undefined;
1242
+ }
1243
+ interface DatabaseCredential {
1244
+ /** The OAuth token that can be used as a password when connecting to a database. */
1245
+ token?: string | undefined;
1246
+ /** Timestamp in UTC of when this credential expires. */
1247
+ expireTime?: Temporal.Instant | undefined;
1248
+ }
1249
+ interface DatabaseOperationMetadata {}
1250
+ interface DeleteBranchRequest {
1251
+ /**
1252
+ * The full resource path of the branch to delete.
1253
+ * Format: projects/{project_id}/branches/{branch_id}
1254
+ */
1255
+ name?: string | undefined;
1256
+ /** If true, permanently delete the branch; if false, soft delete. */
1257
+ purge?: boolean | undefined;
1258
+ }
1259
+ interface DeleteCatalogRequest {
1260
+ /**
1261
+ * The full resource path of the catalog to delete.
1262
+ *
1263
+ * Format: "catalogs/{catalog_id}".
1264
+ */
1265
+ name?: string | undefined;
1308
1266
  }
1309
1267
  /** Request to delete a Lakebase CDF configuration (CdfConfig). */
1310
- export interface DeleteCdfConfigRequest {
1311
- /**
1312
- * The resource name of the CdfConfig to delete.
1313
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1314
- */
1315
- name?: string | undefined;
1316
- /**
1317
- * When true, also drops the replicated Delta tables in Unity Catalog. When
1318
- * false (the default), the replicated tables are preserved at their last
1319
- * synced state.
1320
- */
1321
- force?: boolean | undefined;
1268
+ interface DeleteCdfConfigRequest {
1269
+ /**
1270
+ * The resource name of the CdfConfig to delete.
1271
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1272
+ */
1273
+ name?: string | undefined;
1274
+ /**
1275
+ * When true, also drops the replicated Delta tables in Unity Catalog. When
1276
+ * false (the default), the replicated tables are preserved at their last
1277
+ * synced state.
1278
+ */
1279
+ force?: boolean | undefined;
1322
1280
  }
1323
1281
  /** Disable Data API for a database. */
1324
- export interface DeleteDataApiRequest {
1325
- /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1326
- name?: string | undefined;
1327
- }
1328
- export interface DeleteDatabaseRequest {
1329
- /**
1330
- * The resource name of the postgres database.
1331
- * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1332
- */
1333
- name?: string | undefined;
1334
- }
1335
- export interface DeleteEndpointRequest {
1336
- /**
1337
- * The full resource path of the endpoint to delete.
1338
- * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1339
- */
1340
- name?: string | undefined;
1341
- }
1342
- export interface DeleteProjectRequest {
1343
- /**
1344
- * The full resource path of the project to delete.
1345
- * Format: projects/{project_id}
1346
- */
1347
- name?: string | undefined;
1348
- /**
1349
- * If true, permanently deletes the project (hard delete).
1350
- * If false or unset, performs a soft delete.
1351
- */
1352
- purge?: boolean | undefined;
1353
- }
1354
- export interface DeleteRoleRequest {
1355
- /**
1356
- * The full resource path of the role to delete.
1357
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1358
- */
1359
- name?: string | undefined;
1360
- /**
1361
- * Reassign objects. If this is set, all objects owned by the role are
1362
- * reassigned to the role specified in this parameter.
1363
- *
1364
- * NOTE: setting this requires spinning up a compute to succeed, since it involves running
1365
- * SQL queries.
1366
- */
1367
- reassignOwnedTo?: string | undefined;
1368
- }
1369
- export interface DeleteSyncedTableRequest {
1370
- /**
1371
- * The Full resource name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}",
1372
- * where (catalog, schema, table) are the UC entity names.
1373
- */
1374
- name?: string | undefined;
1375
- }
1376
- export interface DeltaTableSyncInfo {
1377
- /** The Delta Lake commit version that was last successfully synced. */
1378
- deltaCommitVersion?: bigint | undefined;
1379
- /**
1380
- * The timestamp when the above Delta version was committed in the source Delta table.
1381
- * Note: This is the Delta commit time, not the time the data was written to the synced table.
1382
- */
1383
- deltaCommitTime?: Temporal.Instant | undefined;
1384
- }
1385
- export interface Endpoint {
1386
- /**
1387
- * Output only. The full resource path of the endpoint.
1388
- * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1389
- */
1390
- name?: string | undefined;
1391
- /** System-generated unique ID for the endpoint. */
1392
- uid?: string | undefined;
1393
- /**
1394
- * The branch containing this endpoint (API resource hierarchy).
1395
- * Format: projects/{project_id}/branches/{branch_id}
1396
- */
1397
- parent?: string | undefined;
1398
- /** A timestamp indicating when the compute endpoint was created. */
1399
- createTime?: Temporal.Instant | undefined;
1400
- /** A timestamp indicating when the compute endpoint was last updated. */
1401
- updateTime?: Temporal.Instant | undefined;
1402
- /** The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state. */
1403
- spec?: EndpointSpec | undefined;
1404
- /** Current operational status of the compute endpoint. */
1405
- status?: EndpointStatus | undefined;
1406
- /** The part of the name, chosen by the user when the resource was created. */
1407
- endpointId?: string | undefined;
1408
- }
1409
- export interface EndpointGroupSpec {
1410
- /**
1411
- * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
1412
- * than or equal to 1.
1413
- */
1414
- min?: number | undefined;
1415
- /**
1416
- * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
1417
- * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
1418
- * true on the EndpointSpec.
1419
- */
1420
- max?: number | undefined;
1421
- /**
1422
- * Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
1423
- * size.max > 1.
1424
- */
1425
- enableReadableSecondaries?: boolean | undefined;
1426
- }
1427
- export interface EndpointGroupStatus {
1428
- /**
1429
- * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
1430
- * than or equal to 1.
1431
- */
1432
- min?: number | undefined;
1433
- /**
1434
- * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
1435
- * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
1436
- * true on the EndpointSpec.
1437
- */
1438
- max?: number | undefined;
1439
- /**
1440
- * Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured
1441
- * by specifying size.max > 1.
1442
- */
1443
- enableReadableSecondaries?: boolean | undefined;
1282
+ interface DeleteDataApiRequest {
1283
+ /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1284
+ name?: string | undefined;
1285
+ }
1286
+ interface DeleteDatabaseRequest {
1287
+ /**
1288
+ * The resource name of the postgres database.
1289
+ * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1290
+ */
1291
+ name?: string | undefined;
1292
+ }
1293
+ interface DeleteEndpointRequest {
1294
+ /**
1295
+ * The full resource path of the endpoint to delete.
1296
+ * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1297
+ */
1298
+ name?: string | undefined;
1299
+ }
1300
+ interface DeleteProjectRequest {
1301
+ /**
1302
+ * The full resource path of the project to delete.
1303
+ * Format: projects/{project_id}
1304
+ */
1305
+ name?: string | undefined;
1306
+ /**
1307
+ * If true, permanently deletes the project (hard delete).
1308
+ * If false or unset, performs a soft delete.
1309
+ */
1310
+ purge?: boolean | undefined;
1311
+ }
1312
+ interface DeleteRoleRequest {
1313
+ /**
1314
+ * The full resource path of the role to delete.
1315
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1316
+ */
1317
+ name?: string | undefined;
1318
+ /**
1319
+ * Reassign objects. If this is set, all objects owned by the role are
1320
+ * reassigned to the role specified in this parameter.
1321
+ *
1322
+ * NOTE: setting this requires spinning up a compute to succeed, since it involves running
1323
+ * SQL queries.
1324
+ */
1325
+ reassignOwnedTo?: string | undefined;
1326
+ }
1327
+ interface DeleteSyncedTableRequest {
1328
+ /**
1329
+ * The Full resource name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}",
1330
+ * where (catalog, schema, table) are the UC entity names.
1331
+ */
1332
+ name?: string | undefined;
1333
+ }
1334
+ interface DeltaTableSyncInfo {
1335
+ /** The Delta Lake commit version that was last successfully synced. */
1336
+ deltaCommitVersion?: bigint | undefined;
1337
+ /**
1338
+ * The timestamp when the above Delta version was committed in the source Delta table.
1339
+ * Note: This is the Delta commit time, not the time the data was written to the synced table.
1340
+ */
1341
+ deltaCommitTime?: Temporal.Instant | undefined;
1342
+ }
1343
+ interface Endpoint {
1344
+ /**
1345
+ * Output only. The full resource path of the endpoint.
1346
+ * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1347
+ */
1348
+ name?: string | undefined;
1349
+ /** System-generated unique ID for the endpoint. */
1350
+ uid?: string | undefined;
1351
+ /**
1352
+ * The branch containing this endpoint (API resource hierarchy).
1353
+ * Format: projects/{project_id}/branches/{branch_id}
1354
+ */
1355
+ parent?: string | undefined;
1356
+ /** A timestamp indicating when the compute endpoint was created. */
1357
+ createTime?: Temporal.Instant | undefined;
1358
+ /** A timestamp indicating when the compute endpoint was last updated. */
1359
+ updateTime?: Temporal.Instant | undefined;
1360
+ /** The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state. */
1361
+ spec?: EndpointSpec | undefined;
1362
+ /** Current operational status of the compute endpoint. */
1363
+ status?: EndpointStatus | undefined;
1364
+ /** The part of the name, chosen by the user when the resource was created. */
1365
+ endpointId?: string | undefined;
1366
+ }
1367
+ interface EndpointGroupSpec {
1368
+ /**
1369
+ * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
1370
+ * than or equal to 1.
1371
+ */
1372
+ min?: number | undefined;
1373
+ /**
1374
+ * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
1375
+ * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
1376
+ * true on the EndpointSpec.
1377
+ */
1378
+ max?: number | undefined;
1379
+ /**
1380
+ * Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
1381
+ * size.max > 1.
1382
+ */
1383
+ enableReadableSecondaries?: boolean | undefined;
1384
+ }
1385
+ interface EndpointGroupStatus {
1386
+ /**
1387
+ * The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
1388
+ * than or equal to 1.
1389
+ */
1390
+ min?: number | undefined;
1391
+ /**
1392
+ * The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
1393
+ * compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
1394
+ * true on the EndpointSpec.
1395
+ */
1396
+ max?: number | undefined;
1397
+ /**
1398
+ * Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured
1399
+ * by specifying size.max > 1.
1400
+ */
1401
+ enableReadableSecondaries?: boolean | undefined;
1444
1402
  }
1445
1403
  /** Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint. */
1446
- export interface EndpointHosts {
1447
- /**
1448
- * The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects
1449
- * to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.
1450
- */
1451
- host?: string | undefined;
1452
- /**
1453
- * An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,
1454
- * this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined
1455
- * if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.
1456
- */
1457
- readOnlyHost?: string | undefined;
1458
- /** The read-write hostname of the compute endpoint, with pooling. This attribute is only defined for read-write endpoints. */
1459
- readWritePooledHost?: string | undefined;
1460
- /**
1461
- * The read-only hostname of the compute endpoint, with pooling. This attribute is always defined for read-only endpoints,
1462
- * and may be defined for read-write endpoints if configured with read replicas and allow read-only connections.
1463
- */
1464
- readOnlyPooledHost?: string | undefined;
1465
- }
1466
- export interface EndpointOperationMetadata {
1467
- }
1404
+ interface EndpointHosts {
1405
+ /**
1406
+ * The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects
1407
+ * to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.
1408
+ */
1409
+ host?: string | undefined;
1410
+ /**
1411
+ * An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,
1412
+ * this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined
1413
+ * if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.
1414
+ */
1415
+ readOnlyHost?: string | undefined;
1416
+ /** The read-write hostname of the compute endpoint, with pooling. This attribute is only defined for read-write endpoints. */
1417
+ readWritePooledHost?: string | undefined;
1418
+ /**
1419
+ * The read-only hostname of the compute endpoint, with pooling. This attribute is always defined for read-only endpoints,
1420
+ * and may be defined for read-write endpoints if configured with read replicas and allow read-only connections.
1421
+ */
1422
+ readOnlyPooledHost?: string | undefined;
1423
+ }
1424
+ interface EndpointOperationMetadata {}
1468
1425
  /** A collection of settings for a compute endpoint. */
1469
- export interface EndpointSettings {
1470
- /** A raw representation of Postgres settings. */
1471
- pgSettings?: Record<string, string> | undefined;
1472
- }
1473
- export interface EndpointSpec {
1474
- /** The endpoint type. A branch can only have one READ_WRITE endpoint. */
1475
- endpointType?: EndpointType | undefined;
1476
- /** The minimum number of Compute Units. Minimum value is 0.5. */
1477
- autoscalingLimitMinCu?: number | undefined;
1478
- /**
1479
- * The maximum number of Compute Units. The maximum value is 64.
1480
- * The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
1481
- */
1482
- autoscalingLimitMaxCu?: number | undefined;
1483
- /**
1484
- * Whether to restrict connections to the compute endpoint.
1485
- * Enabling this option schedules a suspend compute operation.
1486
- * A disabled compute endpoint cannot be enabled by a connection or
1487
- * console action.
1488
- */
1489
- disabled?: boolean | undefined;
1490
- /**
1491
- * Duration of inactivity after which the compute endpoint is automatically suspended. One of suspend_timeout_duration or no_suspension can be provided.
1492
- * When not specified default suspension behavior will be used (consult with documentation).
1493
- *
1494
- * When updating this field, use "spec.suspension" in the update_mask.
1495
- */
1496
- suspension?: {
1497
- $case: 'suspendTimeoutDuration';
1498
- /**
1499
- * Duration of inactivity after which the compute endpoint is automatically suspended.
1500
- * If specified should be between 60s and 604800s (1 minute to 1 week).
1501
- * Mutually exclusive with `no_suspension`. When updating, use `spec.suspension` in the update_mask.
1502
- */
1503
- suspendTimeoutDuration: Temporal.Duration;
1504
- } | {
1505
- $case: 'noSuspension';
1506
- /**
1507
- * When set to true, explicitly disables automatic suspension (never suspend).
1508
- * Should be set to true when provided.
1509
- * Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.suspension` in the update_mask.
1510
- */
1511
- noSuspension: boolean;
1512
- } | undefined;
1513
- settings?: EndpointSettings | undefined;
1514
- /**
1515
- * Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults
1516
- * to non HA settings, with a single compute backing the endpoint (and no readable secondaries
1517
- * for Read/Write endpoints).
1518
- */
1519
- group?: EndpointGroupSpec | undefined;
1520
- }
1521
- export interface EndpointStatus {
1522
- /** The endpoint type. A branch can only have one READ_WRITE endpoint. */
1523
- endpointType?: EndpointType | undefined;
1524
- /** Contains host information for connecting to the endpoint. */
1525
- hosts?: EndpointHosts | undefined;
1526
- /** A timestamp indicating when the compute endpoint was last active. */
1527
- lastActiveTime?: Temporal.Instant | undefined;
1528
- /** The minimum number of Compute Units. */
1529
- autoscalingLimitMinCu?: number | undefined;
1530
- /**
1531
- * The maximum number of Compute Units. The maximum value is 64.
1532
- * The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
1533
- */
1534
- autoscalingLimitMaxCu?: number | undefined;
1535
- currentState?: EndpointStatus_State | undefined;
1536
- pendingState?: EndpointStatus_State | undefined;
1537
- /**
1538
- * Whether to restrict connections to the compute endpoint.
1539
- * Enabling this option schedules a suspend compute operation.
1540
- * A disabled compute endpoint cannot be enabled by a connection or
1541
- * console action.
1542
- */
1543
- disabled?: boolean | undefined;
1544
- /** Duration of inactivity after which the compute endpoint is automatically suspended. */
1545
- suspendTimeoutDuration?: Temporal.Duration | undefined;
1546
- settings?: EndpointSettings | undefined;
1547
- /** Details on the HA configuration of the endpoint. */
1548
- group?: EndpointGroupStatus | undefined;
1549
- /** Part of the resource name. */
1550
- endpointId?: string | undefined;
1551
- }
1552
- export interface GenerateDatabaseCredentialRequest {
1553
- /** The returned token will be scoped to UC tables with the specified permissions. */
1554
- claims?: RequestedClaims[] | undefined;
1555
- /**
1556
- * The endpoint resource name for which this credential will be generated.
1557
- * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1558
- */
1559
- endpoint?: string | undefined;
1560
- /**
1561
- * Expiration information for the credential.
1562
- * Users can specify either expire_time or ttl.
1563
- * If unspecified, maximum allowed duration (1 hour) is used.
1564
- */
1565
- expiration?: {
1566
- $case: 'ttl';
1567
- /**
1568
- * The requested time-to-live for the generated credential token.
1569
- * Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour).
1570
- */
1571
- ttl: Temporal.Duration;
1572
- } | {
1573
- $case: 'expireTime';
1574
- /**
1575
- * Timestamp in UTC of when this credential should expire.
1576
- * Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time.
1577
- */
1578
- expireTime: Temporal.Instant;
1579
- } | undefined;
1580
- }
1581
- export interface GetBranchRequest {
1582
- /**
1583
- * The full resource path of the branch to retrieve.
1584
- * Format: projects/{project_id}/branches/{branch_id}
1585
- */
1586
- name?: string | undefined;
1587
- }
1588
- export interface GetCatalogRequest {
1589
- /**
1590
- * The full resource path of the catalog to retrieve.
1591
- *
1592
- * Format: "catalogs/{catalog_id}".
1593
- */
1594
- name?: string | undefined;
1426
+ interface EndpointSettings {
1427
+ /** A raw representation of Postgres settings. */
1428
+ pgSettings?: Record<string, string> | undefined;
1429
+ }
1430
+ interface EndpointSpec {
1431
+ /** The endpoint type. A branch can only have one READ_WRITE endpoint. */
1432
+ endpointType?: EndpointType | undefined;
1433
+ /** The minimum number of Compute Units. Minimum value is 0.5. */
1434
+ autoscalingLimitMinCu?: number | undefined;
1435
+ /**
1436
+ * The maximum number of Compute Units. The maximum value is 64.
1437
+ * The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
1438
+ */
1439
+ autoscalingLimitMaxCu?: number | undefined;
1440
+ /**
1441
+ * Whether to restrict connections to the compute endpoint.
1442
+ * Enabling this option schedules a suspend compute operation.
1443
+ * A disabled compute endpoint cannot be enabled by a connection or
1444
+ * console action.
1445
+ */
1446
+ disabled?: boolean | undefined;
1447
+ /**
1448
+ * Duration of inactivity after which the compute endpoint is automatically suspended. One of suspend_timeout_duration or no_suspension can be provided.
1449
+ * When not specified default suspension behavior will be used (consult with documentation).
1450
+ *
1451
+ * When updating this field, use "spec.suspension" in the update_mask.
1452
+ */
1453
+ suspension?: {
1454
+ $case: 'suspendTimeoutDuration';
1455
+ /**
1456
+ * Duration of inactivity after which the compute endpoint is automatically suspended.
1457
+ * If specified should be between 60s and 604800s (1 minute to 1 week).
1458
+ * Mutually exclusive with `no_suspension`. When updating, use `spec.suspension` in the update_mask.
1459
+ */
1460
+ suspendTimeoutDuration: Temporal.Duration;
1461
+ } | {
1462
+ $case: 'noSuspension';
1463
+ /**
1464
+ * When set to true, explicitly disables automatic suspension (never suspend).
1465
+ * Should be set to true when provided.
1466
+ * Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.suspension` in the update_mask.
1467
+ */
1468
+ noSuspension: boolean;
1469
+ } | undefined;
1470
+ settings?: EndpointSettings | undefined;
1471
+ /**
1472
+ * Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults
1473
+ * to non HA settings, with a single compute backing the endpoint (and no readable secondaries
1474
+ * for Read/Write endpoints).
1475
+ */
1476
+ group?: EndpointGroupSpec | undefined;
1477
+ }
1478
+ interface EndpointStatus {
1479
+ /** The endpoint type. A branch can only have one READ_WRITE endpoint. */
1480
+ endpointType?: EndpointType | undefined;
1481
+ /** Contains host information for connecting to the endpoint. */
1482
+ hosts?: EndpointHosts | undefined;
1483
+ /** A timestamp indicating when the compute endpoint was last active. */
1484
+ lastActiveTime?: Temporal.Instant | undefined;
1485
+ /** The minimum number of Compute Units. */
1486
+ autoscalingLimitMinCu?: number | undefined;
1487
+ /**
1488
+ * The maximum number of Compute Units. The maximum value is 64.
1489
+ * The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
1490
+ */
1491
+ autoscalingLimitMaxCu?: number | undefined;
1492
+ currentState?: EndpointStatus_State | undefined;
1493
+ pendingState?: EndpointStatus_State | undefined;
1494
+ /**
1495
+ * Whether to restrict connections to the compute endpoint.
1496
+ * Enabling this option schedules a suspend compute operation.
1497
+ * A disabled compute endpoint cannot be enabled by a connection or
1498
+ * console action.
1499
+ */
1500
+ disabled?: boolean | undefined;
1501
+ /** Duration of inactivity after which the compute endpoint is automatically suspended. */
1502
+ suspendTimeoutDuration?: Temporal.Duration | undefined;
1503
+ settings?: EndpointSettings | undefined;
1504
+ /** Details on the HA configuration of the endpoint. */
1505
+ group?: EndpointGroupStatus | undefined;
1506
+ /** Part of the resource name. */
1507
+ endpointId?: string | undefined;
1508
+ }
1509
+ interface GenerateDatabaseCredentialRequest {
1510
+ /** The returned token will be scoped to UC tables with the specified permissions. */
1511
+ claims?: RequestedClaims[] | undefined;
1512
+ /**
1513
+ * The endpoint resource name for which this credential will be generated.
1514
+ * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1515
+ */
1516
+ endpoint?: string | undefined;
1517
+ /**
1518
+ * Expiration information for the credential.
1519
+ * Users can specify either expire_time or ttl.
1520
+ * If unspecified, maximum allowed duration (1 hour) is used.
1521
+ */
1522
+ expiration?: {
1523
+ $case: 'ttl';
1524
+ /**
1525
+ * The requested time-to-live for the generated credential token.
1526
+ * Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour).
1527
+ */
1528
+ ttl: Temporal.Duration;
1529
+ } | {
1530
+ $case: 'expireTime';
1531
+ /**
1532
+ * Timestamp in UTC of when this credential should expire.
1533
+ * Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time.
1534
+ */
1535
+ expireTime: Temporal.Instant;
1536
+ } | undefined;
1537
+ }
1538
+ interface GetBranchRequest {
1539
+ /**
1540
+ * The full resource path of the branch to retrieve.
1541
+ * Format: projects/{project_id}/branches/{branch_id}
1542
+ */
1543
+ name?: string | undefined;
1544
+ }
1545
+ interface GetCatalogRequest {
1546
+ /**
1547
+ * The full resource path of the catalog to retrieve.
1548
+ *
1549
+ * Format: "catalogs/{catalog_id}".
1550
+ */
1551
+ name?: string | undefined;
1595
1552
  }
1596
1553
  /** Request to retrieve a single CdfConfig. */
1597
- export interface GetCdfConfigRequest {
1598
- /**
1599
- * The resource name of the CdfConfig to retrieve.
1600
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1601
- */
1602
- name?: string | undefined;
1554
+ interface GetCdfConfigRequest {
1555
+ /**
1556
+ * The resource name of the CdfConfig to retrieve.
1557
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1558
+ */
1559
+ name?: string | undefined;
1603
1560
  }
1604
1561
  /** Request to retrieve the status of a single replicated table (CdfStatus). */
1605
- export interface GetCdfStatusRequest {
1606
- /**
1607
- * The resource name of the CdfStatus to retrieve.
1608
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
1609
- */
1610
- name?: string | undefined;
1562
+ interface GetCdfStatusRequest {
1563
+ /**
1564
+ * The resource name of the CdfStatus to retrieve.
1565
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
1566
+ */
1567
+ name?: string | undefined;
1611
1568
  }
1612
1569
  /** Get Data API configuration for a database. */
1613
- export interface GetDataApiRequest {
1614
- /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1615
- name?: string | undefined;
1616
- }
1617
- export interface GetDatabaseRequest {
1618
- /**
1619
- * The name of the Database to retrieve.
1620
- * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1621
- */
1622
- name?: string | undefined;
1623
- }
1624
- export interface GetEndpointRequest {
1625
- /**
1626
- * The full resource path of the endpoint to retrieve.
1627
- * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1628
- */
1629
- name?: string | undefined;
1570
+ interface GetDataApiRequest {
1571
+ /** Resource name: projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api */
1572
+ name?: string | undefined;
1573
+ }
1574
+ interface GetDatabaseRequest {
1575
+ /**
1576
+ * The name of the Database to retrieve.
1577
+ * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
1578
+ */
1579
+ name?: string | undefined;
1580
+ }
1581
+ interface GetEndpointRequest {
1582
+ /**
1583
+ * The full resource path of the endpoint to retrieve.
1584
+ * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
1585
+ */
1586
+ name?: string | undefined;
1630
1587
  }
1631
1588
  /** The request message for `GetOperation` method. */
1632
- export interface GetOperationRequest {
1633
- /** The name of the operation resource. */
1634
- name?: string | undefined;
1635
- }
1636
- export interface GetProjectRequest {
1637
- /**
1638
- * The full resource path of the project to retrieve.
1639
- * Format: projects/{project_id}
1640
- */
1641
- name?: string | undefined;
1642
- }
1643
- export interface GetRoleRequest {
1644
- /**
1645
- * The full resource path of the role to retrieve.
1646
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1647
- */
1648
- name?: string | undefined;
1649
- }
1650
- export interface GetSyncedTableRequest {
1651
- /**
1652
- * The Full resource name of the synced table.
1653
- * Format: "synced_tables/{catalog}.{schema}.{table}",
1654
- * where (catalog, schema, table) are the entity names in the Unity Catalog.
1655
- */
1656
- name?: string | undefined;
1589
+ interface GetOperationRequest {
1590
+ /** The name of the operation resource. */
1591
+ name?: string | undefined;
1592
+ }
1593
+ interface GetProjectRequest {
1594
+ /**
1595
+ * The full resource path of the project to retrieve.
1596
+ * Format: projects/{project_id}
1597
+ */
1598
+ name?: string | undefined;
1599
+ }
1600
+ interface GetRoleRequest {
1601
+ /**
1602
+ * The full resource path of the role to retrieve.
1603
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1604
+ */
1605
+ name?: string | undefined;
1606
+ }
1607
+ interface GetSyncedTableRequest {
1608
+ /**
1609
+ * The Full resource name of the synced table.
1610
+ * Format: "synced_tables/{catalog}.{schema}.{table}",
1611
+ * where (catalog, schema, table) are the entity names in the Unity Catalog.
1612
+ */
1613
+ name?: string | undefined;
1657
1614
  }
1658
1615
  /** Configuration for the initial default branch created during project creation. */
1659
- export interface InitialBranchSpec {
1660
- /** Whether the initial default branch should be protected from deletion. */
1661
- isProtected?: boolean | undefined;
1616
+ interface InitialBranchSpec {
1617
+ /** Whether the initial default branch should be protected from deletion. */
1618
+ isProtected?: boolean | undefined;
1662
1619
  }
1663
1620
  /** Configuration for the initial Read/Write endpoint created during project creation. */
1664
- export interface InitialEndpointSpec {
1665
- /** Settings for HA configuration of the endpoint. */
1666
- group?: EndpointGroupSpec | undefined;
1667
- /** The minimum number of Compute Units for the initial endpoint. */
1668
- autoscalingLimitMinCu?: number | undefined;
1669
- /** The maximum number of Compute Units for the initial endpoint. */
1670
- autoscalingLimitMaxCu?: number | undefined;
1671
- suspension?: {
1672
- $case: 'suspendTimeoutDuration';
1673
- /**
1674
- * Duration of inactivity after which the initial endpoint is automatically suspended.
1675
- * If specified, should be between 60s and 604800s (1 minute to 1 week).
1676
- * Mutually exclusive with `no_suspension`.
1677
- */
1678
- suspendTimeoutDuration: Temporal.Duration;
1679
- } | {
1680
- $case: 'noSuspension';
1681
- /**
1682
- * When set to true, explicitly disables automatic suspension (never suspend).
1683
- * Should be set to true when provided.
1684
- * Mutually exclusive with `suspend_timeout_duration`.
1685
- */
1686
- noSuspension: boolean;
1687
- } | undefined;
1688
- }
1689
- export interface ListBranchesRequest {
1690
- /**
1691
- * The Project that owns this collection of branches.
1692
- * Format: projects/{project_id}
1693
- */
1694
- parent?: string | undefined;
1695
- /** Page token from a previous response. If not provided, returns the first page. */
1696
- pageToken?: string | undefined;
1697
- /** Upper bound for items returned. Cannot be negative. */
1698
- pageSize?: number | undefined;
1699
- /**
1700
- * Whether to include soft-deleted branches in the response.
1701
- * When true, deleted branches are included alongside active branches.
1702
- * Purged branches are never returned.
1703
- */
1704
- showDeleted?: boolean | undefined;
1705
- }
1706
- export interface ListBranchesResponse {
1707
- /** List of branches in the project. */
1708
- branches?: Branch[] | undefined;
1709
- /** Token to request the next page of branches. */
1710
- nextPageToken?: string | undefined;
1621
+ interface InitialEndpointSpec {
1622
+ /** Settings for HA configuration of the endpoint. */
1623
+ group?: EndpointGroupSpec | undefined;
1624
+ /** The minimum number of Compute Units for the initial endpoint. */
1625
+ autoscalingLimitMinCu?: number | undefined;
1626
+ /** The maximum number of Compute Units for the initial endpoint. */
1627
+ autoscalingLimitMaxCu?: number | undefined;
1628
+ suspension?: {
1629
+ $case: 'suspendTimeoutDuration';
1630
+ /**
1631
+ * Duration of inactivity after which the initial endpoint is automatically suspended.
1632
+ * If specified, should be between 60s and 604800s (1 minute to 1 week).
1633
+ * Mutually exclusive with `no_suspension`.
1634
+ */
1635
+ suspendTimeoutDuration: Temporal.Duration;
1636
+ } | {
1637
+ $case: 'noSuspension';
1638
+ /**
1639
+ * When set to true, explicitly disables automatic suspension (never suspend).
1640
+ * Should be set to true when provided.
1641
+ * Mutually exclusive with `suspend_timeout_duration`.
1642
+ */
1643
+ noSuspension: boolean;
1644
+ } | undefined;
1645
+ }
1646
+ interface ListBranchesRequest {
1647
+ /**
1648
+ * The Project that owns this collection of branches.
1649
+ * Format: projects/{project_id}
1650
+ */
1651
+ parent?: string | undefined;
1652
+ /** Page token from a previous response. If not provided, returns the first page. */
1653
+ pageToken?: string | undefined;
1654
+ /** Upper bound for items returned. Cannot be negative. */
1655
+ pageSize?: number | undefined;
1656
+ /**
1657
+ * Whether to include soft-deleted branches in the response.
1658
+ * When true, deleted branches are included alongside active branches.
1659
+ * Purged branches are never returned.
1660
+ */
1661
+ showDeleted?: boolean | undefined;
1662
+ }
1663
+ interface ListBranchesResponse {
1664
+ /** List of branches in the project. */
1665
+ branches?: Branch[] | undefined;
1666
+ /** Token to request the next page of branches. */
1667
+ nextPageToken?: string | undefined;
1711
1668
  }
1712
1669
  /** Request to list the Lakebase CDF configurations (CdfConfigs) under a database. */
1713
- export interface ListCdfConfigsRequest {
1714
- /**
1715
- * The parent database to list CdfConfigs for.
1716
- * Format: projects/{project}/branches/{branch}/databases/{database}
1717
- */
1718
- parent?: string | undefined;
1719
- /** Maximum number of CdfConfigs to return. */
1720
- pageSize?: number | undefined;
1721
- /**
1722
- * Pagination token returned by a previous ListCdfConfigs call. Empty on the
1723
- * first page.
1724
- */
1725
- pageToken?: string | undefined;
1670
+ interface ListCdfConfigsRequest {
1671
+ /**
1672
+ * The parent database to list CdfConfigs for.
1673
+ * Format: projects/{project}/branches/{branch}/databases/{database}
1674
+ */
1675
+ parent?: string | undefined;
1676
+ /** Maximum number of CdfConfigs to return. */
1677
+ pageSize?: number | undefined;
1678
+ /**
1679
+ * Pagination token returned by a previous ListCdfConfigs call. Empty on the
1680
+ * first page.
1681
+ */
1682
+ pageToken?: string | undefined;
1726
1683
  }
1727
1684
  /**
1728
1685
  * Response to a ListCdfConfigs request, containing a page of CdfConfigs and a
1729
1686
  * token for fetching the next page.
1730
1687
  */
1731
- export interface ListCdfConfigsResponse {
1732
- /** The CdfConfigs under the parent database. */
1733
- cdfConfigs?: CdfConfig[] | undefined;
1734
- /** Token to retrieve the next page of results; empty when there are no more. */
1735
- nextPageToken?: string | undefined;
1688
+ interface ListCdfConfigsResponse {
1689
+ /** The CdfConfigs under the parent database. */
1690
+ cdfConfigs?: CdfConfig[] | undefined;
1691
+ /** Token to retrieve the next page of results; empty when there are no more. */
1692
+ nextPageToken?: string | undefined;
1736
1693
  }
1737
1694
  /**
1738
1695
  * Request to list the statuses of all tables replicated under a Lakebase CDF
1739
1696
  * configuration (CdfConfig).
1740
1697
  */
1741
- export interface ListCdfStatusesRequest {
1742
- /**
1743
- * The parent CdfConfig to list CdfStatuses for.
1744
- * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1745
- */
1746
- parent?: string | undefined;
1747
- /** Maximum number of CdfStatuses to return. */
1748
- pageSize?: number | undefined;
1749
- /**
1750
- * Pagination token returned by a previous ListCdfStatuses call. Empty on the
1751
- * first page.
1752
- */
1753
- pageToken?: string | undefined;
1698
+ interface ListCdfStatusesRequest {
1699
+ /**
1700
+ * The parent CdfConfig to list CdfStatuses for.
1701
+ * Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
1702
+ */
1703
+ parent?: string | undefined;
1704
+ /** Maximum number of CdfStatuses to return. */
1705
+ pageSize?: number | undefined;
1706
+ /**
1707
+ * Pagination token returned by a previous ListCdfStatuses call. Empty on the
1708
+ * first page.
1709
+ */
1710
+ pageToken?: string | undefined;
1754
1711
  }
1755
1712
  /**
1756
1713
  * Response to a ListCdfStatuses request, containing a page of replicated table
1757
1714
  * statuses and a token for fetching the next page.
1758
1715
  */
1759
- export interface ListCdfStatusesResponse {
1760
- /** The replicated tables under the parent CdfConfig. */
1761
- cdfStatuses?: CdfStatus[] | undefined;
1762
- /** Token to retrieve the next page of results; empty when there are no more. */
1763
- nextPageToken?: string | undefined;
1716
+ interface ListCdfStatusesResponse {
1717
+ /** The replicated tables under the parent CdfConfig. */
1718
+ cdfStatuses?: CdfStatus[] | undefined;
1719
+ /** Token to retrieve the next page of results; empty when there are no more. */
1720
+ nextPageToken?: string | undefined;
1764
1721
  }
1765
1722
  /** List Databases. */
1766
- export interface ListDatabasesRequest {
1767
- /**
1768
- * The Branch that owns this collection of databases.
1769
- * Format: projects/{project_id}/branches/{branch_id}
1770
- */
1771
- parent?: string | undefined;
1772
- /** Pagination token to go to the next page of Databases. Requests first page if absent. */
1773
- pageToken?: string | undefined;
1774
- /** Upper bound for items returned. */
1775
- pageSize?: number | undefined;
1776
- }
1777
- export interface ListDatabasesResponse {
1778
- /** List of databases. */
1779
- databases?: Database[] | undefined;
1780
- /** Pagination token to request the next page of databases. */
1781
- nextPageToken?: string | undefined;
1782
- }
1783
- export interface ListEndpointsRequest {
1784
- /**
1785
- * The Branch that owns this collection of endpoints.
1786
- * Format: projects/{project_id}/branches/{branch_id}
1787
- */
1788
- parent?: string | undefined;
1789
- /** Page token from a previous response. If not provided, returns the first page. */
1790
- pageToken?: string | undefined;
1791
- /** Upper bound for items returned. Cannot be negative. */
1792
- pageSize?: number | undefined;
1793
- }
1794
- export interface ListEndpointsResponse {
1795
- /** List of compute endpoints in the branch. */
1796
- endpoints?: Endpoint[] | undefined;
1797
- /** Token to request the next page of compute endpoints. */
1798
- nextPageToken?: string | undefined;
1799
- }
1800
- export interface ListProjectsRequest {
1801
- /** Page token from a previous response. If not provided, returns the first page. */
1802
- pageToken?: string | undefined;
1803
- /** Upper bound for items returned. Cannot be negative. The maximum value is 100. */
1804
- pageSize?: number | undefined;
1805
- /**
1806
- * Whether to include soft-deleted projects in the response.
1807
- * When true, soft-deleted projects are included alongside active projects.
1808
- * Hard-deleted and already-purged projects are never returned.
1809
- */
1810
- showDeleted?: boolean | undefined;
1811
- }
1812
- export interface ListProjectsResponse {
1813
- /** List of all projects in the workspace that the user has permission to access. */
1814
- projects?: Project[] | undefined;
1815
- /** Token to request the next page of projects. */
1816
- nextPageToken?: string | undefined;
1817
- }
1818
- export interface ListRolesRequest {
1819
- /**
1820
- * The Branch that owns this collection of roles.
1821
- * Format: projects/{project_id}/branches/{branch_id}
1822
- */
1823
- parent?: string | undefined;
1824
- /** Page token from a previous response. If not provided, returns the first page. */
1825
- pageToken?: string | undefined;
1826
- /** Upper bound for items returned. Cannot be negative. */
1827
- pageSize?: number | undefined;
1828
- }
1829
- export interface ListRolesResponse {
1830
- /** List of Postgres roles in the branch. */
1831
- roles?: Role[] | undefined;
1832
- /** Token to request the next page of Postgres roles. */
1833
- nextPageToken?: string | undefined;
1834
- }
1835
- export interface NewPipelineSpec {
1836
- /**
1837
- * UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).
1838
- * This needs to be a standard catalog where the user has permissions to create Delta tables.
1839
- */
1840
- storageCatalog?: string | undefined;
1841
- /**
1842
- * UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).
1843
- * This needs to be in the standard catalog where the user has permissions to create Delta tables.
1844
- */
1845
- storageSchema?: string | undefined;
1846
- /** Budget policy to set on the newly created pipeline. */
1847
- budgetPolicyId?: string | undefined;
1723
+ interface ListDatabasesRequest {
1724
+ /**
1725
+ * The Branch that owns this collection of databases.
1726
+ * Format: projects/{project_id}/branches/{branch_id}
1727
+ */
1728
+ parent?: string | undefined;
1729
+ /** Pagination token to go to the next page of Databases. Requests first page if absent. */
1730
+ pageToken?: string | undefined;
1731
+ /** Upper bound for items returned. */
1732
+ pageSize?: number | undefined;
1733
+ }
1734
+ interface ListDatabasesResponse {
1735
+ /** List of databases. */
1736
+ databases?: Database[] | undefined;
1737
+ /** Pagination token to request the next page of databases. */
1738
+ nextPageToken?: string | undefined;
1739
+ }
1740
+ interface ListEndpointsRequest {
1741
+ /**
1742
+ * The Branch that owns this collection of endpoints.
1743
+ * Format: projects/{project_id}/branches/{branch_id}
1744
+ */
1745
+ parent?: string | undefined;
1746
+ /** Page token from a previous response. If not provided, returns the first page. */
1747
+ pageToken?: string | undefined;
1748
+ /** Upper bound for items returned. Cannot be negative. */
1749
+ pageSize?: number | undefined;
1750
+ }
1751
+ interface ListEndpointsResponse {
1752
+ /** List of compute endpoints in the branch. */
1753
+ endpoints?: Endpoint[] | undefined;
1754
+ /** Token to request the next page of compute endpoints. */
1755
+ nextPageToken?: string | undefined;
1756
+ }
1757
+ interface ListProjectsRequest {
1758
+ /** Page token from a previous response. If not provided, returns the first page. */
1759
+ pageToken?: string | undefined;
1760
+ /** Upper bound for items returned. Cannot be negative. The maximum value is 100. */
1761
+ pageSize?: number | undefined;
1762
+ /**
1763
+ * Whether to include soft-deleted projects in the response.
1764
+ * When true, soft-deleted projects are included alongside active projects.
1765
+ * Hard-deleted and already-purged projects are never returned.
1766
+ */
1767
+ showDeleted?: boolean | undefined;
1768
+ }
1769
+ interface ListProjectsResponse {
1770
+ /** List of all projects in the workspace that the user has permission to access. */
1771
+ projects?: Project[] | undefined;
1772
+ /** Token to request the next page of projects. */
1773
+ nextPageToken?: string | undefined;
1774
+ }
1775
+ interface ListRolesRequest {
1776
+ /**
1777
+ * The Branch that owns this collection of roles.
1778
+ * Format: projects/{project_id}/branches/{branch_id}
1779
+ */
1780
+ parent?: string | undefined;
1781
+ /** Page token from a previous response. If not provided, returns the first page. */
1782
+ pageToken?: string | undefined;
1783
+ /** Upper bound for items returned. Cannot be negative. */
1784
+ pageSize?: number | undefined;
1785
+ }
1786
+ interface ListRolesResponse {
1787
+ /** List of Postgres roles in the branch. */
1788
+ roles?: Role[] | undefined;
1789
+ /** Token to request the next page of Postgres roles. */
1790
+ nextPageToken?: string | undefined;
1791
+ }
1792
+ interface NewPipelineSpec {
1793
+ /**
1794
+ * UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).
1795
+ * This needs to be a standard catalog where the user has permissions to create Delta tables.
1796
+ */
1797
+ storageCatalog?: string | undefined;
1798
+ /**
1799
+ * UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).
1800
+ * This needs to be in the standard catalog where the user has permissions to create Delta tables.
1801
+ */
1802
+ storageSchema?: string | undefined;
1803
+ /** Budget policy to set on the newly created pipeline. */
1804
+ budgetPolicyId?: string | undefined;
1848
1805
  }
1849
1806
  /**
1850
1807
  * This resource represents a long-running operation that is the result of a
1851
1808
  * network API call.
1852
1809
  */
1853
- export interface Operation {
1854
- /**
1855
- * The server-assigned name, which is only unique within the same service that
1856
- * originally returns it. If you use the default HTTP mapping, the
1857
- * `name` should be a resource name ending with `operations/{unique_id}`.
1858
- */
1859
- name?: string | undefined;
1860
- /**
1861
- * Service-specific metadata associated with the operation. It typically
1862
- * contains progress information and common metadata such as create time.
1863
- * Some services might not provide such metadata.
1864
- */
1865
- metadata?: Record<string, unknown> | undefined;
1866
- /**
1867
- * If the value is `false`, it means the operation is still in progress.
1868
- * If `true`, the operation is completed, and either `error` or `response` is
1869
- * available.
1870
- */
1871
- done?: boolean | undefined;
1872
- /**
1873
- * The operation result, which can be either an `error` or a valid `response`.
1874
- * If `done` == `false`, neither `error` nor `response` is set.
1875
- * If `done` == `true`, exactly one of `error` or `response` can be set.
1876
- * Some services might not provide the result.
1877
- */
1878
- result?: {
1879
- $case: 'error';
1880
- /** The error result of the operation in case of failure or cancellation. */
1881
- error: ApiError;
1882
- } | {
1883
- $case: 'response';
1884
- /** The normal, successful response of the operation. */
1885
- response: Record<string, unknown>;
1886
- } | undefined;
1887
- }
1888
- export interface Project {
1889
- /**
1890
- * Output only. The full resource path of the project.
1891
- * Format: projects/{project_id}
1892
- */
1893
- name?: string | undefined;
1894
- /** System-generated unique ID for the project. */
1895
- uid?: string | undefined;
1896
- /** A timestamp indicating when the project was created. */
1897
- createTime?: Temporal.Instant | undefined;
1898
- /** A timestamp indicating when the project was last updated. */
1899
- updateTime?: Temporal.Instant | undefined;
1900
- /** The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings. */
1901
- spec?: ProjectSpec | undefined;
1902
- /** The current status of a Project. */
1903
- status?: ProjectStatus | undefined;
1904
- /**
1905
- * Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly
1906
- * created project. If omitted, the initial endpoint created will have default settings, without high availability
1907
- * configured. This field does not apply to any endpoints created after project creation. Use
1908
- * spec.default_endpoint_settings to configure default settings for endpoints created after project creation.
1909
- */
1910
- initialEndpointSpec?: InitialEndpointSpec | undefined;
1911
- /**
1912
- * A timestamp indicating when the project was soft-deleted.
1913
- * Empty if the project is not deleted, otherwise set to a timestamp in the past.
1914
- */
1915
- deleteTime?: Temporal.Instant | undefined;
1916
- /**
1917
- * A timestamp indicating when the project is scheduled for permanent deletion.
1918
- * Empty if the project is not deleted, otherwise set to a timestamp in the future.
1919
- */
1920
- purgeTime?: Temporal.Instant | undefined;
1921
- /**
1922
- * Configuration for the initial default branch created as part of project creation.
1923
- * Allows overriding branch protection. These settings only apply at creation time
1924
- * and do not affect resources created after project creation.
1925
- */
1926
- initialBranchSpec?: InitialBranchSpec | undefined;
1927
- /** The part of the name, chosen by the user when the resource was created. */
1928
- projectId?: string | undefined;
1929
- }
1930
- export interface ProjectCustomTag {
1931
- /** The key of the custom tag. */
1932
- key?: string | undefined;
1933
- /** The value of the custom tag. */
1934
- value?: string | undefined;
1810
+ interface Operation {
1811
+ /**
1812
+ * The server-assigned name, which is only unique within the same service that
1813
+ * originally returns it. If you use the default HTTP mapping, the
1814
+ * `name` should be a resource name ending with `operations/{unique_id}`.
1815
+ */
1816
+ name?: string | undefined;
1817
+ /**
1818
+ * Service-specific metadata associated with the operation. It typically
1819
+ * contains progress information and common metadata such as create time.
1820
+ * Some services might not provide such metadata.
1821
+ */
1822
+ metadata?: Record<string, unknown> | undefined;
1823
+ /**
1824
+ * If the value is `false`, it means the operation is still in progress.
1825
+ * If `true`, the operation is completed, and either `error` or `response` is
1826
+ * available.
1827
+ */
1828
+ done?: boolean | undefined;
1829
+ /**
1830
+ * The operation result, which can be either an `error` or a valid `response`.
1831
+ * If `done` == `false`, neither `error` nor `response` is set.
1832
+ * If `done` == `true`, exactly one of `error` or `response` can be set.
1833
+ * Some services might not provide the result.
1834
+ */
1835
+ result?: {
1836
+ $case: 'error'; /** The error result of the operation in case of failure or cancellation. */
1837
+ error: ApiError;
1838
+ } | {
1839
+ $case: 'response'; /** The normal, successful response of the operation. */
1840
+ response: Record<string, unknown>;
1841
+ } | undefined;
1842
+ }
1843
+ interface Project {
1844
+ /**
1845
+ * Output only. The full resource path of the project.
1846
+ * Format: projects/{project_id}
1847
+ */
1848
+ name?: string | undefined;
1849
+ /** System-generated unique ID for the project. */
1850
+ uid?: string | undefined;
1851
+ /** A timestamp indicating when the project was created. */
1852
+ createTime?: Temporal.Instant | undefined;
1853
+ /** A timestamp indicating when the project was last updated. */
1854
+ updateTime?: Temporal.Instant | undefined;
1855
+ /** The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings. */
1856
+ spec?: ProjectSpec | undefined;
1857
+ /** The current status of a Project. */
1858
+ status?: ProjectStatus | undefined;
1859
+ /**
1860
+ * Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly
1861
+ * created project. If omitted, the initial endpoint created will have default settings, without high availability
1862
+ * configured. This field does not apply to any endpoints created after project creation. Use
1863
+ * spec.default_endpoint_settings to configure default settings for endpoints created after project creation.
1864
+ */
1865
+ initialEndpointSpec?: InitialEndpointSpec | undefined;
1866
+ /**
1867
+ * A timestamp indicating when the project was soft-deleted.
1868
+ * Empty if the project is not deleted, otherwise set to a timestamp in the past.
1869
+ */
1870
+ deleteTime?: Temporal.Instant | undefined;
1871
+ /**
1872
+ * A timestamp indicating when the project is scheduled for permanent deletion.
1873
+ * Empty if the project is not deleted, otherwise set to a timestamp in the future.
1874
+ */
1875
+ purgeTime?: Temporal.Instant | undefined;
1876
+ /**
1877
+ * Configuration for the initial default branch created as part of project creation.
1878
+ * Allows overriding branch protection. These settings only apply at creation time
1879
+ * and do not affect resources created after project creation.
1880
+ */
1881
+ initialBranchSpec?: InitialBranchSpec | undefined;
1882
+ /** The part of the name, chosen by the user when the resource was created. */
1883
+ projectId?: string | undefined;
1884
+ }
1885
+ interface ProjectCustomTag {
1886
+ /** The key of the custom tag. */
1887
+ key?: string | undefined;
1888
+ /** The value of the custom tag. */
1889
+ value?: string | undefined;
1935
1890
  }
1936
1891
  /** A collection of settings for a compute endpoint. */
1937
- export interface ProjectDefaultEndpointSettings {
1938
- /** The minimum number of Compute Units. Minimum value is 0.5. */
1939
- autoscalingLimitMinCu?: number | undefined;
1940
- /** The maximum number of Compute Units. Minimum value is 0.5. */
1941
- autoscalingLimitMaxCu?: number | undefined;
1942
- suspension?: {
1943
- $case: 'suspendTimeoutDuration';
1944
- /**
1945
- * Duration of inactivity after which the compute endpoint is automatically suspended.
1946
- * If specified should be between 60s and 604800s (1 minute to 1 week).
1947
- * Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
1948
- */
1949
- suspendTimeoutDuration: Temporal.Duration;
1950
- } | {
1951
- $case: 'noSuspension';
1952
- /**
1953
- * When set to true, explicitly disables automatic suspension (never suspend).
1954
- * Should be set to true when provided.
1955
- * Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
1956
- */
1957
- noSuspension: boolean;
1958
- } | undefined;
1959
- /** A raw representation of Postgres settings. */
1960
- pgSettings?: Record<string, string> | undefined;
1961
- }
1962
- export interface ProjectOperationMetadata {
1963
- }
1964
- export interface ProjectSpec {
1965
- /** Human-readable project name. Length should be between 1 and 256 characters. */
1966
- displayName?: string | undefined;
1967
- /** The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values. */
1968
- pgVersion?: number | undefined;
1969
- /** The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days). */
1970
- historyRetentionDuration?: Temporal.Duration | undefined;
1971
- defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
1972
- /**
1973
- * The desired budget policy to associate with the project.
1974
- * See status.budget_policy_id for the policy that is actually applied to the project.
1975
- */
1976
- budgetPolicyId?: string | undefined;
1977
- /**
1978
- * Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.
1979
- * To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask.
1980
- * To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask.
1981
- * To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).
1982
- */
1983
- customTags?: ProjectCustomTag[] | undefined;
1984
- /** Whether to enable PG native password login on all endpoints in this project. Defaults to false. */
1985
- enablePgNativeLogin?: boolean | undefined;
1986
- /**
1987
- * The full resource path for the default branch of the project
1988
- * Format: projects/{project_id}/branches/{branch_id}
1989
- */
1990
- defaultBranch?: string | undefined;
1991
- }
1992
- export interface ProjectStatus {
1993
- /** The effective human-readable project name. */
1994
- displayName?: string | undefined;
1995
- /** The effective major Postgres version number. */
1996
- pgVersion?: number | undefined;
1997
- /** The effective number of seconds to retain the shared history for point in time recovery. */
1998
- historyRetentionDuration?: Temporal.Duration | undefined;
1999
- /** The effective default endpoint settings. */
2000
- defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
2001
- /** The logical size limit for a branch. */
2002
- branchLogicalSizeLimitBytes?: bigint | undefined;
2003
- /** The current space occupied by the project in storage. */
2004
- syntheticStorageSizeBytes?: bigint | undefined;
2005
- /** The most recent time when any endpoint of this project was active. */
2006
- computeLastActiveTime?: Temporal.Instant | undefined;
2007
- /** The budget policy that is applied to the project. */
2008
- budgetPolicyId?: string | undefined;
2009
- /** The effective custom tags associated with the project. */
2010
- customTags?: ProjectCustomTag[] | undefined;
2011
- /** The email of the project owner. */
2012
- owner?: string | undefined;
2013
- /** Whether to enable PG native password login on all endpoints in this project. */
2014
- enablePgNativeLogin?: boolean | undefined;
2015
- /** The full resource path of the default branch of the project */
2016
- defaultBranch?: string | undefined;
2017
- /** Part of the resource name. */
2018
- projectId?: string | undefined;
1892
+ interface ProjectDefaultEndpointSettings {
1893
+ /** The minimum number of Compute Units. Minimum value is 0.5. */
1894
+ autoscalingLimitMinCu?: number | undefined;
1895
+ /** The maximum number of Compute Units. Minimum value is 0.5. */
1896
+ autoscalingLimitMaxCu?: number | undefined;
1897
+ suspension?: {
1898
+ $case: 'suspendTimeoutDuration';
1899
+ /**
1900
+ * Duration of inactivity after which the compute endpoint is automatically suspended.
1901
+ * If specified should be between 60s and 604800s (1 minute to 1 week).
1902
+ * Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
1903
+ */
1904
+ suspendTimeoutDuration: Temporal.Duration;
1905
+ } | {
1906
+ $case: 'noSuspension';
1907
+ /**
1908
+ * When set to true, explicitly disables automatic suspension (never suspend).
1909
+ * Should be set to true when provided.
1910
+ * Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
1911
+ */
1912
+ noSuspension: boolean;
1913
+ } | undefined;
1914
+ /** A raw representation of Postgres settings. */
1915
+ pgSettings?: Record<string, string> | undefined;
1916
+ }
1917
+ interface ProjectOperationMetadata {}
1918
+ interface ProjectSpec {
1919
+ /** Human-readable project name. Length should be between 1 and 256 characters. */
1920
+ displayName?: string | undefined;
1921
+ /** The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values. */
1922
+ pgVersion?: number | undefined;
1923
+ /** The number of seconds to retain the shared history for point in time recovery for all branches in this project. Value should be between 172800s (2 days) and 3024000s (35 days). */
1924
+ historyRetentionDuration?: Temporal.Duration | undefined;
1925
+ defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
1926
+ /**
1927
+ * The desired budget policy to associate with the project.
1928
+ * See status.budget_policy_id for the policy that is actually applied to the project.
1929
+ */
1930
+ budgetPolicyId?: string | undefined;
1931
+ /**
1932
+ * Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.
1933
+ * To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask.
1934
+ * To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask.
1935
+ * To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).
1936
+ */
1937
+ customTags?: ProjectCustomTag[] | undefined;
1938
+ /** Whether to enable PG native password login on all endpoints in this project. Defaults to false. */
1939
+ enablePgNativeLogin?: boolean | undefined;
1940
+ /**
1941
+ * The full resource path for the default branch of the project
1942
+ * Format: projects/{project_id}/branches/{branch_id}
1943
+ */
1944
+ defaultBranch?: string | undefined;
1945
+ }
1946
+ interface ProjectStatus {
1947
+ /** The effective human-readable project name. */
1948
+ displayName?: string | undefined;
1949
+ /** The effective major Postgres version number. */
1950
+ pgVersion?: number | undefined;
1951
+ /** The effective number of seconds to retain the shared history for point in time recovery. */
1952
+ historyRetentionDuration?: Temporal.Duration | undefined;
1953
+ /** The effective default endpoint settings. */
1954
+ defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
1955
+ /** The logical size limit for a branch. */
1956
+ branchLogicalSizeLimitBytes?: bigint | undefined;
1957
+ /** The current space occupied by the project in storage. */
1958
+ syntheticStorageSizeBytes?: bigint | undefined;
1959
+ /** The most recent time when any endpoint of this project was active. */
1960
+ computeLastActiveTime?: Temporal.Instant | undefined;
1961
+ /** The budget policy that is applied to the project. */
1962
+ budgetPolicyId?: string | undefined;
1963
+ /** The effective custom tags associated with the project. */
1964
+ customTags?: ProjectCustomTag[] | undefined;
1965
+ /** The email of the project owner. */
1966
+ owner?: string | undefined;
1967
+ /** Whether to enable PG native password login on all endpoints in this project. */
1968
+ enablePgNativeLogin?: boolean | undefined;
1969
+ /** The full resource path of the default branch of the project */
1970
+ defaultBranch?: string | undefined;
1971
+ /** Part of the resource name. */
1972
+ projectId?: string | undefined;
2019
1973
  }
2020
1974
  /** The provisioning state of a resource in Unity Catalog. */
2021
- export interface ProvisioningInfo {
1975
+ interface ProvisioningInfo {}
1976
+ interface RequestedClaims {
1977
+ permissionSet?: RequestedClaims_PermissionSet | undefined;
1978
+ resources?: RequestedResource[] | undefined;
2022
1979
  }
2023
- export interface RequestedClaims {
2024
- permissionSet?: RequestedClaims_PermissionSet | undefined;
2025
- resources?: RequestedResource[] | undefined;
2026
- }
2027
- export interface RequestedResource {
2028
- resourceName?: {
2029
- $case: 'tableName';
2030
- /** The full Unity Catalog table name. */
2031
- tableName: string;
2032
- } | undefined;
1980
+ interface RequestedResource {
1981
+ resourceName?: {
1982
+ $case: 'tableName'; /** The full Unity Catalog table name. */
1983
+ tableName: string;
1984
+ } | undefined;
2033
1985
  }
2034
1986
  /** Role represents a Postgres role within a Branch. */
2035
- export interface Role {
2036
- /**
2037
- * Output only. The full resource path of the role.
2038
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
2039
- */
2040
- name?: string | undefined;
2041
- /**
2042
- * The Branch where this Role exists.
2043
- * Format: projects/{project_id}/branches/{branch_id}
2044
- */
2045
- parent?: string | undefined;
2046
- createTime?: Temporal.Instant | undefined;
2047
- updateTime?: Temporal.Instant | undefined;
2048
- /** The spec contains the role configuration, including identity type, authentication method, and role attributes. */
2049
- spec?: Role_RoleSpec | undefined;
2050
- /** Current status of the role, including its identity type, authentication method, and role attributes. */
2051
- status?: Role_RoleStatus | undefined;
2052
- /** The part of the name, chosen by the user when the resource was created. */
2053
- roleId?: string | undefined;
1987
+ interface Role {
1988
+ /**
1989
+ * Output only. The full resource path of the role.
1990
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
1991
+ */
1992
+ name?: string | undefined;
1993
+ /**
1994
+ * The Branch where this Role exists.
1995
+ * Format: projects/{project_id}/branches/{branch_id}
1996
+ */
1997
+ parent?: string | undefined;
1998
+ createTime?: Temporal.Instant | undefined;
1999
+ updateTime?: Temporal.Instant | undefined;
2000
+ /** The spec contains the role configuration, including identity type, authentication method, and role attributes. */
2001
+ spec?: Role_RoleSpec | undefined;
2002
+ /** Current status of the role, including its identity type, authentication method, and role attributes. */
2003
+ status?: Role_RoleStatus | undefined;
2004
+ /** The part of the name, chosen by the user when the resource was created. */
2005
+ roleId?: string | undefined;
2054
2006
  }
2055
2007
  /**
2056
2008
  * Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref:
@@ -2058,453 +2010,453 @@ export interface Role {
2058
2010
  * The values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical
2059
2011
  * underscores between words.
2060
2012
  */
2061
- export interface Role_Attributes {
2062
- createdb?: boolean | undefined;
2063
- createrole?: boolean | undefined;
2064
- bypassrls?: boolean | undefined;
2065
- }
2066
- export interface Role_RoleSpec {
2067
- /** An enum value for a standard role that this role is a member of. */
2068
- membershipRoles?: Role_MembershipRole[] | undefined;
2069
- /**
2070
- * The type of role.
2071
- * When specifying a managed-identity, the chosen role_id must be a valid:
2072
- *
2073
- * * application ID for SERVICE_PRINCIPAL
2074
- * * user email for USER
2075
- * * group name for GROUP
2076
- */
2077
- identityType?: Role_IdentityType | undefined;
2078
- /** The desired API-exposed Postgres role attribute to associate with the role. Optional. */
2079
- attributes?: Role_Attributes | undefined;
2080
- /**
2081
- * Controls how the Postgres role authenticates when a client opens a database
2082
- * connection. Supported values:
2083
- *
2084
- * * LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks
2085
- * OAuth access token derived from the backing managed identity (the
2086
- * <Databricks> user, service principal, or group named by the role's
2087
- * `postgres_role`). No static password exists for roles using this method.
2088
- * * PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres
2089
- * password verified server-side using the SCRAM-SHA-256 mechanism.
2090
- * Lakebase generates a password for the role.
2091
- * * NO_LOGIN: the role cannot open a Postgres session at all. Useful for
2092
- * roles that exist only to own objects or to aggregate privileges that
2093
- * are then granted to other, loginable roles.
2094
- *
2095
- * If auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:
2096
- * * For the managed identities, OAUTH is used.
2097
- * * For the regular postgres roles, authentication based on postgres passwords is used.
2098
- *
2099
- * NOTE: for the <Databricks> identity type GROUP, LAKEBASE_OAUTH_V1
2100
- * is the default auth method (group can login as well).
2101
- */
2102
- authMethod?: Role_AuthMethod | undefined;
2103
- /**
2104
- * The name of the Postgres role.
2105
- *
2106
- * This expects a valid Postgres identifier as specified in the link below.
2107
- * https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
2108
- *
2109
- * Required when creating the Role.
2110
- *
2111
- * If you wish to create a Postgres Role backed by a managed <Databricks> identity, then postgres_role
2112
- * must be one of the following:
2113
- *
2114
- * 1. user email for IdentityType.USER
2115
- * 2. app ID for IdentityType.SERVICE_PRINCIPAL
2116
- * 2. group name for IdentityType.GROUP
2117
- */
2118
- postgresRole?: string | undefined;
2119
- }
2120
- export interface Role_RoleStatus {
2121
- /** An enum value for a standard role that this role is a member of. */
2122
- membershipRoles?: Role_MembershipRole[] | undefined;
2123
- /** The type of the role. */
2124
- identityType?: Role_IdentityType | undefined;
2125
- /** The PG role attributes associated with the role. */
2126
- attributes?: Role_Attributes | undefined;
2127
- authMethod?: Role_AuthMethod | undefined;
2128
- /** The name of the Postgres role. */
2129
- postgresRole?: string | undefined;
2130
- /** Part of the resource name. */
2131
- roleId?: string | undefined;
2132
- }
2133
- export interface RoleOperationMetadata {
2134
- }
2135
- export interface SyncedTable {
2136
- /**
2137
- * Output only. The Full resource name of the synced table in Postgres
2138
- * where (catalog, schema, table) are the UC entity names.
2139
- *
2140
- * Format "synced_tables/{catalog}.{schema}.{table}"
2141
- *
2142
- * For the corresponding source table in the Unity catalog look for the "source_table_full_name" attribute.
2143
- */
2144
- name?: string | undefined;
2145
- /** The Unity Catalog table ID for this synced table. */
2146
- uid?: string | undefined;
2147
- /**
2148
- * Configuration details of the synced table, such as the source table, scheduling policy, etc.
2149
- * This attribute is specified at creation time and most fields are returned as is on subsequent queries.
2150
- */
2151
- spec?: SyncedTable_SyncedTableSpec | undefined;
2152
- /** Synced Table data synchronization status. */
2153
- status?: SyncedTable_SyncedTableStatus | undefined;
2154
- createTime?: Temporal.Instant | undefined;
2155
- /** The part of the name, chosen by the user when the resource was created. */
2156
- syncedTableId?: string | undefined;
2157
- }
2158
- export interface SyncedTable_SyncedTableSpec {
2159
- /**
2160
- * The Postgres database name where the synced table will be created in.
2161
- *
2162
- * If this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred
2163
- * from the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.
2164
- *
2165
- * A value must be specified when creating a synced table inside a Standard Catalog.
2166
- */
2167
- postgresDatabase?: string | undefined;
2168
- /**
2169
- * The full resource name the branch associated with the table.
2170
- *
2171
- * Format: "projects/{project_id}/branches/{branch_id}".
2172
- */
2173
- branch?: string | undefined;
2174
- /** Scheduling policy of the underlying pipeline. */
2175
- schedulingPolicy?: SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy | undefined;
2176
- /**
2177
- * Three-part (catalog, schema, table) name of the source Delta table.
2178
- *
2179
- * For the corresponding destination table, use any of the two:
2180
- *
2181
- * * synced_table_id used at the creation of the SyncedTable
2182
- * * "name" consisting of "synced_tables/" prefix and the full name of the destination table.
2183
- */
2184
- sourceTableFullName?: string | undefined;
2185
- /** Primary Key columns to be used for data insert/update in the destination. */
2186
- primaryKeyColumns?: string[] | undefined;
2187
- /** Time series key to deduplicate (tie-break) rows with the same primary key. */
2188
- timeseriesKey?: string | undefined;
2189
- /**
2190
- * ID of an existing pipeline to bin-pack this synced table into.
2191
- * At most one of existing_pipeline_id and new_pipeline_spec should be defined.
2192
- *
2193
- * The pipeline used for the synced table is returned via the top level pipeline_id attribute.
2194
- */
2195
- existingPipelineId?: string | undefined;
2196
- /**
2197
- * If true, the synced table's logical database and schema resources in PG
2198
- * will be created if they do not already exist.
2199
- * The request will fail if this is false and the database/schema do not exist.
2200
- *
2201
- * Defaults to true if omitted.
2202
- */
2203
- createDatabaseObjectsIfMissing?: boolean | undefined;
2204
- /**
2205
- * Specification for creating a new pipeline.
2206
- * At most one of existing_pipeline_id and new_pipeline_spec should be defined.
2207
- *
2208
- * The pipeline used for the synced table is returned via the top level pipeline_id attribute.
2209
- */
2210
- newPipelineSpec?: NewPipelineSpec | undefined;
2211
- /**
2212
- * When true, enables accelerated sync mode for the initial data load.
2213
- * This significantly improves performance for large tables.
2214
- * Requires workspace-level enablement through Lakebase Accelerated Sync preview.
2215
- */
2216
- acceleratedSync?: boolean | undefined;
2217
- /**
2218
- * Override the default Delta->PG type mapping for specific columns.
2219
- * A TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set.
2220
- */
2221
- typeOverrides?: SyncedTable_SyncedTableSpec_TypeOverride[] | undefined;
2222
- /** Extra PostgreSQL-only columns to add to the synced table. */
2223
- extraColumns?: SyncedTable_SyncedTableSpec_ExtraColumn[] | undefined;
2013
+ interface Role_Attributes {
2014
+ createdb?: boolean | undefined;
2015
+ createrole?: boolean | undefined;
2016
+ bypassrls?: boolean | undefined;
2017
+ }
2018
+ interface Role_RoleSpec {
2019
+ /** An enum value for a standard role that this role is a member of. */
2020
+ membershipRoles?: Role_MembershipRole[] | undefined;
2021
+ /**
2022
+ * The type of role.
2023
+ * When specifying a managed-identity, the chosen role_id must be a valid:
2024
+ *
2025
+ * * application ID for SERVICE_PRINCIPAL
2026
+ * * user email for USER
2027
+ * * group name for GROUP
2028
+ */
2029
+ identityType?: Role_IdentityType | undefined;
2030
+ /** The desired API-exposed Postgres role attribute to associate with the role. Optional. */
2031
+ attributes?: Role_Attributes | undefined;
2032
+ /**
2033
+ * Controls how the Postgres role authenticates when a client opens a database
2034
+ * connection. Supported values:
2035
+ *
2036
+ * * LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks
2037
+ * OAuth access token derived from the backing managed identity (the
2038
+ * <Databricks> user, service principal, or group named by the role's
2039
+ * `postgres_role`). No static password exists for roles using this method.
2040
+ * * PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres
2041
+ * password verified server-side using the SCRAM-SHA-256 mechanism.
2042
+ * Lakebase generates a password for the role.
2043
+ * * NO_LOGIN: the role cannot open a Postgres session at all. Useful for
2044
+ * roles that exist only to own objects or to aggregate privileges that
2045
+ * are then granted to other, loginable roles.
2046
+ *
2047
+ * If auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:
2048
+ * * For the managed identities, OAUTH is used.
2049
+ * * For the regular postgres roles, authentication based on postgres passwords is used.
2050
+ *
2051
+ * NOTE: for the <Databricks> identity type GROUP, LAKEBASE_OAUTH_V1
2052
+ * is the default auth method (group can login as well).
2053
+ */
2054
+ authMethod?: Role_AuthMethod | undefined;
2055
+ /**
2056
+ * The name of the Postgres role.
2057
+ *
2058
+ * This expects a valid Postgres identifier as specified in the link below.
2059
+ * https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
2060
+ *
2061
+ * Required when creating the Role.
2062
+ *
2063
+ * If you wish to create a Postgres Role backed by a managed <Databricks> identity, then postgres_role
2064
+ * must be one of the following:
2065
+ *
2066
+ * 1. user email for IdentityType.USER
2067
+ * 2. app ID for IdentityType.SERVICE_PRINCIPAL
2068
+ * 2. group name for IdentityType.GROUP
2069
+ */
2070
+ postgresRole?: string | undefined;
2071
+ }
2072
+ interface Role_RoleStatus {
2073
+ /** An enum value for a standard role that this role is a member of. */
2074
+ membershipRoles?: Role_MembershipRole[] | undefined;
2075
+ /** The type of the role. */
2076
+ identityType?: Role_IdentityType | undefined;
2077
+ /** The PG role attributes associated with the role. */
2078
+ attributes?: Role_Attributes | undefined;
2079
+ authMethod?: Role_AuthMethod | undefined;
2080
+ /** The name of the Postgres role. */
2081
+ postgresRole?: string | undefined;
2082
+ /** Part of the resource name. */
2083
+ roleId?: string | undefined;
2084
+ }
2085
+ interface RoleOperationMetadata {}
2086
+ interface SyncedTable {
2087
+ /**
2088
+ * Output only. The Full resource name of the synced table in Postgres
2089
+ * where (catalog, schema, table) are the UC entity names.
2090
+ *
2091
+ * Format "synced_tables/{catalog}.{schema}.{table}"
2092
+ *
2093
+ * For the corresponding source table in the Unity catalog look for the "source_table_full_name" attribute.
2094
+ */
2095
+ name?: string | undefined;
2096
+ /** The Unity Catalog table ID for this synced table. */
2097
+ uid?: string | undefined;
2098
+ /**
2099
+ * Configuration details of the synced table, such as the source table, scheduling policy, etc.
2100
+ * This attribute is specified at creation time and most fields are returned as is on subsequent queries.
2101
+ */
2102
+ spec?: SyncedTable_SyncedTableSpec | undefined;
2103
+ /** Synced Table data synchronization status. */
2104
+ status?: SyncedTable_SyncedTableStatus | undefined;
2105
+ createTime?: Temporal.Instant | undefined;
2106
+ /** The part of the name, chosen by the user when the resource was created. */
2107
+ syncedTableId?: string | undefined;
2108
+ }
2109
+ interface SyncedTable_SyncedTableSpec {
2110
+ /**
2111
+ * The Postgres database name where the synced table will be created in.
2112
+ *
2113
+ * If this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred
2114
+ * from the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.
2115
+ *
2116
+ * A value must be specified when creating a synced table inside a Standard Catalog.
2117
+ */
2118
+ postgresDatabase?: string | undefined;
2119
+ /**
2120
+ * The full resource name the branch associated with the table.
2121
+ *
2122
+ * Format: "projects/{project_id}/branches/{branch_id}".
2123
+ */
2124
+ branch?: string | undefined;
2125
+ /** Scheduling policy of the underlying pipeline. */
2126
+ schedulingPolicy?: SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy | undefined;
2127
+ /**
2128
+ * Three-part (catalog, schema, table) name of the source Delta table.
2129
+ *
2130
+ * For the corresponding destination table, use any of the two:
2131
+ *
2132
+ * * synced_table_id used at the creation of the SyncedTable
2133
+ * * "name" consisting of "synced_tables/" prefix and the full name of the destination table.
2134
+ */
2135
+ sourceTableFullName?: string | undefined;
2136
+ /** Primary Key columns to be used for data insert/update in the destination. */
2137
+ primaryKeyColumns?: string[] | undefined;
2138
+ /** Time series key to deduplicate (tie-break) rows with the same primary key. */
2139
+ timeseriesKey?: string | undefined;
2140
+ /**
2141
+ * ID of an existing pipeline to bin-pack this synced table into.
2142
+ * At most one of existing_pipeline_id and new_pipeline_spec should be defined.
2143
+ *
2144
+ * The pipeline used for the synced table is returned via the top level pipeline_id attribute.
2145
+ */
2146
+ existingPipelineId?: string | undefined;
2147
+ /**
2148
+ * If true, the synced table's logical database and schema resources in PG
2149
+ * will be created if they do not already exist.
2150
+ * The request will fail if this is false and the database/schema do not exist.
2151
+ *
2152
+ * Defaults to true if omitted.
2153
+ */
2154
+ createDatabaseObjectsIfMissing?: boolean | undefined;
2155
+ /**
2156
+ * Specification for creating a new pipeline.
2157
+ * At most one of existing_pipeline_id and new_pipeline_spec should be defined.
2158
+ *
2159
+ * The pipeline used for the synced table is returned via the top level pipeline_id attribute.
2160
+ */
2161
+ newPipelineSpec?: NewPipelineSpec | undefined;
2162
+ /**
2163
+ * When true, enables accelerated sync mode for the initial data load.
2164
+ * This significantly improves performance for large tables.
2165
+ * Requires workspace-level enablement through Lakebase Accelerated Sync preview.
2166
+ */
2167
+ acceleratedSync?: boolean | undefined;
2168
+ /**
2169
+ * Override the default Delta->PG type mapping for specific columns.
2170
+ * A TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set.
2171
+ */
2172
+ typeOverrides?: SyncedTable_SyncedTableSpec_TypeOverride[] | undefined;
2173
+ /** Extra PostgreSQL-only columns to add to the synced table. */
2174
+ extraColumns?: SyncedTable_SyncedTableSpec_ExtraColumn[] | undefined;
2224
2175
  }
2225
2176
  /** An extra PostgreSQL column to add to the synced table. */
2226
- export interface SyncedTable_SyncedTableSpec_ExtraColumn {
2227
- /** Name of the column. */
2228
- columnName?: string | undefined;
2229
- /** PostgreSQL type of the column, for example "tsvector" or "vector(1024)". */
2230
- columnType?: string | undefined;
2231
- maintenance?: SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance | undefined;
2232
- /**
2233
- * SQL expression used to compute the column's value, for example
2234
- * "to_tsvector('english', content)".
2235
- */
2236
- compute?: string | undefined;
2177
+ interface SyncedTable_SyncedTableSpec_ExtraColumn {
2178
+ /** Name of the column. */
2179
+ columnName?: string | undefined;
2180
+ /** PostgreSQL type of the column, for example "tsvector" or "vector(1024)". */
2181
+ columnType?: string | undefined;
2182
+ maintenance?: SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance | undefined;
2183
+ /**
2184
+ * SQL expression used to compute the column's value, for example
2185
+ * "to_tsvector('english', content)".
2186
+ */
2187
+ compute?: string | undefined;
2237
2188
  }
2238
2189
  /** Overrides the default Delta-to-PostgreSQL type mapping for a single column. */
2239
- export interface SyncedTable_SyncedTableSpec_TypeOverride {
2240
- /** Name of the source column whose target PostgreSQL type should be overridden. */
2241
- columnName?: string | undefined;
2242
- /** PostgreSQL-specific target type to use for the column. */
2243
- pgType?: SyncedTable_SyncedTableSpec_PgSpecificType | undefined;
2244
- /**
2245
- * Size parameter for the target type, for types that take one (e.g. vector
2246
- * dimension, varchar length). Required when the chosen pg_type needs a size.
2247
- */
2248
- size?: number | undefined;
2249
- }
2250
- export interface SyncedTable_SyncedTableStatus {
2251
- /** A text description of the current state of the synced table. */
2252
- message?: string | undefined;
2253
- /** The state of the synced table. */
2254
- detailedState?: SyncedTableState | undefined;
2255
- /** Summary of the last successful synchronization from source to destination. */
2256
- lastSync?: SyncedTablePosition | undefined;
2257
- ongoingSyncProgress?: SyncedTablePipelineProgress | undefined;
2258
- /** The current phase of the data synchronization pipeline. */
2259
- provisioningPhase?: ProvisioningPhase | undefined;
2260
- /** The last source table Delta version that was successfully synced to the synced table. */
2261
- lastProcessedCommitVersion?: bigint | undefined;
2262
- /**
2263
- * The end timestamp of the last time any data was synchronized from the source table to the synced
2264
- * table. This is when the data is available in the synced table.
2265
- */
2266
- lastSyncTime?: Temporal.Instant | undefined;
2267
- /** ID of the associated pipeline. */
2268
- pipelineId?: string | undefined;
2269
- /** The provisioning state of the synced table entity in Unity Catalog. */
2270
- unityCatalogProvisioningState?: ProvisioningInfo_State | undefined;
2271
- /**
2272
- * The full resource name of the project associated with the table.
2273
- *
2274
- * Format: "projects/{project_id}".
2275
- */
2276
- project?: string | undefined;
2190
+ interface SyncedTable_SyncedTableSpec_TypeOverride {
2191
+ /** Name of the source column whose target PostgreSQL type should be overridden. */
2192
+ columnName?: string | undefined;
2193
+ /** PostgreSQL-specific target type to use for the column. */
2194
+ pgType?: SyncedTable_SyncedTableSpec_PgSpecificType | undefined;
2195
+ /**
2196
+ * Size parameter for the target type, for types that take one (e.g. vector
2197
+ * dimension, varchar length). Required when the chosen pg_type needs a size.
2198
+ */
2199
+ size?: number | undefined;
2200
+ }
2201
+ interface SyncedTable_SyncedTableStatus {
2202
+ /** A text description of the current state of the synced table. */
2203
+ message?: string | undefined;
2204
+ /** The state of the synced table. */
2205
+ detailedState?: SyncedTableState | undefined;
2206
+ /** Summary of the last successful synchronization from source to destination. */
2207
+ lastSync?: SyncedTablePosition | undefined;
2208
+ ongoingSyncProgress?: SyncedTablePipelineProgress | undefined;
2209
+ /** The current phase of the data synchronization pipeline. */
2210
+ provisioningPhase?: ProvisioningPhase | undefined;
2211
+ /** The last source table Delta version that was successfully synced to the synced table. */
2212
+ lastProcessedCommitVersion?: bigint | undefined;
2213
+ /**
2214
+ * The end timestamp of the last time any data was synchronized from the source table to the synced
2215
+ * table. This is when the data is available in the synced table.
2216
+ */
2217
+ lastSyncTime?: Temporal.Instant | undefined;
2218
+ /** ID of the associated pipeline. */
2219
+ pipelineId?: string | undefined;
2220
+ /** The provisioning state of the synced table entity in Unity Catalog. */
2221
+ unityCatalogProvisioningState?: ProvisioningInfo_State | undefined;
2222
+ /**
2223
+ * The full resource name of the project associated with the table.
2224
+ *
2225
+ * Format: "projects/{project_id}".
2226
+ */
2227
+ project?: string | undefined;
2277
2228
  }
2278
2229
  /** Metadata for SyncedTable long-running operations. */
2279
- export interface SyncedTableOperationMetadata {
2280
- }
2230
+ interface SyncedTableOperationMetadata {}
2281
2231
  /** Progress information of the Synced Table data synchronization pipeline. */
2282
- export interface SyncedTablePipelineProgress {
2283
- /**
2284
- * The source table Delta version that was last processed by the pipeline. The pipeline may not
2285
- * have completely processed this version yet.
2286
- */
2287
- latestVersionCurrentlyProcessing?: bigint | undefined;
2288
- /** The number of rows that have been synced in this update. */
2289
- syncedRowCount?: bigint | undefined;
2290
- /** The total number of rows that need to be synced in this update. This number may be an estimate. */
2291
- totalRowCount?: bigint | undefined;
2292
- /** The completion ratio of this update. This is a number between 0 and 1. */
2293
- syncProgressCompletion?: number | undefined;
2294
- /** The estimated time remaining to complete this update in seconds. */
2295
- estimatedCompletionTimeSeconds?: number | undefined;
2296
- }
2297
- export interface SyncedTablePosition {
2298
- /**
2299
- * The starting timestamp of the most recent successful synchronization from the source table
2300
- * to the destination (synced) table.
2301
- * Note this is the starting timestamp of the sync operation, not the end time.
2302
- * E.g., for a batch, this is the time when the sync operation started.
2303
- */
2304
- syncStartTime?: Temporal.Instant | undefined;
2305
- /**
2306
- * The end timestamp of the most recent successful synchronization.
2307
- * This is the time when the data is available in the synced table.
2308
- */
2309
- syncEndTime?: Temporal.Instant | undefined;
2310
- /** Information about the source system at the time of the last sync. */
2311
- sourceSyncInfo?: {
2312
- $case: 'deltaTableSyncInfo';
2313
- deltaTableSyncInfo: DeltaTableSyncInfo;
2314
- } | undefined;
2315
- }
2316
- export interface UndeleteBranchRequest {
2317
- /**
2318
- * The full resource path of the branch to undelete.
2319
- * Format: projects/{project_id}/branches/{branch_id}
2320
- */
2321
- name?: string | undefined;
2232
+ interface SyncedTablePipelineProgress {
2233
+ /**
2234
+ * The source table Delta version that was last processed by the pipeline. The pipeline may not
2235
+ * have completely processed this version yet.
2236
+ */
2237
+ latestVersionCurrentlyProcessing?: bigint | undefined;
2238
+ /** The number of rows that have been synced in this update. */
2239
+ syncedRowCount?: bigint | undefined;
2240
+ /** The total number of rows that need to be synced in this update. This number may be an estimate. */
2241
+ totalRowCount?: bigint | undefined;
2242
+ /** The completion ratio of this update. This is a number between 0 and 1. */
2243
+ syncProgressCompletion?: number | undefined;
2244
+ /** The estimated time remaining to complete this update in seconds. */
2245
+ estimatedCompletionTimeSeconds?: number | undefined;
2246
+ }
2247
+ interface SyncedTablePosition {
2248
+ /**
2249
+ * The starting timestamp of the most recent successful synchronization from the source table
2250
+ * to the destination (synced) table.
2251
+ * Note this is the starting timestamp of the sync operation, not the end time.
2252
+ * E.g., for a batch, this is the time when the sync operation started.
2253
+ */
2254
+ syncStartTime?: Temporal.Instant | undefined;
2255
+ /**
2256
+ * The end timestamp of the most recent successful synchronization.
2257
+ * This is the time when the data is available in the synced table.
2258
+ */
2259
+ syncEndTime?: Temporal.Instant | undefined;
2260
+ /** Information about the source system at the time of the last sync. */
2261
+ sourceSyncInfo?: {
2262
+ $case: 'deltaTableSyncInfo';
2263
+ deltaTableSyncInfo: DeltaTableSyncInfo;
2264
+ } | undefined;
2265
+ }
2266
+ interface UndeleteBranchRequest {
2267
+ /**
2268
+ * The full resource path of the branch to undelete.
2269
+ * Format: projects/{project_id}/branches/{branch_id}
2270
+ */
2271
+ name?: string | undefined;
2322
2272
  }
2323
2273
  /** Request to restore a soft-deleted project within its retention period. */
2324
- export interface UndeleteProjectRequest {
2325
- /**
2326
- * The full resource path of the project to undelete.
2327
- * Format: projects/{project_id}
2328
- */
2329
- name?: string | undefined;
2330
- }
2331
- export interface UpdateBranchRequest {
2332
- /**
2333
- * The Branch to update.
2334
- *
2335
- * The branch's `name` field is used to identify the branch to update.
2336
- * Format: projects/{project_id}/branches/{branch_id}
2337
- */
2338
- branch?: Branch | undefined;
2339
- /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2340
- updateMask?: FieldMask<Branch> | undefined;
2274
+ interface UndeleteProjectRequest {
2275
+ /**
2276
+ * The full resource path of the project to undelete.
2277
+ * Format: projects/{project_id}
2278
+ */
2279
+ name?: string | undefined;
2280
+ }
2281
+ interface UpdateBranchRequest {
2282
+ /**
2283
+ * The Branch to update.
2284
+ *
2285
+ * The branch's `name` field is used to identify the branch to update.
2286
+ * Format: projects/{project_id}/branches/{branch_id}
2287
+ */
2288
+ branch?: Branch | undefined;
2289
+ /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2290
+ updateMask?: FieldMask<Branch> | undefined;
2341
2291
  }
2342
2292
  /** Update Data API configuration for a database. */
2343
- export interface UpdateDataApiRequest {
2344
- /**
2345
- * The Data API configuration to update.
2346
- * The data_api's `name` field identifies the resource.
2347
- */
2348
- dataApi?: DataApi | undefined;
2349
- /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2350
- updateMask?: FieldMask<DataApi> | undefined;
2351
- }
2352
- export interface UpdateDatabaseRequest {
2353
- /**
2354
- * The Database to update.
2355
- *
2356
- * The database's `name` field is used to identify the database to update.
2357
- * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
2358
- */
2359
- database?: Database | undefined;
2360
- /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2361
- updateMask?: FieldMask<Database> | undefined;
2362
- }
2363
- export interface UpdateEndpointRequest {
2364
- /**
2365
- * The Endpoint to update.
2366
- *
2367
- * The endpoint's `name` field is used to identify the endpoint to update.
2368
- * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
2369
- */
2370
- endpoint?: Endpoint | undefined;
2371
- /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2372
- updateMask?: FieldMask<Endpoint> | undefined;
2373
- }
2374
- export interface UpdateProjectRequest {
2375
- /**
2376
- * The Project to update.
2377
- *
2378
- * The project's `name` field is used to identify the project to update.
2379
- * Format: projects/{project_id}
2380
- */
2381
- project?: Project | undefined;
2382
- /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2383
- updateMask?: FieldMask<Project> | undefined;
2384
- }
2385
- export interface UpdateRoleRequest {
2386
- /**
2387
- * The Postgres Role to update.
2388
- *
2389
- * The role's `name` field is used to identify the role to update.
2390
- * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
2391
- */
2392
- role?: Role | undefined;
2393
- /**
2394
- * The list of fields to update in Postgres Role.
2395
- * If unspecified, all fields will be updated when possible.
2396
- */
2397
- updateMask?: FieldMask<Role> | undefined;
2398
- }
2399
- export declare const unmarshalApiErrorSchema: z.ZodType<ApiError>;
2400
- export declare const unmarshalBranchSchema: z.ZodType<Branch>;
2401
- export declare const unmarshalBranchOperationMetadataSchema: z.ZodType<BranchOperationMetadata>;
2402
- export declare const unmarshalBranchSpecSchema: z.ZodType<BranchSpec>;
2403
- export declare const unmarshalBranchStatusSchema: z.ZodType<BranchStatus>;
2404
- export declare const unmarshalCatalogSchema: z.ZodType<Catalog>;
2405
- export declare const unmarshalCatalog_CatalogSpecSchema: z.ZodType<Catalog_CatalogSpec>;
2406
- export declare const unmarshalCatalog_CatalogStatusSchema: z.ZodType<Catalog_CatalogStatus>;
2407
- export declare const unmarshalCatalogOperationMetadataSchema: z.ZodType<CatalogOperationMetadata>;
2408
- export declare const unmarshalCdfConfigSchema: z.ZodType<CdfConfig>;
2409
- export declare const unmarshalCdfConfigOperationMetadataSchema: z.ZodType<CdfConfigOperationMetadata>;
2410
- export declare const unmarshalCdfStatusSchema: z.ZodType<CdfStatus>;
2411
- export declare const unmarshalDataApiSchema: z.ZodType<DataApi>;
2412
- export declare const unmarshalDataApi_DataApiSpecSchema: z.ZodType<DataApi_DataApiSpec>;
2413
- export declare const unmarshalDataApi_DataApiStatusSchema: z.ZodType<DataApi_DataApiStatus>;
2414
- export declare const unmarshalDataApiOperationMetadataSchema: z.ZodType<DataApiOperationMetadata>;
2415
- export declare const unmarshalDatabaseSchema: z.ZodType<Database>;
2416
- export declare const unmarshalDatabase_DatabaseSpecSchema: z.ZodType<Database_DatabaseSpec>;
2417
- export declare const unmarshalDatabase_DatabaseStatusSchema: z.ZodType<Database_DatabaseStatus>;
2418
- export declare const unmarshalDatabaseCredentialSchema: z.ZodType<DatabaseCredential>;
2419
- export declare const unmarshalDatabaseOperationMetadataSchema: z.ZodType<DatabaseOperationMetadata>;
2420
- export declare const unmarshalDeltaTableSyncInfoSchema: z.ZodType<DeltaTableSyncInfo>;
2421
- export declare const unmarshalEndpointSchema: z.ZodType<Endpoint>;
2422
- export declare const unmarshalEndpointGroupSpecSchema: z.ZodType<EndpointGroupSpec>;
2423
- export declare const unmarshalEndpointGroupStatusSchema: z.ZodType<EndpointGroupStatus>;
2424
- export declare const unmarshalEndpointHostsSchema: z.ZodType<EndpointHosts>;
2425
- export declare const unmarshalEndpointOperationMetadataSchema: z.ZodType<EndpointOperationMetadata>;
2426
- export declare const unmarshalEndpointSettingsSchema: z.ZodType<EndpointSettings>;
2427
- export declare const unmarshalEndpointSpecSchema: z.ZodType<EndpointSpec>;
2428
- export declare const unmarshalEndpointStatusSchema: z.ZodType<EndpointStatus>;
2429
- export declare const unmarshalInitialBranchSpecSchema: z.ZodType<InitialBranchSpec>;
2430
- export declare const unmarshalInitialEndpointSpecSchema: z.ZodType<InitialEndpointSpec>;
2431
- export declare const unmarshalListBranchesResponseSchema: z.ZodType<ListBranchesResponse>;
2432
- export declare const unmarshalListCdfConfigsResponseSchema: z.ZodType<ListCdfConfigsResponse>;
2433
- export declare const unmarshalListCdfStatusesResponseSchema: z.ZodType<ListCdfStatusesResponse>;
2434
- export declare const unmarshalListDatabasesResponseSchema: z.ZodType<ListDatabasesResponse>;
2435
- export declare const unmarshalListEndpointsResponseSchema: z.ZodType<ListEndpointsResponse>;
2436
- export declare const unmarshalListProjectsResponseSchema: z.ZodType<ListProjectsResponse>;
2437
- export declare const unmarshalListRolesResponseSchema: z.ZodType<ListRolesResponse>;
2438
- export declare const unmarshalNewPipelineSpecSchema: z.ZodType<NewPipelineSpec>;
2439
- export declare const unmarshalOperationSchema: z.ZodType<Operation>;
2440
- export declare const unmarshalProjectSchema: z.ZodType<Project>;
2441
- export declare const unmarshalProjectCustomTagSchema: z.ZodType<ProjectCustomTag>;
2442
- export declare const unmarshalProjectDefaultEndpointSettingsSchema: z.ZodType<ProjectDefaultEndpointSettings>;
2443
- export declare const unmarshalProjectOperationMetadataSchema: z.ZodType<ProjectOperationMetadata>;
2444
- export declare const unmarshalProjectSpecSchema: z.ZodType<ProjectSpec>;
2445
- export declare const unmarshalProjectStatusSchema: z.ZodType<ProjectStatus>;
2446
- export declare const unmarshalRoleSchema: z.ZodType<Role>;
2447
- export declare const unmarshalRole_AttributesSchema: z.ZodType<Role_Attributes>;
2448
- export declare const unmarshalRole_RoleSpecSchema: z.ZodType<Role_RoleSpec>;
2449
- export declare const unmarshalRole_RoleStatusSchema: z.ZodType<Role_RoleStatus>;
2450
- export declare const unmarshalRoleOperationMetadataSchema: z.ZodType<RoleOperationMetadata>;
2451
- export declare const unmarshalSyncedTableSchema: z.ZodType<SyncedTable>;
2452
- export declare const unmarshalSyncedTable_SyncedTableSpecSchema: z.ZodType<SyncedTable_SyncedTableSpec>;
2453
- export declare const unmarshalSyncedTable_SyncedTableSpec_ExtraColumnSchema: z.ZodType<SyncedTable_SyncedTableSpec_ExtraColumn>;
2454
- export declare const unmarshalSyncedTable_SyncedTableSpec_TypeOverrideSchema: z.ZodType<SyncedTable_SyncedTableSpec_TypeOverride>;
2455
- export declare const unmarshalSyncedTable_SyncedTableStatusSchema: z.ZodType<SyncedTable_SyncedTableStatus>;
2456
- export declare const unmarshalSyncedTableOperationMetadataSchema: z.ZodType<SyncedTableOperationMetadata>;
2457
- export declare const unmarshalSyncedTablePipelineProgressSchema: z.ZodType<SyncedTablePipelineProgress>;
2458
- export declare const unmarshalSyncedTablePositionSchema: z.ZodType<SyncedTablePosition>;
2459
- export declare const marshalBranchSchema: z.ZodType;
2460
- export declare const marshalBranchSpecSchema: z.ZodType;
2461
- export declare const marshalBranchStatusSchema: z.ZodType;
2462
- export declare const marshalCatalogSchema: z.ZodType;
2463
- export declare const marshalCatalog_CatalogSpecSchema: z.ZodType;
2464
- export declare const marshalCatalog_CatalogStatusSchema: z.ZodType;
2465
- export declare const marshalCdfConfigSchema: z.ZodType;
2466
- export declare const marshalDataApiSchema: z.ZodType;
2467
- export declare const marshalDataApi_DataApiSpecSchema: z.ZodType;
2468
- export declare const marshalDataApi_DataApiStatusSchema: z.ZodType;
2469
- export declare const marshalDatabaseSchema: z.ZodType;
2470
- export declare const marshalDatabase_DatabaseSpecSchema: z.ZodType;
2471
- export declare const marshalDatabase_DatabaseStatusSchema: z.ZodType;
2472
- export declare const marshalDeltaTableSyncInfoSchema: z.ZodType;
2473
- export declare const marshalEndpointSchema: z.ZodType;
2474
- export declare const marshalEndpointGroupSpecSchema: z.ZodType;
2475
- export declare const marshalEndpointGroupStatusSchema: z.ZodType;
2476
- export declare const marshalEndpointHostsSchema: z.ZodType;
2477
- export declare const marshalEndpointSettingsSchema: z.ZodType;
2478
- export declare const marshalEndpointSpecSchema: z.ZodType;
2479
- export declare const marshalEndpointStatusSchema: z.ZodType;
2480
- export declare const marshalGenerateDatabaseCredentialRequestSchema: z.ZodType;
2481
- export declare const marshalInitialBranchSpecSchema: z.ZodType;
2482
- export declare const marshalInitialEndpointSpecSchema: z.ZodType;
2483
- export declare const marshalNewPipelineSpecSchema: z.ZodType;
2484
- export declare const marshalProjectSchema: z.ZodType;
2485
- export declare const marshalProjectCustomTagSchema: z.ZodType;
2486
- export declare const marshalProjectDefaultEndpointSettingsSchema: z.ZodType;
2487
- export declare const marshalProjectSpecSchema: z.ZodType;
2488
- export declare const marshalProjectStatusSchema: z.ZodType;
2489
- export declare const marshalRequestedClaimsSchema: z.ZodType;
2490
- export declare const marshalRequestedResourceSchema: z.ZodType;
2491
- export declare const marshalRoleSchema: z.ZodType;
2492
- export declare const marshalRole_AttributesSchema: z.ZodType;
2493
- export declare const marshalRole_RoleSpecSchema: z.ZodType;
2494
- export declare const marshalRole_RoleStatusSchema: z.ZodType;
2495
- export declare const marshalSyncedTableSchema: z.ZodType;
2496
- export declare const marshalSyncedTable_SyncedTableSpecSchema: z.ZodType;
2497
- export declare const marshalSyncedTable_SyncedTableSpec_ExtraColumnSchema: z.ZodType;
2498
- export declare const marshalSyncedTable_SyncedTableSpec_TypeOverrideSchema: z.ZodType;
2499
- export declare const marshalSyncedTable_SyncedTableStatusSchema: z.ZodType;
2500
- export declare const marshalSyncedTablePipelineProgressSchema: z.ZodType;
2501
- export declare const marshalSyncedTablePositionSchema: z.ZodType;
2502
- export declare const marshalUndeleteBranchRequestSchema: z.ZodType;
2503
- export declare const marshalUndeleteProjectRequestSchema: z.ZodType;
2504
- export declare function branchFieldMask(...paths: string[]): FieldMask<Branch>;
2505
- export declare function dataApiFieldMask(...paths: string[]): FieldMask<DataApi>;
2506
- export declare function databaseFieldMask(...paths: string[]): FieldMask<Database>;
2507
- export declare function endpointFieldMask(...paths: string[]): FieldMask<Endpoint>;
2508
- export declare function projectFieldMask(...paths: string[]): FieldMask<Project>;
2509
- export declare function roleFieldMask(...paths: string[]): FieldMask<Role>;
2293
+ interface UpdateDataApiRequest {
2294
+ /**
2295
+ * The Data API configuration to update.
2296
+ * The data_api's `name` field identifies the resource.
2297
+ */
2298
+ dataApi?: DataApi | undefined;
2299
+ /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2300
+ updateMask?: FieldMask<DataApi> | undefined;
2301
+ }
2302
+ interface UpdateDatabaseRequest {
2303
+ /**
2304
+ * The Database to update.
2305
+ *
2306
+ * The database's `name` field is used to identify the database to update.
2307
+ * Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
2308
+ */
2309
+ database?: Database | undefined;
2310
+ /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2311
+ updateMask?: FieldMask<Database> | undefined;
2312
+ }
2313
+ interface UpdateEndpointRequest {
2314
+ /**
2315
+ * The Endpoint to update.
2316
+ *
2317
+ * The endpoint's `name` field is used to identify the endpoint to update.
2318
+ * Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
2319
+ */
2320
+ endpoint?: Endpoint | undefined;
2321
+ /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2322
+ updateMask?: FieldMask<Endpoint> | undefined;
2323
+ }
2324
+ interface UpdateProjectRequest {
2325
+ /**
2326
+ * The Project to update.
2327
+ *
2328
+ * The project's `name` field is used to identify the project to update.
2329
+ * Format: projects/{project_id}
2330
+ */
2331
+ project?: Project | undefined;
2332
+ /** The list of fields to update. If unspecified, all fields will be updated when possible. */
2333
+ updateMask?: FieldMask<Project> | undefined;
2334
+ }
2335
+ interface UpdateRoleRequest {
2336
+ /**
2337
+ * The Postgres Role to update.
2338
+ *
2339
+ * The role's `name` field is used to identify the role to update.
2340
+ * Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
2341
+ */
2342
+ role?: Role | undefined;
2343
+ /**
2344
+ * The list of fields to update in Postgres Role.
2345
+ * If unspecified, all fields will be updated when possible.
2346
+ */
2347
+ updateMask?: FieldMask<Role> | undefined;
2348
+ }
2349
+ declare const unmarshalApiErrorSchema: z.ZodType<ApiError>;
2350
+ declare const unmarshalBranchSchema: z.ZodType<Branch>;
2351
+ declare const unmarshalBranchOperationMetadataSchema: z.ZodType<BranchOperationMetadata>;
2352
+ declare const unmarshalBranchSpecSchema: z.ZodType<BranchSpec>;
2353
+ declare const unmarshalBranchStatusSchema: z.ZodType<BranchStatus>;
2354
+ declare const unmarshalCatalogSchema: z.ZodType<Catalog>;
2355
+ declare const unmarshalCatalog_CatalogSpecSchema: z.ZodType<Catalog_CatalogSpec>;
2356
+ declare const unmarshalCatalog_CatalogStatusSchema: z.ZodType<Catalog_CatalogStatus>;
2357
+ declare const unmarshalCatalogOperationMetadataSchema: z.ZodType<CatalogOperationMetadata>;
2358
+ declare const unmarshalCdfConfigSchema: z.ZodType<CdfConfig>;
2359
+ declare const unmarshalCdfConfigOperationMetadataSchema: z.ZodType<CdfConfigOperationMetadata>;
2360
+ declare const unmarshalCdfStatusSchema: z.ZodType<CdfStatus>;
2361
+ declare const unmarshalDataApiSchema: z.ZodType<DataApi>;
2362
+ declare const unmarshalDataApi_DataApiSpecSchema: z.ZodType<DataApi_DataApiSpec>;
2363
+ declare const unmarshalDataApi_DataApiStatusSchema: z.ZodType<DataApi_DataApiStatus>;
2364
+ declare const unmarshalDataApiOperationMetadataSchema: z.ZodType<DataApiOperationMetadata>;
2365
+ declare const unmarshalDatabaseSchema: z.ZodType<Database>;
2366
+ declare const unmarshalDatabase_DatabaseSpecSchema: z.ZodType<Database_DatabaseSpec>;
2367
+ declare const unmarshalDatabase_DatabaseStatusSchema: z.ZodType<Database_DatabaseStatus>;
2368
+ declare const unmarshalDatabaseCredentialSchema: z.ZodType<DatabaseCredential>;
2369
+ declare const unmarshalDatabaseOperationMetadataSchema: z.ZodType<DatabaseOperationMetadata>;
2370
+ declare const unmarshalDeltaTableSyncInfoSchema: z.ZodType<DeltaTableSyncInfo>;
2371
+ declare const unmarshalEndpointSchema: z.ZodType<Endpoint>;
2372
+ declare const unmarshalEndpointGroupSpecSchema: z.ZodType<EndpointGroupSpec>;
2373
+ declare const unmarshalEndpointGroupStatusSchema: z.ZodType<EndpointGroupStatus>;
2374
+ declare const unmarshalEndpointHostsSchema: z.ZodType<EndpointHosts>;
2375
+ declare const unmarshalEndpointOperationMetadataSchema: z.ZodType<EndpointOperationMetadata>;
2376
+ declare const unmarshalEndpointSettingsSchema: z.ZodType<EndpointSettings>;
2377
+ declare const unmarshalEndpointSpecSchema: z.ZodType<EndpointSpec>;
2378
+ declare const unmarshalEndpointStatusSchema: z.ZodType<EndpointStatus>;
2379
+ declare const unmarshalInitialBranchSpecSchema: z.ZodType<InitialBranchSpec>;
2380
+ declare const unmarshalInitialEndpointSpecSchema: z.ZodType<InitialEndpointSpec>;
2381
+ declare const unmarshalListBranchesResponseSchema: z.ZodType<ListBranchesResponse>;
2382
+ declare const unmarshalListCdfConfigsResponseSchema: z.ZodType<ListCdfConfigsResponse>;
2383
+ declare const unmarshalListCdfStatusesResponseSchema: z.ZodType<ListCdfStatusesResponse>;
2384
+ declare const unmarshalListDatabasesResponseSchema: z.ZodType<ListDatabasesResponse>;
2385
+ declare const unmarshalListEndpointsResponseSchema: z.ZodType<ListEndpointsResponse>;
2386
+ declare const unmarshalListProjectsResponseSchema: z.ZodType<ListProjectsResponse>;
2387
+ declare const unmarshalListRolesResponseSchema: z.ZodType<ListRolesResponse>;
2388
+ declare const unmarshalNewPipelineSpecSchema: z.ZodType<NewPipelineSpec>;
2389
+ declare const unmarshalOperationSchema: z.ZodType<Operation>;
2390
+ declare const unmarshalProjectSchema: z.ZodType<Project>;
2391
+ declare const unmarshalProjectCustomTagSchema: z.ZodType<ProjectCustomTag>;
2392
+ declare const unmarshalProjectDefaultEndpointSettingsSchema: z.ZodType<ProjectDefaultEndpointSettings>;
2393
+ declare const unmarshalProjectOperationMetadataSchema: z.ZodType<ProjectOperationMetadata>;
2394
+ declare const unmarshalProjectSpecSchema: z.ZodType<ProjectSpec>;
2395
+ declare const unmarshalProjectStatusSchema: z.ZodType<ProjectStatus>;
2396
+ declare const unmarshalRoleSchema: z.ZodType<Role>;
2397
+ declare const unmarshalRole_AttributesSchema: z.ZodType<Role_Attributes>;
2398
+ declare const unmarshalRole_RoleSpecSchema: z.ZodType<Role_RoleSpec>;
2399
+ declare const unmarshalRole_RoleStatusSchema: z.ZodType<Role_RoleStatus>;
2400
+ declare const unmarshalRoleOperationMetadataSchema: z.ZodType<RoleOperationMetadata>;
2401
+ declare const unmarshalSyncedTableSchema: z.ZodType<SyncedTable>;
2402
+ declare const unmarshalSyncedTable_SyncedTableSpecSchema: z.ZodType<SyncedTable_SyncedTableSpec>;
2403
+ declare const unmarshalSyncedTable_SyncedTableSpec_ExtraColumnSchema: z.ZodType<SyncedTable_SyncedTableSpec_ExtraColumn>;
2404
+ declare const unmarshalSyncedTable_SyncedTableSpec_TypeOverrideSchema: z.ZodType<SyncedTable_SyncedTableSpec_TypeOverride>;
2405
+ declare const unmarshalSyncedTable_SyncedTableStatusSchema: z.ZodType<SyncedTable_SyncedTableStatus>;
2406
+ declare const unmarshalSyncedTableOperationMetadataSchema: z.ZodType<SyncedTableOperationMetadata>;
2407
+ declare const unmarshalSyncedTablePipelineProgressSchema: z.ZodType<SyncedTablePipelineProgress>;
2408
+ declare const unmarshalSyncedTablePositionSchema: z.ZodType<SyncedTablePosition>;
2409
+ declare const marshalBranchSchema: z.ZodType;
2410
+ declare const marshalBranchSpecSchema: z.ZodType;
2411
+ declare const marshalBranchStatusSchema: z.ZodType;
2412
+ declare const marshalCatalogSchema: z.ZodType;
2413
+ declare const marshalCatalog_CatalogSpecSchema: z.ZodType;
2414
+ declare const marshalCatalog_CatalogStatusSchema: z.ZodType;
2415
+ declare const marshalCdfConfigSchema: z.ZodType;
2416
+ declare const marshalDataApiSchema: z.ZodType;
2417
+ declare const marshalDataApi_DataApiSpecSchema: z.ZodType;
2418
+ declare const marshalDataApi_DataApiStatusSchema: z.ZodType;
2419
+ declare const marshalDatabaseSchema: z.ZodType;
2420
+ declare const marshalDatabase_DatabaseSpecSchema: z.ZodType;
2421
+ declare const marshalDatabase_DatabaseStatusSchema: z.ZodType;
2422
+ declare const marshalDeltaTableSyncInfoSchema: z.ZodType;
2423
+ declare const marshalEndpointSchema: z.ZodType;
2424
+ declare const marshalEndpointGroupSpecSchema: z.ZodType;
2425
+ declare const marshalEndpointGroupStatusSchema: z.ZodType;
2426
+ declare const marshalEndpointHostsSchema: z.ZodType;
2427
+ declare const marshalEndpointSettingsSchema: z.ZodType;
2428
+ declare const marshalEndpointSpecSchema: z.ZodType;
2429
+ declare const marshalEndpointStatusSchema: z.ZodType;
2430
+ declare const marshalGenerateDatabaseCredentialRequestSchema: z.ZodType;
2431
+ declare const marshalInitialBranchSpecSchema: z.ZodType;
2432
+ declare const marshalInitialEndpointSpecSchema: z.ZodType;
2433
+ declare const marshalNewPipelineSpecSchema: z.ZodType;
2434
+ declare const marshalProjectSchema: z.ZodType;
2435
+ declare const marshalProjectCustomTagSchema: z.ZodType;
2436
+ declare const marshalProjectDefaultEndpointSettingsSchema: z.ZodType;
2437
+ declare const marshalProjectSpecSchema: z.ZodType;
2438
+ declare const marshalProjectStatusSchema: z.ZodType;
2439
+ declare const marshalRequestedClaimsSchema: z.ZodType;
2440
+ declare const marshalRequestedResourceSchema: z.ZodType;
2441
+ declare const marshalRoleSchema: z.ZodType;
2442
+ declare const marshalRole_AttributesSchema: z.ZodType;
2443
+ declare const marshalRole_RoleSpecSchema: z.ZodType;
2444
+ declare const marshalRole_RoleStatusSchema: z.ZodType;
2445
+ declare const marshalSyncedTableSchema: z.ZodType;
2446
+ declare const marshalSyncedTable_SyncedTableSpecSchema: z.ZodType;
2447
+ declare const marshalSyncedTable_SyncedTableSpec_ExtraColumnSchema: z.ZodType;
2448
+ declare const marshalSyncedTable_SyncedTableSpec_TypeOverrideSchema: z.ZodType;
2449
+ declare const marshalSyncedTable_SyncedTableStatusSchema: z.ZodType;
2450
+ declare const marshalSyncedTablePipelineProgressSchema: z.ZodType;
2451
+ declare const marshalSyncedTablePositionSchema: z.ZodType;
2452
+ declare const marshalUndeleteBranchRequestSchema: z.ZodType;
2453
+ declare const marshalUndeleteProjectRequestSchema: z.ZodType;
2454
+ declare function branchFieldMask(...paths: string[]): FieldMask<Branch>;
2455
+ declare function dataApiFieldMask(...paths: string[]): FieldMask<DataApi>;
2456
+ declare function databaseFieldMask(...paths: string[]): FieldMask<Database>;
2457
+ declare function endpointFieldMask(...paths: string[]): FieldMask<Endpoint>;
2458
+ declare function projectFieldMask(...paths: string[]): FieldMask<Project>;
2459
+ declare function roleFieldMask(...paths: string[]): FieldMask<Role>;
2460
+ //#endregion
2461
+ export { ApiError, Branch, BranchOperationMetadata, BranchSpec, BranchStatus, BranchStatus_State, Catalog, CatalogOperationMetadata, Catalog_CatalogSpec, Catalog_CatalogStatus, CdfConfig, CdfConfigOperationMetadata, CdfState, CdfStatus, CreateBranchRequest, CreateCatalogRequest, CreateCdfConfigRequest, CreateDataApiRequest, CreateDatabaseRequest, CreateEndpointRequest, CreateProjectRequest, CreateRoleRequest, CreateSyncedTableRequest, DataApi, DataApiOperationMetadata, DataApi_DataApiSpec, DataApi_DataApiStatus, Database, DatabaseCredential, DatabaseOperationMetadata, Database_DatabaseSpec, Database_DatabaseStatus, DeleteBranchRequest, DeleteCatalogRequest, DeleteCdfConfigRequest, DeleteDataApiRequest, DeleteDatabaseRequest, DeleteEndpointRequest, DeleteProjectRequest, DeleteRoleRequest, DeleteSyncedTableRequest, DeltaTableSyncInfo, Endpoint, EndpointGroupSpec, EndpointGroupStatus, EndpointHosts, EndpointOperationMetadata, EndpointSettings, EndpointSpec, EndpointStatus, EndpointStatus_State, EndpointType, ErrorCode, GenerateDatabaseCredentialRequest, GetBranchRequest, GetCatalogRequest, GetCdfConfigRequest, GetCdfStatusRequest, GetDataApiRequest, GetDatabaseRequest, GetEndpointRequest, GetOperationRequest, GetProjectRequest, GetRoleRequest, GetSyncedTableRequest, InitialBranchSpec, InitialEndpointSpec, ListBranchesRequest, ListBranchesResponse, ListCdfConfigsRequest, ListCdfConfigsResponse, ListCdfStatusesRequest, ListCdfStatusesResponse, ListDatabasesRequest, ListDatabasesResponse, ListEndpointsRequest, ListEndpointsResponse, ListProjectsRequest, ListProjectsResponse, ListRolesRequest, ListRolesResponse, NewPipelineSpec, OpenApiMode, Operation, Project, ProjectCustomTag, ProjectDefaultEndpointSettings, ProjectOperationMetadata, ProjectSpec, ProjectStatus, ProvisioningInfo, ProvisioningInfo_State, ProvisioningPhase, RequestedClaims, RequestedClaims_PermissionSet, RequestedResource, Role, RoleOperationMetadata, Role_Attributes, Role_AuthMethod, Role_IdentityType, Role_MembershipRole, Role_RoleSpec, Role_RoleStatus, SyncedTable, SyncedTableOperationMetadata, SyncedTablePipelineProgress, SyncedTablePosition, SyncedTableState, SyncedTable_SyncedTableSpec, SyncedTable_SyncedTableSpec_ExtraColumn, SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance, SyncedTable_SyncedTableSpec_PgSpecificType, SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy, SyncedTable_SyncedTableSpec_TypeOverride, SyncedTable_SyncedTableStatus, UndeleteBranchRequest, UndeleteProjectRequest, UpdateBranchRequest, UpdateDataApiRequest, UpdateDatabaseRequest, UpdateEndpointRequest, UpdateProjectRequest, UpdateRoleRequest, branchFieldMask, dataApiFieldMask, databaseFieldMask, endpointFieldMask, marshalBranchSchema, marshalBranchSpecSchema, marshalBranchStatusSchema, marshalCatalogSchema, marshalCatalog_CatalogSpecSchema, marshalCatalog_CatalogStatusSchema, marshalCdfConfigSchema, marshalDataApiSchema, marshalDataApi_DataApiSpecSchema, marshalDataApi_DataApiStatusSchema, marshalDatabaseSchema, marshalDatabase_DatabaseSpecSchema, marshalDatabase_DatabaseStatusSchema, marshalDeltaTableSyncInfoSchema, marshalEndpointGroupSpecSchema, marshalEndpointGroupStatusSchema, marshalEndpointHostsSchema, marshalEndpointSchema, marshalEndpointSettingsSchema, marshalEndpointSpecSchema, marshalEndpointStatusSchema, marshalGenerateDatabaseCredentialRequestSchema, marshalInitialBranchSpecSchema, marshalInitialEndpointSpecSchema, marshalNewPipelineSpecSchema, marshalProjectCustomTagSchema, marshalProjectDefaultEndpointSettingsSchema, marshalProjectSchema, marshalProjectSpecSchema, marshalProjectStatusSchema, marshalRequestedClaimsSchema, marshalRequestedResourceSchema, marshalRoleSchema, marshalRole_AttributesSchema, marshalRole_RoleSpecSchema, marshalRole_RoleStatusSchema, marshalSyncedTablePipelineProgressSchema, marshalSyncedTablePositionSchema, marshalSyncedTableSchema, marshalSyncedTable_SyncedTableSpecSchema, marshalSyncedTable_SyncedTableSpec_ExtraColumnSchema, marshalSyncedTable_SyncedTableSpec_TypeOverrideSchema, marshalSyncedTable_SyncedTableStatusSchema, marshalUndeleteBranchRequestSchema, marshalUndeleteProjectRequestSchema, projectFieldMask, roleFieldMask, unmarshalApiErrorSchema, unmarshalBranchOperationMetadataSchema, unmarshalBranchSchema, unmarshalBranchSpecSchema, unmarshalBranchStatusSchema, unmarshalCatalogOperationMetadataSchema, unmarshalCatalogSchema, unmarshalCatalog_CatalogSpecSchema, unmarshalCatalog_CatalogStatusSchema, unmarshalCdfConfigOperationMetadataSchema, unmarshalCdfConfigSchema, unmarshalCdfStatusSchema, unmarshalDataApiOperationMetadataSchema, unmarshalDataApiSchema, unmarshalDataApi_DataApiSpecSchema, unmarshalDataApi_DataApiStatusSchema, unmarshalDatabaseCredentialSchema, unmarshalDatabaseOperationMetadataSchema, unmarshalDatabaseSchema, unmarshalDatabase_DatabaseSpecSchema, unmarshalDatabase_DatabaseStatusSchema, unmarshalDeltaTableSyncInfoSchema, unmarshalEndpointGroupSpecSchema, unmarshalEndpointGroupStatusSchema, unmarshalEndpointHostsSchema, unmarshalEndpointOperationMetadataSchema, unmarshalEndpointSchema, unmarshalEndpointSettingsSchema, unmarshalEndpointSpecSchema, unmarshalEndpointStatusSchema, unmarshalInitialBranchSpecSchema, unmarshalInitialEndpointSpecSchema, unmarshalListBranchesResponseSchema, unmarshalListCdfConfigsResponseSchema, unmarshalListCdfStatusesResponseSchema, unmarshalListDatabasesResponseSchema, unmarshalListEndpointsResponseSchema, unmarshalListProjectsResponseSchema, unmarshalListRolesResponseSchema, unmarshalNewPipelineSpecSchema, unmarshalOperationSchema, unmarshalProjectCustomTagSchema, unmarshalProjectDefaultEndpointSettingsSchema, unmarshalProjectOperationMetadataSchema, unmarshalProjectSchema, unmarshalProjectSpecSchema, unmarshalProjectStatusSchema, unmarshalRoleOperationMetadataSchema, unmarshalRoleSchema, unmarshalRole_AttributesSchema, unmarshalRole_RoleSpecSchema, unmarshalRole_RoleStatusSchema, unmarshalSyncedTableOperationMetadataSchema, unmarshalSyncedTablePipelineProgressSchema, unmarshalSyncedTablePositionSchema, unmarshalSyncedTableSchema, unmarshalSyncedTable_SyncedTableSpecSchema, unmarshalSyncedTable_SyncedTableSpec_ExtraColumnSchema, unmarshalSyncedTable_SyncedTableSpec_TypeOverrideSchema, unmarshalSyncedTable_SyncedTableStatusSchema };
2510
2462
  //# sourceMappingURL=model.d.ts.map