@databricks/sdk-postgres 0.0.0-dev → 0.1.0-dev.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +203 -0
- package/dist/v1/client.d.ts +469 -0
- package/dist/v1/client.d.ts.map +1 -0
- package/dist/v1/client.js +2652 -0
- package/dist/v1/client.js.map +1 -0
- package/dist/v1/index.d.ts +5 -0
- package/dist/v1/index.d.ts.map +1 -0
- package/dist/v1/index.js +5 -0
- package/dist/v1/index.js.map +1 -0
- package/dist/v1/model.d.ts +2013 -0
- package/dist/v1/model.d.ts.map +1 -0
- package/dist/v1/model.js +2409 -0
- package/dist/v1/model.js.map +1 -0
- package/dist/v1/transport.d.ts +5 -0
- package/dist/v1/transport.d.ts.map +1 -0
- package/dist/v1/transport.js +57 -0
- package/dist/v1/transport.js.map +1 -0
- package/dist/v1/utils.d.ts +22 -0
- package/dist/v1/utils.d.ts.map +1 -0
- package/dist/v1/utils.js +113 -0
- package/dist/v1/utils.js.map +1 -0
- package/package.json +38 -4
- package/src/v1/client.ts +3453 -0
- package/src/v1/index.ts +140 -0
- package/src/v1/model.ts +3932 -0
- package/src/v1/transport.ts +73 -0
- package/src/v1/utils.ts +156 -0
- package/README.md +0 -1
- package/index.js +0 -1
|
@@ -0,0 +1,2013 @@
|
|
|
1
|
+
import { Temporal } from '@js-temporal/polyfill';
|
|
2
|
+
import { FieldMask } from '@databricks/sdk-core/wkt';
|
|
3
|
+
import { z } from 'zod';
|
|
4
|
+
/** The compute endpoint type. Either `read_write` or `read_only`. */
|
|
5
|
+
export declare enum EndpointType {
|
|
6
|
+
/** Default value, not used */
|
|
7
|
+
ENDPOINT_TYPE_UNSPECIFIED = "ENDPOINT_TYPE_UNSPECIFIED",
|
|
8
|
+
ENDPOINT_TYPE_READ_WRITE = "ENDPOINT_TYPE_READ_WRITE",
|
|
9
|
+
ENDPOINT_TYPE_READ_ONLY = "ENDPOINT_TYPE_READ_ONLY"
|
|
10
|
+
}
|
|
11
|
+
/** Error codes returned by Databricks APIs to indicate specific failure conditions. */
|
|
12
|
+
export declare enum ErrorCode {
|
|
13
|
+
/**
|
|
14
|
+
* Unknown error. This error generally should not be returned explicitly, but will be used
|
|
15
|
+
* as a fallback if the error enum is missing from the message for some reason.
|
|
16
|
+
*
|
|
17
|
+
* It's assigned tag 0 to follow the best practice from
|
|
18
|
+
* https://developers.google.com/protocol-buffers/docs/style#enums
|
|
19
|
+
*
|
|
20
|
+
* TODO(PLAT-55898): Add custom option to declare HTTP and gRPC mappings.
|
|
21
|
+
* Maps to:
|
|
22
|
+
* - google.rpc.Code: UNKNOWN = 2;
|
|
23
|
+
* - HTTP code: 500 Internal Server Error
|
|
24
|
+
*/
|
|
25
|
+
UNKNOWN = "UNKNOWN",
|
|
26
|
+
/**
|
|
27
|
+
* Internal error. This means that some invariants expected by the underlying system have been
|
|
28
|
+
* broken. This error code is reserved for serious errors, which generally cannot be resolved
|
|
29
|
+
* by the user.
|
|
30
|
+
*
|
|
31
|
+
* Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless there's some
|
|
32
|
+
* automation that relies on the custom error code.
|
|
33
|
+
*
|
|
34
|
+
* Maps to:
|
|
35
|
+
* - google.rpc.Code: INTERNAL = 13;
|
|
36
|
+
* - HTTP code: 500 Internal Server Error
|
|
37
|
+
*/
|
|
38
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
39
|
+
/**
|
|
40
|
+
* The service is currently unavailable. This is most likely a transient condition, which can be
|
|
41
|
+
* corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent
|
|
42
|
+
* operations.
|
|
43
|
+
*
|
|
44
|
+
* Prefer this over SERVICE_UNDER_MAINTENANCE, WORKSPACE_TEMPORARILY_UNAVAILABLE.
|
|
45
|
+
*
|
|
46
|
+
* See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
|
|
47
|
+
* for guideline on how to pick this vs RESOURCE_EXHAUSTED.
|
|
48
|
+
*
|
|
49
|
+
* Maps to:
|
|
50
|
+
* - google.rpc.Code: UNAVAILABLE = 14;
|
|
51
|
+
* - HTTP code: 503 Service Unavailable
|
|
52
|
+
*/
|
|
53
|
+
TEMPORARILY_UNAVAILABLE = "TEMPORARILY_UNAVAILABLE",
|
|
54
|
+
/**
|
|
55
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
56
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
57
|
+
* Indicates that an IOException has been internally thrown.
|
|
58
|
+
*/
|
|
59
|
+
IO_ERROR = "IO_ERROR",
|
|
60
|
+
/**
|
|
61
|
+
* The request is invalid. Prefer more specific error code whenever possible.
|
|
62
|
+
* Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
|
|
63
|
+
*
|
|
64
|
+
* Prefer this error code over MALFORMED_REQUEST, INVALID_STATE, UNPARSEABLE_HTTP_ERROR.
|
|
65
|
+
*
|
|
66
|
+
* Maps to:
|
|
67
|
+
* - google.rpc.Code: FAILED_PRECONDITION = 9;
|
|
68
|
+
* - HTTP code: 400 Bad Request
|
|
69
|
+
*/
|
|
70
|
+
BAD_REQUEST = "BAD_REQUEST",
|
|
71
|
+
/**
|
|
72
|
+
* An external service is unavailable temporarily as it is being updated/re-deployed. Indicates
|
|
73
|
+
* gateway proxy to safely retry the request.
|
|
74
|
+
*/
|
|
75
|
+
SERVICE_UNDER_MAINTENANCE = "SERVICE_UNDER_MAINTENANCE",
|
|
76
|
+
/** A workspace is temporarily unavailable as the workspace is being re-assigned. */
|
|
77
|
+
WORKSPACE_TEMPORARILY_UNAVAILABLE = "WORKSPACE_TEMPORARILY_UNAVAILABLE",
|
|
78
|
+
/**
|
|
79
|
+
* The deadline expired before the operation could complete. For operations that change the state
|
|
80
|
+
* of the system, this error may be returned even if the operation has completed successfully.
|
|
81
|
+
* For example, a successful response from a server could have been delayed long enough for
|
|
82
|
+
* the deadline to expire. When possible - implementations should make sure further processing of
|
|
83
|
+
* the request is aborted, e.g. by throwing an exception instead of making the RPC request,
|
|
84
|
+
* making the database query, etc.
|
|
85
|
+
*
|
|
86
|
+
* Maps to:
|
|
87
|
+
* - google.rpc.Code: DEADLINE_EXCEEDED = 4;
|
|
88
|
+
* - HTTP code: 504 Gateway Timeout
|
|
89
|
+
*/
|
|
90
|
+
DEADLINE_EXCEEDED = "DEADLINE_EXCEEDED",
|
|
91
|
+
/**
|
|
92
|
+
* The operation was canceled by the caller. An example - client closed the connection without
|
|
93
|
+
* waiting for a response.
|
|
94
|
+
*
|
|
95
|
+
* Maps to:
|
|
96
|
+
* - google.rpc.Code: CANCELLED = 1;
|
|
97
|
+
* - HTTP code: 499 Client Closed Request
|
|
98
|
+
*/
|
|
99
|
+
CANCELLED = "CANCELLED",
|
|
100
|
+
/**
|
|
101
|
+
* The operation is rejected because of either rate limiting or resource quota,
|
|
102
|
+
* such as the client has sent too many requests recently or the client has allocated too many
|
|
103
|
+
* resources.
|
|
104
|
+
*
|
|
105
|
+
* See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
|
|
106
|
+
* for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
|
|
107
|
+
*
|
|
108
|
+
* Maps to:
|
|
109
|
+
* - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
|
|
110
|
+
* - HTTP code: 429 Too Many Requests
|
|
111
|
+
*/
|
|
112
|
+
RESOURCE_EXHAUSTED = "RESOURCE_EXHAUSTED",
|
|
113
|
+
/**
|
|
114
|
+
* The operation was aborted, typically due to a concurrency issue such as a sequencer
|
|
115
|
+
* check failure, transaction abort, or transaction conflict.
|
|
116
|
+
*
|
|
117
|
+
* Maps to:
|
|
118
|
+
* - google.rpc.Code: ABORTED = 10;
|
|
119
|
+
* - HTTP code: 409 Conflict
|
|
120
|
+
*/
|
|
121
|
+
ABORTED = "ABORTED",
|
|
122
|
+
/**
|
|
123
|
+
* Operation was performed on a resource that does not exist,
|
|
124
|
+
* e.g. file or directory was not found.
|
|
125
|
+
*
|
|
126
|
+
* Maps to:
|
|
127
|
+
* - google.rpc.Code: NOT_FOUND = 5;
|
|
128
|
+
* - HTTP code: 404 Not Found
|
|
129
|
+
*/
|
|
130
|
+
NOT_FOUND = "NOT_FOUND",
|
|
131
|
+
/**
|
|
132
|
+
* Operation was rejected due a conflict with an existing resource, e.g. attempted to create
|
|
133
|
+
* file or directory that already exists.
|
|
134
|
+
*
|
|
135
|
+
* Prefer this over RESOURCE_CONFLICT.
|
|
136
|
+
*
|
|
137
|
+
* Maps to:
|
|
138
|
+
* - google.rpc.Code: ALREADY_EXISTS = 6;
|
|
139
|
+
* - HTTP code: 409 Conflict
|
|
140
|
+
*/
|
|
141
|
+
ALREADY_EXISTS = "ALREADY_EXISTS",
|
|
142
|
+
/**
|
|
143
|
+
* The request does not have valid authentication (AuthN) credentials for the operation.
|
|
144
|
+
*
|
|
145
|
+
* Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent behavior with legacy
|
|
146
|
+
* code.
|
|
147
|
+
* For authorization (AuthZ) errors use PERMISSION_DENIED.
|
|
148
|
+
*
|
|
149
|
+
* Maps to:
|
|
150
|
+
* - google.rpc.Code: UNAUTHENTICATED = 16;
|
|
151
|
+
* - HTTP code: 401 Unauthorized
|
|
152
|
+
*/
|
|
153
|
+
UNAUTHENTICATED = "UNAUTHENTICATED",
|
|
154
|
+
/**
|
|
155
|
+
* The service is currently unavailable. Please note that the unavailability may or may not be transient.
|
|
156
|
+
* That means if this is a non-transient condition, retrying it does not work. If the unavailability
|
|
157
|
+
* is certainly a transient condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
|
|
158
|
+
* nature explicitly.
|
|
159
|
+
* An example of this error code’s use case is that when DNS resolution fails, the DNS resolver does
|
|
160
|
+
* not know whether it is because the domain name is completely wrong (non-transient situation) or
|
|
161
|
+
* the domain name is valid but the DNS server does not have an entry for this domain name yet (transient
|
|
162
|
+
* situation). Hence, `UNAVAILABLE` is suitable for this case.
|
|
163
|
+
*
|
|
164
|
+
* Maps to:
|
|
165
|
+
* - google.rpc.Code: UNAVAILABLE = 14;
|
|
166
|
+
* - HTTP code: 503 Service Unavailable
|
|
167
|
+
*/
|
|
168
|
+
UNAVAILABLE = "UNAVAILABLE",
|
|
169
|
+
/**
|
|
170
|
+
* Supplied value for a parameter was invalid (e.g., giving a number for a string parameter).
|
|
171
|
+
*
|
|
172
|
+
* Maps to:
|
|
173
|
+
* - google.rpc.Code: INVALID_ARGUMENT = 3;
|
|
174
|
+
* - HTTP code: 400 Bad Request
|
|
175
|
+
*/
|
|
176
|
+
INVALID_PARAMETER_VALUE = "INVALID_PARAMETER_VALUE",
|
|
177
|
+
/**
|
|
178
|
+
* Indicates that the given API endpoint does not exist. Legacy, when possible - NOT_IMPLEMENTED
|
|
179
|
+
* should be used instead to indicate that API doesn't exist.
|
|
180
|
+
*
|
|
181
|
+
* Maps to:
|
|
182
|
+
* - google.rpc.Code: NOT_FOUND = 5;
|
|
183
|
+
* - HTTP code: 404 Not Found
|
|
184
|
+
*/
|
|
185
|
+
ENDPOINT_NOT_FOUND = "ENDPOINT_NOT_FOUND",
|
|
186
|
+
/** Indicates that the given API request was malformed. */
|
|
187
|
+
MALFORMED_REQUEST = "MALFORMED_REQUEST",
|
|
188
|
+
/**
|
|
189
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
190
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
191
|
+
* If one or more of the inputs to a given RPC are not in a valid state for the action.
|
|
192
|
+
*/
|
|
193
|
+
INVALID_STATE = "INVALID_STATE",
|
|
194
|
+
/**
|
|
195
|
+
* The caller does not have permission to execute the specified operation.
|
|
196
|
+
* PERMISSION_DENIED must not be used for rejections caused by exhausting some resource,
|
|
197
|
+
* use RESOURCE_EXHAUSTED instead for those errors.
|
|
198
|
+
* PERMISSION_DENIED must not be used if the caller can not be identified,
|
|
199
|
+
* use CUSTOMER_UNAUTHORIZED instead for those errors.
|
|
200
|
+
* This error code does not imply the request is valid or the requested entity exists or
|
|
201
|
+
* satisfies other pre-conditions.
|
|
202
|
+
*
|
|
203
|
+
* Maps to:
|
|
204
|
+
* - google.rpc.Code: PERMISSION_DENIED = 7;
|
|
205
|
+
* - HTTP code: 403 Forbidden
|
|
206
|
+
*/
|
|
207
|
+
PERMISSION_DENIED = "PERMISSION_DENIED",
|
|
208
|
+
/**
|
|
209
|
+
* NOTE: Deprecated due to inconsistent mapping in legacy code, see
|
|
210
|
+
* https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
|
|
211
|
+
* Prefer using NOT_FOUND or PERMISSION_DENIED.
|
|
212
|
+
*
|
|
213
|
+
* If a given user/entity is trying to use a feature which has been disabled.
|
|
214
|
+
*
|
|
215
|
+
* Maps to:
|
|
216
|
+
* - google.rpc.Code: NOT_FOUND = 5;
|
|
217
|
+
* - HTTP code: 404 Not Found
|
|
218
|
+
*/
|
|
219
|
+
FEATURE_DISABLED = "FEATURE_DISABLED",
|
|
220
|
+
/**
|
|
221
|
+
* The request does not have valid authentication (AuthN) credentials for the operation.
|
|
222
|
+
*
|
|
223
|
+
* For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you need to keep
|
|
224
|
+
* consistent behavior with legacy code.
|
|
225
|
+
* For authorization (AuthZ) errors use PERMISSION_DENIED.
|
|
226
|
+
*
|
|
227
|
+
* Important: name is confusing, this error code is for authentication (AuthN) errors, not
|
|
228
|
+
* authorization (AuthZ) errors. It maps to 401 Unauthorized and suffers from the same confusing
|
|
229
|
+
* naming. See https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status code
|
|
230
|
+
* indicates that the request has not been applied because it lacks valid authentication
|
|
231
|
+
* credentials for the target resource. [...] If the request included authentication credentials,
|
|
232
|
+
* then the 401 response indicates that authorization has been refused for those credentials."
|
|
233
|
+
*
|
|
234
|
+
* Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty well.
|
|
235
|
+
*
|
|
236
|
+
* Maps to:
|
|
237
|
+
* - google.rpc.Code: UNAUTHENTICATED = 16;
|
|
238
|
+
* - HTTP code: 401 Unauthorized
|
|
239
|
+
*/
|
|
240
|
+
CUSTOMER_UNAUTHORIZED = "CUSTOMER_UNAUTHORIZED",
|
|
241
|
+
/**
|
|
242
|
+
* The operation is rejected because of request rate limit, for example rate limiting applied to
|
|
243
|
+
* users, workspaces, IP addresses, etc.
|
|
244
|
+
*
|
|
245
|
+
* Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
|
|
246
|
+
*
|
|
247
|
+
* See https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
|
|
248
|
+
* for guideline on the rate limiting vs throttling.
|
|
249
|
+
*
|
|
250
|
+
* Maps to:
|
|
251
|
+
* - google.rpc.Code: RESOURCE_EXHAUSTED = 8;
|
|
252
|
+
* - HTTP code: 429 Too Many Requests
|
|
253
|
+
*/
|
|
254
|
+
REQUEST_LIMIT_EXCEEDED = "REQUEST_LIMIT_EXCEEDED",
|
|
255
|
+
/** Indicates API request was rejected due a conflict with an existing resource. */
|
|
256
|
+
RESOURCE_CONFLICT = "RESOURCE_CONFLICT",
|
|
257
|
+
/**
|
|
258
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
259
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
260
|
+
* Indicates that the HTTP response cannot be correctly deserialized.
|
|
261
|
+
* This currently is only used in DUST test clients, and not by any real service code.
|
|
262
|
+
*/
|
|
263
|
+
UNPARSEABLE_HTTP_ERROR = "UNPARSEABLE_HTTP_ERROR",
|
|
264
|
+
/**
|
|
265
|
+
* The operation is not implemented or is not supported/enabled in this service.
|
|
266
|
+
*
|
|
267
|
+
* Maps to:
|
|
268
|
+
* - google.rpc.Code: UNIMPLEMENTED = 12;
|
|
269
|
+
* - HTTP code: 501 Not Implemented
|
|
270
|
+
*/
|
|
271
|
+
NOT_IMPLEMENTED = "NOT_IMPLEMENTED",
|
|
272
|
+
/**
|
|
273
|
+
* Unrecoverable data loss or corruption.
|
|
274
|
+
*
|
|
275
|
+
* One of the major use cases is to indicate that server failed to validate the integrity of
|
|
276
|
+
* the request. This error can occur when the checksum specified in the `X-Databricks-Checksum`
|
|
277
|
+
* request header (or trailer) doesn't match the actual request content checksum.
|
|
278
|
+
*
|
|
279
|
+
* Note, in case of the severe corruption that results in a malformed request, the server may
|
|
280
|
+
* send a generic `400 Bad Request` response rather than sending this error code.
|
|
281
|
+
*
|
|
282
|
+
* Maps to:
|
|
283
|
+
* - google.rpc.Code: DATA_LOSS = 15;
|
|
284
|
+
* - HTTP code: 500 Internal Server Error
|
|
285
|
+
*/
|
|
286
|
+
DATA_LOSS = "DATA_LOSS",
|
|
287
|
+
/** If the user attempts to perform an invalid state transition on a shard. */
|
|
288
|
+
INVALID_STATE_TRANSITION = "INVALID_STATE_TRANSITION",
|
|
289
|
+
/**
|
|
290
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
291
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
292
|
+
* Unable to perform the operation because the shard was locked by some other operation.
|
|
293
|
+
*/
|
|
294
|
+
COULD_NOT_ACQUIRE_LOCK = "COULD_NOT_ACQUIRE_LOCK",
|
|
295
|
+
/**
|
|
296
|
+
* NOTE: Deprecated, prefer using ALREADY_EXISTS.
|
|
297
|
+
* Unlike ALREADY_EXISTS - this maps to HTTP code 400 Bad Request due to legacy reasons,
|
|
298
|
+
* remapping will be a backwards incompatible change.
|
|
299
|
+
*
|
|
300
|
+
* Operation was performed on a resource that already exists.
|
|
301
|
+
*/
|
|
302
|
+
RESOURCE_ALREADY_EXISTS = "RESOURCE_ALREADY_EXISTS",
|
|
303
|
+
/**
|
|
304
|
+
* NOTE: Deprecated, prefer using NOT_FOUND - see the note for the RESOURCE_ALREADY_EXISTS,
|
|
305
|
+
* because this pair of codes is related and RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP
|
|
306
|
+
* codes we added new error codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
|
|
307
|
+
*
|
|
308
|
+
* Operation was performed on a resource that does not exist.
|
|
309
|
+
*/
|
|
310
|
+
RESOURCE_DOES_NOT_EXIST = "RESOURCE_DOES_NOT_EXIST",
|
|
311
|
+
/**
|
|
312
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
313
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
314
|
+
*/
|
|
315
|
+
QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
|
|
316
|
+
/**
|
|
317
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
318
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
319
|
+
*/
|
|
320
|
+
MAX_BLOCK_SIZE_EXCEEDED = "MAX_BLOCK_SIZE_EXCEEDED",
|
|
321
|
+
/**
|
|
322
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
323
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
324
|
+
*/
|
|
325
|
+
MAX_READ_SIZE_EXCEEDED = "MAX_READ_SIZE_EXCEEDED",
|
|
326
|
+
PARTIAL_DELETE = "PARTIAL_DELETE",
|
|
327
|
+
MAX_LIST_SIZE_EXCEEDED = "MAX_LIST_SIZE_EXCEEDED",
|
|
328
|
+
/**
|
|
329
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
330
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
331
|
+
*/
|
|
332
|
+
DRY_RUN_FAILED = "DRY_RUN_FAILED",
|
|
333
|
+
/**
|
|
334
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
335
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
336
|
+
* Cluster request was rejected because it would exceed a resource limit.
|
|
337
|
+
*/
|
|
338
|
+
RESOURCE_LIMIT_EXCEEDED = "RESOURCE_LIMIT_EXCEEDED",
|
|
339
|
+
/**
|
|
340
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
341
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
342
|
+
*/
|
|
343
|
+
DIRECTORY_NOT_EMPTY = "DIRECTORY_NOT_EMPTY",
|
|
344
|
+
/**
|
|
345
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
346
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
347
|
+
*/
|
|
348
|
+
DIRECTORY_PROTECTED = "DIRECTORY_PROTECTED",
|
|
349
|
+
/**
|
|
350
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
351
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
352
|
+
*/
|
|
353
|
+
MAX_NOTEBOOK_SIZE_EXCEEDED = "MAX_NOTEBOOK_SIZE_EXCEEDED",
|
|
354
|
+
MAX_CHILD_NODE_SIZE_EXCEEDED = "MAX_CHILD_NODE_SIZE_EXCEEDED",
|
|
355
|
+
/**
|
|
356
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
357
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
358
|
+
*/
|
|
359
|
+
SEARCH_QUERY_TOO_LONG = "SEARCH_QUERY_TOO_LONG",
|
|
360
|
+
/**
|
|
361
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
362
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
363
|
+
*/
|
|
364
|
+
SEARCH_QUERY_TOO_SHORT = "SEARCH_QUERY_TOO_SHORT",
|
|
365
|
+
/**
|
|
366
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
367
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
368
|
+
*/
|
|
369
|
+
MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST = "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST",
|
|
370
|
+
/**
|
|
371
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
372
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
373
|
+
*/
|
|
374
|
+
PERMISSION_NOT_PROPAGATED = "PERMISSION_NOT_PROPAGATED",
|
|
375
|
+
/**
|
|
376
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
377
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
378
|
+
*/
|
|
379
|
+
DEPLOYMENT_TIMEOUT = "DEPLOYMENT_TIMEOUT",
|
|
380
|
+
/**
|
|
381
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
382
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
383
|
+
*/
|
|
384
|
+
GIT_CONFLICT = "GIT_CONFLICT",
|
|
385
|
+
/**
|
|
386
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
387
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
388
|
+
*/
|
|
389
|
+
GIT_UNKNOWN_REF = "GIT_UNKNOWN_REF",
|
|
390
|
+
/**
|
|
391
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
392
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
393
|
+
*/
|
|
394
|
+
GIT_SENSITIVE_TOKEN_DETECTED = "GIT_SENSITIVE_TOKEN_DETECTED",
|
|
395
|
+
/**
|
|
396
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
397
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
398
|
+
*/
|
|
399
|
+
GIT_URL_NOT_ON_ALLOW_LIST = "GIT_URL_NOT_ON_ALLOW_LIST",
|
|
400
|
+
/**
|
|
401
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
402
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
403
|
+
*/
|
|
404
|
+
GIT_REMOTE_ERROR = "GIT_REMOTE_ERROR",
|
|
405
|
+
/**
|
|
406
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
407
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
408
|
+
*/
|
|
409
|
+
PROJECTS_OPERATION_TIMEOUT = "PROJECTS_OPERATION_TIMEOUT",
|
|
410
|
+
/**
|
|
411
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
412
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
413
|
+
*/
|
|
414
|
+
IPYNB_FILE_IN_REPO = "IPYNB_FILE_IN_REPO",
|
|
415
|
+
/**
|
|
416
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
417
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
418
|
+
*/
|
|
419
|
+
INSECURE_PARTNER_RESPONSE = "INSECURE_PARTNER_RESPONSE",
|
|
420
|
+
/**
|
|
421
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
422
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
423
|
+
*/
|
|
424
|
+
MALFORMED_PARTNER_RESPONSE = "MALFORMED_PARTNER_RESPONSE",
|
|
425
|
+
METASTORE_DOES_NOT_EXIST = "METASTORE_DOES_NOT_EXIST",
|
|
426
|
+
/**
|
|
427
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
428
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
429
|
+
*/
|
|
430
|
+
DAC_DOES_NOT_EXIST = "DAC_DOES_NOT_EXIST",
|
|
431
|
+
CATALOG_DOES_NOT_EXIST = "CATALOG_DOES_NOT_EXIST",
|
|
432
|
+
SCHEMA_DOES_NOT_EXIST = "SCHEMA_DOES_NOT_EXIST",
|
|
433
|
+
TABLE_DOES_NOT_EXIST = "TABLE_DOES_NOT_EXIST",
|
|
434
|
+
SHARE_DOES_NOT_EXIST = "SHARE_DOES_NOT_EXIST",
|
|
435
|
+
RECIPIENT_DOES_NOT_EXIST = "RECIPIENT_DOES_NOT_EXIST",
|
|
436
|
+
STORAGE_CREDENTIAL_DOES_NOT_EXIST = "STORAGE_CREDENTIAL_DOES_NOT_EXIST",
|
|
437
|
+
EXTERNAL_LOCATION_DOES_NOT_EXIST = "EXTERNAL_LOCATION_DOES_NOT_EXIST",
|
|
438
|
+
PRINCIPAL_DOES_NOT_EXIST = "PRINCIPAL_DOES_NOT_EXIST",
|
|
439
|
+
PROVIDER_DOES_NOT_EXIST = "PROVIDER_DOES_NOT_EXIST",
|
|
440
|
+
/**
|
|
441
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
442
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
443
|
+
*/
|
|
444
|
+
METASTORE_ALREADY_EXISTS = "METASTORE_ALREADY_EXISTS",
|
|
445
|
+
/**
|
|
446
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
447
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
448
|
+
*/
|
|
449
|
+
DAC_ALREADY_EXISTS = "DAC_ALREADY_EXISTS",
|
|
450
|
+
/**
|
|
451
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
452
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
453
|
+
*/
|
|
454
|
+
CATALOG_ALREADY_EXISTS = "CATALOG_ALREADY_EXISTS",
|
|
455
|
+
/**
|
|
456
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
457
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
458
|
+
*/
|
|
459
|
+
SCHEMA_ALREADY_EXISTS = "SCHEMA_ALREADY_EXISTS",
|
|
460
|
+
/**
|
|
461
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
462
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
463
|
+
*/
|
|
464
|
+
TABLE_ALREADY_EXISTS = "TABLE_ALREADY_EXISTS",
|
|
465
|
+
/**
|
|
466
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
467
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
468
|
+
*/
|
|
469
|
+
SHARE_ALREADY_EXISTS = "SHARE_ALREADY_EXISTS",
|
|
470
|
+
/**
|
|
471
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
472
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
473
|
+
*/
|
|
474
|
+
RECIPIENT_ALREADY_EXISTS = "RECIPIENT_ALREADY_EXISTS",
|
|
475
|
+
/**
|
|
476
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
477
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
478
|
+
*/
|
|
479
|
+
STORAGE_CREDENTIAL_ALREADY_EXISTS = "STORAGE_CREDENTIAL_ALREADY_EXISTS",
|
|
480
|
+
/**
|
|
481
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
482
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
483
|
+
*/
|
|
484
|
+
EXTERNAL_LOCATION_ALREADY_EXISTS = "EXTERNAL_LOCATION_ALREADY_EXISTS",
|
|
485
|
+
/**
|
|
486
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
487
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
488
|
+
*/
|
|
489
|
+
PROVIDER_ALREADY_EXISTS = "PROVIDER_ALREADY_EXISTS",
|
|
490
|
+
/**
|
|
491
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
492
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
493
|
+
*/
|
|
494
|
+
CATALOG_NOT_EMPTY = "CATALOG_NOT_EMPTY",
|
|
495
|
+
/**
|
|
496
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
497
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
498
|
+
*/
|
|
499
|
+
SCHEMA_NOT_EMPTY = "SCHEMA_NOT_EMPTY",
|
|
500
|
+
/**
|
|
501
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
502
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
503
|
+
*/
|
|
504
|
+
METASTORE_NOT_EMPTY = "METASTORE_NOT_EMPTY",
|
|
505
|
+
/**
|
|
506
|
+
* NOTE: Deprecated and kept to maintain backwards compatibility for public APIs that use it,
|
|
507
|
+
* avoid using it in the new APIs, refer error codes listed in the http://go/error-codes.
|
|
508
|
+
*/
|
|
509
|
+
PROVIDER_SHARE_NOT_ACCESSIBLE = "PROVIDER_SHARE_NOT_ACCESSIBLE"
|
|
510
|
+
}
|
|
511
|
+
/** The current phase of the data synchronization pipeline. */
|
|
512
|
+
export declare enum ProvisioningPhase {
|
|
513
|
+
/** The default phase. It should not be reported by any synced tables. */
|
|
514
|
+
PROVISIONING_PHASE_UNSPECIFIED = "PROVISIONING_PHASE_UNSPECIFIED",
|
|
515
|
+
/** Ingestion phase of the synced table. This is when the synced table is ingesting data from the delta table. */
|
|
516
|
+
PROVISIONING_PHASE_MAIN = "PROVISIONING_PHASE_MAIN",
|
|
517
|
+
/** Index scan phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
|
|
518
|
+
PROVISIONING_PHASE_INDEX_SCAN = "PROVISIONING_PHASE_INDEX_SCAN",
|
|
519
|
+
/** Index sort phase of the synced table. This is when the synced table is creating indexes on the ingested data. */
|
|
520
|
+
PROVISIONING_PHASE_INDEX_SORT = "PROVISIONING_PHASE_INDEX_SORT"
|
|
521
|
+
}
|
|
522
|
+
/** The state of a synced table. */
|
|
523
|
+
export declare enum SyncedTableState {
|
|
524
|
+
/** The default state. It should not be reported by any synced tables. */
|
|
525
|
+
SYNCED_TABLE_STATE_UNSPECIFIED = "SYNCED_TABLE_STATE_UNSPECIFIED",
|
|
526
|
+
/**
|
|
527
|
+
* The synced table has just been created and resources are being provisioned. This is also the
|
|
528
|
+
* catch-all state if there is not a more suitable state to report for the synced table.
|
|
529
|
+
*/
|
|
530
|
+
SYNCED_TABLE_PROVISIONING = "SYNCED_TABLE_PROVISIONING",
|
|
531
|
+
/** The synced table is provisioning resources for the data synchronization pipeline. */
|
|
532
|
+
SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES = "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES",
|
|
533
|
+
/** The synced table is executing the initial data synchronization. */
|
|
534
|
+
SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT = "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT",
|
|
535
|
+
/** The synced table is ready to serve data. */
|
|
536
|
+
SYNCED_TABLE_ONLINE = "SYNCED_TABLE_ONLINE",
|
|
537
|
+
/**
|
|
538
|
+
* The synced table is ready to serve data and is continuously updating. Only shown for synced
|
|
539
|
+
* tables using the "Continuous" sync mode.
|
|
540
|
+
*/
|
|
541
|
+
SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE = "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE",
|
|
542
|
+
/**
|
|
543
|
+
* The synced table is ready to serve data and an active update is in progress. Only shown for
|
|
544
|
+
* synced tables using the "Triggered" sync mode.
|
|
545
|
+
*/
|
|
546
|
+
SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE = "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE",
|
|
547
|
+
/**
|
|
548
|
+
* The synced table is ready to serve data and there are no active updates. Only shown for synced
|
|
549
|
+
* tables using the "Triggered" sync mode.
|
|
550
|
+
*/
|
|
551
|
+
SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE = "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE",
|
|
552
|
+
/** The synced table has encountered an internal error and is not available for serving. */
|
|
553
|
+
SYNCED_TABLE_OFFLINE = "SYNCED_TABLE_OFFLINE",
|
|
554
|
+
/**
|
|
555
|
+
* The synced table is not available for serving because the data synchronization pipeline has
|
|
556
|
+
* failed. Please review the pipeline event logs to troubleshoot.
|
|
557
|
+
*/
|
|
558
|
+
SYNCED_TABLE_OFFLINE_FAILED = "SYNCED_TABLE_OFFLINE_FAILED",
|
|
559
|
+
/**
|
|
560
|
+
* The data synchronization pipeline has encountered an error but the synced table is still
|
|
561
|
+
* available for serving (potentially stale) data. Please review the pipeline event logs to
|
|
562
|
+
* troubleshoot.
|
|
563
|
+
*/
|
|
564
|
+
SYNCED_TABLE_ONLINE_PIPELINE_FAILED = "SYNCED_TABLE_ONLINE_PIPELINE_FAILED",
|
|
565
|
+
/**
|
|
566
|
+
* The synced table is available for serving, and is provisioning resources for a newly started
|
|
567
|
+
* data synchronization pipeline.
|
|
568
|
+
*/
|
|
569
|
+
SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES = "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES"
|
|
570
|
+
}
|
|
571
|
+
/** The state of the branch. */
|
|
572
|
+
export declare enum BranchStatus_State {
|
|
573
|
+
/** Default value, not used. */
|
|
574
|
+
STATE_UNSPECIFIED = "STATE_UNSPECIFIED",
|
|
575
|
+
/** The branch is being created but is not yet available for querying. */
|
|
576
|
+
INIT = "INIT",
|
|
577
|
+
/** The branch is being imported and is not yet available for querying. */
|
|
578
|
+
IMPORTING = "IMPORTING",
|
|
579
|
+
/** The branch is being reset to a specific point in time or LSN and is not yet available for querying. */
|
|
580
|
+
RESETTING = "RESETTING",
|
|
581
|
+
/** The branch is fully operational and ready for querying. */
|
|
582
|
+
READY = "READY",
|
|
583
|
+
/** The branch is stored in cost-effective archival storage. Expect slow query response times. */
|
|
584
|
+
ARCHIVED = "ARCHIVED",
|
|
585
|
+
/** The branch is deleted and is not available for querying, but can be undeleted. */
|
|
586
|
+
DELETED = "DELETED"
|
|
587
|
+
}
|
|
588
|
+
/** The state of the compute endpoint. */
|
|
589
|
+
export declare enum EndpointStatus_State {
|
|
590
|
+
/** Default value, not used */
|
|
591
|
+
STATE_UNSPECIFIED = "STATE_UNSPECIFIED",
|
|
592
|
+
INIT = "INIT",
|
|
593
|
+
ACTIVE = "ACTIVE",
|
|
594
|
+
IDLE = "IDLE",
|
|
595
|
+
DEGRADED = "DEGRADED"
|
|
596
|
+
}
|
|
597
|
+
export declare enum ProvisioningInfo_State {
|
|
598
|
+
STATE_UNSPECIFIED = "STATE_UNSPECIFIED",
|
|
599
|
+
PROVISIONING = "PROVISIONING",
|
|
600
|
+
ACTIVE = "ACTIVE",
|
|
601
|
+
FAILED = "FAILED",
|
|
602
|
+
DELETING = "DELETING",
|
|
603
|
+
UPDATING = "UPDATING",
|
|
604
|
+
DEGRADED = "DEGRADED"
|
|
605
|
+
}
|
|
606
|
+
export declare enum RequestedClaims_PermissionSet {
|
|
607
|
+
PERMISSION_SET_UNSPECIFIED = "PERMISSION_SET_UNSPECIFIED",
|
|
608
|
+
READ_ONLY = "READ_ONLY"
|
|
609
|
+
}
|
|
610
|
+
/** How the role is authenticated when connecting to Postgres. */
|
|
611
|
+
export declare enum Role_AuthMethod {
|
|
612
|
+
AUTH_METHOD_UNSPECIFIED = "AUTH_METHOD_UNSPECIFIED",
|
|
613
|
+
/** NO_LOGIN means this role cannot be used for interactive access */
|
|
614
|
+
NO_LOGIN = "NO_LOGIN",
|
|
615
|
+
/** PG_PASSWORD_SCRAM_SHA_256 is a password-based authentication */
|
|
616
|
+
PG_PASSWORD_SCRAM_SHA_256 = "PG_PASSWORD_SCRAM_SHA_256",
|
|
617
|
+
/**
|
|
618
|
+
* LAKEBASE_OAUTH_V1 is for logging in with the managed identities like
|
|
619
|
+
* the <Databricks> service principal, <Databricks> Group or <Databricks> user.
|
|
620
|
+
*/
|
|
621
|
+
LAKEBASE_OAUTH_V1 = "LAKEBASE_OAUTH_V1"
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* The type of the <Databricks> managed identity that this Role represents.
|
|
625
|
+
* Leave empty if you wish to create a regular Postgres role not associated with a <Databricks> identity.
|
|
626
|
+
*/
|
|
627
|
+
export declare enum Role_IdentityType {
|
|
628
|
+
/** Default value, not used */
|
|
629
|
+
IDENTITY_TYPE_UNSPECIFIED = "IDENTITY_TYPE_UNSPECIFIED",
|
|
630
|
+
/** A user in a <Databricks> workspace. */
|
|
631
|
+
USER = "USER",
|
|
632
|
+
/** A service principal in a <Databricks> workspace. */
|
|
633
|
+
SERVICE_PRINCIPAL = "SERVICE_PRINCIPAL",
|
|
634
|
+
/** A group in a <Databricks> workspace. */
|
|
635
|
+
GROUP = "GROUP"
|
|
636
|
+
}
|
|
637
|
+
/** Roles that the DatabaseInstanceRole can be a member of. */
|
|
638
|
+
export declare enum Role_MembershipRole {
|
|
639
|
+
/** Indicates that the DatabaseInstanceRole is not a member of any standard, managed roles. */
|
|
640
|
+
MEMBERSHIP_ROLE_UNSPECIFIED = "MEMBERSHIP_ROLE_UNSPECIFIED",
|
|
641
|
+
/** Indicates membership in DATABRICKS_SUPERUSER, the highest set of privileges exposed to customers. */
|
|
642
|
+
DATABRICKS_SUPERUSER = "DATABRICKS_SUPERUSER"
|
|
643
|
+
}
|
|
644
|
+
/** Scheduling policy of the synced table's underlying pipeline. */
|
|
645
|
+
export declare enum SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy {
|
|
646
|
+
SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED = "SYNCED_TABLE_SCHEDULING_POLICY_UNSPECIFIED",
|
|
647
|
+
/**
|
|
648
|
+
* Pipeline runs continuously after generating the initial data.
|
|
649
|
+
* Requires the source table to have Change Data Feed (CDF) enabled.
|
|
650
|
+
*/
|
|
651
|
+
CONTINUOUS = "CONTINUOUS",
|
|
652
|
+
/**
|
|
653
|
+
* Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
|
|
654
|
+
* Requires the source table to have Change Data Feed (CDF) enabled.
|
|
655
|
+
*/
|
|
656
|
+
TRIGGERED = "TRIGGERED",
|
|
657
|
+
/**
|
|
658
|
+
* Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers).
|
|
659
|
+
* Successive updates always perform a full copy of the source table data (no incremental updates).
|
|
660
|
+
* Does not require the source table to have Change Data Feed (CDF) enabled.
|
|
661
|
+
*/
|
|
662
|
+
SNAPSHOT = "SNAPSHOT"
|
|
663
|
+
}
|
|
664
|
+
export interface Branch {
|
|
665
|
+
/**
|
|
666
|
+
* Output only. The full resource path of the branch.
|
|
667
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
668
|
+
*/
|
|
669
|
+
name?: string | undefined;
|
|
670
|
+
/** System-generated unique ID for the branch. */
|
|
671
|
+
uid?: string | undefined;
|
|
672
|
+
/**
|
|
673
|
+
* The project containing this branch (API resource hierarchy).
|
|
674
|
+
* Format: projects/{project_id}
|
|
675
|
+
*
|
|
676
|
+
* Note: This field indicates where the branch exists in the resource hierarchy.
|
|
677
|
+
* For point-in-time branching from another branch, see `status.source_branch`.
|
|
678
|
+
*/
|
|
679
|
+
parent?: string | undefined;
|
|
680
|
+
/** A timestamp indicating when the branch was created. */
|
|
681
|
+
createTime?: Temporal.Instant | undefined;
|
|
682
|
+
/** A timestamp indicating when the branch was last updated. */
|
|
683
|
+
updateTime?: Temporal.Instant | undefined;
|
|
684
|
+
/** The spec contains the branch configuration. */
|
|
685
|
+
spec?: BranchSpec | undefined;
|
|
686
|
+
/** The current status of a Branch. */
|
|
687
|
+
status?: BranchStatus | undefined;
|
|
688
|
+
}
|
|
689
|
+
export interface BranchOperationMetadata {
|
|
690
|
+
}
|
|
691
|
+
export interface BranchSpec {
|
|
692
|
+
/**
|
|
693
|
+
* The name of the source branch from which this branch was created (data lineage for point-in-time recovery).
|
|
694
|
+
* If not specified, defaults to the project's default branch.
|
|
695
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
696
|
+
*/
|
|
697
|
+
sourceBranch?: string | undefined;
|
|
698
|
+
/** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
|
|
699
|
+
sourceBranchLsn?: string | undefined;
|
|
700
|
+
/** The point in time on the source branch from which this branch was created. */
|
|
701
|
+
sourceBranchTime?: Temporal.Instant | undefined;
|
|
702
|
+
/** 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. */
|
|
703
|
+
isProtected?: boolean | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* Expiration configuration for the branch. One of expire_time, ttl, or no_expiry must be provided.
|
|
706
|
+
* To disable expiration, set no_expiry to true.
|
|
707
|
+
*
|
|
708
|
+
* When updating this field, use "spec.expiration" in the update_mask.
|
|
709
|
+
*/
|
|
710
|
+
expiration?: {
|
|
711
|
+
$case: 'expireTime';
|
|
712
|
+
/**
|
|
713
|
+
* Absolute expiration timestamp. When set, the branch will expire at this time.
|
|
714
|
+
* Mutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
|
|
715
|
+
*/
|
|
716
|
+
expireTime: Temporal.Instant;
|
|
717
|
+
} | {
|
|
718
|
+
$case: 'ttl';
|
|
719
|
+
/**
|
|
720
|
+
* Relative time-to-live duration. When set, the branch will expire at creation_time + ttl.
|
|
721
|
+
* Mutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.
|
|
722
|
+
*/
|
|
723
|
+
ttl: Temporal.Duration;
|
|
724
|
+
} | {
|
|
725
|
+
$case: 'noExpiry';
|
|
726
|
+
/**
|
|
727
|
+
* Explicitly disable expiration. When set to true, the branch will not expire.
|
|
728
|
+
* If set to false, the request is invalid; provide either ttl or expire_time instead.
|
|
729
|
+
* Mutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.
|
|
730
|
+
*/
|
|
731
|
+
noExpiry: boolean;
|
|
732
|
+
} | undefined;
|
|
733
|
+
}
|
|
734
|
+
export interface BranchStatus {
|
|
735
|
+
/**
|
|
736
|
+
* The name of the source branch from which this branch was created.
|
|
737
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
738
|
+
*/
|
|
739
|
+
sourceBranch?: string | undefined;
|
|
740
|
+
/** The Log Sequence Number (LSN) on the source branch from which this branch was created. */
|
|
741
|
+
sourceBranchLsn?: string | undefined;
|
|
742
|
+
/** The point in time on the source branch from which this branch was created. */
|
|
743
|
+
sourceBranchTime?: Temporal.Instant | undefined;
|
|
744
|
+
/** Whether the branch is the project's default branch. */
|
|
745
|
+
default?: boolean | undefined;
|
|
746
|
+
/** Whether the branch is protected. */
|
|
747
|
+
isProtected?: boolean | undefined;
|
|
748
|
+
/** The branch's state, indicating if it is initializing, ready for use, or archived. */
|
|
749
|
+
currentState?: BranchStatus_State | undefined;
|
|
750
|
+
/** The pending state of the branch, if a state transition is in progress. */
|
|
751
|
+
pendingState?: BranchStatus_State | undefined;
|
|
752
|
+
/** A timestamp indicating when the `current_state` began. */
|
|
753
|
+
stateChangeTime?: Temporal.Instant | undefined;
|
|
754
|
+
/** The logical size of the branch. */
|
|
755
|
+
logicalSizeBytes?: bigint | undefined;
|
|
756
|
+
/** Absolute expiration time for the branch. Empty if expiration is disabled. */
|
|
757
|
+
expireTime?: Temporal.Instant | undefined;
|
|
758
|
+
/** Part of the resource name. */
|
|
759
|
+
branchId?: string | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* A timestamp indicating when the branch was deleted.
|
|
762
|
+
* Empty if the branch is not deleted.
|
|
763
|
+
*/
|
|
764
|
+
deleteTime?: Temporal.Instant | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* A timestamp indicating when the branch is scheduled to be purged.
|
|
767
|
+
* Empty if the branch is not deleted, otherwise set to a timestamp in the future.
|
|
768
|
+
*/
|
|
769
|
+
purgeTime?: Temporal.Instant | undefined;
|
|
770
|
+
}
|
|
771
|
+
export interface Catalog {
|
|
772
|
+
/**
|
|
773
|
+
* Output only. The full resource path of the catalog.
|
|
774
|
+
*
|
|
775
|
+
* Format: "catalogs/{catalog_id}".
|
|
776
|
+
*/
|
|
777
|
+
name?: string | undefined;
|
|
778
|
+
/** System-generated unique identifier for the catalog. */
|
|
779
|
+
uid?: string | undefined;
|
|
780
|
+
/** The desired state of the Catalog. */
|
|
781
|
+
spec?: Catalog_CatalogSpec | undefined;
|
|
782
|
+
/** The observed state of the Catalog. */
|
|
783
|
+
status?: Catalog_CatalogStatus | undefined;
|
|
784
|
+
/** A timestamp indicating when the catalog was created. */
|
|
785
|
+
createTime?: Temporal.Instant | undefined;
|
|
786
|
+
/** A timestamp indicating when the catalog was last updated. */
|
|
787
|
+
updateTime?: Temporal.Instant | undefined;
|
|
788
|
+
}
|
|
789
|
+
/** The desired state of the Catalog. */
|
|
790
|
+
export interface Catalog_CatalogSpec {
|
|
791
|
+
/**
|
|
792
|
+
* The name of the Postgres database inside the specified Lakebase project and branch to be associated with the UC catalog.
|
|
793
|
+
* This database must already exist, unless create_database_if_missing is set to true on creation.
|
|
794
|
+
*
|
|
795
|
+
* A database can only be registered with one UC catalog at a time.
|
|
796
|
+
* To re-register a database with a different catalog, the existing catalog must be deleted first.
|
|
797
|
+
*
|
|
798
|
+
* A child branch inherits the fact of parent's registration. This means the same-named database
|
|
799
|
+
* in a child branch cannot be registered with a second catalog
|
|
800
|
+
* while the parent's registration exists. To allow registering the database of a child branch,
|
|
801
|
+
* drop and recreate the database on the child branch.
|
|
802
|
+
* This removes the fact of parent's registration from this branch only.
|
|
803
|
+
*
|
|
804
|
+
* Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB was registered
|
|
805
|
+
* in the Catalog drops the fact of registration of the database. So the user should avoid doing so.
|
|
806
|
+
*/
|
|
807
|
+
postgresDatabase?: string | undefined;
|
|
808
|
+
/**
|
|
809
|
+
* If set to true, the specified postgres_database is created on behalf of the calling user
|
|
810
|
+
* if it does not already exist. In this case, the calling user has a role created for
|
|
811
|
+
* them in Postgres if they do not already have one.
|
|
812
|
+
*
|
|
813
|
+
* Defaults to false, meaning that the request fails if the specified postgres_database does not already exist.
|
|
814
|
+
*/
|
|
815
|
+
createDatabaseIfMissing?: boolean | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* The resource path of the branch associated with the catalog.
|
|
818
|
+
*
|
|
819
|
+
* Format: projects/{project_id}/branches/{branch_id}.
|
|
820
|
+
*/
|
|
821
|
+
branch?: string | undefined;
|
|
822
|
+
}
|
|
823
|
+
/** The observed state of the Catalog. */
|
|
824
|
+
export interface Catalog_CatalogStatus {
|
|
825
|
+
/** The name of the Postgres database associated with the catalog. */
|
|
826
|
+
postgresDatabase?: string | undefined;
|
|
827
|
+
/**
|
|
828
|
+
* The resource path of the project associated with the catalog.
|
|
829
|
+
*
|
|
830
|
+
* Format: projects/{project_id}.
|
|
831
|
+
*/
|
|
832
|
+
project?: string | undefined;
|
|
833
|
+
/**
|
|
834
|
+
* The resource path of the branch associated with the catalog.
|
|
835
|
+
*
|
|
836
|
+
* Format: projects/{project_id}/branches/{branch_id}.
|
|
837
|
+
*/
|
|
838
|
+
branch?: string | undefined;
|
|
839
|
+
}
|
|
840
|
+
export interface CatalogOperationMetadata {
|
|
841
|
+
}
|
|
842
|
+
export interface CreateBranchRequest {
|
|
843
|
+
/**
|
|
844
|
+
* The Project where this Branch will be created.
|
|
845
|
+
* Format: projects/{project_id}
|
|
846
|
+
*/
|
|
847
|
+
parent?: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* The ID to use for the Branch. This becomes the final component of the branch's resource name.
|
|
850
|
+
* The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
|
|
851
|
+
* For example, `development` becomes `projects/my-app/branches/development`.
|
|
852
|
+
*/
|
|
853
|
+
branchId?: string | undefined;
|
|
854
|
+
/** The Branch to create. */
|
|
855
|
+
branch?: Branch | undefined;
|
|
856
|
+
/** If true, update the branch if it already exists instead of returning an error. */
|
|
857
|
+
replaceExisting?: boolean | undefined;
|
|
858
|
+
}
|
|
859
|
+
export interface CreateCatalogRequest {
|
|
860
|
+
/**
|
|
861
|
+
* The ID in the Unity Catalog.
|
|
862
|
+
* It becomes the full resource name, for example "my_catalog" becomes "catalogs/my_catalog".
|
|
863
|
+
*/
|
|
864
|
+
catalogId?: string | undefined;
|
|
865
|
+
catalog?: Catalog | undefined;
|
|
866
|
+
}
|
|
867
|
+
export interface CreateDatabaseRequest {
|
|
868
|
+
/**
|
|
869
|
+
* The Branch where this Database will be created.
|
|
870
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
871
|
+
*/
|
|
872
|
+
parent?: string | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* The ID to use for the Database, which will become the final component of
|
|
875
|
+
* the database's resource name.
|
|
876
|
+
* This ID becomes the database name in postgres.
|
|
877
|
+
*
|
|
878
|
+
* This value should be 4-63 characters, and only use characters available in DNS names,
|
|
879
|
+
* as defined by RFC-1123
|
|
880
|
+
*
|
|
881
|
+
* If database_id is not specified in the request, it is generated automatically.
|
|
882
|
+
*/
|
|
883
|
+
databaseId?: string | undefined;
|
|
884
|
+
/** The desired specification of a Database. */
|
|
885
|
+
database?: Database | undefined;
|
|
886
|
+
}
|
|
887
|
+
export interface CreateEndpointRequest {
|
|
888
|
+
/**
|
|
889
|
+
* The Branch where this Endpoint will be created.
|
|
890
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
891
|
+
*/
|
|
892
|
+
parent?: string | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* The ID to use for the Endpoint. This becomes the final component of the endpoint's resource name.
|
|
895
|
+
* The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
|
|
896
|
+
* For example, `primary` becomes `projects/my-app/branches/development/endpoints/primary`.
|
|
897
|
+
*/
|
|
898
|
+
endpointId?: string | undefined;
|
|
899
|
+
/** The Endpoint to create. */
|
|
900
|
+
endpoint?: Endpoint | undefined;
|
|
901
|
+
/** If true, update the endpoint if it already exists instead of returning an error. */
|
|
902
|
+
replaceExisting?: boolean | undefined;
|
|
903
|
+
}
|
|
904
|
+
export interface CreateProjectRequest {
|
|
905
|
+
/**
|
|
906
|
+
* The ID to use for the Project. This becomes the final component of the project's resource name.
|
|
907
|
+
* The ID is required and must be 1-63 characters long, start with a lowercase letter, and contain only lowercase letters, numbers, and hyphens.
|
|
908
|
+
* For example, `my-app` becomes `projects/my-app`.
|
|
909
|
+
*/
|
|
910
|
+
projectId?: string | undefined;
|
|
911
|
+
/** The Project to create. */
|
|
912
|
+
project?: Project | undefined;
|
|
913
|
+
}
|
|
914
|
+
export interface CreateRoleRequest {
|
|
915
|
+
/**
|
|
916
|
+
* The Branch where this Role is created.
|
|
917
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
918
|
+
*/
|
|
919
|
+
parent?: string | undefined;
|
|
920
|
+
/**
|
|
921
|
+
* The ID to use for the Role, which will become the final component of
|
|
922
|
+
* the role's resource name.
|
|
923
|
+
* This ID becomes the role in Postgres.
|
|
924
|
+
*
|
|
925
|
+
* This value should be 4-63 characters, and valid characters
|
|
926
|
+
* are lowercase letters, numbers, and hyphens, as defined by RFC 1123.
|
|
927
|
+
*
|
|
928
|
+
* If role_id is not specified in the request, it is generated automatically.
|
|
929
|
+
*/
|
|
930
|
+
roleId?: string | undefined;
|
|
931
|
+
/** The desired specification of a Role. */
|
|
932
|
+
role?: Role | undefined;
|
|
933
|
+
}
|
|
934
|
+
/** Establish a synchronisation to the Postgres database for Reverse ETL for the source table selected from the Unity Catalog. */
|
|
935
|
+
export interface CreateSyncedTableRequest {
|
|
936
|
+
/**
|
|
937
|
+
* The ID to use for the Synced Table. This becomes the final component of the SyncedTable's resource name.
|
|
938
|
+
* ID is required and is the synced table name, containing (catalog, schema, table) tuple.
|
|
939
|
+
* Elements of the tuple are the UC entity names.
|
|
940
|
+
*
|
|
941
|
+
* Example: "{catalog}.{schema}.{table}"
|
|
942
|
+
*
|
|
943
|
+
* synced_table_id represents both of the following:
|
|
944
|
+
*
|
|
945
|
+
* 1. An online VIEW virtual table in the Unity Catalog accessible via the Lakehouse Federation.
|
|
946
|
+
* 2. Postgres table named "{table}" in schema "{schema}" in the connected Postgres database
|
|
947
|
+
*/
|
|
948
|
+
syncedTableId?: string | undefined;
|
|
949
|
+
syncedTable?: SyncedTable | undefined;
|
|
950
|
+
}
|
|
951
|
+
/** Database represents a Postgres database within a Branch. */
|
|
952
|
+
export interface Database {
|
|
953
|
+
/**
|
|
954
|
+
* The resource name of the database.
|
|
955
|
+
* Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
|
|
956
|
+
*/
|
|
957
|
+
name?: string | undefined;
|
|
958
|
+
/**
|
|
959
|
+
* The branch containing this database.
|
|
960
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
961
|
+
*/
|
|
962
|
+
parent?: string | undefined;
|
|
963
|
+
/** A timestamp indicating when the database was created. */
|
|
964
|
+
createTime?: Temporal.Instant | undefined;
|
|
965
|
+
/** A timestamp indicating when the database was last updated. */
|
|
966
|
+
updateTime?: Temporal.Instant | undefined;
|
|
967
|
+
/** The desired state of the Database. */
|
|
968
|
+
spec?: Database_DatabaseSpec | undefined;
|
|
969
|
+
/** The observed state of the Database. */
|
|
970
|
+
status?: Database_DatabaseStatus | undefined;
|
|
971
|
+
}
|
|
972
|
+
export interface Database_DatabaseSpec {
|
|
973
|
+
/**
|
|
974
|
+
* The name of the role that owns the database.
|
|
975
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
976
|
+
*
|
|
977
|
+
* To change the owner, pass valid existing Role name when updating the Database
|
|
978
|
+
*
|
|
979
|
+
* A database always has an owner.
|
|
980
|
+
*/
|
|
981
|
+
role?: string | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* The name of the Postgres database.
|
|
984
|
+
*
|
|
985
|
+
* This expects a valid Postgres identifier as specified in the link below.
|
|
986
|
+
* https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
|
|
987
|
+
* Required when creating the Database.
|
|
988
|
+
*
|
|
989
|
+
* To rename, pass a valid postgres identifier when updating the Database.
|
|
990
|
+
*/
|
|
991
|
+
postgresDatabase?: string | undefined;
|
|
992
|
+
}
|
|
993
|
+
export interface Database_DatabaseStatus {
|
|
994
|
+
/**
|
|
995
|
+
* The name of the role that owns the database.
|
|
996
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
997
|
+
*/
|
|
998
|
+
role?: string | undefined;
|
|
999
|
+
/** The name of the Postgres database. */
|
|
1000
|
+
postgresDatabase?: string | undefined;
|
|
1001
|
+
/** Part of the resource name. */
|
|
1002
|
+
databaseId?: string | undefined;
|
|
1003
|
+
}
|
|
1004
|
+
export interface DatabaseCredential {
|
|
1005
|
+
/** The OAuth token that can be used as a password when connecting to a database. */
|
|
1006
|
+
token?: string | undefined;
|
|
1007
|
+
/** Timestamp in UTC of when this credential expires. */
|
|
1008
|
+
expireTime?: Temporal.Instant | undefined;
|
|
1009
|
+
}
|
|
1010
|
+
export interface DatabaseOperationMetadata {
|
|
1011
|
+
}
|
|
1012
|
+
/** Databricks Error that is returned by all Databricks APIs. */
|
|
1013
|
+
export interface DatabricksServiceExceptionWithDetailsProto {
|
|
1014
|
+
errorCode?: ErrorCode | undefined;
|
|
1015
|
+
message?: string | undefined;
|
|
1016
|
+
stackTrace?: string | undefined;
|
|
1017
|
+
details?: Record<string, unknown>[] | undefined;
|
|
1018
|
+
}
|
|
1019
|
+
export interface DeleteBranchRequest {
|
|
1020
|
+
/**
|
|
1021
|
+
* The full resource path of the branch to delete.
|
|
1022
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1023
|
+
*/
|
|
1024
|
+
name?: string | undefined;
|
|
1025
|
+
/** If true, permanently delete the branch; if false, soft delete. */
|
|
1026
|
+
purge?: boolean | undefined;
|
|
1027
|
+
}
|
|
1028
|
+
export interface DeleteCatalogRequest {
|
|
1029
|
+
/**
|
|
1030
|
+
* The full resource path of the catalog to delete.
|
|
1031
|
+
*
|
|
1032
|
+
* Format: "catalogs/{catalog_id}".
|
|
1033
|
+
*/
|
|
1034
|
+
name?: string | undefined;
|
|
1035
|
+
}
|
|
1036
|
+
export interface DeleteDatabaseRequest {
|
|
1037
|
+
/**
|
|
1038
|
+
* The resource name of the postgres database.
|
|
1039
|
+
* Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
|
|
1040
|
+
*/
|
|
1041
|
+
name?: string | undefined;
|
|
1042
|
+
}
|
|
1043
|
+
export interface DeleteEndpointRequest {
|
|
1044
|
+
/**
|
|
1045
|
+
* The full resource path of the endpoint to delete.
|
|
1046
|
+
* Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
|
|
1047
|
+
*/
|
|
1048
|
+
name?: string | undefined;
|
|
1049
|
+
}
|
|
1050
|
+
export interface DeleteProjectRequest {
|
|
1051
|
+
/**
|
|
1052
|
+
* The full resource path of the project to delete.
|
|
1053
|
+
* Format: projects/{project_id}
|
|
1054
|
+
*/
|
|
1055
|
+
name?: string | undefined;
|
|
1056
|
+
/**
|
|
1057
|
+
* If true, permanently deletes the project (hard delete).
|
|
1058
|
+
* If false or unset, performs a soft delete.
|
|
1059
|
+
*/
|
|
1060
|
+
purge?: boolean | undefined;
|
|
1061
|
+
}
|
|
1062
|
+
export interface DeleteRoleRequest {
|
|
1063
|
+
/**
|
|
1064
|
+
* The full resource path of the role to delete.
|
|
1065
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
1066
|
+
*/
|
|
1067
|
+
name?: string | undefined;
|
|
1068
|
+
/**
|
|
1069
|
+
* Reassign objects. If this is set, all objects owned by the role are
|
|
1070
|
+
* reassigned to the role specified in this parameter.
|
|
1071
|
+
*
|
|
1072
|
+
* NOTE: setting this requires spinning up a compute to succeed, since it involves running
|
|
1073
|
+
* SQL queries.
|
|
1074
|
+
*/
|
|
1075
|
+
reassignOwnedTo?: string | undefined;
|
|
1076
|
+
}
|
|
1077
|
+
export interface DeleteSyncedTableRequest {
|
|
1078
|
+
/**
|
|
1079
|
+
* The Full resource name of the synced table, of the format "synced_tables/{catalog}.{schema}.{table}",
|
|
1080
|
+
* where (catalog, schema, table) are the UC entity names.
|
|
1081
|
+
*/
|
|
1082
|
+
name?: string | undefined;
|
|
1083
|
+
}
|
|
1084
|
+
export interface DeltaTableSyncInfo {
|
|
1085
|
+
/** The Delta Lake commit version that was last successfully synced. */
|
|
1086
|
+
deltaCommitVersion?: bigint | undefined;
|
|
1087
|
+
/**
|
|
1088
|
+
* The timestamp when the above Delta version was committed in the source Delta table.
|
|
1089
|
+
* Note: This is the Delta commit time, not the time the data was written to the synced table.
|
|
1090
|
+
*/
|
|
1091
|
+
deltaCommitTime?: Temporal.Instant | undefined;
|
|
1092
|
+
}
|
|
1093
|
+
export interface Endpoint {
|
|
1094
|
+
/**
|
|
1095
|
+
* Output only. The full resource path of the endpoint.
|
|
1096
|
+
* Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
|
|
1097
|
+
*/
|
|
1098
|
+
name?: string | undefined;
|
|
1099
|
+
/** System-generated unique ID for the endpoint. */
|
|
1100
|
+
uid?: string | undefined;
|
|
1101
|
+
/**
|
|
1102
|
+
* The branch containing this endpoint (API resource hierarchy).
|
|
1103
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1104
|
+
*/
|
|
1105
|
+
parent?: string | undefined;
|
|
1106
|
+
/** A timestamp indicating when the compute endpoint was created. */
|
|
1107
|
+
createTime?: Temporal.Instant | undefined;
|
|
1108
|
+
/** A timestamp indicating when the compute endpoint was last updated. */
|
|
1109
|
+
updateTime?: Temporal.Instant | undefined;
|
|
1110
|
+
/** The spec contains the compute endpoint configuration, including autoscaling limits, suspend timeout, and disabled state. */
|
|
1111
|
+
spec?: EndpointSpec | undefined;
|
|
1112
|
+
/** Current operational status of the compute endpoint. */
|
|
1113
|
+
status?: EndpointStatus | undefined;
|
|
1114
|
+
}
|
|
1115
|
+
export interface EndpointGroupSpec {
|
|
1116
|
+
/**
|
|
1117
|
+
* The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
|
|
1118
|
+
* than or equal to 1.
|
|
1119
|
+
*/
|
|
1120
|
+
min?: number | undefined;
|
|
1121
|
+
/**
|
|
1122
|
+
* The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
|
|
1123
|
+
* compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
|
|
1124
|
+
* true on the EndpointSpec.
|
|
1125
|
+
*/
|
|
1126
|
+
max?: number | undefined;
|
|
1127
|
+
/**
|
|
1128
|
+
* Whether to allow read-only connections to read-write endpoints. Only relevant for read-write endpoints where
|
|
1129
|
+
* size.max > 1.
|
|
1130
|
+
*/
|
|
1131
|
+
enableReadableSecondaries?: boolean | undefined;
|
|
1132
|
+
}
|
|
1133
|
+
export interface EndpointGroupStatus {
|
|
1134
|
+
/**
|
|
1135
|
+
* The minimum number of computes in the endpoint group. Currently, this must be equal to max. This must be greater
|
|
1136
|
+
* than or equal to 1.
|
|
1137
|
+
*/
|
|
1138
|
+
min?: number | undefined;
|
|
1139
|
+
/**
|
|
1140
|
+
* The maximum number of computes in the endpoint group. Currently, this must be equal to min. Set to 1 for single
|
|
1141
|
+
* compute endpoints, to disable HA. To manually suspend all computes in an endpoint group, set disabled to
|
|
1142
|
+
* true on the EndpointSpec.
|
|
1143
|
+
*/
|
|
1144
|
+
max?: number | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* Whether read-only connections to read-write endpoints are allowed. Only relevant if read replicas are configured
|
|
1147
|
+
* by specifying size.max > 1.
|
|
1148
|
+
*/
|
|
1149
|
+
enableReadableSecondaries?: boolean | undefined;
|
|
1150
|
+
}
|
|
1151
|
+
/** Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint. */
|
|
1152
|
+
export interface EndpointHosts {
|
|
1153
|
+
/**
|
|
1154
|
+
* The hostname to connect to this endpoint. For read-write endpoints, this is a read-write hostname which connects
|
|
1155
|
+
* to the primary compute. For read-only endpoints, this is a read-only hostname which allows read-only operations.
|
|
1156
|
+
*/
|
|
1157
|
+
host?: string | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* An optionally defined read-only host for the endpoint, without pooling. For read-only endpoints,
|
|
1160
|
+
* this attribute is always defined and is equivalent to host. For read-write endpoints, this attribute is defined
|
|
1161
|
+
* if the enclosing endpoint is a group with greater than 1 computes configured, and has readable secondaries enabled.
|
|
1162
|
+
*/
|
|
1163
|
+
readOnlyHost?: string | undefined;
|
|
1164
|
+
}
|
|
1165
|
+
export interface EndpointOperationMetadata {
|
|
1166
|
+
}
|
|
1167
|
+
/** A collection of settings for a compute endpoint. */
|
|
1168
|
+
export interface EndpointSettings {
|
|
1169
|
+
/** A raw representation of Postgres settings. */
|
|
1170
|
+
pgSettings?: Record<string, string> | undefined;
|
|
1171
|
+
}
|
|
1172
|
+
export interface EndpointSettings_PgSettingsEntry {
|
|
1173
|
+
key?: string | undefined;
|
|
1174
|
+
value?: string | undefined;
|
|
1175
|
+
}
|
|
1176
|
+
export interface EndpointSpec {
|
|
1177
|
+
/** The endpoint type. A branch can only have one READ_WRITE endpoint. */
|
|
1178
|
+
endpointType?: EndpointType | undefined;
|
|
1179
|
+
/** The minimum number of Compute Units. Minimum value is 0.5. */
|
|
1180
|
+
autoscalingLimitMinCu?: number | undefined;
|
|
1181
|
+
/**
|
|
1182
|
+
* The maximum number of Compute Units. The maximum value is 64.
|
|
1183
|
+
* The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
|
|
1184
|
+
*/
|
|
1185
|
+
autoscalingLimitMaxCu?: number | undefined;
|
|
1186
|
+
/**
|
|
1187
|
+
* Whether to restrict connections to the compute endpoint.
|
|
1188
|
+
* Enabling this option schedules a suspend compute operation.
|
|
1189
|
+
* A disabled compute endpoint cannot be enabled by a connection or
|
|
1190
|
+
* console action.
|
|
1191
|
+
*/
|
|
1192
|
+
disabled?: boolean | undefined;
|
|
1193
|
+
/**
|
|
1194
|
+
* Duration of inactivity after which the compute endpoint is automatically suspended. One of suspend_timeout_duration or no_suspension can be provided.
|
|
1195
|
+
* When not specified default suspension behavior will be used (consult with documentation).
|
|
1196
|
+
*
|
|
1197
|
+
* When updating this field, use "spec.suspension" in the update_mask.
|
|
1198
|
+
*/
|
|
1199
|
+
suspension?: {
|
|
1200
|
+
$case: 'suspendTimeoutDuration';
|
|
1201
|
+
/**
|
|
1202
|
+
* Duration of inactivity after which the compute endpoint is automatically suspended.
|
|
1203
|
+
* If specified should be between 60s and 604800s (1 minute to 1 week).
|
|
1204
|
+
* Mutually exclusive with `no_suspension`. When updating, use `spec.suspension` in the update_mask.
|
|
1205
|
+
*/
|
|
1206
|
+
suspendTimeoutDuration: Temporal.Duration;
|
|
1207
|
+
} | {
|
|
1208
|
+
$case: 'noSuspension';
|
|
1209
|
+
/**
|
|
1210
|
+
* When set to true, explicitly disables automatic suspension (never suspend).
|
|
1211
|
+
* Should be set to true when provided.
|
|
1212
|
+
* Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.suspension` in the update_mask.
|
|
1213
|
+
*/
|
|
1214
|
+
noSuspension: boolean;
|
|
1215
|
+
} | undefined;
|
|
1216
|
+
settings?: EndpointSettings | undefined;
|
|
1217
|
+
/**
|
|
1218
|
+
* Settings for optional HA configuration of the endpoint. If unspecified, the endpoint defaults
|
|
1219
|
+
* to non HA settings, with a single compute backing the endpoint (and no readable secondaries
|
|
1220
|
+
* for Read/Write endpoints).
|
|
1221
|
+
*/
|
|
1222
|
+
group?: EndpointGroupSpec | undefined;
|
|
1223
|
+
}
|
|
1224
|
+
export interface EndpointStatus {
|
|
1225
|
+
/** The endpoint type. A branch can only have one READ_WRITE endpoint. */
|
|
1226
|
+
endpointType?: EndpointType | undefined;
|
|
1227
|
+
/** Contains host information for connecting to the endpoint. */
|
|
1228
|
+
hosts?: EndpointHosts | undefined;
|
|
1229
|
+
/** The minimum number of Compute Units. */
|
|
1230
|
+
autoscalingLimitMinCu?: number | undefined;
|
|
1231
|
+
/**
|
|
1232
|
+
* The maximum number of Compute Units. The maximum value is 64.
|
|
1233
|
+
* The difference between the minimum and maximum Compute Units (max - min) must not exceed 16.
|
|
1234
|
+
*/
|
|
1235
|
+
autoscalingLimitMaxCu?: number | undefined;
|
|
1236
|
+
currentState?: EndpointStatus_State | undefined;
|
|
1237
|
+
pendingState?: EndpointStatus_State | undefined;
|
|
1238
|
+
/**
|
|
1239
|
+
* Whether to restrict connections to the compute endpoint.
|
|
1240
|
+
* Enabling this option schedules a suspend compute operation.
|
|
1241
|
+
* A disabled compute endpoint cannot be enabled by a connection or
|
|
1242
|
+
* console action.
|
|
1243
|
+
*/
|
|
1244
|
+
disabled?: boolean | undefined;
|
|
1245
|
+
/** Duration of inactivity after which the compute endpoint is automatically suspended. */
|
|
1246
|
+
suspendTimeoutDuration?: Temporal.Duration | undefined;
|
|
1247
|
+
settings?: EndpointSettings | undefined;
|
|
1248
|
+
/** Details on the HA configuration of the endpoint. */
|
|
1249
|
+
group?: EndpointGroupStatus | undefined;
|
|
1250
|
+
/** Part of the resource name. */
|
|
1251
|
+
endpointId?: string | undefined;
|
|
1252
|
+
}
|
|
1253
|
+
export interface GenerateDatabaseCredentialRequest {
|
|
1254
|
+
/** The returned token will be scoped to UC tables with the specified permissions. */
|
|
1255
|
+
claims?: RequestedClaims[] | undefined;
|
|
1256
|
+
/**
|
|
1257
|
+
* The endpoint resource name for which this credential will be generated.
|
|
1258
|
+
* Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
|
|
1259
|
+
*/
|
|
1260
|
+
endpoint?: string | undefined;
|
|
1261
|
+
}
|
|
1262
|
+
export interface GetBranchRequest {
|
|
1263
|
+
/**
|
|
1264
|
+
* The full resource path of the branch to retrieve.
|
|
1265
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1266
|
+
*/
|
|
1267
|
+
name?: string | undefined;
|
|
1268
|
+
}
|
|
1269
|
+
export interface GetCatalogRequest {
|
|
1270
|
+
/**
|
|
1271
|
+
* The full resource path of the catalog to retrieve.
|
|
1272
|
+
*
|
|
1273
|
+
* Format: "catalogs/{catalog_id}".
|
|
1274
|
+
*/
|
|
1275
|
+
name?: string | undefined;
|
|
1276
|
+
}
|
|
1277
|
+
export interface GetDatabaseRequest {
|
|
1278
|
+
/**
|
|
1279
|
+
* The name of the Database to retrieve.
|
|
1280
|
+
* Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
|
|
1281
|
+
*/
|
|
1282
|
+
name?: string | undefined;
|
|
1283
|
+
}
|
|
1284
|
+
export interface GetEndpointRequest {
|
|
1285
|
+
/**
|
|
1286
|
+
* The full resource path of the endpoint to retrieve.
|
|
1287
|
+
* Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
|
|
1288
|
+
*/
|
|
1289
|
+
name?: string | undefined;
|
|
1290
|
+
}
|
|
1291
|
+
/** The request message for `GetOperation` method. */
|
|
1292
|
+
export interface GetOperationRequest {
|
|
1293
|
+
/** The name of the operation resource. */
|
|
1294
|
+
name?: string | undefined;
|
|
1295
|
+
}
|
|
1296
|
+
export interface GetProjectRequest {
|
|
1297
|
+
/**
|
|
1298
|
+
* The full resource path of the project to retrieve.
|
|
1299
|
+
* Format: projects/{project_id}
|
|
1300
|
+
*/
|
|
1301
|
+
name?: string | undefined;
|
|
1302
|
+
}
|
|
1303
|
+
export interface GetRoleRequest {
|
|
1304
|
+
/**
|
|
1305
|
+
* The full resource path of the role to retrieve.
|
|
1306
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
1307
|
+
*/
|
|
1308
|
+
name?: string | undefined;
|
|
1309
|
+
}
|
|
1310
|
+
export interface GetSyncedTableRequest {
|
|
1311
|
+
/**
|
|
1312
|
+
* The Full resource name of the synced table.
|
|
1313
|
+
* Format: "synced_tables/{catalog}.{schema}.{table}",
|
|
1314
|
+
* where (catalog, schema, table) are the entity names in the Unity Catalog.
|
|
1315
|
+
*/
|
|
1316
|
+
name?: string | undefined;
|
|
1317
|
+
}
|
|
1318
|
+
/** Configuration for the initial Read/Write endpoint created during project creation. */
|
|
1319
|
+
export interface InitialEndpointSpec {
|
|
1320
|
+
/** Settings for HA configuration of the endpoint. */
|
|
1321
|
+
group?: EndpointGroupSpec | undefined;
|
|
1322
|
+
}
|
|
1323
|
+
export interface ListBranchesRequest {
|
|
1324
|
+
/**
|
|
1325
|
+
* The Project that owns this collection of branches.
|
|
1326
|
+
* Format: projects/{project_id}
|
|
1327
|
+
*/
|
|
1328
|
+
parent?: string | undefined;
|
|
1329
|
+
/** Page token from a previous response. If not provided, returns the first page. */
|
|
1330
|
+
pageToken?: string | undefined;
|
|
1331
|
+
/** Upper bound for items returned. Cannot be negative. */
|
|
1332
|
+
pageSize?: number | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* Whether to include soft-deleted branches in the response.
|
|
1335
|
+
* When true, deleted branches are included alongside active branches.
|
|
1336
|
+
* Purged branches are never returned.
|
|
1337
|
+
*/
|
|
1338
|
+
showDeleted?: boolean | undefined;
|
|
1339
|
+
}
|
|
1340
|
+
export interface ListBranchesResponse {
|
|
1341
|
+
/** List of branches in the project. */
|
|
1342
|
+
branches?: Branch[] | undefined;
|
|
1343
|
+
/** Token to request the next page of branches. */
|
|
1344
|
+
nextPageToken?: string | undefined;
|
|
1345
|
+
}
|
|
1346
|
+
/** List Databases. */
|
|
1347
|
+
export interface ListDatabasesRequest {
|
|
1348
|
+
/**
|
|
1349
|
+
* The Branch that owns this collection of databases.
|
|
1350
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1351
|
+
*/
|
|
1352
|
+
parent?: string | undefined;
|
|
1353
|
+
/** Pagination token to go to the next page of Databases. Requests first page if absent. */
|
|
1354
|
+
pageToken?: string | undefined;
|
|
1355
|
+
/** Upper bound for items returned. */
|
|
1356
|
+
pageSize?: number | undefined;
|
|
1357
|
+
}
|
|
1358
|
+
export interface ListDatabasesResponse {
|
|
1359
|
+
/** List of databases. */
|
|
1360
|
+
databases?: Database[] | undefined;
|
|
1361
|
+
/** Pagination token to request the next page of databases. */
|
|
1362
|
+
nextPageToken?: string | undefined;
|
|
1363
|
+
}
|
|
1364
|
+
export interface ListEndpointsRequest {
|
|
1365
|
+
/**
|
|
1366
|
+
* The Branch that owns this collection of endpoints.
|
|
1367
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1368
|
+
*/
|
|
1369
|
+
parent?: string | undefined;
|
|
1370
|
+
/** Page token from a previous response. If not provided, returns the first page. */
|
|
1371
|
+
pageToken?: string | undefined;
|
|
1372
|
+
/** Upper bound for items returned. Cannot be negative. */
|
|
1373
|
+
pageSize?: number | undefined;
|
|
1374
|
+
}
|
|
1375
|
+
export interface ListEndpointsResponse {
|
|
1376
|
+
/** List of compute endpoints in the branch. */
|
|
1377
|
+
endpoints?: Endpoint[] | undefined;
|
|
1378
|
+
/** Token to request the next page of compute endpoints. */
|
|
1379
|
+
nextPageToken?: string | undefined;
|
|
1380
|
+
}
|
|
1381
|
+
export interface ListProjectsRequest {
|
|
1382
|
+
/** Page token from a previous response. If not provided, returns the first page. */
|
|
1383
|
+
pageToken?: string | undefined;
|
|
1384
|
+
/** Upper bound for items returned. Cannot be negative. The maximum value is 100. */
|
|
1385
|
+
pageSize?: number | undefined;
|
|
1386
|
+
/**
|
|
1387
|
+
* Whether to include soft-deleted projects in the response.
|
|
1388
|
+
* When true, soft-deleted projects are included alongside active projects.
|
|
1389
|
+
* Hard-deleted and already-purged projects are never returned.
|
|
1390
|
+
*/
|
|
1391
|
+
showDeleted?: boolean | undefined;
|
|
1392
|
+
}
|
|
1393
|
+
export interface ListProjectsResponse {
|
|
1394
|
+
/** List of all projects in the workspace that the user has permission to access. */
|
|
1395
|
+
projects?: Project[] | undefined;
|
|
1396
|
+
/** Token to request the next page of projects. */
|
|
1397
|
+
nextPageToken?: string | undefined;
|
|
1398
|
+
}
|
|
1399
|
+
export interface ListRolesRequest {
|
|
1400
|
+
/**
|
|
1401
|
+
* The Branch that owns this collection of roles.
|
|
1402
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1403
|
+
*/
|
|
1404
|
+
parent?: string | undefined;
|
|
1405
|
+
/** Page token from a previous response. If not provided, returns the first page. */
|
|
1406
|
+
pageToken?: string | undefined;
|
|
1407
|
+
/** Upper bound for items returned. Cannot be negative. */
|
|
1408
|
+
pageSize?: number | undefined;
|
|
1409
|
+
}
|
|
1410
|
+
export interface ListRolesResponse {
|
|
1411
|
+
/** List of Postgres roles in the branch. */
|
|
1412
|
+
roles?: Role[] | undefined;
|
|
1413
|
+
/** Token to request the next page of Postgres roles. */
|
|
1414
|
+
nextPageToken?: string | undefined;
|
|
1415
|
+
}
|
|
1416
|
+
export interface NewPipelineSpec {
|
|
1417
|
+
/**
|
|
1418
|
+
* UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc).
|
|
1419
|
+
* This needs to be a standard catalog where the user has permissions to create Delta tables.
|
|
1420
|
+
*/
|
|
1421
|
+
storageCatalog?: string | undefined;
|
|
1422
|
+
/**
|
|
1423
|
+
* UC schema for the pipeline to store intermediate files (checkpoints, event logs etc).
|
|
1424
|
+
* This needs to be in the standard catalog where the user has permissions to create Delta tables.
|
|
1425
|
+
*/
|
|
1426
|
+
storageSchema?: string | undefined;
|
|
1427
|
+
/** Budget policy to set on the newly created pipeline. */
|
|
1428
|
+
budgetPolicyId?: string | undefined;
|
|
1429
|
+
}
|
|
1430
|
+
/**
|
|
1431
|
+
* This resource represents a long-running operation that is the result of a
|
|
1432
|
+
* network API call.
|
|
1433
|
+
*/
|
|
1434
|
+
export interface Operation {
|
|
1435
|
+
/**
|
|
1436
|
+
* The server-assigned name, which is only unique within the same service that
|
|
1437
|
+
* originally returns it. If you use the default HTTP mapping, the
|
|
1438
|
+
* `name` should be a resource name ending with `operations/{unique_id}`.
|
|
1439
|
+
*/
|
|
1440
|
+
name?: string | undefined;
|
|
1441
|
+
/**
|
|
1442
|
+
* Service-specific metadata associated with the operation. It typically
|
|
1443
|
+
* contains progress information and common metadata such as create time.
|
|
1444
|
+
* Some services might not provide such metadata.
|
|
1445
|
+
*/
|
|
1446
|
+
metadata?: Record<string, unknown> | undefined;
|
|
1447
|
+
/**
|
|
1448
|
+
* If the value is `false`, it means the operation is still in progress.
|
|
1449
|
+
* If `true`, the operation is completed, and either `error` or `response` is
|
|
1450
|
+
* available.
|
|
1451
|
+
*/
|
|
1452
|
+
done?: boolean | undefined;
|
|
1453
|
+
/**
|
|
1454
|
+
* The operation result, which can be either an `error` or a valid `response`.
|
|
1455
|
+
* If `done` == `false`, neither `error` nor `response` is set.
|
|
1456
|
+
* If `done` == `true`, exactly one of `error` or `response` can be set.
|
|
1457
|
+
* Some services might not provide the result.
|
|
1458
|
+
*/
|
|
1459
|
+
result?: {
|
|
1460
|
+
$case: 'error';
|
|
1461
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
1462
|
+
error: DatabricksServiceExceptionWithDetailsProto;
|
|
1463
|
+
} | {
|
|
1464
|
+
$case: 'response';
|
|
1465
|
+
/** The normal, successful response of the operation. */
|
|
1466
|
+
response: Record<string, unknown>;
|
|
1467
|
+
} | undefined;
|
|
1468
|
+
}
|
|
1469
|
+
export interface Project {
|
|
1470
|
+
/**
|
|
1471
|
+
* Output only. The full resource path of the project.
|
|
1472
|
+
* Format: projects/{project_id}
|
|
1473
|
+
*/
|
|
1474
|
+
name?: string | undefined;
|
|
1475
|
+
/** System-generated unique ID for the project. */
|
|
1476
|
+
uid?: string | undefined;
|
|
1477
|
+
/** A timestamp indicating when the project was created. */
|
|
1478
|
+
createTime?: Temporal.Instant | undefined;
|
|
1479
|
+
/** A timestamp indicating when the project was last updated. */
|
|
1480
|
+
updateTime?: Temporal.Instant | undefined;
|
|
1481
|
+
/** The spec contains the project configuration, including display_name, pg_version (Postgres version), history_retention_duration, and default_endpoint_settings. */
|
|
1482
|
+
spec?: ProjectSpec | undefined;
|
|
1483
|
+
/** The current status of a Project. */
|
|
1484
|
+
status?: ProjectStatus | undefined;
|
|
1485
|
+
/**
|
|
1486
|
+
* Configuration settings for the initial Read/Write endpoint created inside the initial branch for a newly
|
|
1487
|
+
* created project. If omitted, the initial endpoint created will have default settings, without high availability
|
|
1488
|
+
* configured. This field does not apply to any endpoints created after project creation. Use
|
|
1489
|
+
* spec.default_endpoint_settings to configure default settings for endpoints created after project creation.
|
|
1490
|
+
*/
|
|
1491
|
+
initialEndpointSpec?: InitialEndpointSpec | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* A timestamp indicating when the project was soft-deleted.
|
|
1494
|
+
* Empty if the project is not deleted, otherwise set to a timestamp in the past.
|
|
1495
|
+
*/
|
|
1496
|
+
deleteTime?: Temporal.Instant | undefined;
|
|
1497
|
+
/**
|
|
1498
|
+
* A timestamp indicating when the project is scheduled for permanent deletion.
|
|
1499
|
+
* Empty if the project is not deleted, otherwise set to a timestamp in the future.
|
|
1500
|
+
*/
|
|
1501
|
+
purgeTime?: Temporal.Instant | undefined;
|
|
1502
|
+
}
|
|
1503
|
+
export interface ProjectCustomTag {
|
|
1504
|
+
/** The key of the custom tag. */
|
|
1505
|
+
key?: string | undefined;
|
|
1506
|
+
/** The value of the custom tag. */
|
|
1507
|
+
value?: string | undefined;
|
|
1508
|
+
}
|
|
1509
|
+
/** A collection of settings for a compute endpoint. */
|
|
1510
|
+
export interface ProjectDefaultEndpointSettings {
|
|
1511
|
+
/** The minimum number of Compute Units. Minimum value is 0.5. */
|
|
1512
|
+
autoscalingLimitMinCu?: number | undefined;
|
|
1513
|
+
/** The maximum number of Compute Units. Minimum value is 0.5. */
|
|
1514
|
+
autoscalingLimitMaxCu?: number | undefined;
|
|
1515
|
+
suspension?: {
|
|
1516
|
+
$case: 'suspendTimeoutDuration';
|
|
1517
|
+
/**
|
|
1518
|
+
* Duration of inactivity after which the compute endpoint is automatically suspended.
|
|
1519
|
+
* If specified should be between 60s and 604800s (1 minute to 1 week).
|
|
1520
|
+
* Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
|
|
1521
|
+
*/
|
|
1522
|
+
suspendTimeoutDuration: Temporal.Duration;
|
|
1523
|
+
} | {
|
|
1524
|
+
$case: 'noSuspension';
|
|
1525
|
+
/**
|
|
1526
|
+
* When set to true, explicitly disables automatic suspension (never suspend).
|
|
1527
|
+
* Should be set to true when provided.
|
|
1528
|
+
* Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.
|
|
1529
|
+
*/
|
|
1530
|
+
noSuspension: boolean;
|
|
1531
|
+
} | undefined;
|
|
1532
|
+
/** A raw representation of Postgres settings. */
|
|
1533
|
+
pgSettings?: Record<string, string> | undefined;
|
|
1534
|
+
}
|
|
1535
|
+
export interface ProjectDefaultEndpointSettings_PgSettingsEntry {
|
|
1536
|
+
key?: string | undefined;
|
|
1537
|
+
value?: string | undefined;
|
|
1538
|
+
}
|
|
1539
|
+
export interface ProjectOperationMetadata {
|
|
1540
|
+
}
|
|
1541
|
+
export interface ProjectSpec {
|
|
1542
|
+
/** Human-readable project name. Length should be between 1 and 256 characters. */
|
|
1543
|
+
displayName?: string | undefined;
|
|
1544
|
+
/** The major Postgres version number. The set of supported versions may vary; consult the API documentation for currently accepted values. */
|
|
1545
|
+
pgVersion?: number | undefined;
|
|
1546
|
+
/** 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). */
|
|
1547
|
+
historyRetentionDuration?: Temporal.Duration | undefined;
|
|
1548
|
+
defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
|
|
1549
|
+
/**
|
|
1550
|
+
* The desired budget policy to associate with the project.
|
|
1551
|
+
* See status.budget_policy_id for the policy that is actually applied to the project.
|
|
1552
|
+
*/
|
|
1553
|
+
budgetPolicyId?: string | undefined;
|
|
1554
|
+
/**
|
|
1555
|
+
* Custom tags to associate with the project. Forwarded to LBM for billing and cost tracking.
|
|
1556
|
+
* To update tags, provide the new tag list and include "spec.custom_tags" in the update_mask.
|
|
1557
|
+
* To clear all tags, provide an empty list and include "spec.custom_tags" in the update_mask.
|
|
1558
|
+
* To preserve existing tags, omit this field from the update_mask (or use wildcard "*" which auto-excludes empty tags).
|
|
1559
|
+
*/
|
|
1560
|
+
customTags?: ProjectCustomTag[] | undefined;
|
|
1561
|
+
/** Whether to enable PG native password login on all endpoints in this project. Defaults to false. */
|
|
1562
|
+
enablePgNativeLogin?: boolean | undefined;
|
|
1563
|
+
/**
|
|
1564
|
+
* The full resource path for the default branch of the project
|
|
1565
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1566
|
+
*/
|
|
1567
|
+
defaultBranch?: string | undefined;
|
|
1568
|
+
}
|
|
1569
|
+
export interface ProjectStatus {
|
|
1570
|
+
/** The effective human-readable project name. */
|
|
1571
|
+
displayName?: string | undefined;
|
|
1572
|
+
/** The effective major Postgres version number. */
|
|
1573
|
+
pgVersion?: number | undefined;
|
|
1574
|
+
/** The effective number of seconds to retain the shared history for point in time recovery. */
|
|
1575
|
+
historyRetentionDuration?: Temporal.Duration | undefined;
|
|
1576
|
+
/** The effective default endpoint settings. */
|
|
1577
|
+
defaultEndpointSettings?: ProjectDefaultEndpointSettings | undefined;
|
|
1578
|
+
/** The logical size limit for a branch. */
|
|
1579
|
+
branchLogicalSizeLimitBytes?: bigint | undefined;
|
|
1580
|
+
/** The current space occupied by the project in storage. */
|
|
1581
|
+
syntheticStorageSizeBytes?: bigint | undefined;
|
|
1582
|
+
/** The budget policy that is applied to the project. */
|
|
1583
|
+
budgetPolicyId?: string | undefined;
|
|
1584
|
+
/** The effective custom tags associated with the project. */
|
|
1585
|
+
customTags?: ProjectCustomTag[] | undefined;
|
|
1586
|
+
/** The email of the project owner. */
|
|
1587
|
+
owner?: string | undefined;
|
|
1588
|
+
/** Whether to enable PG native password login on all endpoints in this project. */
|
|
1589
|
+
enablePgNativeLogin?: boolean | undefined;
|
|
1590
|
+
/** The full resource path of the default branch of the project */
|
|
1591
|
+
defaultBranch?: string | undefined;
|
|
1592
|
+
/** Part of the resource name. */
|
|
1593
|
+
projectId?: string | undefined;
|
|
1594
|
+
}
|
|
1595
|
+
/** The provisioning state of a resource in Unity Catalog. */
|
|
1596
|
+
export interface ProvisioningInfo {
|
|
1597
|
+
}
|
|
1598
|
+
export interface RequestedClaims {
|
|
1599
|
+
permissionSet?: RequestedClaims_PermissionSet | undefined;
|
|
1600
|
+
resources?: RequestedResource[] | undefined;
|
|
1601
|
+
}
|
|
1602
|
+
export interface RequestedResource {
|
|
1603
|
+
resourceName?: {
|
|
1604
|
+
$case: 'tableName';
|
|
1605
|
+
/** The full Unity Catalog table name. */
|
|
1606
|
+
tableName: string;
|
|
1607
|
+
} | undefined;
|
|
1608
|
+
}
|
|
1609
|
+
/** Role represents a Postgres role within a Branch. */
|
|
1610
|
+
export interface Role {
|
|
1611
|
+
/**
|
|
1612
|
+
* Output only. The full resource path of the role.
|
|
1613
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
1614
|
+
*/
|
|
1615
|
+
name?: string | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* The Branch where this Role exists.
|
|
1618
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1619
|
+
*/
|
|
1620
|
+
parent?: string | undefined;
|
|
1621
|
+
createTime?: Temporal.Instant | undefined;
|
|
1622
|
+
updateTime?: Temporal.Instant | undefined;
|
|
1623
|
+
/** The spec contains the role configuration, including identity type, authentication method, and role attributes. */
|
|
1624
|
+
spec?: Role_RoleSpec | undefined;
|
|
1625
|
+
/** Current status of the role, including its identity type, authentication method, and role attributes. */
|
|
1626
|
+
status?: Role_RoleStatus | undefined;
|
|
1627
|
+
}
|
|
1628
|
+
/**
|
|
1629
|
+
* Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref:
|
|
1630
|
+
* https://www.postgresql.org/docs/16/sql-createrole.html
|
|
1631
|
+
* The values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical
|
|
1632
|
+
* underscores between words.
|
|
1633
|
+
*/
|
|
1634
|
+
export interface Role_Attributes {
|
|
1635
|
+
createdb?: boolean | undefined;
|
|
1636
|
+
createrole?: boolean | undefined;
|
|
1637
|
+
bypassrls?: boolean | undefined;
|
|
1638
|
+
}
|
|
1639
|
+
export interface Role_RoleSpec {
|
|
1640
|
+
/** An enum value for a standard role that this role is a member of. */
|
|
1641
|
+
membershipRoles?: Role_MembershipRole[] | undefined;
|
|
1642
|
+
/**
|
|
1643
|
+
* The type of role.
|
|
1644
|
+
* When specifying a managed-identity, the chosen role_id must be a valid:
|
|
1645
|
+
*
|
|
1646
|
+
* * application ID for SERVICE_PRINCIPAL
|
|
1647
|
+
* * user email for USER
|
|
1648
|
+
* * group name for GROUP
|
|
1649
|
+
*/
|
|
1650
|
+
identityType?: Role_IdentityType | undefined;
|
|
1651
|
+
/** The desired API-exposed Postgres role attribute to associate with the role. Optional. */
|
|
1652
|
+
attributes?: Role_Attributes | undefined;
|
|
1653
|
+
/**
|
|
1654
|
+
* Controls how the Postgres role authenticates when a client opens a database
|
|
1655
|
+
* connection. Supported values:
|
|
1656
|
+
*
|
|
1657
|
+
* * LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks
|
|
1658
|
+
* OAuth access token derived from the backing managed identity (the
|
|
1659
|
+
* <Databricks> user, service principal, or group named by the role's
|
|
1660
|
+
* `postgres_role`). No static password exists for roles using this method.
|
|
1661
|
+
* * PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres
|
|
1662
|
+
* password verified server-side using the SCRAM-SHA-256 mechanism.
|
|
1663
|
+
* Lakebase generates a password for the role.
|
|
1664
|
+
* * NO_LOGIN: the role cannot open a Postgres session at all. Useful for
|
|
1665
|
+
* roles that exist only to own objects or to aggregate privileges that
|
|
1666
|
+
* are then granted to other, loginable roles.
|
|
1667
|
+
*
|
|
1668
|
+
* If auth_method is left unspecified, a meaningful authentication method is derived from the identity_type:
|
|
1669
|
+
* * For the managed identities, OAUTH is used.
|
|
1670
|
+
* * For the regular postgres roles, authentication based on postgres passwords is used.
|
|
1671
|
+
*
|
|
1672
|
+
* NOTE: for the <Databricks> identity type GROUP, LAKEBASE_OAUTH_V1
|
|
1673
|
+
* is the default auth method (group can login as well).
|
|
1674
|
+
*/
|
|
1675
|
+
authMethod?: Role_AuthMethod | undefined;
|
|
1676
|
+
/**
|
|
1677
|
+
* The name of the Postgres role.
|
|
1678
|
+
*
|
|
1679
|
+
* This expects a valid Postgres identifier as specified in the link below.
|
|
1680
|
+
* https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
|
|
1681
|
+
*
|
|
1682
|
+
* Required when creating the Role.
|
|
1683
|
+
*
|
|
1684
|
+
* If you wish to create a Postgres Role backed by a managed <Databricks> identity, then postgres_role
|
|
1685
|
+
* must be one of the following:
|
|
1686
|
+
*
|
|
1687
|
+
* 1. user email for IdentityType.USER
|
|
1688
|
+
* 2. app ID for IdentityType.SERVICE_PRINCIPAL
|
|
1689
|
+
* 2. group name for IdentityType.GROUP
|
|
1690
|
+
*/
|
|
1691
|
+
postgresRole?: string | undefined;
|
|
1692
|
+
}
|
|
1693
|
+
export interface Role_RoleStatus {
|
|
1694
|
+
/** An enum value for a standard role that this role is a member of. */
|
|
1695
|
+
membershipRoles?: Role_MembershipRole[] | undefined;
|
|
1696
|
+
/** The type of the role. */
|
|
1697
|
+
identityType?: Role_IdentityType | undefined;
|
|
1698
|
+
/** The PG role attributes associated with the role. */
|
|
1699
|
+
attributes?: Role_Attributes | undefined;
|
|
1700
|
+
authMethod?: Role_AuthMethod | undefined;
|
|
1701
|
+
/** The name of the Postgres role. */
|
|
1702
|
+
postgresRole?: string | undefined;
|
|
1703
|
+
/** Part of the resource name. */
|
|
1704
|
+
roleId?: string | undefined;
|
|
1705
|
+
}
|
|
1706
|
+
export interface RoleOperationMetadata {
|
|
1707
|
+
}
|
|
1708
|
+
export interface SyncedTable {
|
|
1709
|
+
/**
|
|
1710
|
+
* Output only. The Full resource name of the synced table in Postgres
|
|
1711
|
+
* where (catalog, schema, table) are the UC entity names.
|
|
1712
|
+
*
|
|
1713
|
+
* Format "synced_tables/{catalog}.{schema}.{table}"
|
|
1714
|
+
*
|
|
1715
|
+
* For the corresponding source table in the Unity catalog look for the "source_table_full_name" attribute.
|
|
1716
|
+
*/
|
|
1717
|
+
name?: string | undefined;
|
|
1718
|
+
/** The Unity Catalog table ID for this synced table. */
|
|
1719
|
+
uid?: string | undefined;
|
|
1720
|
+
/**
|
|
1721
|
+
* Configuration details of the synced table, such as the source table, scheduling policy, etc.
|
|
1722
|
+
* This attribute is specified at creation time and most fields are returned as is on subsequent queries.
|
|
1723
|
+
*/
|
|
1724
|
+
spec?: SyncedTable_SyncedTableSpec | undefined;
|
|
1725
|
+
/** Synced Table data synchronization status. */
|
|
1726
|
+
status?: SyncedTable_SyncedTableStatus | undefined;
|
|
1727
|
+
createTime?: Temporal.Instant | undefined;
|
|
1728
|
+
}
|
|
1729
|
+
export interface SyncedTable_SyncedTableSpec {
|
|
1730
|
+
/**
|
|
1731
|
+
* The Postgres database name where the synced table will be created in.
|
|
1732
|
+
*
|
|
1733
|
+
* If this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred
|
|
1734
|
+
* from the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.
|
|
1735
|
+
*
|
|
1736
|
+
* A value must be specified when creating a synced table inside a Standard Catalog.
|
|
1737
|
+
*/
|
|
1738
|
+
postgresDatabase?: string | undefined;
|
|
1739
|
+
/**
|
|
1740
|
+
* The full resource name the branch associated with the table.
|
|
1741
|
+
*
|
|
1742
|
+
* Format: "projects/{project_id}/branches/{branch_id}".
|
|
1743
|
+
*/
|
|
1744
|
+
branch?: string | undefined;
|
|
1745
|
+
/** Scheduling policy of the underlying pipeline. */
|
|
1746
|
+
schedulingPolicy?: SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy | undefined;
|
|
1747
|
+
/**
|
|
1748
|
+
* Three-part (catalog, schema, table) name of the source Delta table.
|
|
1749
|
+
*
|
|
1750
|
+
* For the corresponding destination table, use any of the two:
|
|
1751
|
+
*
|
|
1752
|
+
* * synced_table_id used at the creation of the SyncedTable
|
|
1753
|
+
* * "name" consisting of "synced_tables/" prefix and the full name of the destination table.
|
|
1754
|
+
*/
|
|
1755
|
+
sourceTableFullName?: string | undefined;
|
|
1756
|
+
/** Primary Key columns to be used for data insert/update in the destination. */
|
|
1757
|
+
primaryKeyColumns?: string[] | undefined;
|
|
1758
|
+
/** Time series key to deduplicate (tie-break) rows with the same primary key. */
|
|
1759
|
+
timeseriesKey?: string | undefined;
|
|
1760
|
+
/**
|
|
1761
|
+
* ID of an existing pipeline to bin-pack this synced table into.
|
|
1762
|
+
* At most one of existing_pipeline_id and new_pipeline_spec should be defined.
|
|
1763
|
+
*
|
|
1764
|
+
* The pipeline used for the synced table is returned via the top level pipeline_id attribute.
|
|
1765
|
+
*/
|
|
1766
|
+
existingPipelineId?: string | undefined;
|
|
1767
|
+
/**
|
|
1768
|
+
* If true, the synced table's logical database and schema resources in PG
|
|
1769
|
+
* will be created if they do not already exist.
|
|
1770
|
+
* The request will fail if this is false and the database/schema do not exist.
|
|
1771
|
+
*
|
|
1772
|
+
* Defaults to true if omitted.
|
|
1773
|
+
*/
|
|
1774
|
+
createDatabaseObjectsIfMissing?: boolean | undefined;
|
|
1775
|
+
/**
|
|
1776
|
+
* Specification for creating a new pipeline.
|
|
1777
|
+
* At most one of existing_pipeline_id and new_pipeline_spec should be defined.
|
|
1778
|
+
*
|
|
1779
|
+
* The pipeline used for the synced table is returned via the top level pipeline_id attribute.
|
|
1780
|
+
*/
|
|
1781
|
+
newPipelineSpec?: NewPipelineSpec | undefined;
|
|
1782
|
+
}
|
|
1783
|
+
export interface SyncedTable_SyncedTableStatus {
|
|
1784
|
+
/** A text description of the current state of the synced table. */
|
|
1785
|
+
message?: string | undefined;
|
|
1786
|
+
/** The state of the synced table. */
|
|
1787
|
+
detailedState?: SyncedTableState | undefined;
|
|
1788
|
+
/** Summary of the last successful synchronization from source to destination. */
|
|
1789
|
+
lastSync?: SyncedTablePosition | undefined;
|
|
1790
|
+
ongoingSyncProgress?: SyncedTablePipelineProgress | undefined;
|
|
1791
|
+
/** The current phase of the data synchronization pipeline. */
|
|
1792
|
+
provisioningPhase?: ProvisioningPhase | undefined;
|
|
1793
|
+
/** The last source table Delta version that was successfully synced to the synced table. */
|
|
1794
|
+
lastProcessedCommitVersion?: bigint | undefined;
|
|
1795
|
+
/**
|
|
1796
|
+
* The end timestamp of the last time any data was synchronized from the source table to the synced
|
|
1797
|
+
* table. This is when the data is available in the synced table.
|
|
1798
|
+
*/
|
|
1799
|
+
lastSyncTime?: Temporal.Instant | undefined;
|
|
1800
|
+
/** ID of the associated pipeline. */
|
|
1801
|
+
pipelineId?: string | undefined;
|
|
1802
|
+
/** The provisioning state of the synced table entity in Unity Catalog. */
|
|
1803
|
+
unityCatalogProvisioningState?: ProvisioningInfo_State | undefined;
|
|
1804
|
+
/**
|
|
1805
|
+
* The full resource name of the project associated with the table.
|
|
1806
|
+
*
|
|
1807
|
+
* Format: "projects/{project_id}".
|
|
1808
|
+
*/
|
|
1809
|
+
project?: string | undefined;
|
|
1810
|
+
}
|
|
1811
|
+
/** Metadata for SyncedTable long-running operations. */
|
|
1812
|
+
export interface SyncedTableOperationMetadata {
|
|
1813
|
+
}
|
|
1814
|
+
/** Progress information of the Synced Table data synchronization pipeline. */
|
|
1815
|
+
export interface SyncedTablePipelineProgress {
|
|
1816
|
+
/**
|
|
1817
|
+
* The source table Delta version that was last processed by the pipeline. The pipeline may not
|
|
1818
|
+
* have completely processed this version yet.
|
|
1819
|
+
*/
|
|
1820
|
+
latestVersionCurrentlyProcessing?: bigint | undefined;
|
|
1821
|
+
/** The number of rows that have been synced in this update. */
|
|
1822
|
+
syncedRowCount?: bigint | undefined;
|
|
1823
|
+
/** The total number of rows that need to be synced in this update. This number may be an estimate. */
|
|
1824
|
+
totalRowCount?: bigint | undefined;
|
|
1825
|
+
/** The completion ratio of this update. This is a number between 0 and 1. */
|
|
1826
|
+
syncProgressCompletion?: number | undefined;
|
|
1827
|
+
/** The estimated time remaining to complete this update in seconds. */
|
|
1828
|
+
estimatedCompletionTimeSeconds?: number | undefined;
|
|
1829
|
+
}
|
|
1830
|
+
export interface SyncedTablePosition {
|
|
1831
|
+
/**
|
|
1832
|
+
* The starting timestamp of the most recent successful synchronization from the source table
|
|
1833
|
+
* to the destination (synced) table.
|
|
1834
|
+
* Note this is the starting timestamp of the sync operation, not the end time.
|
|
1835
|
+
* E.g., for a batch, this is the time when the sync operation started.
|
|
1836
|
+
*/
|
|
1837
|
+
syncStartTime?: Temporal.Instant | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* The end timestamp of the most recent successful synchronization.
|
|
1840
|
+
* This is the time when the data is available in the synced table.
|
|
1841
|
+
*/
|
|
1842
|
+
syncEndTime?: Temporal.Instant | undefined;
|
|
1843
|
+
/** Information about the source system at the time of the last sync. */
|
|
1844
|
+
sourceSyncInfo?: {
|
|
1845
|
+
$case: 'deltaTableSyncInfo';
|
|
1846
|
+
deltaTableSyncInfo: DeltaTableSyncInfo;
|
|
1847
|
+
} | undefined;
|
|
1848
|
+
}
|
|
1849
|
+
export interface UndeleteBranchRequest {
|
|
1850
|
+
/**
|
|
1851
|
+
* The full resource path of the branch to undelete.
|
|
1852
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1853
|
+
*/
|
|
1854
|
+
name?: string | undefined;
|
|
1855
|
+
}
|
|
1856
|
+
/** Request to restore a soft-deleted project within its retention period. */
|
|
1857
|
+
export interface UndeleteProjectRequest {
|
|
1858
|
+
/**
|
|
1859
|
+
* The full resource path of the project to undelete.
|
|
1860
|
+
* Format: projects/{project_id}
|
|
1861
|
+
*/
|
|
1862
|
+
name?: string | undefined;
|
|
1863
|
+
}
|
|
1864
|
+
export interface UpdateBranchRequest {
|
|
1865
|
+
/**
|
|
1866
|
+
* The Branch to update.
|
|
1867
|
+
*
|
|
1868
|
+
* The branch's `name` field is used to identify the branch to update.
|
|
1869
|
+
* Format: projects/{project_id}/branches/{branch_id}
|
|
1870
|
+
*/
|
|
1871
|
+
branch?: Branch | undefined;
|
|
1872
|
+
/** The list of fields to update. If unspecified, all fields will be updated when possible. */
|
|
1873
|
+
updateMask?: FieldMask<Branch> | undefined;
|
|
1874
|
+
}
|
|
1875
|
+
export interface UpdateDatabaseRequest {
|
|
1876
|
+
/**
|
|
1877
|
+
* The Database to update.
|
|
1878
|
+
*
|
|
1879
|
+
* The database's `name` field is used to identify the database to update.
|
|
1880
|
+
* Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
|
|
1881
|
+
*/
|
|
1882
|
+
database?: Database | undefined;
|
|
1883
|
+
/** The list of fields to update. If unspecified, all fields will be updated when possible. */
|
|
1884
|
+
updateMask?: FieldMask<Database> | undefined;
|
|
1885
|
+
}
|
|
1886
|
+
export interface UpdateEndpointRequest {
|
|
1887
|
+
/**
|
|
1888
|
+
* The Endpoint to update.
|
|
1889
|
+
*
|
|
1890
|
+
* The endpoint's `name` field is used to identify the endpoint to update.
|
|
1891
|
+
* Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
|
|
1892
|
+
*/
|
|
1893
|
+
endpoint?: Endpoint | undefined;
|
|
1894
|
+
/** The list of fields to update. If unspecified, all fields will be updated when possible. */
|
|
1895
|
+
updateMask?: FieldMask<Endpoint> | undefined;
|
|
1896
|
+
}
|
|
1897
|
+
export interface UpdateProjectRequest {
|
|
1898
|
+
/**
|
|
1899
|
+
* The Project to update.
|
|
1900
|
+
*
|
|
1901
|
+
* The project's `name` field is used to identify the project to update.
|
|
1902
|
+
* Format: projects/{project_id}
|
|
1903
|
+
*/
|
|
1904
|
+
project?: Project | undefined;
|
|
1905
|
+
/** The list of fields to update. If unspecified, all fields will be updated when possible. */
|
|
1906
|
+
updateMask?: FieldMask<Project> | undefined;
|
|
1907
|
+
}
|
|
1908
|
+
export interface UpdateRoleRequest {
|
|
1909
|
+
/**
|
|
1910
|
+
* The Postgres Role to update.
|
|
1911
|
+
*
|
|
1912
|
+
* The role's `name` field is used to identify the role to update.
|
|
1913
|
+
* Format: projects/{project_id}/branches/{branch_id}/roles/{role_id}
|
|
1914
|
+
*/
|
|
1915
|
+
role?: Role | undefined;
|
|
1916
|
+
/**
|
|
1917
|
+
* The list of fields to update in Postgres Role.
|
|
1918
|
+
* If unspecified, all fields will be updated when possible.
|
|
1919
|
+
*/
|
|
1920
|
+
updateMask?: FieldMask<Role> | undefined;
|
|
1921
|
+
}
|
|
1922
|
+
export declare const unmarshalBranchSchema: z.ZodType<Branch>;
|
|
1923
|
+
export declare const unmarshalBranchOperationMetadataSchema: z.ZodType<BranchOperationMetadata>;
|
|
1924
|
+
export declare const unmarshalBranchSpecSchema: z.ZodType<BranchSpec>;
|
|
1925
|
+
export declare const unmarshalBranchStatusSchema: z.ZodType<BranchStatus>;
|
|
1926
|
+
export declare const unmarshalCatalogSchema: z.ZodType<Catalog>;
|
|
1927
|
+
export declare const unmarshalCatalog_CatalogSpecSchema: z.ZodType<Catalog_CatalogSpec>;
|
|
1928
|
+
export declare const unmarshalCatalog_CatalogStatusSchema: z.ZodType<Catalog_CatalogStatus>;
|
|
1929
|
+
export declare const unmarshalCatalogOperationMetadataSchema: z.ZodType<CatalogOperationMetadata>;
|
|
1930
|
+
export declare const unmarshalDatabaseSchema: z.ZodType<Database>;
|
|
1931
|
+
export declare const unmarshalDatabase_DatabaseSpecSchema: z.ZodType<Database_DatabaseSpec>;
|
|
1932
|
+
export declare const unmarshalDatabase_DatabaseStatusSchema: z.ZodType<Database_DatabaseStatus>;
|
|
1933
|
+
export declare const unmarshalDatabaseCredentialSchema: z.ZodType<DatabaseCredential>;
|
|
1934
|
+
export declare const unmarshalDatabaseOperationMetadataSchema: z.ZodType<DatabaseOperationMetadata>;
|
|
1935
|
+
export declare const unmarshalDatabricksServiceExceptionWithDetailsProtoSchema: z.ZodType<DatabricksServiceExceptionWithDetailsProto>;
|
|
1936
|
+
export declare const unmarshalDeltaTableSyncInfoSchema: z.ZodType<DeltaTableSyncInfo>;
|
|
1937
|
+
export declare const unmarshalEndpointSchema: z.ZodType<Endpoint>;
|
|
1938
|
+
export declare const unmarshalEndpointGroupSpecSchema: z.ZodType<EndpointGroupSpec>;
|
|
1939
|
+
export declare const unmarshalEndpointGroupStatusSchema: z.ZodType<EndpointGroupStatus>;
|
|
1940
|
+
export declare const unmarshalEndpointHostsSchema: z.ZodType<EndpointHosts>;
|
|
1941
|
+
export declare const unmarshalEndpointOperationMetadataSchema: z.ZodType<EndpointOperationMetadata>;
|
|
1942
|
+
export declare const unmarshalEndpointSettingsSchema: z.ZodType<EndpointSettings>;
|
|
1943
|
+
export declare const unmarshalEndpointSpecSchema: z.ZodType<EndpointSpec>;
|
|
1944
|
+
export declare const unmarshalEndpointStatusSchema: z.ZodType<EndpointStatus>;
|
|
1945
|
+
export declare const unmarshalInitialEndpointSpecSchema: z.ZodType<InitialEndpointSpec>;
|
|
1946
|
+
export declare const unmarshalListBranchesResponseSchema: z.ZodType<ListBranchesResponse>;
|
|
1947
|
+
export declare const unmarshalListDatabasesResponseSchema: z.ZodType<ListDatabasesResponse>;
|
|
1948
|
+
export declare const unmarshalListEndpointsResponseSchema: z.ZodType<ListEndpointsResponse>;
|
|
1949
|
+
export declare const unmarshalListProjectsResponseSchema: z.ZodType<ListProjectsResponse>;
|
|
1950
|
+
export declare const unmarshalListRolesResponseSchema: z.ZodType<ListRolesResponse>;
|
|
1951
|
+
export declare const unmarshalNewPipelineSpecSchema: z.ZodType<NewPipelineSpec>;
|
|
1952
|
+
export declare const unmarshalOperationSchema: z.ZodType<Operation>;
|
|
1953
|
+
export declare const unmarshalProjectSchema: z.ZodType<Project>;
|
|
1954
|
+
export declare const unmarshalProjectCustomTagSchema: z.ZodType<ProjectCustomTag>;
|
|
1955
|
+
export declare const unmarshalProjectDefaultEndpointSettingsSchema: z.ZodType<ProjectDefaultEndpointSettings>;
|
|
1956
|
+
export declare const unmarshalProjectOperationMetadataSchema: z.ZodType<ProjectOperationMetadata>;
|
|
1957
|
+
export declare const unmarshalProjectSpecSchema: z.ZodType<ProjectSpec>;
|
|
1958
|
+
export declare const unmarshalProjectStatusSchema: z.ZodType<ProjectStatus>;
|
|
1959
|
+
export declare const unmarshalRoleSchema: z.ZodType<Role>;
|
|
1960
|
+
export declare const unmarshalRole_AttributesSchema: z.ZodType<Role_Attributes>;
|
|
1961
|
+
export declare const unmarshalRole_RoleSpecSchema: z.ZodType<Role_RoleSpec>;
|
|
1962
|
+
export declare const unmarshalRole_RoleStatusSchema: z.ZodType<Role_RoleStatus>;
|
|
1963
|
+
export declare const unmarshalRoleOperationMetadataSchema: z.ZodType<RoleOperationMetadata>;
|
|
1964
|
+
export declare const unmarshalSyncedTableSchema: z.ZodType<SyncedTable>;
|
|
1965
|
+
export declare const unmarshalSyncedTable_SyncedTableSpecSchema: z.ZodType<SyncedTable_SyncedTableSpec>;
|
|
1966
|
+
export declare const unmarshalSyncedTable_SyncedTableStatusSchema: z.ZodType<SyncedTable_SyncedTableStatus>;
|
|
1967
|
+
export declare const unmarshalSyncedTableOperationMetadataSchema: z.ZodType<SyncedTableOperationMetadata>;
|
|
1968
|
+
export declare const unmarshalSyncedTablePipelineProgressSchema: z.ZodType<SyncedTablePipelineProgress>;
|
|
1969
|
+
export declare const unmarshalSyncedTablePositionSchema: z.ZodType<SyncedTablePosition>;
|
|
1970
|
+
export declare const marshalBranchSchema: z.ZodType;
|
|
1971
|
+
export declare const marshalBranchSpecSchema: z.ZodType;
|
|
1972
|
+
export declare const marshalBranchStatusSchema: z.ZodType;
|
|
1973
|
+
export declare const marshalCatalogSchema: z.ZodType;
|
|
1974
|
+
export declare const marshalCatalog_CatalogSpecSchema: z.ZodType;
|
|
1975
|
+
export declare const marshalCatalog_CatalogStatusSchema: z.ZodType;
|
|
1976
|
+
export declare const marshalDatabaseSchema: z.ZodType;
|
|
1977
|
+
export declare const marshalDatabase_DatabaseSpecSchema: z.ZodType;
|
|
1978
|
+
export declare const marshalDatabase_DatabaseStatusSchema: z.ZodType;
|
|
1979
|
+
export declare const marshalDeltaTableSyncInfoSchema: z.ZodType;
|
|
1980
|
+
export declare const marshalEndpointSchema: z.ZodType;
|
|
1981
|
+
export declare const marshalEndpointGroupSpecSchema: z.ZodType;
|
|
1982
|
+
export declare const marshalEndpointGroupStatusSchema: z.ZodType;
|
|
1983
|
+
export declare const marshalEndpointHostsSchema: z.ZodType;
|
|
1984
|
+
export declare const marshalEndpointSettingsSchema: z.ZodType;
|
|
1985
|
+
export declare const marshalEndpointSpecSchema: z.ZodType;
|
|
1986
|
+
export declare const marshalEndpointStatusSchema: z.ZodType;
|
|
1987
|
+
export declare const marshalGenerateDatabaseCredentialRequestSchema: z.ZodType;
|
|
1988
|
+
export declare const marshalInitialEndpointSpecSchema: z.ZodType;
|
|
1989
|
+
export declare const marshalNewPipelineSpecSchema: z.ZodType;
|
|
1990
|
+
export declare const marshalProjectSchema: z.ZodType;
|
|
1991
|
+
export declare const marshalProjectCustomTagSchema: z.ZodType;
|
|
1992
|
+
export declare const marshalProjectDefaultEndpointSettingsSchema: z.ZodType;
|
|
1993
|
+
export declare const marshalProjectSpecSchema: z.ZodType;
|
|
1994
|
+
export declare const marshalProjectStatusSchema: z.ZodType;
|
|
1995
|
+
export declare const marshalRequestedClaimsSchema: z.ZodType;
|
|
1996
|
+
export declare const marshalRequestedResourceSchema: z.ZodType;
|
|
1997
|
+
export declare const marshalRoleSchema: z.ZodType;
|
|
1998
|
+
export declare const marshalRole_AttributesSchema: z.ZodType;
|
|
1999
|
+
export declare const marshalRole_RoleSpecSchema: z.ZodType;
|
|
2000
|
+
export declare const marshalRole_RoleStatusSchema: z.ZodType;
|
|
2001
|
+
export declare const marshalSyncedTableSchema: z.ZodType;
|
|
2002
|
+
export declare const marshalSyncedTable_SyncedTableSpecSchema: z.ZodType;
|
|
2003
|
+
export declare const marshalSyncedTable_SyncedTableStatusSchema: z.ZodType;
|
|
2004
|
+
export declare const marshalSyncedTablePipelineProgressSchema: z.ZodType;
|
|
2005
|
+
export declare const marshalSyncedTablePositionSchema: z.ZodType;
|
|
2006
|
+
export declare const marshalUndeleteBranchRequestSchema: z.ZodType;
|
|
2007
|
+
export declare const marshalUndeleteProjectRequestSchema: z.ZodType;
|
|
2008
|
+
export declare function branchFieldMask(...paths: string[]): FieldMask<Branch>;
|
|
2009
|
+
export declare function databaseFieldMask(...paths: string[]): FieldMask<Database>;
|
|
2010
|
+
export declare function endpointFieldMask(...paths: string[]): FieldMask<Endpoint>;
|
|
2011
|
+
export declare function projectFieldMask(...paths: string[]): FieldMask<Project>;
|
|
2012
|
+
export declare function roleFieldMask(...paths: string[]): FieldMask<Role>;
|
|
2013
|
+
//# sourceMappingURL=model.d.ts.map
|