@databricks/sdk-warehouses 0.34.0 → 0.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,33 +1,29 @@
1
- import { FieldMask } from '@databricks/sdk-core/wkt';
2
- import { z } from 'zod';
3
- export declare const ChannelName: {
4
- readonly CHANNEL_NAME_UNSPECIFIED: "CHANNEL_NAME_UNSPECIFIED";
5
- readonly CHANNEL_NAME_PREVIEW: "CHANNEL_NAME_PREVIEW";
6
- readonly CHANNEL_NAME_CURRENT: "CHANNEL_NAME_CURRENT";
7
- readonly CHANNEL_NAME_PREVIOUS: "CHANNEL_NAME_PREVIOUS";
8
- readonly CHANNEL_NAME_CUSTOM: "CHANNEL_NAME_CUSTOM";
1
+ import { FieldMask } from "@databricks/sdk-core/wkt";
2
+ import { z } from "zod";
3
+
4
+ //#region src/v1/model.d.ts
5
+ declare const ChannelName: {
6
+ readonly CHANNEL_NAME_UNSPECIFIED: "CHANNEL_NAME_UNSPECIFIED";
7
+ readonly CHANNEL_NAME_PREVIEW: "CHANNEL_NAME_PREVIEW";
8
+ readonly CHANNEL_NAME_CURRENT: "CHANNEL_NAME_CURRENT";
9
+ readonly CHANNEL_NAME_PREVIOUS: "CHANNEL_NAME_PREVIOUS";
10
+ readonly CHANNEL_NAME_CUSTOM: "CHANNEL_NAME_CUSTOM";
9
11
  };
10
- export type ChannelName = (typeof ChannelName)[keyof typeof ChannelName] | (string & {});
12
+ type ChannelName = (typeof ChannelName)[keyof typeof ChannelName] | (string & {});
11
13
  /** Type of default warehouse override behavior. */
12
- export declare const DefaultWarehouseOverrideType: {
13
- /** Unspecified default warehouse override type. */
14
- readonly DEFAULT_WAREHOUSE_OVERRIDE_TYPE_UNSPECIFIED: "DEFAULT_WAREHOUSE_OVERRIDE_TYPE_UNSPECIFIED";
15
- /** The user should remember their last-selected warehouse. */
16
- readonly LAST_SELECTED: "LAST_SELECTED";
17
- /** The user should use a specific warehouse. */
18
- readonly CUSTOM: "CUSTOM";
14
+ declare const DefaultWarehouseOverrideType: {
15
+ /** Unspecified default warehouse override type. */readonly DEFAULT_WAREHOUSE_OVERRIDE_TYPE_UNSPECIFIED: "DEFAULT_WAREHOUSE_OVERRIDE_TYPE_UNSPECIFIED"; /** The user should remember their last-selected warehouse. */
16
+ readonly LAST_SELECTED: "LAST_SELECTED"; /** The user should use a specific warehouse. */
17
+ readonly CUSTOM: "CUSTOM";
19
18
  };
20
- export type DefaultWarehouseOverrideType = (typeof DefaultWarehouseOverrideType)[keyof typeof DefaultWarehouseOverrideType] | (string & {});
19
+ type DefaultWarehouseOverrideType = (typeof DefaultWarehouseOverrideType)[keyof typeof DefaultWarehouseOverrideType] | (string & {});
21
20
  /** Security policy to be used for warehouses */
22
- export declare const EndpointSecurityPolicy: {
23
- /** No passthrough or Table ACLs support */
24
- readonly NONE: "NONE";
25
- /** Support only Table ACLs */
26
- readonly DATA_ACCESS_CONTROL: "DATA_ACCESS_CONTROL";
27
- /** Support only ADLS / IAM passthrough */
28
- readonly PASSTHROUGH: "PASSTHROUGH";
21
+ declare const EndpointSecurityPolicy: {
22
+ /** No passthrough or Table ACLs support */readonly NONE: "NONE"; /** Support only Table ACLs */
23
+ readonly DATA_ACCESS_CONTROL: "DATA_ACCESS_CONTROL"; /** Support only ADLS / IAM passthrough */
24
+ readonly PASSTHROUGH: "PASSTHROUGH";
29
25
  };
30
- export type EndpointSecurityPolicy = (typeof EndpointSecurityPolicy)[keyof typeof EndpointSecurityPolicy] | (string & {});
26
+ type EndpointSecurityPolicy = (typeof EndpointSecurityPolicy)[keyof typeof EndpointSecurityPolicy] | (string & {});
31
27
  /**
32
28
  * EndpointSpotInstancePolicy configures whether the endpoint should use spot
33
29
  * instances.
@@ -43,767 +39,629 @@ export type EndpointSecurityPolicy = (typeof EndpointSecurityPolicy)[keyof typeo
43
39
  * and Executors |
44
40
  * +-------+--------------------------------------+--------------------------------+
45
41
  */
46
- export declare const EndpointSpotInstancePolicy: {
47
- /**
48
- * UNSPECIFIED if no value is set by the caller.
49
- * Consult endpoint docs to learn about the defaults that kick in if
50
- * UNSPECIFIED.
51
- *
52
- * Protobuf enums should start with INVALID/UNSPECIFIED=0
53
- * (https://github.com/uber/prototool/tree/dev/style#enums), but since proto
54
- * enum values must be unique within a proto package so protobuf recommends
55
- * prefixing enum with enum name
56
- * (https://buf.build/docs/lint-checkers/#enum_value_prefix). We do not want
57
- * to do that because it makes for unergonomic customer facing JSON api
58
- * {"spot_instance_policy": "ENDPOINT_SPOT_INSTANCE_POLICY_UNSPECIFIED"}.
59
- *
60
- * As a compromise between protobuf rules (i.e., package unique enum values)
61
- * and JSON friendliness, we prevent UNSPECIFIED collision but hope that the
62
- * rest of the enums do not collide.
63
- *
64
- * This follows Google APIs:
65
- * https://cloud.google.com/apis/design/design_patterns#enum_default_value.
66
- */
67
- readonly POLICY_UNSPECIFIED: "POLICY_UNSPECIFIED";
68
- /** COST_OPTIMIZED to prefer spot instance. */
69
- readonly COST_OPTIMIZED: "COST_OPTIMIZED";
70
- /** RELIABILITY_OPTIMIZED to prefer on demand instance. */
71
- readonly RELIABILITY_OPTIMIZED: "RELIABILITY_OPTIMIZED";
42
+ declare const EndpointSpotInstancePolicy: {
43
+ /**
44
+ * UNSPECIFIED if no value is set by the caller.
45
+ * Consult endpoint docs to learn about the defaults that kick in if
46
+ * UNSPECIFIED.
47
+ *
48
+ * Protobuf enums should start with INVALID/UNSPECIFIED=0
49
+ * (https://github.com/uber/prototool/tree/dev/style#enums), but since proto
50
+ * enum values must be unique within a proto package so protobuf recommends
51
+ * prefixing enum with enum name
52
+ * (https://buf.build/docs/lint-checkers/#enum_value_prefix). We do not want
53
+ * to do that because it makes for unergonomic customer facing JSON api
54
+ * {"spot_instance_policy": "ENDPOINT_SPOT_INSTANCE_POLICY_UNSPECIFIED"}.
55
+ *
56
+ * As a compromise between protobuf rules (i.e., package unique enum values)
57
+ * and JSON friendliness, we prevent UNSPECIFIED collision but hope that the
58
+ * rest of the enums do not collide.
59
+ *
60
+ * This follows Google APIs:
61
+ * https://cloud.google.com/apis/design/design_patterns#enum_default_value.
62
+ */
63
+ readonly POLICY_UNSPECIFIED: "POLICY_UNSPECIFIED"; /** COST_OPTIMIZED to prefer spot instance. */
64
+ readonly COST_OPTIMIZED: "COST_OPTIMIZED"; /** RELIABILITY_OPTIMIZED to prefer on demand instance. */
65
+ readonly RELIABILITY_OPTIMIZED: "RELIABILITY_OPTIMIZED";
72
66
  };
73
- export type EndpointSpotInstancePolicy = (typeof EndpointSpotInstancePolicy)[keyof typeof EndpointSpotInstancePolicy] | (string & {});
67
+ type EndpointSpotInstancePolicy = (typeof EndpointSpotInstancePolicy)[keyof typeof EndpointSpotInstancePolicy] | (string & {});
74
68
  /**
75
69
  * *
76
70
  * State of a warehouse.
77
71
  */
78
- export declare const EndpointState: {
79
- /** Indicates that the endpoint is in the process of starting */
80
- readonly STARTING: "STARTING";
81
- /** Indicates the starting process is done, and the endpoint is ready to use */
82
- readonly RUNNING: "RUNNING";
83
- /** Indicates the endpoint is in the process of destroying */
84
- readonly STOPPING: "STOPPING";
85
- /** Indicates the endpoint is stopped, but can be started by calling start */
86
- readonly STOPPED: "STOPPED";
87
- /** Indicates the endpoint is in the process of destroying */
88
- readonly DELETING: "DELETING";
89
- /** Indicates an endpoint is deleted, and can not be recovered */
90
- readonly DELETED: "DELETED";
72
+ declare const EndpointState: {
73
+ /** Indicates that the endpoint is in the process of starting */readonly STARTING: "STARTING"; /** Indicates the starting process is done, and the endpoint is ready to use */
74
+ readonly RUNNING: "RUNNING"; /** Indicates the endpoint is in the process of destroying */
75
+ readonly STOPPING: "STOPPING"; /** Indicates the endpoint is stopped, but can be started by calling start */
76
+ readonly STOPPED: "STOPPED"; /** Indicates the endpoint is in the process of destroying */
77
+ readonly DELETING: "DELETING"; /** Indicates an endpoint is deleted, and can not be recovered */
78
+ readonly DELETED: "DELETED";
91
79
  };
92
- export type EndpointState = (typeof EndpointState)[keyof typeof EndpointState] | (string & {});
80
+ type EndpointState = (typeof EndpointState)[keyof typeof EndpointState] | (string & {});
93
81
  /** The status code indicating why the cluster was terminated */
94
- export declare const TerminationCode: {
95
- /** Default when there is no termination code. */
96
- readonly UNKNOWN: "UNKNOWN";
97
- /**
98
- * A user terminated the cluster directly. Parameters should include a ``username`` field
99
- * that indicates the specific user who terminated the cluster.
100
- */
101
- readonly USER_REQUEST: "USER_REQUEST";
102
- /** This cluster was launched by a Job, and terminated when the Job completed. */
103
- readonly JOB_FINISHED: "JOB_FINISHED";
104
- /** This cluster was terminated since it was idle. */
105
- readonly INACTIVITY: "INACTIVITY";
106
- /**
107
- * The instance that hosted the spark driver was terminated by the cloud provider. In AWS, for
108
- * example, AWS may retire instances and directly shut them down.
109
- * Parameters should include an ``aws_instance_state_reason`` field indicating the AWS-provided
110
- * reason why the instance was terminated.
111
- */
112
- readonly CLOUD_PROVIDER_SHUTDOWN: "CLOUD_PROVIDER_SHUTDOWN";
113
- /**
114
- * Databricks may lose connection to services on the driver instance. One such case is when
115
- * problems arise in cloud networking infrastructure, or when the instance itself becomes
116
- * unhealthy.
117
- */
118
- readonly COMMUNICATION_LOST: "COMMUNICATION_LOST";
119
- /**
120
- * Databricks may hit cloud provider failures when requesting instances to launch clusters.
121
- * For example, AWS limits the number of running instances and EBS volumes. If you ask Databricks
122
- * to launch a cluster that requires instances or EBS volumes that exceed your AWS limit, the
123
- * cluster will fail with this status code.
124
- * Parameters should include one of ``aws_api_error_code``, ``aws_instance_state_reason``, or
125
- * ``aws_spot_request_status`` to indicate the AWS-provided reason why Databricks could not
126
- * request the required instances for the cluster.
127
- */
128
- readonly CLOUD_PROVIDER_LAUNCH_FAILURE: "CLOUD_PROVIDER_LAUNCH_FAILURE";
129
- /**
130
- * Databricks cannot load and execute a cluster-scoped init script on one of the cluster's nodes,
131
- * or the init script terminates with a non-zero exit code or there was a general failure during
132
- * the loading/executing of init scripts that does not pertain to any specific script.
133
- */
134
- readonly INIT_SCRIPT_FAILURE: "INIT_SCRIPT_FAILURE";
135
- /**
136
- * The Spark driver failed to start. Possible reasons may include incompatible libraries and
137
- * initialization scripts that corrupted the Spark container.
138
- */
139
- readonly SPARK_STARTUP_FAILURE: "SPARK_STARTUP_FAILURE";
140
- /**
141
- * Cannot launch the cluster because the user specified an invalid argument. For example,
142
- * the use might specify an invalid spark version for the cluster.
143
- */
144
- readonly INVALID_ARGUMENT: "INVALID_ARGUMENT";
145
- /**
146
- * While launching this cluster, Databricks failed to complete critical setup steps, terminating
147
- * the cluster.
148
- */
149
- readonly UNEXPECTED_LAUNCH_FAILURE: "UNEXPECTED_LAUNCH_FAILURE";
150
- /**
151
- * Databricks encountered an unexpected error which forced the running cluster to be terminated.
152
- * Please contact Databricks support for additional details.
153
- */
154
- readonly INTERNAL_ERROR: "INTERNAL_ERROR";
155
- /**
156
- * Databricks was not able to access instances in order to start the cluster. This can be a
157
- * transient networking issue. If the problem persists, this usually indicates a networking
158
- * environment misconfiguration.
159
- */
160
- readonly INSTANCE_UNREACHABLE: "INSTANCE_UNREACHABLE";
161
- /**
162
- * Blocked upsize requests for the workspace according to
163
- * https://databricks.atlassian.net/wiki/spaces/UN/pages/934088320/Banning+Workspace+Upsize+Runbook
164
- */
165
- readonly REQUEST_REJECTED: "REQUEST_REJECTED";
166
- /** The cluster was terminated because it was running in a trial workspace that expired. */
167
- readonly TRIAL_EXPIRED: "TRIAL_EXPIRED";
168
- /**
169
- * The cluster was terminated because no response from the chauffeur could be received. We name
170
- * this "DRIVER_" instead of "CHAUFFEUR_" since chauffeur is non-external terminology
171
- */
172
- readonly DRIVER_UNREACHABLE: "DRIVER_UNREACHABLE";
173
- /** Spark error on startup */
174
- readonly SPARK_ERROR: "SPARK_ERROR";
175
- /** Driver unresponsive */
176
- readonly DRIVER_UNRESPONSIVE: "DRIVER_UNRESPONSIVE";
177
- /** Metastore component unhealthy */
178
- readonly METASTORE_COMPONENT_UNHEALTHY: "METASTORE_COMPONENT_UNHEALTHY";
179
- /** DBFS component unhealthy */
180
- readonly DBFS_COMPONENT_UNHEALTHY: "DBFS_COMPONENT_UNHEALTHY";
181
- /** Execution component unhealthy */
182
- readonly EXECUTION_COMPONENT_UNHEALTHY: "EXECUTION_COMPONENT_UNHEALTHY";
183
- /**
184
- * Databricks may hit the azure resource manager request limit. Which will keep the Azure SDK
185
- * from issuing any read or write request to Azure resource manager. The request limit is applied
186
- * to each subscription every hour, thus retry after an hour or changing to a smaller cluster size
187
- * might help to resolve the issue. Please check the following link for more information:
188
- * https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits
189
- */
190
- readonly AZURE_RESOURCE_MANAGER_THROTTLING: "AZURE_RESOURCE_MANAGER_THROTTLING";
191
- /**
192
- * Databricks may hit the azure resource provider request limit. Specifically, the API request
193
- * rate to the specific resource type (Compute, Network, etc..) can't exceed the limit. Retry
194
- * might help to resolve the issue. Please check the following link for more information:
195
- * https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/
196
- * troubleshooting-throttling-errors
197
- */
198
- readonly AZURE_RESOURCE_PROVIDER_THROTTLING: "AZURE_RESOURCE_PROVIDER_THROTTLING";
199
- /** The cluster was terminated due to an error in the network configuration. */
200
- readonly NETWORK_CONFIGURATION_FAILURE: "NETWORK_CONFIGURATION_FAILURE";
201
- /**
202
- * Databricks encountered an unexpected error while launching containers on worker nodes for the
203
- * cluster, terminating the cluster.
204
- */
205
- readonly CONTAINER_LAUNCH_FAILURE: "CONTAINER_LAUNCH_FAILURE";
206
- /** Instance pool backed cluster specific failure */
207
- readonly INSTANCE_POOL_CLUSTER_FAILURE: "INSTANCE_POOL_CLUSTER_FAILURE";
208
- /** Cluster start successfully completed but skipped some instances which were slow to launch */
209
- readonly SKIPPED_SLOW_NODES: "SKIPPED_SLOW_NODES";
210
- /** Attach projects failure */
211
- readonly ATTACH_PROJECT_FAILURE: "ATTACH_PROJECT_FAILURE";
212
- /** Attach projects failure */
213
- readonly UPDATE_INSTANCE_PROFILE_FAILURE: "UPDATE_INSTANCE_PROFILE_FAILURE";
214
- /** Cluster terminated due to database failure */
215
- readonly DATABASE_CONNECTION_FAILURE: "DATABASE_CONNECTION_FAILURE";
216
- /**
217
- * Databricks cannot handle the request at this moment. Please try again later
218
- * and contact Databricks if the problem persists.
219
- */
220
- readonly REQUEST_THROTTLED: "REQUEST_THROTTLED";
221
- /** SelfBootstrap failure. Either self-bootstrap fast fail or node daemon ping timeout */
222
- readonly SELF_BOOTSTRAP_FAILURE: "SELF_BOOTSTRAP_FAILURE";
223
- /**
224
- * Databricks cannot load and execute a global init script on one of the cluster's nodes,
225
- * or the init script terminates with a non-zero exit code.
226
- */
227
- readonly GLOBAL_INIT_SCRIPT_FAILURE: "GLOBAL_INIT_SCRIPT_FAILURE";
228
- /**
229
- * Container launch timed out downloading the spark image. This can happen if the customer
230
- * has byo-vpc/vnet and the download of large files is being throttled.
231
- */
232
- readonly SLOW_IMAGE_DOWNLOAD: "SLOW_IMAGE_DOWNLOAD";
233
- /** Container setup failed due to an invalid Spark image. */
234
- readonly INVALID_SPARK_IMAGE: "INVALID_SPARK_IMAGE";
235
- /**
236
- * If the ngrok tunnel token provisioning fails for any reason, for example hitting the
237
- * max capacity of allowed ngrok tokens. (ES-32083)
238
- */
239
- readonly NPIP_TUNNEL_TOKEN_FAILURE: "NPIP_TUNNEL_TOKEN_FAILURE";
240
- /** Hive Metastore provisioning failue in launch container step */
241
- readonly HIVE_METASTORE_PROVISIONING_FAILURE: "HIVE_METASTORE_PROVISIONING_FAILURE";
242
- /**
243
- * Occurs when the deployment template we submit to Azure violates their requirements.
244
- * Typical scenarios:
245
- * - Wrong parameter key/value used
246
- * - Exceed the limit for certain parameter
247
- */
248
- readonly AZURE_INVALID_DEPLOYMENT_TEMPLATE: "AZURE_INVALID_DEPLOYMENT_TEMPLATE";
249
- /**
250
- * The set of un-categorized failure responses from Azure when we launch instance resources
251
- * using deployment template
252
- */
253
- readonly AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE: "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE";
254
- /** Subnet (typically Azure vnet injected) has run out of ip addresses */
255
- readonly SUBNET_EXHAUSTED_FAILURE: "SUBNET_EXHAUSTED_FAILURE";
256
- /**
257
- * Timeout to ping the nodeDaemon, possible reason: nodeDaemon didn't start (configuration issue),
258
- * network connectivity issue
259
- */
260
- readonly BOOTSTRAP_TIMEOUT: "BOOTSTRAP_TIMEOUT";
261
- /** Bootstrap timeout due to script download failure */
262
- readonly STORAGE_DOWNLOAD_FAILURE: "STORAGE_DOWNLOAD_FAILURE";
263
- /** Bootstrap timeout due to get runbook failure */
264
- readonly CONTROL_PLANE_REQUEST_FAILURE: "CONTROL_PLANE_REQUEST_FAILURE";
265
- /** Bootstrap timeout due to Azure Extension Service Failure */
266
- readonly BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION: "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION";
267
- /** Could not find enough of the requested instance type in the requested AZ. Often related to Auto AZ. */
268
- readonly AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE: "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE";
269
- /** Container setup failure due to docker image pulling failure */
270
- readonly DOCKER_IMAGE_PULL_FAILURE: "DOCKER_IMAGE_PULL_FAILURE";
271
- /**
272
- * Failures during azure vnet configuration. For example, a workspace with VNet injection had
273
- * incorrect DNS settings that blocked access to worker artifacts.
274
- */
275
- readonly AZURE_VNET_CONFIGURATION_FAILURE: "AZURE_VNET_CONFIGURATION_FAILURE";
276
- /**
277
- * Bootstrap failure due to Ngrok tunnel setup timeout or failure. For example, if the worker
278
- * node is unable to reach the Ngrok tunnel domain.
279
- */
280
- readonly NPIP_TUNNEL_SETUP_FAILURE: "NPIP_TUNNEL_SETUP_FAILURE";
281
- /**
282
- * Lack authorization for cluster operation.
283
- * For example, awsApiErrorCode: 'AccessDenied' or 'UnauthorizedOperation'.
284
- */
285
- readonly AWS_AUTHORIZATION_FAILURE: "AWS_AUTHORIZATION_FAILURE";
286
- /** request comes form Nephos resource pool auto management */
287
- readonly NEPHOS_RESOURCE_MANAGEMENT: "NEPHOS_RESOURCE_MANAGEMENT";
288
- /**
289
- * Container setup failed during container registration to security daemon due to STS endpoint
290
- * connection error.
291
- */
292
- readonly STS_CLIENT_SETUP_FAILURE: "STS_CLIENT_SETUP_FAILURE";
293
- /** Container setup failed during registration to security daemon due to an unspecified error. */
294
- readonly SECURITY_DAEMON_REGISTRATION_EXCEPTION: "SECURITY_DAEMON_REGISTRATION_EXCEPTION";
295
- /** The maximum request rate permitted by the Amazon EC2 APIs has been exceeded for your account. */
296
- readonly AWS_REQUEST_LIMIT_EXCEEDED: "AWS_REQUEST_LIMIT_EXCEEDED";
297
- /** We don't have enough addresses in the subnet for the instances in the request. */
298
- readonly AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE: "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE";
299
- /** The request is not supported (This is a vague error code that can be thrown for a lot of reasons.) */
300
- readonly AWS_UNSUPPORTED_FAILURE: "AWS_UNSUPPORTED_FAILURE";
301
- /** Could not find enough azure resources to fulfill the request. */
302
- readonly AZURE_QUOTA_EXCEEDED_EXCEPTION: "AZURE_QUOTA_EXCEEDED_EXCEPTION";
303
- /** NOTE: This is currently used by exceptions with messages that are classified as user errors. */
304
- readonly AZURE_OPERATION_NOT_ALLOWED_EXCEPTION: "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION";
305
- /** Failure when mounting remote NFS to container */
306
- readonly NFS_MOUNT_FAILURE: "NFS_MOUNT_FAILURE";
307
- /** K8S failed to upscale to acquire new nodes */
308
- readonly K8S_AUTOSCALING_FAILURE: "K8S_AUTOSCALING_FAILURE";
309
- /** DBR Cluster launched on K8s (i.e. CMv2) has failed to start up in time */
310
- readonly K8S_DBR_CLUSTER_LAUNCH_TIMEOUT: "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT";
311
- /**
312
- * Container launch failed while downloading the spark image. Catch all for if anything
313
- * goes wrong while downloading and extracting the spark tarball.
314
- */
315
- readonly SPARK_IMAGE_DOWNLOAD_FAILURE: "SPARK_IMAGE_DOWNLOAD_FAILURE";
316
- /** Azure VM Extension failure during instance bootstrap */
317
- readonly AZURE_VM_EXTENSION_FAILURE: "AZURE_VM_EXTENSION_FAILURE";
318
- /** Workspace was cancelled hence deny/terminate the cluster */
319
- readonly WORKSPACE_CANCELLED_ERROR: "WORKSPACE_CANCELLED_ERROR";
320
- /** The spot instance count in an account has exceeded the limit */
321
- readonly AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE: "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE";
322
- /**
323
- * Cluster is terminated because the services are temporarily unavailable.
324
- * This normally happens when CM is restarting and draining execution contexts,
325
- * or IM/Delegate is overloaded, so that it will not be able to retry the instance launch request.
326
- */
327
- readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
328
- /**
329
- * Bootstrap failure due to error during worker setup, usually due to an issue with
330
- * disk or gpu setup. See SetupCommandBuilder for other possible causes
331
- */
332
- readonly WORKER_SETUP_FAILURE: "WORKER_SETUP_FAILURE";
333
- /**
334
- * Cluster failure due to IP space exhaustion. For example on CMv2, Kubernetes will fail to scale
335
- * up new nodes if the pod IP CIDR block is exhausted.
336
- */
337
- readonly IP_EXHAUSTION_FAILURE: "IP_EXHAUSTION_FAILURE";
338
- /**
339
- * Could not find enough GCP resources to fulfill the request.
340
- * TODO: It's very unfortunate that we have per-cloud termination reasons while we should have
341
- * cloud-agnostic termination reasons. For example, we should consolidate
342
- * {AZURE_QUOTA_EXCEEDED_EXCEPTION, AWS_REQUEST_LIMIT_EXCEEDED and GCP_QUOTA_EXCEEDED},
343
- * {AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE, IP_EXHAUSTION_FAILURE}, etc.
344
- */
345
- readonly GCP_QUOTA_EXCEEDED: "GCP_QUOTA_EXCEEDED";
346
- /** Cloud provider is undergoing a transient resource throttling. This is retryable. */
347
- readonly CLOUD_PROVIDER_RESOURCE_STOCKOUT: "CLOUD_PROVIDER_RESOURCE_STOCKOUT";
348
- /** The GCP service account associated with the DBR cluster is deleted. */
349
- readonly GCP_SERVICE_ACCOUNT_DELETED: "GCP_SERVICE_ACCOUNT_DELETED";
350
- /** Legit cluster termination in Azure caused by customer revoking the key permission used for managed-disks encryption */
351
- readonly AZURE_BYOK_KEY_PERMISSION_FAILURE: "AZURE_BYOK_KEY_PERMISSION_FAILURE";
352
- /** Termination because of spot instance terminated by cloud provider */
353
- readonly SPOT_INSTANCE_TERMINATION: "SPOT_INSTANCE_TERMINATION";
354
- /** Termination because of unsupported azure ephemeral os disk setup */
355
- readonly AZURE_EPHEMERAL_DISK_FAILURE: "AZURE_EPHEMERAL_DISK_FAILURE";
356
- /**
357
- * The cluster was terminated because we detected an abusive runtime behavior that violated
358
- * Terms of Service or Acceptable Use Policy.
359
- */
360
- readonly ABUSE_DETECTED: "ABUSE_DETECTED";
361
- /** Failed to pull DBR images due to permission error. */
362
- readonly IMAGE_PULL_PERMISSION_DENIED: "IMAGE_PULL_PERMISSION_DENIED";
363
- /** Workspace configuration is in error state due to configuration issue or ACL modification by the customer side */
364
- readonly WORKSPACE_CONFIGURATION_ERROR: "WORKSPACE_CONFIGURATION_ERROR";
365
- /**
366
- * Catch all error for all secret resolution issues in cluster launch. This should be alerted on,
367
- * and is considered a server error. This can be split out into other cases if there are client
368
- * errors - for e.g. INVALID_ARGUMENT is used for secrets that don't exist and permission issues
369
- */
370
- readonly SECRET_RESOLUTION_ERROR: "SECRET_RESOLUTION_ERROR";
371
- /**
372
- * Failure due to an instance being of an unsupported type. This is used when an instance in
373
- * an EC2 fleet is of an unrecognized type, or an invalid type (i.e. graviton when we don't
374
- * want graviton instances). This should be alerted on.
375
- */
376
- readonly UNSUPPORTED_INSTANCE_TYPE: "UNSUPPORTED_INSTANCE_TYPE";
377
- /** Failed during instance bootstrap with error code Cannot convert NVMe-based dev id */
378
- readonly CLOUD_PROVIDER_DISK_SETUP_FAILURE: "CLOUD_PROVIDER_DISK_SETUP_FAILURE";
379
- /** Exception when setting up instances using ssh bootstrap */
380
- readonly SSH_BOOTSTRAP_FAILURE: "SSH_BOOTSTRAP_FAILURE";
381
- /** Failed during instance bootstrap with error code Cannot convert NVMe-based dev id */
382
- readonly AWS_INACCESSIBLE_KMS_KEY_FAILURE: "AWS_INACCESSIBLE_KMS_KEY_FAILURE";
383
- /**
384
- * The bootstrapping init-containers in Spark failed or timed out, blocking the Spark container
385
- * from bootstrapping. This is a refinement of `SPARK_STARTUP_FAILURE`.
386
- * (init-containers are a bootstrapping step owned by Databricks)
387
- */
388
- readonly INIT_CONTAINER_NOT_FINISHED: "INIT_CONTAINER_NOT_FINISHED";
389
- /**
390
- * Container launch failed due to storage servers throttling our download of spark images. Can
391
- * happen due to transient spikes of downloads overloading storage servers or gradual increase in
392
- * usage. In the latter case we need to increase the number of storage servers in the region to
393
- * help spread load.
394
- */
395
- readonly SPARK_IMAGE_DOWNLOAD_THROTTLED: "SPARK_IMAGE_DOWNLOAD_THROTTLED";
396
- /**
397
- * The spark image specified for the cluster was not found when attempting to download. Usually
398
- * due to the customer custom specifying a bad image.
399
- */
400
- readonly SPARK_IMAGE_NOT_FOUND: "SPARK_IMAGE_NOT_FOUND";
401
- /**
402
- * Indicates that the cloud provider operations performed for the cluster were dropped due to
403
- * an influx in load in the cloud provider and had to be dropped from our end to alleviate
404
- * pressure within the DelegateRpcClient. Please see go/cmloadshedding for more.
405
- */
406
- readonly CLUSTER_OPERATION_THROTTLED: "CLUSTER_OPERATION_THROTTLED";
407
- /**
408
- * The error code can be used to indicate a request misses its deadline. Can be used for either request timeouts
409
- * or missed deadlines (i.e. a request is not completed as it was processed after its specified deadline)
410
- */
411
- readonly CLUSTER_OPERATION_TIMEOUT: "CLUSTER_OPERATION_TIMEOUT";
412
- /**
413
- * This error code is used to terminate long-running Generic compute jobs in Serverless Environment
414
- * as part of the NephosLongRunning watcher running in Cluster Monitor Service.
415
- */
416
- readonly SERVERLESS_LONG_RUNNING_TERMINATED: "SERVERLESS_LONG_RUNNING_TERMINATED";
417
- /**
418
- * This error code is used when the cluster is terminated due to its instances fail with partial failure from Azure
419
- * packed deployments. In Azure, we might pack multiple launch requests in one deployment template in order
420
- * to avoid the 800 templates limit on Azure side. If the packed deployment fails multiple times, the cluster could
421
- * be terminated by this [[AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE]] termination code.
422
- */
423
- readonly AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE: "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE";
424
- /**
425
- * The instances acquired from a pool in IMv2 do not have a valid worker image to be used in the
426
- * cluster launch. This usually occurs after AMI/VHD upgrades, worker branch updates, etc.
427
- */
428
- readonly INVALID_WORKER_IMAGE_FAILURE: "INVALID_WORKER_IMAGE_FAILURE";
429
- /** Worker environment version was changed due to workspace network or CMK update. */
430
- readonly WORKSPACE_UPDATE: "WORKSPACE_UPDATE";
431
- /** The parameter user specified or the user account to create the cluster is invalid according to AWS. */
432
- readonly INVALID_AWS_PARAMETER: "INVALID_AWS_PARAMETER";
433
- /**
434
- * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
435
- *
436
- * k8s evicted the driver pod due to disk pressure on the driver node. This is likely due to a
437
- * customer job consuming too much disk and so this is classified as a customer issue.
438
- */
439
- readonly DRIVER_OUT_OF_DISK: "DRIVER_OUT_OF_DISK";
440
- /**
441
- * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
442
- *
443
- * k8s evicted the driver pod due to memory pressure on the driver node. A customer job consuming
444
- * significant amounts of memory should not be able to trigger this as the driver container would
445
- * OOM first (we set memory limits on our pods). Thus this termination reason will be considered
446
- * a databricks issue.
447
- */
448
- readonly DRIVER_OUT_OF_MEMORY: "DRIVER_OUT_OF_MEMORY";
449
- /**
450
- * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
451
- * Original driver pod took too long to become ready and timed out.
452
- */
453
- readonly DRIVER_LAUNCH_TIMEOUT: "DRIVER_LAUNCH_TIMEOUT";
454
- /**
455
- * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
456
- * Unexpected failure during driver pod launch.
457
- */
458
- readonly DRIVER_UNEXPECTED_FAILURE: "DRIVER_UNEXPECTED_FAILURE";
459
- /**
460
- * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
461
- * Unexpected new driver pod created
462
- */
463
- readonly UNEXPECTED_POD_RECREATION: "UNEXPECTED_POD_RECREATION";
464
- /** Failure due to disabled or inaccessible CMK. */
465
- readonly GCP_INACCESSIBLE_KMS_KEY_FAILURE: "GCP_INACCESSIBLE_KMS_KEY_FAILURE";
466
- /** Failure due to missing/incorrect permission setup on CMK. */
467
- readonly GCP_KMS_KEY_PERMISSION_DENIED: "GCP_KMS_KEY_PERMISSION_DENIED";
468
- /** Driver pod evicted in Nephos */
469
- readonly DRIVER_EVICTION: "DRIVER_EVICTION";
470
- /** User request for termination directly to cloud */
471
- readonly USER_INITIATED_VM_TERMINATION: "USER_INITIATED_VM_TERMINATION";
472
- /** GCP Specific IAM API timeout issues during Workload Idenitity (Cluster Identity) binding process */
473
- readonly GCP_IAM_TIMEOUT: "GCP_IAM_TIMEOUT";
474
- /** Could not find enough AWS resources to fulfill the request */
475
- readonly AWS_RESOURCE_QUOTA_EXCEEDED: "AWS_RESOURCE_QUOTA_EXCEEDED";
476
- /** Cloud account setup has some error (e.g. pending email verification, blocked) */
477
- readonly CLOUD_ACCOUNT_SETUP_FAILURE: "CLOUD_ACCOUNT_SETUP_FAILURE";
478
- /** The specified key pair name does not exist. */
479
- readonly AWS_INVALID_KEY_PAIR: "AWS_INVALID_KEY_PAIR";
480
- /** Driver pod creation failure in nephos */
481
- readonly DRIVER_POD_CREATION_FAILURE: "DRIVER_POD_CREATION_FAILURE";
482
- /** Cluster terminated manually by on-call due to emergency maintenance */
483
- readonly MAINTENANCE_MODE: "MAINTENANCE_MODE";
484
- /** Nephos internal error due to insufficient provisioned k8s capacity or insufficient cloud quota */
485
- readonly INTERNAL_CAPACITY_FAILURE: "INTERNAL_CAPACITY_FAILURE";
486
- /** Nephos: could not acquire executor pods from pod pool */
487
- readonly EXECUTOR_POD_UNSCHEDULED: "EXECUTOR_POD_UNSCHEDULED";
488
- /** Artifact download failed because it was too slow */
489
- readonly STORAGE_DOWNLOAD_FAILURE_SLOW: "STORAGE_DOWNLOAD_FAILURE_SLOW";
490
- /** Artifact download failed because it was throttled by the download server */
491
- readonly STORAGE_DOWNLOAD_FAILURE_THROTTLED: "STORAGE_DOWNLOAD_FAILURE_THROTTLED";
492
- /** The cluster was terminated because the size of the dynamic spark conf exceeded the limit. */
493
- readonly DYNAMIC_SPARK_CONF_SIZE_EXCEEDED: "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED";
494
- /** Failure to update the instance profile for the cluster. */
495
- readonly AWS_INSTANCE_PROFILE_UPDATE_FAILURE: "AWS_INSTANCE_PROFILE_UPDATE_FAILURE";
496
- /** The instance pool did not exist when the cluster was launched. */
497
- readonly INSTANCE_POOL_NOT_FOUND: "INSTANCE_POOL_NOT_FOUND";
498
- /** Attempting to launch more instances was rejected as it would exceed the pool's max capacity. */
499
- readonly INSTANCE_POOL_MAX_CAPACITY_REACHED: "INSTANCE_POOL_MAX_CAPACITY_REACHED";
500
- /** The KMS key provided is in an incorrect state. */
501
- readonly AWS_INVALID_KMS_KEY_STATE: "AWS_INVALID_KMS_KEY_STATE";
502
- /** Insufficient capacity failure from GCE API. */
503
- readonly GCP_INSUFFICIENT_CAPACITY: "GCP_INSUFFICIENT_CAPACITY";
504
- /** Rate quota exceeded for GCP API (e.g. Read requests per minute per region). */
505
- readonly GCP_API_RATE_QUOTA_EXCEEDED: "GCP_API_RATE_QUOTA_EXCEEDED";
506
- /** Resource quota exceeded (e.g. # of n1 vCPUs in a region). */
507
- readonly GCP_RESOURCE_QUOTA_EXCEEDED: "GCP_RESOURCE_QUOTA_EXCEEDED";
508
- /** Subnet IP space exhausted. */
509
- readonly GCP_IP_SPACE_EXHAUSTED: "GCP_IP_SPACE_EXHAUSTED";
510
- /** Missing permissions to launch VM with service account. */
511
- readonly GCP_SERVICE_ACCOUNT_ACCESS_DENIED: "GCP_SERVICE_ACCOUNT_ACCESS_DENIED";
512
- /** VM attempting to launch with non-existent service account. */
513
- readonly GCP_SERVICE_ACCOUNT_NOT_FOUND: "GCP_SERVICE_ACCOUNT_NOT_FOUND";
514
- /** Forbidden (403) returned by GCP API. */
515
- readonly GCP_FORBIDDEN: "GCP_FORBIDDEN";
516
- /** Not found (404) returned by GCP API. */
517
- readonly GCP_NOT_FOUND: "GCP_NOT_FOUND";
518
- /** Gatekeeper indicated the cluster should be shutdown */
519
- readonly RESOURCE_USAGE_BLOCKED: "RESOURCE_USAGE_BLOCKED";
520
- /** The data access config of the workspace has changed, and clusters using outdated config will be terminated. */
521
- readonly DATA_ACCESS_CONFIG_CHANGED: "DATA_ACCESS_CONFIG_CHANGED";
522
- /** Failed to fetch internal PAT token required for init script installation from WSFS/UC volumes */
523
- readonly ACCESS_TOKEN_FAILURE: "ACCESS_TOKEN_FAILURE";
524
- /**
525
- * It indicates there is a placement v2 protocol rollout/rollback event for the corresponding workspace when
526
- * processing the placement session on the instance-manager side. A retry will fix the issue by switching back
527
- * to the correct placement protocol.
528
- */
529
- readonly INVALID_INSTANCE_PLACEMENT_PROTOCOL: "INVALID_INSTANCE_PLACEMENT_PROTOCOL";
530
- /** The cluster was terminated as it failed to resolve budget policy. */
531
- readonly BUDGET_POLICY_RESOLUTION_FAILURE: "BUDGET_POLICY_RESOLUTION_FAILURE";
532
- /**
533
- * This customer/error combination is a known issue and is intentionally excluded from termination
534
- * metrics
535
- */
536
- readonly IN_PENALTY_BOX: "IN_PENALTY_BOX";
537
- /**
538
- * The cluster was terminated when the primary workspace failed over to the secondary workspace.
539
- * This is expected because there is no data plane in the secondary workspace.
540
- */
541
- readonly DISASTER_RECOVERY_REPLICATION: "DISASTER_RECOVERY_REPLICATION";
542
- /** A bootstrap timeout that was caused by misconfiguration on the customer's side */
543
- readonly BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG: "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG";
544
- /** Instance unreachable, but due to misconfiguration on the customer's side */
545
- readonly INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG: "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG";
546
- /** Bootstrap timeout due to script download failure, but due to misconfiguration on the customer's side */
547
- readonly STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG: "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG";
548
- /** CPRF, but due to misconfiguration on the customer's side */
549
- readonly CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG: "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG";
550
- /** CPLF, but due to misconfiguration on the customer's side */
551
- readonly CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG: "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG";
552
- /** GCP subnet is in transient "resourceNotReady" state. */
553
- readonly GCP_SUBNET_NOT_READY: "GCP_SUBNET_NOT_READY";
554
- /** The operation on the cloud provider was cancelled. Possibly due to a user action. */
555
- readonly CLOUD_OPERATION_CANCELLED: "CLOUD_OPERATION_CANCELLED";
556
- /**
557
- * If cloud provider indicates instance creation was a success, yet the instance is never created.
558
- * This can happen in certain edge cases like quota exhaustion on GCP. We have an open bug here:
559
- * https://partnerissuetracker.corp.google.com/issues/339061883
560
- */
561
- readonly CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED: "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED";
562
- /** GCP Databricks VM Machine Image is blocked by customer organization policy. */
563
- readonly GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED: "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED";
564
- /** cluster terminate can happened when a budget policy limit enforcement activated */
565
- readonly BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED: "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED";
566
- readonly EOS_SPARK_IMAGE: "EOS_SPARK_IMAGE";
567
- /** Serverless only. There are no eligible K8s for the cluster. */
568
- readonly NO_MATCHED_K8S: "NO_MATCHED_K8S";
569
- /** Lazy allocation timeout. Timeout before any internal DBR clusters were allocated. */
570
- readonly LAZY_ALLOCATION_TIMEOUT: "LAZY_ALLOCATION_TIMEOUT";
571
- /** CMv2 unable to contact chauffeur or node-daemon on the driver node. */
572
- readonly DRIVER_NODE_UNREACHABLE: "DRIVER_NODE_UNREACHABLE";
573
- /** Dynamic secret generation failed. */
574
- readonly SECRET_CREATION_FAILURE: "SECRET_CREATION_FAILURE";
575
- /** Driver or executor pod failed to be scheduled. */
576
- readonly POD_SCHEDULING_FAILURE: "POD_SCHEDULING_FAILURE";
577
- /** Driver or executor pod failed to finish assigning. */
578
- readonly POD_ASSIGNMENT_FAILURE: "POD_ASSIGNMENT_FAILURE";
579
- /** Lazy allocation timeout with unknown reason. */
580
- readonly ALLOCATION_TIMEOUT: "ALLOCATION_TIMEOUT";
581
- /** Lazy allocation timeout. Maps to NoUnallocatedDbrCluster. */
582
- readonly ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS: "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS";
583
- /** Lazy allocation timeout. Maps to NoMatchedUnallocatedDbrCluster. */
584
- readonly ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS: "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS";
585
- /** Lazy allocation timeout. Maps to NoUnallocatedReadyDbrCluster. */
586
- readonly ALLOCATION_TIMEOUT_NO_READY_CLUSTERS: "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS";
587
- /** Lazy allocation timeout. Maps to NoMatchedUnallocatedWarmedUpDbrCluster. */
588
- readonly ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS: "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS";
589
- /** Lazy allocation timeout. Maps to NoCandidatesWithNodeDaemonK8sReady. */
590
- readonly ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY: "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY";
591
- /** Lazy allocation timeout. Maps to NoCandidatesHealthy. */
592
- readonly ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS: "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS";
593
- /**
594
- * When nephos blocking wait for netvisor setup ready signal, terminated by timeout.
595
- * This error code only applies to clusters with the attribute should_block_for_network_readiness: true
596
- */
597
- readonly NETVISOR_SETUP_TIMEOUT: "NETVISOR_SETUP_TIMEOUT";
598
- /** Serverless only. The preselected K8s for the cluster is not eligible. */
599
- readonly NO_MATCHED_K8S_TESTING_TAG: "NO_MATCHED_K8S_TESTING_TAG";
600
- /** The customer's repeatedly attempting to launch clusters with some configuration that the CSP's not able to provide */
601
- readonly CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG: "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG";
602
- /** For the GCP CMv1 Migration, we will terminate all CMv2 based clusters with this failure. */
603
- readonly GKE_BASED_CLUSTER_TERMINATION: "GKE_BASED_CLUSTER_TERMINATION";
604
- /** Lazy allocation timeout. Maps to NoCandidatesHealthyAndWarmedUp. */
605
- readonly ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS: "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS";
606
- /** Docker container's OS was not valid. */
607
- readonly DOCKER_INVALID_OS_EXCEPTION: "DOCKER_INVALID_OS_EXCEPTION";
608
- /** Something went wrong during the creation of the docker container. */
609
- readonly DOCKER_CONTAINER_CREATION_EXCEPTION: "DOCKER_CONTAINER_CREATION_EXCEPTION";
610
- /** Customer passed in a docker image that's too large for the instance. */
611
- readonly DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION: "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION";
612
- /** The cluster was terminated because the DNS resolution failed. */
613
- readonly DNS_RESOLUTION_ERROR: "DNS_RESOLUTION_ERROR";
614
- /** Org policy is preventing a GCE API operation from being executed. */
615
- readonly GCP_DENIED_BY_ORG_POLICY: "GCP_DENIED_BY_ORG_POLICY";
616
- /** Customer passed in a secret that they do not have permissions to resolve. */
617
- readonly SECRET_PERMISSION_DENIED: "SECRET_PERMISSION_DENIED";
618
- /** Start of network health check generated failures */
619
- readonly NETWORK_CHECK_NIC_FAILURE: "NETWORK_CHECK_NIC_FAILURE";
620
- readonly NETWORK_CHECK_DNS_SERVER_FAILURE: "NETWORK_CHECK_DNS_SERVER_FAILURE";
621
- readonly NETWORK_CHECK_STORAGE_FAILURE: "NETWORK_CHECK_STORAGE_FAILURE";
622
- readonly NETWORK_CHECK_METADATA_ENDPOINT_FAILURE: "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE";
623
- readonly NETWORK_CHECK_CONTROL_PLANE_FAILURE: "NETWORK_CHECK_CONTROL_PLANE_FAILURE";
624
- readonly NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE: "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE";
625
- /** Driver has been down or unresponsive for an extended period of time */
626
- readonly DRIVER_UNHEALTHY: "DRIVER_UNHEALTHY";
627
- /** cluster request is denied due to disallowed usage policy entitlement */
628
- readonly USAGE_POLICY_ENTITLEMENT_DENIED: "USAGE_POLICY_ENTITLEMENT_DENIED";
629
- /** Request exceeded MAX_ACTIVE_DBR_PODS_PER_K8S_CLUSTER quota - too many active pods on the K8s cluster */
630
- readonly K8S_ACTIVE_POD_QUOTA_EXCEEDED: "K8S_ACTIVE_POD_QUOTA_EXCEEDED";
631
- /** Request exceeded MAX_PODS_PER_CLOUD_ACCOUNT quota - subscription/cloud account pod limit reached */
632
- readonly CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED: "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED";
633
- /** Start of network health check generated failures due to misconfiguration */
634
- readonly NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG";
635
- readonly NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG";
636
- readonly NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG";
637
- readonly NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG";
638
- readonly NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG";
639
- readonly NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG";
640
- /**
641
- * CMv2 could not resolve the DBR image for versionless workloads (REPL, GENERIC).
642
- * This typically happens when no spark version is found from the channel mapping
643
- * and the workload is versionless-enabled.
644
- */
645
- readonly DBR_IMAGE_RESOLUTION_FAILURE: "DBR_IMAGE_RESOLUTION_FAILURE";
646
- readonly CONTROL_PLANE_CONNECTION_FAILURE: "CONTROL_PLANE_CONNECTION_FAILURE";
647
- readonly CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG: "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG";
648
- readonly RATE_LIMITED: "RATE_LIMITED";
649
- /** The cluster was terminated because mutual TLS port 8443 check failed. */
650
- readonly MTLS_PORT_CONNECTIVITY_FAILURE: "MTLS_PORT_CONNECTIVITY_FAILURE";
651
- /** The cluster was terminated because hivemetastore connectivity check failed. */
652
- readonly HIVEMETASTORE_CONNECTIVITY_FAILURE: "HIVEMETASTORE_CONNECTIVITY_FAILURE";
82
+ declare const TerminationCode: {
83
+ /** Default when there is no termination code. */readonly UNKNOWN: "UNKNOWN";
84
+ /**
85
+ * A user terminated the cluster directly. Parameters should include a ``username`` field
86
+ * that indicates the specific user who terminated the cluster.
87
+ */
88
+ readonly USER_REQUEST: "USER_REQUEST"; /** This cluster was launched by a Job, and terminated when the Job completed. */
89
+ readonly JOB_FINISHED: "JOB_FINISHED"; /** This cluster was terminated since it was idle. */
90
+ readonly INACTIVITY: "INACTIVITY";
91
+ /**
92
+ * The instance that hosted the spark driver was terminated by the cloud provider. In AWS, for
93
+ * example, AWS may retire instances and directly shut them down.
94
+ * Parameters should include an ``aws_instance_state_reason`` field indicating the AWS-provided
95
+ * reason why the instance was terminated.
96
+ */
97
+ readonly CLOUD_PROVIDER_SHUTDOWN: "CLOUD_PROVIDER_SHUTDOWN";
98
+ /**
99
+ * Databricks may lose connection to services on the driver instance. One such case is when
100
+ * problems arise in cloud networking infrastructure, or when the instance itself becomes
101
+ * unhealthy.
102
+ */
103
+ readonly COMMUNICATION_LOST: "COMMUNICATION_LOST";
104
+ /**
105
+ * Databricks may hit cloud provider failures when requesting instances to launch clusters.
106
+ * For example, AWS limits the number of running instances and EBS volumes. If you ask Databricks
107
+ * to launch a cluster that requires instances or EBS volumes that exceed your AWS limit, the
108
+ * cluster will fail with this status code.
109
+ * Parameters should include one of ``aws_api_error_code``, ``aws_instance_state_reason``, or
110
+ * ``aws_spot_request_status`` to indicate the AWS-provided reason why Databricks could not
111
+ * request the required instances for the cluster.
112
+ */
113
+ readonly CLOUD_PROVIDER_LAUNCH_FAILURE: "CLOUD_PROVIDER_LAUNCH_FAILURE";
114
+ /**
115
+ * Databricks cannot load and execute a cluster-scoped init script on one of the cluster's nodes,
116
+ * or the init script terminates with a non-zero exit code or there was a general failure during
117
+ * the loading/executing of init scripts that does not pertain to any specific script.
118
+ */
119
+ readonly INIT_SCRIPT_FAILURE: "INIT_SCRIPT_FAILURE";
120
+ /**
121
+ * The Spark driver failed to start. Possible reasons may include incompatible libraries and
122
+ * initialization scripts that corrupted the Spark container.
123
+ */
124
+ readonly SPARK_STARTUP_FAILURE: "SPARK_STARTUP_FAILURE";
125
+ /**
126
+ * Cannot launch the cluster because the user specified an invalid argument. For example,
127
+ * the use might specify an invalid spark version for the cluster.
128
+ */
129
+ readonly INVALID_ARGUMENT: "INVALID_ARGUMENT";
130
+ /**
131
+ * While launching this cluster, Databricks failed to complete critical setup steps, terminating
132
+ * the cluster.
133
+ */
134
+ readonly UNEXPECTED_LAUNCH_FAILURE: "UNEXPECTED_LAUNCH_FAILURE";
135
+ /**
136
+ * Databricks encountered an unexpected error which forced the running cluster to be terminated.
137
+ * Please contact Databricks support for additional details.
138
+ */
139
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
140
+ /**
141
+ * Databricks was not able to access instances in order to start the cluster. This can be a
142
+ * transient networking issue. If the problem persists, this usually indicates a networking
143
+ * environment misconfiguration.
144
+ */
145
+ readonly INSTANCE_UNREACHABLE: "INSTANCE_UNREACHABLE";
146
+ /**
147
+ * Blocked upsize requests for the workspace according to
148
+ * https://databricks.atlassian.net/wiki/spaces/UN/pages/934088320/Banning+Workspace+Upsize+Runbook
149
+ */
150
+ readonly REQUEST_REJECTED: "REQUEST_REJECTED"; /** The cluster was terminated because it was running in a trial workspace that expired. */
151
+ readonly TRIAL_EXPIRED: "TRIAL_EXPIRED";
152
+ /**
153
+ * The cluster was terminated because no response from the chauffeur could be received. We name
154
+ * this "DRIVER_" instead of "CHAUFFEUR_" since chauffeur is non-external terminology
155
+ */
156
+ readonly DRIVER_UNREACHABLE: "DRIVER_UNREACHABLE"; /** Spark error on startup */
157
+ readonly SPARK_ERROR: "SPARK_ERROR"; /** Driver unresponsive */
158
+ readonly DRIVER_UNRESPONSIVE: "DRIVER_UNRESPONSIVE"; /** Metastore component unhealthy */
159
+ readonly METASTORE_COMPONENT_UNHEALTHY: "METASTORE_COMPONENT_UNHEALTHY"; /** DBFS component unhealthy */
160
+ readonly DBFS_COMPONENT_UNHEALTHY: "DBFS_COMPONENT_UNHEALTHY"; /** Execution component unhealthy */
161
+ readonly EXECUTION_COMPONENT_UNHEALTHY: "EXECUTION_COMPONENT_UNHEALTHY";
162
+ /**
163
+ * Databricks may hit the azure resource manager request limit. Which will keep the Azure SDK
164
+ * from issuing any read or write request to Azure resource manager. The request limit is applied
165
+ * to each subscription every hour, thus retry after an hour or changing to a smaller cluster size
166
+ * might help to resolve the issue. Please check the following link for more information:
167
+ * https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits
168
+ */
169
+ readonly AZURE_RESOURCE_MANAGER_THROTTLING: "AZURE_RESOURCE_MANAGER_THROTTLING";
170
+ /**
171
+ * Databricks may hit the azure resource provider request limit. Specifically, the API request
172
+ * rate to the specific resource type (Compute, Network, etc..) can't exceed the limit. Retry
173
+ * might help to resolve the issue. Please check the following link for more information:
174
+ * https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/
175
+ * troubleshooting-throttling-errors
176
+ */
177
+ readonly AZURE_RESOURCE_PROVIDER_THROTTLING: "AZURE_RESOURCE_PROVIDER_THROTTLING"; /** The cluster was terminated due to an error in the network configuration. */
178
+ readonly NETWORK_CONFIGURATION_FAILURE: "NETWORK_CONFIGURATION_FAILURE";
179
+ /**
180
+ * Databricks encountered an unexpected error while launching containers on worker nodes for the
181
+ * cluster, terminating the cluster.
182
+ */
183
+ readonly CONTAINER_LAUNCH_FAILURE: "CONTAINER_LAUNCH_FAILURE"; /** Instance pool backed cluster specific failure */
184
+ readonly INSTANCE_POOL_CLUSTER_FAILURE: "INSTANCE_POOL_CLUSTER_FAILURE"; /** Cluster start successfully completed but skipped some instances which were slow to launch */
185
+ readonly SKIPPED_SLOW_NODES: "SKIPPED_SLOW_NODES"; /** Attach projects failure */
186
+ readonly ATTACH_PROJECT_FAILURE: "ATTACH_PROJECT_FAILURE"; /** Attach projects failure */
187
+ readonly UPDATE_INSTANCE_PROFILE_FAILURE: "UPDATE_INSTANCE_PROFILE_FAILURE"; /** Cluster terminated due to database failure */
188
+ readonly DATABASE_CONNECTION_FAILURE: "DATABASE_CONNECTION_FAILURE";
189
+ /**
190
+ * Databricks cannot handle the request at this moment. Please try again later
191
+ * and contact Databricks if the problem persists.
192
+ */
193
+ readonly REQUEST_THROTTLED: "REQUEST_THROTTLED"; /** SelfBootstrap failure. Either self-bootstrap fast fail or node daemon ping timeout */
194
+ readonly SELF_BOOTSTRAP_FAILURE: "SELF_BOOTSTRAP_FAILURE";
195
+ /**
196
+ * Databricks cannot load and execute a global init script on one of the cluster's nodes,
197
+ * or the init script terminates with a non-zero exit code.
198
+ */
199
+ readonly GLOBAL_INIT_SCRIPT_FAILURE: "GLOBAL_INIT_SCRIPT_FAILURE";
200
+ /**
201
+ * Container launch timed out downloading the spark image. This can happen if the customer
202
+ * has byo-vpc/vnet and the download of large files is being throttled.
203
+ */
204
+ readonly SLOW_IMAGE_DOWNLOAD: "SLOW_IMAGE_DOWNLOAD"; /** Container setup failed due to an invalid Spark image. */
205
+ readonly INVALID_SPARK_IMAGE: "INVALID_SPARK_IMAGE";
206
+ /**
207
+ * If the ngrok tunnel token provisioning fails for any reason, for example hitting the
208
+ * max capacity of allowed ngrok tokens. (ES-32083)
209
+ */
210
+ readonly NPIP_TUNNEL_TOKEN_FAILURE: "NPIP_TUNNEL_TOKEN_FAILURE"; /** Hive Metastore provisioning failue in launch container step */
211
+ readonly HIVE_METASTORE_PROVISIONING_FAILURE: "HIVE_METASTORE_PROVISIONING_FAILURE";
212
+ /**
213
+ * Occurs when the deployment template we submit to Azure violates their requirements.
214
+ * Typical scenarios:
215
+ * - Wrong parameter key/value used
216
+ * - Exceed the limit for certain parameter
217
+ */
218
+ readonly AZURE_INVALID_DEPLOYMENT_TEMPLATE: "AZURE_INVALID_DEPLOYMENT_TEMPLATE";
219
+ /**
220
+ * The set of un-categorized failure responses from Azure when we launch instance resources
221
+ * using deployment template
222
+ */
223
+ readonly AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE: "AZURE_UNEXPECTED_DEPLOYMENT_TEMPLATE_FAILURE"; /** Subnet (typically Azure vnet injected) has run out of ip addresses */
224
+ readonly SUBNET_EXHAUSTED_FAILURE: "SUBNET_EXHAUSTED_FAILURE";
225
+ /**
226
+ * Timeout to ping the nodeDaemon, possible reason: nodeDaemon didn't start (configuration issue),
227
+ * network connectivity issue
228
+ */
229
+ readonly BOOTSTRAP_TIMEOUT: "BOOTSTRAP_TIMEOUT"; /** Bootstrap timeout due to script download failure */
230
+ readonly STORAGE_DOWNLOAD_FAILURE: "STORAGE_DOWNLOAD_FAILURE"; /** Bootstrap timeout due to get runbook failure */
231
+ readonly CONTROL_PLANE_REQUEST_FAILURE: "CONTROL_PLANE_REQUEST_FAILURE"; /** Bootstrap timeout due to Azure Extension Service Failure */
232
+ readonly BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION: "BOOTSTRAP_TIMEOUT_CLOUD_PROVIDER_EXCEPTION"; /** Could not find enough of the requested instance type in the requested AZ. Often related to Auto AZ. */
233
+ readonly AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE: "AWS_INSUFFICIENT_INSTANCE_CAPACITY_FAILURE"; /** Container setup failure due to docker image pulling failure */
234
+ readonly DOCKER_IMAGE_PULL_FAILURE: "DOCKER_IMAGE_PULL_FAILURE";
235
+ /**
236
+ * Failures during azure vnet configuration. For example, a workspace with VNet injection had
237
+ * incorrect DNS settings that blocked access to worker artifacts.
238
+ */
239
+ readonly AZURE_VNET_CONFIGURATION_FAILURE: "AZURE_VNET_CONFIGURATION_FAILURE";
240
+ /**
241
+ * Bootstrap failure due to Ngrok tunnel setup timeout or failure. For example, if the worker
242
+ * node is unable to reach the Ngrok tunnel domain.
243
+ */
244
+ readonly NPIP_TUNNEL_SETUP_FAILURE: "NPIP_TUNNEL_SETUP_FAILURE";
245
+ /**
246
+ * Lack authorization for cluster operation.
247
+ * For example, awsApiErrorCode: 'AccessDenied' or 'UnauthorizedOperation'.
248
+ */
249
+ readonly AWS_AUTHORIZATION_FAILURE: "AWS_AUTHORIZATION_FAILURE"; /** request comes form Nephos resource pool auto management */
250
+ readonly NEPHOS_RESOURCE_MANAGEMENT: "NEPHOS_RESOURCE_MANAGEMENT";
251
+ /**
252
+ * Container setup failed during container registration to security daemon due to STS endpoint
253
+ * connection error.
254
+ */
255
+ readonly STS_CLIENT_SETUP_FAILURE: "STS_CLIENT_SETUP_FAILURE"; /** Container setup failed during registration to security daemon due to an unspecified error. */
256
+ readonly SECURITY_DAEMON_REGISTRATION_EXCEPTION: "SECURITY_DAEMON_REGISTRATION_EXCEPTION"; /** The maximum request rate permitted by the Amazon EC2 APIs has been exceeded for your account. */
257
+ readonly AWS_REQUEST_LIMIT_EXCEEDED: "AWS_REQUEST_LIMIT_EXCEEDED"; /** We don't have enough addresses in the subnet for the instances in the request. */
258
+ readonly AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE: "AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE"; /** The request is not supported (This is a vague error code that can be thrown for a lot of reasons.) */
259
+ readonly AWS_UNSUPPORTED_FAILURE: "AWS_UNSUPPORTED_FAILURE"; /** Could not find enough azure resources to fulfill the request. */
260
+ readonly AZURE_QUOTA_EXCEEDED_EXCEPTION: "AZURE_QUOTA_EXCEEDED_EXCEPTION"; /** NOTE: This is currently used by exceptions with messages that are classified as user errors. */
261
+ readonly AZURE_OPERATION_NOT_ALLOWED_EXCEPTION: "AZURE_OPERATION_NOT_ALLOWED_EXCEPTION"; /** Failure when mounting remote NFS to container */
262
+ readonly NFS_MOUNT_FAILURE: "NFS_MOUNT_FAILURE"; /** K8S failed to upscale to acquire new nodes */
263
+ readonly K8S_AUTOSCALING_FAILURE: "K8S_AUTOSCALING_FAILURE"; /** DBR Cluster launched on K8s (i.e. CMv2) has failed to start up in time */
264
+ readonly K8S_DBR_CLUSTER_LAUNCH_TIMEOUT: "K8S_DBR_CLUSTER_LAUNCH_TIMEOUT";
265
+ /**
266
+ * Container launch failed while downloading the spark image. Catch all for if anything
267
+ * goes wrong while downloading and extracting the spark tarball.
268
+ */
269
+ readonly SPARK_IMAGE_DOWNLOAD_FAILURE: "SPARK_IMAGE_DOWNLOAD_FAILURE"; /** Azure VM Extension failure during instance bootstrap */
270
+ readonly AZURE_VM_EXTENSION_FAILURE: "AZURE_VM_EXTENSION_FAILURE"; /** Workspace was cancelled hence deny/terminate the cluster */
271
+ readonly WORKSPACE_CANCELLED_ERROR: "WORKSPACE_CANCELLED_ERROR"; /** The spot instance count in an account has exceeded the limit */
272
+ readonly AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE: "AWS_MAX_SPOT_INSTANCE_COUNT_EXCEEDED_FAILURE";
273
+ /**
274
+ * Cluster is terminated because the services are temporarily unavailable.
275
+ * This normally happens when CM is restarting and draining execution contexts,
276
+ * or IM/Delegate is overloaded, so that it will not be able to retry the instance launch request.
277
+ */
278
+ readonly TEMPORARILY_UNAVAILABLE: "TEMPORARILY_UNAVAILABLE";
279
+ /**
280
+ * Bootstrap failure due to error during worker setup, usually due to an issue with
281
+ * disk or gpu setup. See SetupCommandBuilder for other possible causes
282
+ */
283
+ readonly WORKER_SETUP_FAILURE: "WORKER_SETUP_FAILURE";
284
+ /**
285
+ * Cluster failure due to IP space exhaustion. For example on CMv2, Kubernetes will fail to scale
286
+ * up new nodes if the pod IP CIDR block is exhausted.
287
+ */
288
+ readonly IP_EXHAUSTION_FAILURE: "IP_EXHAUSTION_FAILURE";
289
+ /**
290
+ * Could not find enough GCP resources to fulfill the request.
291
+ * TODO: It's very unfortunate that we have per-cloud termination reasons while we should have
292
+ * cloud-agnostic termination reasons. For example, we should consolidate
293
+ * {AZURE_QUOTA_EXCEEDED_EXCEPTION, AWS_REQUEST_LIMIT_EXCEEDED and GCP_QUOTA_EXCEEDED},
294
+ * {AWS_INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET_FAILURE, IP_EXHAUSTION_FAILURE}, etc.
295
+ */
296
+ readonly GCP_QUOTA_EXCEEDED: "GCP_QUOTA_EXCEEDED"; /** Cloud provider is undergoing a transient resource throttling. This is retryable. */
297
+ readonly CLOUD_PROVIDER_RESOURCE_STOCKOUT: "CLOUD_PROVIDER_RESOURCE_STOCKOUT"; /** The GCP service account associated with the DBR cluster is deleted. */
298
+ readonly GCP_SERVICE_ACCOUNT_DELETED: "GCP_SERVICE_ACCOUNT_DELETED"; /** Legit cluster termination in Azure caused by customer revoking the key permission used for managed-disks encryption */
299
+ readonly AZURE_BYOK_KEY_PERMISSION_FAILURE: "AZURE_BYOK_KEY_PERMISSION_FAILURE"; /** Termination because of spot instance terminated by cloud provider */
300
+ readonly SPOT_INSTANCE_TERMINATION: "SPOT_INSTANCE_TERMINATION"; /** Termination because of unsupported azure ephemeral os disk setup */
301
+ readonly AZURE_EPHEMERAL_DISK_FAILURE: "AZURE_EPHEMERAL_DISK_FAILURE";
302
+ /**
303
+ * The cluster was terminated because we detected an abusive runtime behavior that violated
304
+ * Terms of Service or Acceptable Use Policy.
305
+ */
306
+ readonly ABUSE_DETECTED: "ABUSE_DETECTED"; /** Failed to pull DBR images due to permission error. */
307
+ readonly IMAGE_PULL_PERMISSION_DENIED: "IMAGE_PULL_PERMISSION_DENIED"; /** Workspace configuration is in error state due to configuration issue or ACL modification by the customer side */
308
+ readonly WORKSPACE_CONFIGURATION_ERROR: "WORKSPACE_CONFIGURATION_ERROR";
309
+ /**
310
+ * Catch all error for all secret resolution issues in cluster launch. This should be alerted on,
311
+ * and is considered a server error. This can be split out into other cases if there are client
312
+ * errors - for e.g. INVALID_ARGUMENT is used for secrets that don't exist and permission issues
313
+ */
314
+ readonly SECRET_RESOLUTION_ERROR: "SECRET_RESOLUTION_ERROR";
315
+ /**
316
+ * Failure due to an instance being of an unsupported type. This is used when an instance in
317
+ * an EC2 fleet is of an unrecognized type, or an invalid type (i.e. graviton when we don't
318
+ * want graviton instances). This should be alerted on.
319
+ */
320
+ readonly UNSUPPORTED_INSTANCE_TYPE: "UNSUPPORTED_INSTANCE_TYPE"; /** Failed during instance bootstrap with error code Cannot convert NVMe-based dev id */
321
+ readonly CLOUD_PROVIDER_DISK_SETUP_FAILURE: "CLOUD_PROVIDER_DISK_SETUP_FAILURE"; /** Exception when setting up instances using ssh bootstrap */
322
+ readonly SSH_BOOTSTRAP_FAILURE: "SSH_BOOTSTRAP_FAILURE"; /** Failed during instance bootstrap with error code Cannot convert NVMe-based dev id */
323
+ readonly AWS_INACCESSIBLE_KMS_KEY_FAILURE: "AWS_INACCESSIBLE_KMS_KEY_FAILURE";
324
+ /**
325
+ * The bootstrapping init-containers in Spark failed or timed out, blocking the Spark container
326
+ * from bootstrapping. This is a refinement of `SPARK_STARTUP_FAILURE`.
327
+ * (init-containers are a bootstrapping step owned by Databricks)
328
+ */
329
+ readonly INIT_CONTAINER_NOT_FINISHED: "INIT_CONTAINER_NOT_FINISHED";
330
+ /**
331
+ * Container launch failed due to storage servers throttling our download of spark images. Can
332
+ * happen due to transient spikes of downloads overloading storage servers or gradual increase in
333
+ * usage. In the latter case we need to increase the number of storage servers in the region to
334
+ * help spread load.
335
+ */
336
+ readonly SPARK_IMAGE_DOWNLOAD_THROTTLED: "SPARK_IMAGE_DOWNLOAD_THROTTLED";
337
+ /**
338
+ * The spark image specified for the cluster was not found when attempting to download. Usually
339
+ * due to the customer custom specifying a bad image.
340
+ */
341
+ readonly SPARK_IMAGE_NOT_FOUND: "SPARK_IMAGE_NOT_FOUND";
342
+ /**
343
+ * Indicates that the cloud provider operations performed for the cluster were dropped due to
344
+ * an influx in load in the cloud provider and had to be dropped from our end to alleviate
345
+ * pressure within the DelegateRpcClient. Please see go/cmloadshedding for more.
346
+ */
347
+ readonly CLUSTER_OPERATION_THROTTLED: "CLUSTER_OPERATION_THROTTLED";
348
+ /**
349
+ * The error code can be used to indicate a request misses its deadline. Can be used for either request timeouts
350
+ * or missed deadlines (i.e. a request is not completed as it was processed after its specified deadline)
351
+ */
352
+ readonly CLUSTER_OPERATION_TIMEOUT: "CLUSTER_OPERATION_TIMEOUT";
353
+ /**
354
+ * This error code is used to terminate long-running Generic compute jobs in Serverless Environment
355
+ * as part of the NephosLongRunning watcher running in Cluster Monitor Service.
356
+ */
357
+ readonly SERVERLESS_LONG_RUNNING_TERMINATED: "SERVERLESS_LONG_RUNNING_TERMINATED";
358
+ /**
359
+ * This error code is used when the cluster is terminated due to its instances fail with partial failure from Azure
360
+ * packed deployments. In Azure, we might pack multiple launch requests in one deployment template in order
361
+ * to avoid the 800 templates limit on Azure side. If the packed deployment fails multiple times, the cluster could
362
+ * be terminated by this [[AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE]] termination code.
363
+ */
364
+ readonly AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE: "AZURE_PACKED_DEPLOYMENT_PARTIAL_FAILURE";
365
+ /**
366
+ * The instances acquired from a pool in IMv2 do not have a valid worker image to be used in the
367
+ * cluster launch. This usually occurs after AMI/VHD upgrades, worker branch updates, etc.
368
+ */
369
+ readonly INVALID_WORKER_IMAGE_FAILURE: "INVALID_WORKER_IMAGE_FAILURE"; /** Worker environment version was changed due to workspace network or CMK update. */
370
+ readonly WORKSPACE_UPDATE: "WORKSPACE_UPDATE"; /** The parameter user specified or the user account to create the cluster is invalid according to AWS. */
371
+ readonly INVALID_AWS_PARAMETER: "INVALID_AWS_PARAMETER";
372
+ /**
373
+ * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
374
+ *
375
+ * k8s evicted the driver pod due to disk pressure on the driver node. This is likely due to a
376
+ * customer job consuming too much disk and so this is classified as a customer issue.
377
+ */
378
+ readonly DRIVER_OUT_OF_DISK: "DRIVER_OUT_OF_DISK";
379
+ /**
380
+ * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
381
+ *
382
+ * k8s evicted the driver pod due to memory pressure on the driver node. A customer job consuming
383
+ * significant amounts of memory should not be able to trigger this as the driver container would
384
+ * OOM first (we set memory limits on our pods). Thus this termination reason will be considered
385
+ * a databricks issue.
386
+ */
387
+ readonly DRIVER_OUT_OF_MEMORY: "DRIVER_OUT_OF_MEMORY";
388
+ /**
389
+ * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
390
+ * Original driver pod took too long to become ready and timed out.
391
+ */
392
+ readonly DRIVER_LAUNCH_TIMEOUT: "DRIVER_LAUNCH_TIMEOUT";
393
+ /**
394
+ * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
395
+ * Unexpected failure during driver pod launch.
396
+ */
397
+ readonly DRIVER_UNEXPECTED_FAILURE: "DRIVER_UNEXPECTED_FAILURE";
398
+ /**
399
+ * ** Only relevant on k8s dataplanes (i.e. clusters launched with CMv2 - not CMv1).
400
+ * Unexpected new driver pod created
401
+ */
402
+ readonly UNEXPECTED_POD_RECREATION: "UNEXPECTED_POD_RECREATION"; /** Failure due to disabled or inaccessible CMK. */
403
+ readonly GCP_INACCESSIBLE_KMS_KEY_FAILURE: "GCP_INACCESSIBLE_KMS_KEY_FAILURE"; /** Failure due to missing/incorrect permission setup on CMK. */
404
+ readonly GCP_KMS_KEY_PERMISSION_DENIED: "GCP_KMS_KEY_PERMISSION_DENIED"; /** Driver pod evicted in Nephos */
405
+ readonly DRIVER_EVICTION: "DRIVER_EVICTION"; /** User request for termination directly to cloud */
406
+ readonly USER_INITIATED_VM_TERMINATION: "USER_INITIATED_VM_TERMINATION"; /** GCP Specific IAM API timeout issues during Workload Idenitity (Cluster Identity) binding process */
407
+ readonly GCP_IAM_TIMEOUT: "GCP_IAM_TIMEOUT"; /** Could not find enough AWS resources to fulfill the request */
408
+ readonly AWS_RESOURCE_QUOTA_EXCEEDED: "AWS_RESOURCE_QUOTA_EXCEEDED"; /** Cloud account setup has some error (e.g. pending email verification, blocked) */
409
+ readonly CLOUD_ACCOUNT_SETUP_FAILURE: "CLOUD_ACCOUNT_SETUP_FAILURE"; /** The specified key pair name does not exist. */
410
+ readonly AWS_INVALID_KEY_PAIR: "AWS_INVALID_KEY_PAIR"; /** Driver pod creation failure in nephos */
411
+ readonly DRIVER_POD_CREATION_FAILURE: "DRIVER_POD_CREATION_FAILURE"; /** Cluster terminated manually by on-call due to emergency maintenance */
412
+ readonly MAINTENANCE_MODE: "MAINTENANCE_MODE"; /** Nephos internal error due to insufficient provisioned k8s capacity or insufficient cloud quota */
413
+ readonly INTERNAL_CAPACITY_FAILURE: "INTERNAL_CAPACITY_FAILURE"; /** Nephos: could not acquire executor pods from pod pool */
414
+ readonly EXECUTOR_POD_UNSCHEDULED: "EXECUTOR_POD_UNSCHEDULED"; /** Artifact download failed because it was too slow */
415
+ readonly STORAGE_DOWNLOAD_FAILURE_SLOW: "STORAGE_DOWNLOAD_FAILURE_SLOW"; /** Artifact download failed because it was throttled by the download server */
416
+ readonly STORAGE_DOWNLOAD_FAILURE_THROTTLED: "STORAGE_DOWNLOAD_FAILURE_THROTTLED"; /** The cluster was terminated because the size of the dynamic spark conf exceeded the limit. */
417
+ readonly DYNAMIC_SPARK_CONF_SIZE_EXCEEDED: "DYNAMIC_SPARK_CONF_SIZE_EXCEEDED"; /** Failure to update the instance profile for the cluster. */
418
+ readonly AWS_INSTANCE_PROFILE_UPDATE_FAILURE: "AWS_INSTANCE_PROFILE_UPDATE_FAILURE"; /** The instance pool did not exist when the cluster was launched. */
419
+ readonly INSTANCE_POOL_NOT_FOUND: "INSTANCE_POOL_NOT_FOUND"; /** Attempting to launch more instances was rejected as it would exceed the pool's max capacity. */
420
+ readonly INSTANCE_POOL_MAX_CAPACITY_REACHED: "INSTANCE_POOL_MAX_CAPACITY_REACHED"; /** The KMS key provided is in an incorrect state. */
421
+ readonly AWS_INVALID_KMS_KEY_STATE: "AWS_INVALID_KMS_KEY_STATE"; /** Insufficient capacity failure from GCE API. */
422
+ readonly GCP_INSUFFICIENT_CAPACITY: "GCP_INSUFFICIENT_CAPACITY"; /** Rate quota exceeded for GCP API (e.g. Read requests per minute per region). */
423
+ readonly GCP_API_RATE_QUOTA_EXCEEDED: "GCP_API_RATE_QUOTA_EXCEEDED"; /** Resource quota exceeded (e.g. # of n1 vCPUs in a region). */
424
+ readonly GCP_RESOURCE_QUOTA_EXCEEDED: "GCP_RESOURCE_QUOTA_EXCEEDED"; /** Subnet IP space exhausted. */
425
+ readonly GCP_IP_SPACE_EXHAUSTED: "GCP_IP_SPACE_EXHAUSTED"; /** Missing permissions to launch VM with service account. */
426
+ readonly GCP_SERVICE_ACCOUNT_ACCESS_DENIED: "GCP_SERVICE_ACCOUNT_ACCESS_DENIED"; /** VM attempting to launch with non-existent service account. */
427
+ readonly GCP_SERVICE_ACCOUNT_NOT_FOUND: "GCP_SERVICE_ACCOUNT_NOT_FOUND"; /** Forbidden (403) returned by GCP API. */
428
+ readonly GCP_FORBIDDEN: "GCP_FORBIDDEN"; /** Not found (404) returned by GCP API. */
429
+ readonly GCP_NOT_FOUND: "GCP_NOT_FOUND"; /** Gatekeeper indicated the cluster should be shutdown */
430
+ readonly RESOURCE_USAGE_BLOCKED: "RESOURCE_USAGE_BLOCKED"; /** The data access config of the workspace has changed, and clusters using outdated config will be terminated. */
431
+ readonly DATA_ACCESS_CONFIG_CHANGED: "DATA_ACCESS_CONFIG_CHANGED"; /** Failed to fetch internal PAT token required for init script installation from WSFS/UC volumes */
432
+ readonly ACCESS_TOKEN_FAILURE: "ACCESS_TOKEN_FAILURE";
433
+ /**
434
+ * It indicates there is a placement v2 protocol rollout/rollback event for the corresponding workspace when
435
+ * processing the placement session on the instance-manager side. A retry will fix the issue by switching back
436
+ * to the correct placement protocol.
437
+ */
438
+ readonly INVALID_INSTANCE_PLACEMENT_PROTOCOL: "INVALID_INSTANCE_PLACEMENT_PROTOCOL"; /** The cluster was terminated as it failed to resolve budget policy. */
439
+ readonly BUDGET_POLICY_RESOLUTION_FAILURE: "BUDGET_POLICY_RESOLUTION_FAILURE";
440
+ /**
441
+ * This customer/error combination is a known issue and is intentionally excluded from termination
442
+ * metrics
443
+ */
444
+ readonly IN_PENALTY_BOX: "IN_PENALTY_BOX";
445
+ /**
446
+ * The cluster was terminated when the primary workspace failed over to the secondary workspace.
447
+ * This is expected because there is no data plane in the secondary workspace.
448
+ */
449
+ readonly DISASTER_RECOVERY_REPLICATION: "DISASTER_RECOVERY_REPLICATION"; /** A bootstrap timeout that was caused by misconfiguration on the customer's side */
450
+ readonly BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG: "BOOTSTRAP_TIMEOUT_DUE_TO_MISCONFIG"; /** Instance unreachable, but due to misconfiguration on the customer's side */
451
+ readonly INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG: "INSTANCE_UNREACHABLE_DUE_TO_MISCONFIG"; /** Bootstrap timeout due to script download failure, but due to misconfiguration on the customer's side */
452
+ readonly STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG: "STORAGE_DOWNLOAD_FAILURE_DUE_TO_MISCONFIG"; /** CPRF, but due to misconfiguration on the customer's side */
453
+ readonly CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG: "CONTROL_PLANE_REQUEST_FAILURE_DUE_TO_MISCONFIG"; /** CPLF, but due to misconfiguration on the customer's side */
454
+ readonly CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG: "CLOUD_PROVIDER_LAUNCH_FAILURE_DUE_TO_MISCONFIG"; /** GCP subnet is in transient "resourceNotReady" state. */
455
+ readonly GCP_SUBNET_NOT_READY: "GCP_SUBNET_NOT_READY"; /** The operation on the cloud provider was cancelled. Possibly due to a user action. */
456
+ readonly CLOUD_OPERATION_CANCELLED: "CLOUD_OPERATION_CANCELLED";
457
+ /**
458
+ * If cloud provider indicates instance creation was a success, yet the instance is never created.
459
+ * This can happen in certain edge cases like quota exhaustion on GCP. We have an open bug here:
460
+ * https://partnerissuetracker.corp.google.com/issues/339061883
461
+ */
462
+ readonly CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED: "CLOUD_PROVIDER_INSTANCE_NOT_LAUNCHED"; /** GCP Databricks VM Machine Image is blocked by customer organization policy. */
463
+ readonly GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED: "GCP_TRUSTED_IMAGE_PROJECTS_VIOLATED"; /** cluster terminate can happened when a budget policy limit enforcement activated */
464
+ readonly BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED: "BUDGET_POLICY_LIMIT_ENFORCEMENT_ACTIVATED";
465
+ readonly EOS_SPARK_IMAGE: "EOS_SPARK_IMAGE"; /** Serverless only. There are no eligible K8s for the cluster. */
466
+ readonly NO_MATCHED_K8S: "NO_MATCHED_K8S"; /** Lazy allocation timeout. Timeout before any internal DBR clusters were allocated. */
467
+ readonly LAZY_ALLOCATION_TIMEOUT: "LAZY_ALLOCATION_TIMEOUT"; /** CMv2 unable to contact chauffeur or node-daemon on the driver node. */
468
+ readonly DRIVER_NODE_UNREACHABLE: "DRIVER_NODE_UNREACHABLE"; /** Dynamic secret generation failed. */
469
+ readonly SECRET_CREATION_FAILURE: "SECRET_CREATION_FAILURE"; /** Driver or executor pod failed to be scheduled. */
470
+ readonly POD_SCHEDULING_FAILURE: "POD_SCHEDULING_FAILURE"; /** Driver or executor pod failed to finish assigning. */
471
+ readonly POD_ASSIGNMENT_FAILURE: "POD_ASSIGNMENT_FAILURE"; /** Lazy allocation timeout with unknown reason. */
472
+ readonly ALLOCATION_TIMEOUT: "ALLOCATION_TIMEOUT"; /** Lazy allocation timeout. Maps to NoUnallocatedDbrCluster. */
473
+ readonly ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS: "ALLOCATION_TIMEOUT_NO_UNALLOCATED_CLUSTERS"; /** Lazy allocation timeout. Maps to NoMatchedUnallocatedDbrCluster. */
474
+ readonly ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS: "ALLOCATION_TIMEOUT_NO_MATCHED_CLUSTERS"; /** Lazy allocation timeout. Maps to NoUnallocatedReadyDbrCluster. */
475
+ readonly ALLOCATION_TIMEOUT_NO_READY_CLUSTERS: "ALLOCATION_TIMEOUT_NO_READY_CLUSTERS"; /** Lazy allocation timeout. Maps to NoMatchedUnallocatedWarmedUpDbrCluster. */
476
+ readonly ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS: "ALLOCATION_TIMEOUT_NO_WARMED_UP_CLUSTERS"; /** Lazy allocation timeout. Maps to NoCandidatesWithNodeDaemonK8sReady. */
477
+ readonly ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY: "ALLOCATION_TIMEOUT_NODE_DAEMON_NOT_READY"; /** Lazy allocation timeout. Maps to NoCandidatesHealthy. */
478
+ readonly ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS: "ALLOCATION_TIMEOUT_NO_HEALTHY_CLUSTERS";
479
+ /**
480
+ * When nephos blocking wait for netvisor setup ready signal, terminated by timeout.
481
+ * This error code only applies to clusters with the attribute should_block_for_network_readiness: true
482
+ */
483
+ readonly NETVISOR_SETUP_TIMEOUT: "NETVISOR_SETUP_TIMEOUT"; /** Serverless only. The preselected K8s for the cluster is not eligible. */
484
+ readonly NO_MATCHED_K8S_TESTING_TAG: "NO_MATCHED_K8S_TESTING_TAG"; /** The customer's repeatedly attempting to launch clusters with some configuration that the CSP's not able to provide */
485
+ readonly CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG: "CLOUD_PROVIDER_RESOURCE_STOCKOUT_DUE_TO_MISCONFIG"; /** For the GCP CMv1 Migration, we will terminate all CMv2 based clusters with this failure. */
486
+ readonly GKE_BASED_CLUSTER_TERMINATION: "GKE_BASED_CLUSTER_TERMINATION"; /** Lazy allocation timeout. Maps to NoCandidatesHealthyAndWarmedUp. */
487
+ readonly ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS: "ALLOCATION_TIMEOUT_NO_HEALTHY_AND_WARMED_UP_CLUSTERS"; /** Docker container's OS was not valid. */
488
+ readonly DOCKER_INVALID_OS_EXCEPTION: "DOCKER_INVALID_OS_EXCEPTION"; /** Something went wrong during the creation of the docker container. */
489
+ readonly DOCKER_CONTAINER_CREATION_EXCEPTION: "DOCKER_CONTAINER_CREATION_EXCEPTION"; /** Customer passed in a docker image that's too large for the instance. */
490
+ readonly DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION: "DOCKER_IMAGE_TOO_LARGE_FOR_INSTANCE_EXCEPTION"; /** The cluster was terminated because the DNS resolution failed. */
491
+ readonly DNS_RESOLUTION_ERROR: "DNS_RESOLUTION_ERROR"; /** Org policy is preventing a GCE API operation from being executed. */
492
+ readonly GCP_DENIED_BY_ORG_POLICY: "GCP_DENIED_BY_ORG_POLICY"; /** Customer passed in a secret that they do not have permissions to resolve. */
493
+ readonly SECRET_PERMISSION_DENIED: "SECRET_PERMISSION_DENIED"; /** Start of network health check generated failures */
494
+ readonly NETWORK_CHECK_NIC_FAILURE: "NETWORK_CHECK_NIC_FAILURE";
495
+ readonly NETWORK_CHECK_DNS_SERVER_FAILURE: "NETWORK_CHECK_DNS_SERVER_FAILURE";
496
+ readonly NETWORK_CHECK_STORAGE_FAILURE: "NETWORK_CHECK_STORAGE_FAILURE";
497
+ readonly NETWORK_CHECK_METADATA_ENDPOINT_FAILURE: "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE";
498
+ readonly NETWORK_CHECK_CONTROL_PLANE_FAILURE: "NETWORK_CHECK_CONTROL_PLANE_FAILURE";
499
+ readonly NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE: "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE"; /** Driver has been down or unresponsive for an extended period of time */
500
+ readonly DRIVER_UNHEALTHY: "DRIVER_UNHEALTHY"; /** cluster request is denied due to disallowed usage policy entitlement */
501
+ readonly USAGE_POLICY_ENTITLEMENT_DENIED: "USAGE_POLICY_ENTITLEMENT_DENIED"; /** Request exceeded MAX_ACTIVE_DBR_PODS_PER_K8S_CLUSTER quota - too many active pods on the K8s cluster */
502
+ readonly K8S_ACTIVE_POD_QUOTA_EXCEEDED: "K8S_ACTIVE_POD_QUOTA_EXCEEDED"; /** Request exceeded MAX_PODS_PER_CLOUD_ACCOUNT quota - subscription/cloud account pod limit reached */
503
+ readonly CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED: "CLOUD_ACCOUNT_POD_QUOTA_EXCEEDED"; /** Start of network health check generated failures due to misconfiguration */
504
+ readonly NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_NIC_FAILURE_DUE_TO_MISCONFIG";
505
+ readonly NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_DNS_SERVER_FAILURE_DUE_TO_MISCONFIG";
506
+ readonly NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_STORAGE_FAILURE_DUE_TO_MISCONFIG";
507
+ readonly NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_METADATA_ENDPOINT_FAILURE_DUE_TO_MISCONFIG";
508
+ readonly NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_CONTROL_PLANE_FAILURE_DUE_TO_MISCONFIG";
509
+ readonly NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG: "NETWORK_CHECK_MULTIPLE_COMPONENTS_FAILURE_DUE_TO_MISCONFIG";
510
+ /**
511
+ * CMv2 could not resolve the DBR image for versionless workloads (REPL, GENERIC).
512
+ * This typically happens when no spark version is found from the channel mapping
513
+ * and the workload is versionless-enabled.
514
+ */
515
+ readonly DBR_IMAGE_RESOLUTION_FAILURE: "DBR_IMAGE_RESOLUTION_FAILURE";
516
+ readonly CONTROL_PLANE_CONNECTION_FAILURE: "CONTROL_PLANE_CONNECTION_FAILURE";
517
+ readonly CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG: "CONTROL_PLANE_CONNECTION_FAILURE_DUE_TO_MISCONFIG";
518
+ readonly RATE_LIMITED: "RATE_LIMITED"; /** The cluster was terminated because mutual TLS port 8443 check failed. */
519
+ readonly MTLS_PORT_CONNECTIVITY_FAILURE: "MTLS_PORT_CONNECTIVITY_FAILURE"; /** The cluster was terminated because hivemetastore connectivity check failed. */
520
+ readonly HIVEMETASTORE_CONNECTIVITY_FAILURE: "HIVEMETASTORE_CONNECTIVITY_FAILURE";
653
521
  };
654
- export type TerminationCode = (typeof TerminationCode)[keyof typeof TerminationCode] | (string & {});
522
+ type TerminationCode = (typeof TerminationCode)[keyof typeof TerminationCode] | (string & {});
655
523
  /** type of the termination */
656
- export declare const TerminationType: {
657
- /** Termination succeeded normally */
658
- readonly SUCCESS: "SUCCESS";
659
- /** Non-retryable. Client must fix parameters before reattempting the cluster creation */
660
- readonly CLIENT_ERROR: "CLIENT_ERROR";
661
- /** Databricks service issue. Clients may retry */
662
- readonly SERVICE_FAULT: "SERVICE_FAULT";
663
- /** AWS or Azure infrastructure issue. Clients may retry after the underlying cloud issue is resolved */
664
- readonly CLOUD_FAILURE: "CLOUD_FAILURE";
524
+ declare const TerminationType: {
525
+ /** Termination succeeded normally */readonly SUCCESS: "SUCCESS"; /** Non-retryable. Client must fix parameters before reattempting the cluster creation */
526
+ readonly CLIENT_ERROR: "CLIENT_ERROR"; /** Databricks service issue. Clients may retry */
527
+ readonly SERVICE_FAULT: "SERVICE_FAULT"; /** AWS or Azure infrastructure issue. Clients may retry after the underlying cloud issue is resolved */
528
+ readonly CLOUD_FAILURE: "CLOUD_FAILURE";
665
529
  };
666
- export type TerminationType = (typeof TerminationType)[keyof typeof TerminationType] | (string & {});
667
- export declare const WarehouseType: {
668
- /** UNDOCUMENTED. Indicates no value is specified. */
669
- readonly TYPE_UNSPECIFIED: "TYPE_UNSPECIFIED";
670
- /** Classic warehouse type */
671
- readonly CLASSIC: "CLASSIC";
672
- /** Pro warehouse type */
673
- readonly PRO: "PRO";
530
+ type TerminationType = (typeof TerminationType)[keyof typeof TerminationType] | (string & {});
531
+ declare const WarehouseType: {
532
+ /** UNDOCUMENTED. Indicates no value is specified. */readonly TYPE_UNSPECIFIED: "TYPE_UNSPECIFIED"; /** Classic warehouse type */
533
+ readonly CLASSIC: "CLASSIC"; /** Pro warehouse type */
534
+ readonly PRO: "PRO";
674
535
  };
675
- export type WarehouseType = (typeof WarehouseType)[keyof typeof WarehouseType] | (string & {});
676
- export declare const EndpointHealth_Status: {
677
- /** UNDOCUMENTED. Indicates no value is specified. An implementation detail. */
678
- readonly STATUS_UNSPECIFIED: "STATUS_UNSPECIFIED";
679
- /** Endpoint is functioning normally and there are no known issues. */
680
- readonly HEALTHY: "HEALTHY";
681
- /**
682
- * Endpoint might be functional, but there are some known issues.
683
- * Performance might be affected.
684
- */
685
- readonly DEGRADED: "DEGRADED";
686
- /** Endpoint is severely affected. Likely will not be able to serve queries. */
687
- readonly FAILED: "FAILED";
536
+ type WarehouseType = (typeof WarehouseType)[keyof typeof WarehouseType] | (string & {});
537
+ declare const EndpointHealth_Status: {
538
+ /** UNDOCUMENTED. Indicates no value is specified. An implementation detail. */readonly STATUS_UNSPECIFIED: "STATUS_UNSPECIFIED"; /** Endpoint is functioning normally and there are no known issues. */
539
+ readonly HEALTHY: "HEALTHY";
540
+ /**
541
+ * Endpoint might be functional, but there are some known issues.
542
+ * Performance might be affected.
543
+ */
544
+ readonly DEGRADED: "DEGRADED"; /** Endpoint is severely affected. Likely will not be able to serve queries. */
545
+ readonly FAILED: "FAILED";
688
546
  };
689
- export type EndpointHealth_Status = (typeof EndpointHealth_Status)[keyof typeof EndpointHealth_Status] | (string & {});
547
+ type EndpointHealth_Status = (typeof EndpointHealth_Status)[keyof typeof EndpointHealth_Status] | (string & {});
690
548
  /** Configures the channel name and DBSQL version of the warehouse. CHANNEL_NAME_CUSTOM should be chosen only when `dbsql_version` is specified. */
691
- export interface Channel {
692
- name?: ChannelName | undefined;
693
- dbsqlVersion?: string | undefined;
549
+ interface Channel {
550
+ name?: ChannelName | undefined;
551
+ dbsqlVersion?: string | undefined;
694
552
  }
695
553
  /** Request message for CreateDefaultWarehouseOverride. */
696
- export interface CreateDefaultWarehouseOverrideRequest {
697
- /**
698
- * Required. The ID to use for the override, which will become the final component
699
- * of the override's resource name.
700
- * Can be a numeric user ID or the literal string "me" for the current user.
701
- */
702
- defaultWarehouseOverrideId?: string | undefined;
703
- /** Required. The default warehouse override to create. */
704
- defaultWarehouseOverride?: DefaultWarehouseOverride | undefined;
554
+ interface CreateDefaultWarehouseOverrideRequest {
555
+ /**
556
+ * Required. The ID to use for the override, which will become the final component
557
+ * of the override's resource name.
558
+ * Can be a numeric user ID or the literal string "me" for the current user.
559
+ */
560
+ defaultWarehouseOverrideId?: string | undefined;
561
+ /** Required. The default warehouse override to create. */
562
+ defaultWarehouseOverride?: DefaultWarehouseOverride | undefined;
705
563
  }
706
564
  /** Creates a new SQL warehouse. */
707
- export interface CreateWarehouseRequest {
708
- /**
709
- * Logical name for the cluster.
710
- *
711
- * Supported values:
712
- * - Must be unique within an org.
713
- * - Must be less than 100 characters.
714
- */
715
- name?: string | undefined;
716
- /**
717
- * Size of the clusters allocated for this warehouse.
718
- * Increasing the size of a spark cluster allows you to run larger queries on
719
- * it. If you want to increase the number of concurrent queries, please tune
720
- * max_num_clusters.
721
- *
722
- * Supported values:
723
- * - 2X-Small
724
- * - X-Small
725
- * - Small
726
- * - Medium
727
- * - Large
728
- * - X-Large
729
- * - 2X-Large
730
- * - 3X-Large
731
- * - 4X-Large
732
- * - 5X-Large
733
- */
734
- clusterSize?: string | undefined;
735
- /**
736
- * Minimum number of available clusters that will be maintained for this SQL
737
- * warehouse. Increasing this will ensure that a larger number of clusters are
738
- * always running and therefore may reduce the cold start time for new
739
- * queries. This is similar to reserved vs. revocable cores in a resource
740
- * manager.
741
- *
742
- * Supported values:
743
- * - Must be > 0
744
- * - Must be <= min(max_num_clusters, 30)
745
- *
746
- * Defaults to 1
747
- */
748
- minNumClusters?: number | undefined;
749
- /**
750
- * Maximum number of clusters that the autoscaler will create to handle
751
- * concurrent queries.
752
- *
753
- * Supported values:
754
- * - Must be >= min_num_clusters
755
- * - Must be <= 40.
756
- *
757
- * Defaults to min_clusters if unset.
758
- */
759
- maxNumClusters?: number | undefined;
760
- /**
761
- * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
762
- * RUNNING queries) before it is automatically stopped.
763
- *
764
- * Supported values:
765
- * - Must be == 0 or >= 10 mins
766
- * - 0 indicates no autostop.
767
- *
768
- * Defaults to 120 mins
769
- */
770
- autoStopMins?: number | undefined;
771
- /** warehouse creator name */
772
- creatorName?: string | undefined;
773
- /** Deprecated. Instance profile used to pass IAM role to the cluster */
774
- instanceProfileArn?: string | undefined;
775
- /**
776
- * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
777
- * with this SQL warehouse.
778
- *
779
- * Supported values:
780
- * - Number of tags < 45.
781
- */
782
- tags?: EndpointTags | undefined;
783
- /** Configurations whether the endpoint should use spot instances. */
784
- spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
785
- /**
786
- * Configures whether the warehouse should use Photon optimized clusters.
787
- *
788
- * Defaults to true.
789
- */
790
- enablePhoton?: boolean | undefined;
791
- /** Channel Details */
792
- channel?: Channel | undefined;
793
- /** Configures whether the warehouse should use serverless compute */
794
- enableServerlessCompute?: boolean | undefined;
795
- /**
796
- * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
797
- * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
798
- */
799
- warehouseType?: WarehouseType | undefined;
565
+ interface CreateWarehouseRequest {
566
+ /**
567
+ * Logical name for the cluster.
568
+ *
569
+ * Supported values:
570
+ * - Must be unique within an org.
571
+ * - Must be less than 100 characters.
572
+ */
573
+ name?: string | undefined;
574
+ /**
575
+ * Size of the clusters allocated for this warehouse.
576
+ * Increasing the size of a spark cluster allows you to run larger queries on
577
+ * it. If you want to increase the number of concurrent queries, please tune
578
+ * max_num_clusters.
579
+ *
580
+ * Supported values:
581
+ * - 2X-Small
582
+ * - X-Small
583
+ * - Small
584
+ * - Medium
585
+ * - Large
586
+ * - X-Large
587
+ * - 2X-Large
588
+ * - 3X-Large
589
+ * - 4X-Large
590
+ * - 5X-Large
591
+ */
592
+ clusterSize?: string | undefined;
593
+ /**
594
+ * Minimum number of available clusters that will be maintained for this SQL
595
+ * warehouse. Increasing this will ensure that a larger number of clusters are
596
+ * always running and therefore may reduce the cold start time for new
597
+ * queries. This is similar to reserved vs. revocable cores in a resource
598
+ * manager.
599
+ *
600
+ * Supported values:
601
+ * - Must be > 0
602
+ * - Must be <= min(max_num_clusters, 30)
603
+ *
604
+ * Defaults to 1
605
+ */
606
+ minNumClusters?: number | undefined;
607
+ /**
608
+ * Maximum number of clusters that the autoscaler will create to handle
609
+ * concurrent queries.
610
+ *
611
+ * Supported values:
612
+ * - Must be >= min_num_clusters
613
+ * - Must be <= 40.
614
+ *
615
+ * Defaults to min_clusters if unset.
616
+ */
617
+ maxNumClusters?: number | undefined;
618
+ /**
619
+ * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
620
+ * RUNNING queries) before it is automatically stopped.
621
+ *
622
+ * Supported values:
623
+ * - Must be == 0 or >= 10 mins
624
+ * - 0 indicates no autostop.
625
+ *
626
+ * Defaults to 120 mins
627
+ */
628
+ autoStopMins?: number | undefined;
629
+ /** warehouse creator name */
630
+ creatorName?: string | undefined;
631
+ /** Deprecated. Instance profile used to pass IAM role to the cluster */
632
+ instanceProfileArn?: string | undefined;
633
+ /**
634
+ * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
635
+ * with this SQL warehouse.
636
+ *
637
+ * Supported values:
638
+ * - Number of tags < 45.
639
+ */
640
+ tags?: EndpointTags | undefined;
641
+ /** Configurations whether the endpoint should use spot instances. */
642
+ spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
643
+ /**
644
+ * Configures whether the warehouse should use Photon optimized clusters.
645
+ *
646
+ * Defaults to true.
647
+ */
648
+ enablePhoton?: boolean | undefined;
649
+ /** Channel Details */
650
+ channel?: Channel | undefined;
651
+ /** Configures whether the warehouse should use serverless compute */
652
+ enableServerlessCompute?: boolean | undefined;
653
+ /**
654
+ * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
655
+ * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
656
+ */
657
+ warehouseType?: WarehouseType | undefined;
800
658
  }
801
- export interface CreateWarehouseResponse {
802
- /**
803
- * Id for the SQL warehouse.
804
- * This value is unique across all SQL warehouses.
805
- */
806
- id?: string | undefined;
659
+ interface CreateWarehouseResponse {
660
+ /**
661
+ * Id for the SQL warehouse.
662
+ * This value is unique across all SQL warehouses.
663
+ */
664
+ id?: string | undefined;
807
665
  }
808
666
  /**
809
667
  * Represents a per-user default warehouse override configuration.
@@ -811,656 +669,652 @@ export interface CreateWarehouseResponse {
811
669
  * default warehouse is selected for SQL operations.
812
670
  * If no override exists for a user, the workspace default warehouse will be used.
813
671
  */
814
- export interface DefaultWarehouseOverride {
815
- /**
816
- * The resource name of the default warehouse override.
817
- * Format: default-warehouse-overrides/{default_warehouse_override_id}
818
- */
819
- name?: string | undefined;
820
- /** The ID component of the resource name (user ID). */
821
- defaultWarehouseOverrideId?: string | undefined;
822
- /** The type of override behavior. */
823
- type?: DefaultWarehouseOverrideType | undefined;
824
- /**
825
- * The specific warehouse ID when type is CUSTOM.
826
- * Not set for LAST_SELECTED type.
827
- */
828
- warehouseId?: string | undefined;
672
+ interface DefaultWarehouseOverride {
673
+ /**
674
+ * The resource name of the default warehouse override.
675
+ * Format: default-warehouse-overrides/{default_warehouse_override_id}
676
+ */
677
+ name?: string | undefined;
678
+ /** The ID component of the resource name (user ID). */
679
+ defaultWarehouseOverrideId?: string | undefined;
680
+ /** The type of override behavior. */
681
+ type?: DefaultWarehouseOverrideType | undefined;
682
+ /**
683
+ * The specific warehouse ID when type is CUSTOM.
684
+ * Not set for LAST_SELECTED type.
685
+ */
686
+ warehouseId?: string | undefined;
829
687
  }
830
688
  /** Request message for DeleteDefaultWarehouseOverride. */
831
- export interface DeleteDefaultWarehouseOverrideRequest {
832
- /**
833
- * Required. The resource name of the default warehouse override to delete.
834
- * Format: default-warehouse-overrides/{default_warehouse_override_id}
835
- * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
836
- */
837
- name?: string | undefined;
838
- }
839
- export interface DeleteWarehouseResponse {
689
+ interface DeleteDefaultWarehouseOverrideRequest {
690
+ /**
691
+ * Required. The resource name of the default warehouse override to delete.
692
+ * Format: default-warehouse-overrides/{default_warehouse_override_id}
693
+ * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
694
+ */
695
+ name?: string | undefined;
840
696
  }
697
+ interface DeleteWarehouseResponse {}
841
698
  /**
842
699
  * This is an incremental edit functionality, so all fields except id are optional. If a field is set, the corresponding
843
700
  * configuration in the SQL warehouse is modified. If a field is unset, the existing configuration value in the SQL
844
701
  * warehouse is retained. Thus, this API is not idempotent.
845
702
  */
846
- export interface EditWarehouseRequest {
847
- /** Required. Id of the warehouse to configure. */
848
- id?: string | undefined;
849
- /**
850
- * Logical name for the cluster.
851
- *
852
- * Supported values:
853
- * - Must be unique within an org.
854
- * - Must be less than 100 characters.
855
- */
856
- name?: string | undefined;
857
- /**
858
- * Size of the clusters allocated for this warehouse.
859
- * Increasing the size of a spark cluster allows you to run larger queries on
860
- * it. If you want to increase the number of concurrent queries, please tune
861
- * max_num_clusters.
862
- *
863
- * Supported values:
864
- * - 2X-Small
865
- * - X-Small
866
- * - Small
867
- * - Medium
868
- * - Large
869
- * - X-Large
870
- * - 2X-Large
871
- * - 3X-Large
872
- * - 4X-Large
873
- * - 5X-Large
874
- */
875
- clusterSize?: string | undefined;
876
- /**
877
- * Minimum number of available clusters that will be maintained for this SQL
878
- * warehouse. Increasing this will ensure that a larger number of clusters are
879
- * always running and therefore may reduce the cold start time for new
880
- * queries. This is similar to reserved vs. revocable cores in a resource
881
- * manager.
882
- *
883
- * Supported values:
884
- * - Must be > 0
885
- * - Must be <= min(max_num_clusters, 30)
886
- *
887
- * Defaults to 1
888
- */
889
- minNumClusters?: number | undefined;
890
- /**
891
- * Maximum number of clusters that the autoscaler will create to handle
892
- * concurrent queries.
893
- *
894
- * Supported values:
895
- * - Must be >= min_num_clusters
896
- * - Must be <= 40.
897
- *
898
- * Defaults to min_clusters if unset.
899
- */
900
- maxNumClusters?: number | undefined;
901
- /**
902
- * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
903
- * RUNNING queries) before it is automatically stopped.
904
- *
905
- * Supported values:
906
- * - Must be == 0 or >= 10 mins
907
- * - 0 indicates no autostop.
908
- *
909
- * Defaults to 120 mins
910
- */
911
- autoStopMins?: number | undefined;
912
- /** warehouse creator name */
913
- creatorName?: string | undefined;
914
- /** Deprecated. Instance profile used to pass IAM role to the cluster */
915
- instanceProfileArn?: string | undefined;
916
- /**
917
- * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
918
- * with this SQL warehouse.
919
- *
920
- * Supported values:
921
- * - Number of tags < 45.
922
- */
923
- tags?: EndpointTags | undefined;
924
- /** Configurations whether the endpoint should use spot instances. */
925
- spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
926
- /**
927
- * Configures whether the warehouse should use Photon optimized clusters.
928
- *
929
- * Defaults to true.
930
- */
931
- enablePhoton?: boolean | undefined;
932
- /** Channel Details */
933
- channel?: Channel | undefined;
934
- /** Configures whether the warehouse should use serverless compute */
935
- enableServerlessCompute?: boolean | undefined;
936
- /**
937
- * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
938
- * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
939
- */
940
- warehouseType?: WarehouseType | undefined;
941
- }
942
- export interface EditWarehouseResponse {
703
+ interface EditWarehouseRequest {
704
+ /** Required. Id of the warehouse to configure. */
705
+ id?: string | undefined;
706
+ /**
707
+ * Logical name for the cluster.
708
+ *
709
+ * Supported values:
710
+ * - Must be unique within an org.
711
+ * - Must be less than 100 characters.
712
+ */
713
+ name?: string | undefined;
714
+ /**
715
+ * Size of the clusters allocated for this warehouse.
716
+ * Increasing the size of a spark cluster allows you to run larger queries on
717
+ * it. If you want to increase the number of concurrent queries, please tune
718
+ * max_num_clusters.
719
+ *
720
+ * Supported values:
721
+ * - 2X-Small
722
+ * - X-Small
723
+ * - Small
724
+ * - Medium
725
+ * - Large
726
+ * - X-Large
727
+ * - 2X-Large
728
+ * - 3X-Large
729
+ * - 4X-Large
730
+ * - 5X-Large
731
+ */
732
+ clusterSize?: string | undefined;
733
+ /**
734
+ * Minimum number of available clusters that will be maintained for this SQL
735
+ * warehouse. Increasing this will ensure that a larger number of clusters are
736
+ * always running and therefore may reduce the cold start time for new
737
+ * queries. This is similar to reserved vs. revocable cores in a resource
738
+ * manager.
739
+ *
740
+ * Supported values:
741
+ * - Must be > 0
742
+ * - Must be <= min(max_num_clusters, 30)
743
+ *
744
+ * Defaults to 1
745
+ */
746
+ minNumClusters?: number | undefined;
747
+ /**
748
+ * Maximum number of clusters that the autoscaler will create to handle
749
+ * concurrent queries.
750
+ *
751
+ * Supported values:
752
+ * - Must be >= min_num_clusters
753
+ * - Must be <= 40.
754
+ *
755
+ * Defaults to min_clusters if unset.
756
+ */
757
+ maxNumClusters?: number | undefined;
758
+ /**
759
+ * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
760
+ * RUNNING queries) before it is automatically stopped.
761
+ *
762
+ * Supported values:
763
+ * - Must be == 0 or >= 10 mins
764
+ * - 0 indicates no autostop.
765
+ *
766
+ * Defaults to 120 mins
767
+ */
768
+ autoStopMins?: number | undefined;
769
+ /** warehouse creator name */
770
+ creatorName?: string | undefined;
771
+ /** Deprecated. Instance profile used to pass IAM role to the cluster */
772
+ instanceProfileArn?: string | undefined;
773
+ /**
774
+ * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
775
+ * with this SQL warehouse.
776
+ *
777
+ * Supported values:
778
+ * - Number of tags < 45.
779
+ */
780
+ tags?: EndpointTags | undefined;
781
+ /** Configurations whether the endpoint should use spot instances. */
782
+ spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
783
+ /**
784
+ * Configures whether the warehouse should use Photon optimized clusters.
785
+ *
786
+ * Defaults to true.
787
+ */
788
+ enablePhoton?: boolean | undefined;
789
+ /** Channel Details */
790
+ channel?: Channel | undefined;
791
+ /** Configures whether the warehouse should use serverless compute */
792
+ enableServerlessCompute?: boolean | undefined;
793
+ /**
794
+ * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
795
+ * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
796
+ */
797
+ warehouseType?: WarehouseType | undefined;
943
798
  }
944
- export interface EndpointConfPair {
945
- key?: string | undefined;
946
- value?: string | undefined;
799
+ interface EditWarehouseResponse {}
800
+ interface EndpointConfPair {
801
+ key?: string | undefined;
802
+ value?: string | undefined;
947
803
  }
948
- export interface EndpointHealth {
949
- /** Health status of the endpoint. */
950
- status?: EndpointHealth_Status | undefined;
951
- /** Deprecated. split into summary and details for security */
952
- message?: string | undefined;
953
- /** The reason for failure to bring up clusters for this warehouse. This is available when status is 'FAILED' and sometimes when it is DEGRADED. */
954
- failureReason?: TerminationReason | undefined;
955
- /** A short summary of the health status in case of degraded/failed warehouses. */
956
- summary?: string | undefined;
957
- /** Details about errors that are causing current degraded/failed status. */
958
- details?: string | undefined;
804
+ interface EndpointHealth {
805
+ /** Health status of the endpoint. */
806
+ status?: EndpointHealth_Status | undefined;
807
+ /** Deprecated. split into summary and details for security */
808
+ message?: string | undefined;
809
+ /** The reason for failure to bring up clusters for this warehouse. This is available when status is 'FAILED' and sometimes when it is DEGRADED. */
810
+ failureReason?: TerminationReason | undefined;
811
+ /** A short summary of the health status in case of degraded/failed warehouses. */
812
+ summary?: string | undefined;
813
+ /** Details about errors that are causing current degraded/failed status. */
814
+ details?: string | undefined;
959
815
  }
960
- export interface EndpointInfo {
961
- /** unique identifier for warehouse */
962
- id?: string | undefined;
963
- /**
964
- * Logical name for the cluster.
965
- *
966
- * Supported values:
967
- * - Must be unique within an org.
968
- * - Must be less than 100 characters.
969
- */
970
- name?: string | undefined;
971
- /**
972
- * Size of the clusters allocated for this warehouse.
973
- * Increasing the size of a spark cluster allows you to run larger queries on
974
- * it. If you want to increase the number of concurrent queries, please tune
975
- * max_num_clusters.
976
- *
977
- * Supported values:
978
- * - 2X-Small
979
- * - X-Small
980
- * - Small
981
- * - Medium
982
- * - Large
983
- * - X-Large
984
- * - 2X-Large
985
- * - 3X-Large
986
- * - 4X-Large
987
- * - 5X-Large
988
- */
989
- clusterSize?: string | undefined;
990
- /**
991
- * Minimum number of available clusters that will be maintained for this SQL
992
- * warehouse. Increasing this will ensure that a larger number of clusters are
993
- * always running and therefore may reduce the cold start time for new
994
- * queries. This is similar to reserved vs. revocable cores in a resource
995
- * manager.
996
- *
997
- * Supported values:
998
- * - Must be > 0
999
- * - Must be <= min(max_num_clusters, 30)
1000
- *
1001
- * Defaults to 1
1002
- */
1003
- minNumClusters?: number | undefined;
1004
- /**
1005
- * Maximum number of clusters that the autoscaler will create to handle
1006
- * concurrent queries.
1007
- *
1008
- * Supported values:
1009
- * - Must be >= min_num_clusters
1010
- * - Must be <= 40.
1011
- *
1012
- * Defaults to min_clusters if unset.
1013
- */
1014
- maxNumClusters?: number | undefined;
1015
- /**
1016
- * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
1017
- * RUNNING queries) before it is automatically stopped.
1018
- *
1019
- * Supported values:
1020
- * - Must be == 0 or >= 10 mins
1021
- * - 0 indicates no autostop.
1022
- *
1023
- * Defaults to 120 mins
1024
- */
1025
- autoStopMins?: number | undefined;
1026
- /** warehouse creator name */
1027
- creatorName?: string | undefined;
1028
- /** Deprecated. Instance profile used to pass IAM role to the cluster */
1029
- instanceProfileArn?: string | undefined;
1030
- /**
1031
- * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
1032
- * with this SQL warehouse.
1033
- *
1034
- * Supported values:
1035
- * - Number of tags < 45.
1036
- */
1037
- tags?: EndpointTags | undefined;
1038
- /** Configurations whether the endpoint should use spot instances. */
1039
- spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
1040
- /**
1041
- * Configures whether the warehouse should use Photon optimized clusters.
1042
- *
1043
- * Defaults to true.
1044
- */
1045
- enablePhoton?: boolean | undefined;
1046
- /** Channel Details */
1047
- channel?: Channel | undefined;
1048
- /** Configures whether the warehouse should use serverless compute */
1049
- enableServerlessCompute?: boolean | undefined;
1050
- /**
1051
- * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
1052
- * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
1053
- */
1054
- warehouseType?: WarehouseType | undefined;
1055
- /** current number of clusters running for the service */
1056
- numClusters?: number | undefined;
1057
- /** Deprecated. current number of active sessions for the warehouse */
1058
- numActiveSessions?: bigint | undefined;
1059
- /** state of the endpoint */
1060
- state?: EndpointState | undefined;
1061
- /** the jdbc connection string for this warehouse */
1062
- jdbcUrl?: string | undefined;
1063
- /** ODBC parameters for the SQL warehouse */
1064
- odbcParams?: OdbcParams | undefined;
1065
- /** Optional health status. Assume the warehouse is healthy if this field is not set. */
1066
- health?: EndpointHealth | undefined;
816
+ interface EndpointInfo {
817
+ /** unique identifier for warehouse */
818
+ id?: string | undefined;
819
+ /**
820
+ * Logical name for the cluster.
821
+ *
822
+ * Supported values:
823
+ * - Must be unique within an org.
824
+ * - Must be less than 100 characters.
825
+ */
826
+ name?: string | undefined;
827
+ /**
828
+ * Size of the clusters allocated for this warehouse.
829
+ * Increasing the size of a spark cluster allows you to run larger queries on
830
+ * it. If you want to increase the number of concurrent queries, please tune
831
+ * max_num_clusters.
832
+ *
833
+ * Supported values:
834
+ * - 2X-Small
835
+ * - X-Small
836
+ * - Small
837
+ * - Medium
838
+ * - Large
839
+ * - X-Large
840
+ * - 2X-Large
841
+ * - 3X-Large
842
+ * - 4X-Large
843
+ * - 5X-Large
844
+ */
845
+ clusterSize?: string | undefined;
846
+ /**
847
+ * Minimum number of available clusters that will be maintained for this SQL
848
+ * warehouse. Increasing this will ensure that a larger number of clusters are
849
+ * always running and therefore may reduce the cold start time for new
850
+ * queries. This is similar to reserved vs. revocable cores in a resource
851
+ * manager.
852
+ *
853
+ * Supported values:
854
+ * - Must be > 0
855
+ * - Must be <= min(max_num_clusters, 30)
856
+ *
857
+ * Defaults to 1
858
+ */
859
+ minNumClusters?: number | undefined;
860
+ /**
861
+ * Maximum number of clusters that the autoscaler will create to handle
862
+ * concurrent queries.
863
+ *
864
+ * Supported values:
865
+ * - Must be >= min_num_clusters
866
+ * - Must be <= 40.
867
+ *
868
+ * Defaults to min_clusters if unset.
869
+ */
870
+ maxNumClusters?: number | undefined;
871
+ /**
872
+ * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
873
+ * RUNNING queries) before it is automatically stopped.
874
+ *
875
+ * Supported values:
876
+ * - Must be == 0 or >= 10 mins
877
+ * - 0 indicates no autostop.
878
+ *
879
+ * Defaults to 120 mins
880
+ */
881
+ autoStopMins?: number | undefined;
882
+ /** warehouse creator name */
883
+ creatorName?: string | undefined;
884
+ /** Deprecated. Instance profile used to pass IAM role to the cluster */
885
+ instanceProfileArn?: string | undefined;
886
+ /**
887
+ * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
888
+ * with this SQL warehouse.
889
+ *
890
+ * Supported values:
891
+ * - Number of tags < 45.
892
+ */
893
+ tags?: EndpointTags | undefined;
894
+ /** Configurations whether the endpoint should use spot instances. */
895
+ spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
896
+ /**
897
+ * Configures whether the warehouse should use Photon optimized clusters.
898
+ *
899
+ * Defaults to true.
900
+ */
901
+ enablePhoton?: boolean | undefined;
902
+ /** Channel Details */
903
+ channel?: Channel | undefined;
904
+ /** Configures whether the warehouse should use serverless compute */
905
+ enableServerlessCompute?: boolean | undefined;
906
+ /**
907
+ * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
908
+ * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
909
+ */
910
+ warehouseType?: WarehouseType | undefined;
911
+ /** current number of clusters running for the service */
912
+ numClusters?: number | undefined;
913
+ /** Deprecated. current number of active sessions for the warehouse */
914
+ numActiveSessions?: bigint | undefined;
915
+ /** state of the endpoint */
916
+ state?: EndpointState | undefined;
917
+ /** the jdbc connection string for this warehouse */
918
+ jdbcUrl?: string | undefined;
919
+ /** ODBC parameters for the SQL warehouse */
920
+ odbcParams?: OdbcParams | undefined;
921
+ /** Optional health status. Assume the warehouse is healthy if this field is not set. */
922
+ health?: EndpointHealth | undefined;
1067
923
  }
1068
- export interface EndpointTagPair {
1069
- key?: string | undefined;
1070
- value?: string | undefined;
924
+ interface EndpointTagPair {
925
+ key?: string | undefined;
926
+ value?: string | undefined;
1071
927
  }
1072
- export interface EndpointTags {
1073
- customTags?: EndpointTagPair[] | undefined;
928
+ interface EndpointTags {
929
+ customTags?: EndpointTagPair[] | undefined;
1074
930
  }
1075
931
  /** Request message for GetDefaultWarehouseOverride. */
1076
- export interface GetDefaultWarehouseOverrideRequest {
1077
- /**
1078
- * Required. The resource name of the default warehouse override to retrieve.
1079
- * Format: default-warehouse-overrides/{default_warehouse_override_id}
1080
- * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
1081
- */
1082
- name?: string | undefined;
932
+ interface GetDefaultWarehouseOverrideRequest {
933
+ /**
934
+ * Required. The resource name of the default warehouse override to retrieve.
935
+ * Format: default-warehouse-overrides/{default_warehouse_override_id}
936
+ * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
937
+ */
938
+ name?: string | undefined;
1083
939
  }
1084
940
  /** Fetches the warehouse info for a single SQL warehouse. */
1085
- export interface GetWarehouseRequest {
1086
- /** Required. Id of the SQL warehouse. */
1087
- id?: string | undefined;
941
+ interface GetWarehouseRequest {
942
+ /** Required. Id of the SQL warehouse. */
943
+ id?: string | undefined;
1088
944
  }
1089
- export interface GetWarehouseResponse {
1090
- /** unique identifier for warehouse */
1091
- id?: string | undefined;
1092
- /**
1093
- * Logical name for the cluster.
1094
- *
1095
- * Supported values:
1096
- * - Must be unique within an org.
1097
- * - Must be less than 100 characters.
1098
- */
1099
- name?: string | undefined;
1100
- /**
1101
- * Size of the clusters allocated for this warehouse.
1102
- * Increasing the size of a spark cluster allows you to run larger queries on
1103
- * it. If you want to increase the number of concurrent queries, please tune
1104
- * max_num_clusters.
1105
- *
1106
- * Supported values:
1107
- * - 2X-Small
1108
- * - X-Small
1109
- * - Small
1110
- * - Medium
1111
- * - Large
1112
- * - X-Large
1113
- * - 2X-Large
1114
- * - 3X-Large
1115
- * - 4X-Large
1116
- * - 5X-Large
1117
- */
1118
- clusterSize?: string | undefined;
1119
- /**
1120
- * Minimum number of available clusters that will be maintained for this SQL
1121
- * warehouse. Increasing this will ensure that a larger number of clusters are
1122
- * always running and therefore may reduce the cold start time for new
1123
- * queries. This is similar to reserved vs. revocable cores in a resource
1124
- * manager.
1125
- *
1126
- * Supported values:
1127
- * - Must be > 0
1128
- * - Must be <= min(max_num_clusters, 30)
1129
- *
1130
- * Defaults to 1
1131
- */
1132
- minNumClusters?: number | undefined;
1133
- /**
1134
- * Maximum number of clusters that the autoscaler will create to handle
1135
- * concurrent queries.
1136
- *
1137
- * Supported values:
1138
- * - Must be >= min_num_clusters
1139
- * - Must be <= 40.
1140
- *
1141
- * Defaults to min_clusters if unset.
1142
- */
1143
- maxNumClusters?: number | undefined;
1144
- /**
1145
- * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
1146
- * RUNNING queries) before it is automatically stopped.
1147
- *
1148
- * Supported values:
1149
- * - Must be == 0 or >= 10 mins
1150
- * - 0 indicates no autostop.
1151
- *
1152
- * Defaults to 120 mins
1153
- */
1154
- autoStopMins?: number | undefined;
1155
- /** warehouse creator name */
1156
- creatorName?: string | undefined;
1157
- /** Deprecated. Instance profile used to pass IAM role to the cluster */
1158
- instanceProfileArn?: string | undefined;
1159
- /**
1160
- * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
1161
- * with this SQL warehouse.
1162
- *
1163
- * Supported values:
1164
- * - Number of tags < 45.
1165
- */
1166
- tags?: EndpointTags | undefined;
1167
- /** Configurations whether the endpoint should use spot instances. */
1168
- spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
1169
- /**
1170
- * Configures whether the warehouse should use Photon optimized clusters.
1171
- *
1172
- * Defaults to true.
1173
- */
1174
- enablePhoton?: boolean | undefined;
1175
- /** Channel Details */
1176
- channel?: Channel | undefined;
1177
- /** Configures whether the warehouse should use serverless compute */
1178
- enableServerlessCompute?: boolean | undefined;
1179
- /**
1180
- * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
1181
- * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
1182
- */
1183
- warehouseType?: WarehouseType | undefined;
1184
- /** current number of clusters running for the service */
1185
- numClusters?: number | undefined;
1186
- /** Deprecated. current number of active sessions for the warehouse */
1187
- numActiveSessions?: bigint | undefined;
1188
- /** state of the endpoint */
1189
- state?: EndpointState | undefined;
1190
- /** the jdbc connection string for this warehouse */
1191
- jdbcUrl?: string | undefined;
1192
- /** ODBC parameters for the SQL warehouse */
1193
- odbcParams?: OdbcParams | undefined;
1194
- /** Optional health status. Assume the warehouse is healthy if this field is not set. */
1195
- health?: EndpointHealth | undefined;
945
+ interface GetWarehouseResponse {
946
+ /** unique identifier for warehouse */
947
+ id?: string | undefined;
948
+ /**
949
+ * Logical name for the cluster.
950
+ *
951
+ * Supported values:
952
+ * - Must be unique within an org.
953
+ * - Must be less than 100 characters.
954
+ */
955
+ name?: string | undefined;
956
+ /**
957
+ * Size of the clusters allocated for this warehouse.
958
+ * Increasing the size of a spark cluster allows you to run larger queries on
959
+ * it. If you want to increase the number of concurrent queries, please tune
960
+ * max_num_clusters.
961
+ *
962
+ * Supported values:
963
+ * - 2X-Small
964
+ * - X-Small
965
+ * - Small
966
+ * - Medium
967
+ * - Large
968
+ * - X-Large
969
+ * - 2X-Large
970
+ * - 3X-Large
971
+ * - 4X-Large
972
+ * - 5X-Large
973
+ */
974
+ clusterSize?: string | undefined;
975
+ /**
976
+ * Minimum number of available clusters that will be maintained for this SQL
977
+ * warehouse. Increasing this will ensure that a larger number of clusters are
978
+ * always running and therefore may reduce the cold start time for new
979
+ * queries. This is similar to reserved vs. revocable cores in a resource
980
+ * manager.
981
+ *
982
+ * Supported values:
983
+ * - Must be > 0
984
+ * - Must be <= min(max_num_clusters, 30)
985
+ *
986
+ * Defaults to 1
987
+ */
988
+ minNumClusters?: number | undefined;
989
+ /**
990
+ * Maximum number of clusters that the autoscaler will create to handle
991
+ * concurrent queries.
992
+ *
993
+ * Supported values:
994
+ * - Must be >= min_num_clusters
995
+ * - Must be <= 40.
996
+ *
997
+ * Defaults to min_clusters if unset.
998
+ */
999
+ maxNumClusters?: number | undefined;
1000
+ /**
1001
+ * The amount of time in minutes that a SQL warehouse must be idle (i.e., no
1002
+ * RUNNING queries) before it is automatically stopped.
1003
+ *
1004
+ * Supported values:
1005
+ * - Must be == 0 or >= 10 mins
1006
+ * - 0 indicates no autostop.
1007
+ *
1008
+ * Defaults to 120 mins
1009
+ */
1010
+ autoStopMins?: number | undefined;
1011
+ /** warehouse creator name */
1012
+ creatorName?: string | undefined;
1013
+ /** Deprecated. Instance profile used to pass IAM role to the cluster */
1014
+ instanceProfileArn?: string | undefined;
1015
+ /**
1016
+ * A set of key-value pairs that will be tagged on all resources (e.g., AWS instances and EBS volumes) associated
1017
+ * with this SQL warehouse.
1018
+ *
1019
+ * Supported values:
1020
+ * - Number of tags < 45.
1021
+ */
1022
+ tags?: EndpointTags | undefined;
1023
+ /** Configurations whether the endpoint should use spot instances. */
1024
+ spotInstancePolicy?: EndpointSpotInstancePolicy | undefined;
1025
+ /**
1026
+ * Configures whether the warehouse should use Photon optimized clusters.
1027
+ *
1028
+ * Defaults to true.
1029
+ */
1030
+ enablePhoton?: boolean | undefined;
1031
+ /** Channel Details */
1032
+ channel?: Channel | undefined;
1033
+ /** Configures whether the warehouse should use serverless compute */
1034
+ enableServerlessCompute?: boolean | undefined;
1035
+ /**
1036
+ * Warehouse type: `PRO` or `CLASSIC`. If you want to use serverless compute,
1037
+ * you must set to `PRO` and also set the field `enable_serverless_compute` to `true`.
1038
+ */
1039
+ warehouseType?: WarehouseType | undefined;
1040
+ /** current number of clusters running for the service */
1041
+ numClusters?: number | undefined;
1042
+ /** Deprecated. current number of active sessions for the warehouse */
1043
+ numActiveSessions?: bigint | undefined;
1044
+ /** state of the endpoint */
1045
+ state?: EndpointState | undefined;
1046
+ /** the jdbc connection string for this warehouse */
1047
+ jdbcUrl?: string | undefined;
1048
+ /** ODBC parameters for the SQL warehouse */
1049
+ odbcParams?: OdbcParams | undefined;
1050
+ /** Optional health status. Assume the warehouse is healthy if this field is not set. */
1051
+ health?: EndpointHealth | undefined;
1196
1052
  }
1197
1053
  /**
1198
1054
  * Fetches the workspace level SQL warehouse configurations. These are the configurations that are set centrally and
1199
1055
  * shared by all SQL warehouses in a workspace.
1200
1056
  */
1201
- export interface GetWorkspaceWarehouseConfigRequest {
1202
- }
1203
- export interface GetWorkspaceWarehouseConfigResponse {
1204
- /** Security policy for warehouses */
1205
- securityPolicy?: EndpointSecurityPolicy | undefined;
1206
- /**
1207
- * Spark confs for external hive metastore configuration
1208
- * JSON serialized size must be less than <= 512K
1209
- */
1210
- dataAccessConfig?: EndpointConfPair[] | undefined;
1211
- /**
1212
- * AWS Only: The instance profile used to pass an IAM role to the SQL
1213
- * warehouses. This configuration is also applied to the workspace's
1214
- * serverless compute for notebooks and jobs.
1215
- */
1216
- instanceProfileArn?: string | undefined;
1217
- /** Optional: Channel selection details */
1218
- channel?: Channel | undefined;
1219
- /** Deprecated: only setting this to true is allowed. */
1220
- enableServerlessCompute?: boolean | undefined;
1221
- /** Deprecated: Use sql_configuration_parameters */
1222
- globalParam?: RepeatedEndpointConfPairs | undefined;
1223
- /** Deprecated: Use sql_configuration_parameters */
1224
- configParam?: RepeatedEndpointConfPairs | undefined;
1225
- /** SQL configuration parameters */
1226
- sqlConfigurationParameters?: RepeatedEndpointConfPairs | undefined;
1227
- /**
1228
- * GCP only: Google Service Account used to pass to cluster to access Google
1229
- * Cloud Storage
1230
- */
1231
- googleServiceAccount?: string | undefined;
1232
- /**
1233
- * List of Warehouse Types allowed in this workspace (limits allowed value of
1234
- * the type field in CreateWarehouse and EditWarehouse). Note: Some types
1235
- * cannot be disabled, they don't need to be specified
1236
- * in SetWorkspaceWarehouseConfig.
1237
- * Note: Disabling a type may cause existing warehouses to be converted to
1238
- * another type. Used by frontend to save specific type availability in the
1239
- * warehouse create and edit form UI.
1240
- */
1241
- enabledWarehouseTypes?: WarehouseTypePair[] | undefined;
1057
+ interface GetWorkspaceWarehouseConfigRequest {}
1058
+ interface GetWorkspaceWarehouseConfigResponse {
1059
+ /** Security policy for warehouses */
1060
+ securityPolicy?: EndpointSecurityPolicy | undefined;
1061
+ /**
1062
+ * Spark confs for external hive metastore configuration
1063
+ * JSON serialized size must be less than <= 512K
1064
+ */
1065
+ dataAccessConfig?: EndpointConfPair[] | undefined;
1066
+ /**
1067
+ * AWS Only: The instance profile used to pass an IAM role to the SQL
1068
+ * warehouses. This configuration is also applied to the workspace's
1069
+ * serverless compute for notebooks and jobs.
1070
+ */
1071
+ instanceProfileArn?: string | undefined;
1072
+ /** Optional: Channel selection details */
1073
+ channel?: Channel | undefined;
1074
+ /** Deprecated: only setting this to true is allowed. */
1075
+ enableServerlessCompute?: boolean | undefined;
1076
+ /** Deprecated: Use sql_configuration_parameters */
1077
+ globalParam?: RepeatedEndpointConfPairs | undefined;
1078
+ /** Deprecated: Use sql_configuration_parameters */
1079
+ configParam?: RepeatedEndpointConfPairs | undefined;
1080
+ /** SQL configuration parameters */
1081
+ sqlConfigurationParameters?: RepeatedEndpointConfPairs | undefined;
1082
+ /**
1083
+ * GCP only: Google Service Account used to pass to cluster to access Google
1084
+ * Cloud Storage
1085
+ */
1086
+ googleServiceAccount?: string | undefined;
1087
+ /**
1088
+ * List of Warehouse Types allowed in this workspace (limits allowed value of
1089
+ * the type field in CreateWarehouse and EditWarehouse). Note: Some types
1090
+ * cannot be disabled, they don't need to be specified
1091
+ * in SetWorkspaceWarehouseConfig.
1092
+ * Note: Disabling a type may cause existing warehouses to be converted to
1093
+ * another type. Used by frontend to save specific type availability in the
1094
+ * warehouse create and edit form UI.
1095
+ */
1096
+ enabledWarehouseTypes?: WarehouseTypePair[] | undefined;
1242
1097
  }
1243
1098
  /** Request message for ListDefaultWarehouseOverrides. */
1244
- export interface ListDefaultWarehouseOverridesRequest {
1245
- /**
1246
- * The maximum number of overrides to return. The service may return fewer than
1247
- * this value.
1248
- * If unspecified, at most 100 overrides will be returned.
1249
- * The maximum value is 1000; values above 1000 will be coerced to 1000.
1250
- */
1251
- pageSize?: number | undefined;
1252
- /**
1253
- * A page token, received from a previous `ListDefaultWarehouseOverrides` call.
1254
- * Provide this to retrieve the subsequent page.
1255
- *
1256
- * When paginating, all other parameters provided to `ListDefaultWarehouseOverrides`
1257
- * must match the call that provided the page token.
1258
- */
1259
- pageToken?: string | undefined;
1099
+ interface ListDefaultWarehouseOverridesRequest {
1100
+ /**
1101
+ * The maximum number of overrides to return. The service may return fewer than
1102
+ * this value.
1103
+ * If unspecified, at most 100 overrides will be returned.
1104
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
1105
+ */
1106
+ pageSize?: number | undefined;
1107
+ /**
1108
+ * A page token, received from a previous `ListDefaultWarehouseOverrides` call.
1109
+ * Provide this to retrieve the subsequent page.
1110
+ *
1111
+ * When paginating, all other parameters provided to `ListDefaultWarehouseOverrides`
1112
+ * must match the call that provided the page token.
1113
+ */
1114
+ pageToken?: string | undefined;
1260
1115
  }
1261
1116
  /** Response message for ListDefaultWarehouseOverrides. */
1262
- export interface ListDefaultWarehouseOverridesResponse {
1263
- /** The default warehouse overrides in the workspace. */
1264
- defaultWarehouseOverrides?: DefaultWarehouseOverride[] | undefined;
1265
- /**
1266
- * A token, which can be sent as `page_token` to retrieve the next page.
1267
- * If this field is omitted, there are no subsequent pages.
1268
- */
1269
- nextPageToken?: string | undefined;
1117
+ interface ListDefaultWarehouseOverridesResponse {
1118
+ /** The default warehouse overrides in the workspace. */
1119
+ defaultWarehouseOverrides?: DefaultWarehouseOverride[] | undefined;
1120
+ /**
1121
+ * A token, which can be sent as `page_token` to retrieve the next page.
1122
+ * If this field is omitted, there are no subsequent pages.
1123
+ */
1124
+ nextPageToken?: string | undefined;
1270
1125
  }
1271
- export interface ListWarehousesResponse {
1272
- /** A list of warehouses and their configurations. */
1273
- warehouses?: EndpointInfo[] | undefined;
1274
- /**
1275
- * A token, which can be sent as `page_token` to retrieve the next page.
1276
- * If this field is omitted, there are no subsequent pages.
1277
- */
1278
- nextPageToken?: string | undefined;
1126
+ interface ListWarehousesResponse {
1127
+ /** A list of warehouses and their configurations. */
1128
+ warehouses?: EndpointInfo[] | undefined;
1129
+ /**
1130
+ * A token, which can be sent as `page_token` to retrieve the next page.
1131
+ * If this field is omitted, there are no subsequent pages.
1132
+ */
1133
+ nextPageToken?: string | undefined;
1279
1134
  }
1280
- export interface OdbcParams {
1281
- hostname?: string | undefined;
1282
- path?: string | undefined;
1283
- protocol?: string | undefined;
1284
- port?: number | undefined;
1135
+ interface OdbcParams {
1136
+ hostname?: string | undefined;
1137
+ path?: string | undefined;
1138
+ protocol?: string | undefined;
1139
+ port?: number | undefined;
1285
1140
  }
1286
- export interface RepeatedEndpointConfPairs {
1287
- /** Deprecated: Use configuration_pairs */
1288
- configPair?: EndpointConfPair[] | undefined;
1289
- configurationPairs?: EndpointConfPair[] | undefined;
1141
+ interface RepeatedEndpointConfPairs {
1142
+ /** Deprecated: Use configuration_pairs */
1143
+ configPair?: EndpointConfPair[] | undefined;
1144
+ configurationPairs?: EndpointConfPair[] | undefined;
1290
1145
  }
1291
1146
  /**
1292
1147
  * Sets the workspace level warehouse configuration that is shared by all SQL warehouses in this workspace.
1293
1148
  *
1294
1149
  * This is idempotent.
1295
1150
  */
1296
- export interface SetWorkspaceWarehouseConfigRequest {
1297
- /** Security policy for warehouses */
1298
- securityPolicy?: EndpointSecurityPolicy | undefined;
1299
- /**
1300
- * Spark confs for external hive metastore configuration
1301
- * JSON serialized size must be less than <= 512K
1302
- */
1303
- dataAccessConfig?: EndpointConfPair[] | undefined;
1304
- /**
1305
- * AWS Only: The instance profile used to pass an IAM role to the SQL
1306
- * warehouses. This configuration is also applied to the workspace's
1307
- * serverless compute for notebooks and jobs.
1308
- */
1309
- instanceProfileArn?: string | undefined;
1310
- /** Optional: Channel selection details */
1311
- channel?: Channel | undefined;
1312
- /** Deprecated: only setting this to true is allowed. */
1313
- enableServerlessCompute?: boolean | undefined;
1314
- /** Deprecated: Use sql_configuration_parameters */
1315
- globalParam?: RepeatedEndpointConfPairs | undefined;
1316
- /** Deprecated: Use sql_configuration_parameters */
1317
- configParam?: RepeatedEndpointConfPairs | undefined;
1318
- /** SQL configuration parameters */
1319
- sqlConfigurationParameters?: RepeatedEndpointConfPairs | undefined;
1320
- /**
1321
- * GCP only: Google Service Account used to pass to cluster to access Google
1322
- * Cloud Storage
1323
- */
1324
- googleServiceAccount?: string | undefined;
1325
- /**
1326
- * List of Warehouse Types allowed in this workspace (limits allowed value of
1327
- * the type field in CreateWarehouse and EditWarehouse). Note: Some types
1328
- * cannot be disabled, they don't need to be specified
1329
- * in SetWorkspaceWarehouseConfig.
1330
- * Note: Disabling a type may cause existing warehouses to be converted to
1331
- * another type. Used by frontend to save specific type availability in the
1332
- * warehouse create and edit form UI.
1333
- */
1334
- enabledWarehouseTypes?: WarehouseTypePair[] | undefined;
1335
- }
1336
- export interface SetWorkspaceWarehouseConfigResponse {
1337
- }
1338
- export interface StartResponse {
1339
- }
1340
- export interface StopResponse {
1151
+ interface SetWorkspaceWarehouseConfigRequest {
1152
+ /** Security policy for warehouses */
1153
+ securityPolicy?: EndpointSecurityPolicy | undefined;
1154
+ /**
1155
+ * Spark confs for external hive metastore configuration
1156
+ * JSON serialized size must be less than <= 512K
1157
+ */
1158
+ dataAccessConfig?: EndpointConfPair[] | undefined;
1159
+ /**
1160
+ * AWS Only: The instance profile used to pass an IAM role to the SQL
1161
+ * warehouses. This configuration is also applied to the workspace's
1162
+ * serverless compute for notebooks and jobs.
1163
+ */
1164
+ instanceProfileArn?: string | undefined;
1165
+ /** Optional: Channel selection details */
1166
+ channel?: Channel | undefined;
1167
+ /** Deprecated: only setting this to true is allowed. */
1168
+ enableServerlessCompute?: boolean | undefined;
1169
+ /** Deprecated: Use sql_configuration_parameters */
1170
+ globalParam?: RepeatedEndpointConfPairs | undefined;
1171
+ /** Deprecated: Use sql_configuration_parameters */
1172
+ configParam?: RepeatedEndpointConfPairs | undefined;
1173
+ /** SQL configuration parameters */
1174
+ sqlConfigurationParameters?: RepeatedEndpointConfPairs | undefined;
1175
+ /**
1176
+ * GCP only: Google Service Account used to pass to cluster to access Google
1177
+ * Cloud Storage
1178
+ */
1179
+ googleServiceAccount?: string | undefined;
1180
+ /**
1181
+ * List of Warehouse Types allowed in this workspace (limits allowed value of
1182
+ * the type field in CreateWarehouse and EditWarehouse). Note: Some types
1183
+ * cannot be disabled, they don't need to be specified
1184
+ * in SetWorkspaceWarehouseConfig.
1185
+ * Note: Disabling a type may cause existing warehouses to be converted to
1186
+ * another type. Used by frontend to save specific type availability in the
1187
+ * warehouse create and edit form UI.
1188
+ */
1189
+ enabledWarehouseTypes?: WarehouseTypePair[] | undefined;
1341
1190
  }
1342
- export interface TerminationReason {
1343
- /** status code indicating why the cluster was terminated */
1344
- code?: TerminationCode | undefined;
1345
- /** type of the termination */
1346
- type?: TerminationType | undefined;
1347
- /** list of parameters that provide additional information about why the cluster was terminated */
1348
- parameters?: Record<string, string> | undefined;
1191
+ interface SetWorkspaceWarehouseConfigResponse {}
1192
+ interface StartResponse {}
1193
+ interface StopResponse {}
1194
+ interface TerminationReason {
1195
+ /** status code indicating why the cluster was terminated */
1196
+ code?: TerminationCode | undefined;
1197
+ /** type of the termination */
1198
+ type?: TerminationType | undefined;
1199
+ /** list of parameters that provide additional information about why the cluster was terminated */
1200
+ parameters?: Record<string, string> | undefined;
1349
1201
  }
1350
1202
  /** Request message for UpdateDefaultWarehouseOverride. */
1351
- export interface UpdateDefaultWarehouseOverrideRequest {
1352
- /**
1353
- * Required. The default warehouse override to update.
1354
- * The name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}
1355
- * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
1356
- */
1357
- defaultWarehouseOverride?: DefaultWarehouseOverride | undefined;
1358
- /**
1359
- * Required. Field mask specifying which fields to update.
1360
- * Only the fields specified in the mask will be updated.
1361
- * Use "*" to update all fields.
1362
- * When allow_missing is true, this field is ignored and all fields are applied.
1363
- */
1364
- updateMask?: FieldMask<DefaultWarehouseOverride> | undefined;
1365
- /**
1366
- * If set to true, and the override is not found, a new override will be created.
1367
- * In this situation, `update_mask` is ignored and all fields are applied.
1368
- * Defaults to false.
1369
- */
1370
- allowMissing?: boolean | undefined;
1203
+ interface UpdateDefaultWarehouseOverrideRequest {
1204
+ /**
1205
+ * Required. The default warehouse override to update.
1206
+ * The name field must be set in the format: default-warehouse-overrides/{default_warehouse_override_id}
1207
+ * The default_warehouse_override_id can be a numeric user ID or the literal string "me" for the current user.
1208
+ */
1209
+ defaultWarehouseOverride?: DefaultWarehouseOverride | undefined;
1210
+ /**
1211
+ * Required. Field mask specifying which fields to update.
1212
+ * Only the fields specified in the mask will be updated.
1213
+ * Use "*" to update all fields.
1214
+ * When allow_missing is true, this field is ignored and all fields are applied.
1215
+ */
1216
+ updateMask?: FieldMask<DefaultWarehouseOverride> | undefined;
1217
+ /**
1218
+ * If set to true, and the override is not found, a new override will be created.
1219
+ * In this situation, `update_mask` is ignored and all fields are applied.
1220
+ * Defaults to false.
1221
+ */
1222
+ allowMissing?: boolean | undefined;
1371
1223
  }
1372
1224
  /**
1373
1225
  * *
1374
1226
  * Configuration values to enable or disable the access to specific warehouse
1375
1227
  * types in the workspace.
1376
1228
  */
1377
- export interface WarehouseTypePair {
1378
- warehouseType?: WarehouseType | undefined;
1379
- /**
1380
- * If set to false the specific warehouse type will not be allowed as a
1381
- * value for warehouse_type in CreateWarehouse and EditWarehouse
1382
- */
1383
- enabled?: boolean | undefined;
1229
+ interface WarehouseTypePair {
1230
+ warehouseType?: WarehouseType | undefined;
1231
+ /**
1232
+ * If set to false the specific warehouse type will not be allowed as a
1233
+ * value for warehouse_type in CreateWarehouse and EditWarehouse
1234
+ */
1235
+ enabled?: boolean | undefined;
1384
1236
  }
1385
1237
  /**
1386
1238
  * Deletes a warehouse.
1387
1239
  * This API is idempotent.
1388
1240
  */
1389
- export interface DeleteWarehouseRequest {
1390
- /** Required. Id of the SQL warehouse. */
1391
- id?: string | undefined;
1241
+ interface DeleteWarehouseRequest {
1242
+ /** Required. Id of the SQL warehouse. */
1243
+ id?: string | undefined;
1392
1244
  }
1393
1245
  /**
1394
1246
  * Lists all of the SQL warehouses.
1395
1247
  * TODO: consider paginating to limit the number of warehouses returned.
1396
1248
  */
1397
- export interface ListWarehousesRequest {
1398
- /**
1399
- * Deprecated: this field is ignored by the server.
1400
- * Service Principal which will be used to fetch the list of endpoints.
1401
- * If not specified, SQL Gateway will use the user from the session header.
1402
- */
1403
- runAsUserId?: bigint | undefined;
1404
- /** The max number of warehouses to return. */
1405
- pageSize?: number | undefined;
1406
- /**
1407
- * A page token, received from a previous `ListWarehouses` call.
1408
- * Provide this to retrieve the subsequent page; otherwise the first
1409
- * will be retrieved.
1410
- *
1411
- * When paginating, all other parameters provided to `ListWarehouses` must match
1412
- * the call that provided the page token.
1413
- */
1414
- pageToken?: string | undefined;
1249
+ interface ListWarehousesRequest {
1250
+ /**
1251
+ * Deprecated: this field is ignored by the server.
1252
+ * Service Principal which will be used to fetch the list of endpoints.
1253
+ * If not specified, SQL Gateway will use the user from the session header.
1254
+ */
1255
+ runAsUserId?: bigint | undefined;
1256
+ /** The max number of warehouses to return. */
1257
+ pageSize?: number | undefined;
1258
+ /**
1259
+ * A page token, received from a previous `ListWarehouses` call.
1260
+ * Provide this to retrieve the subsequent page; otherwise the first
1261
+ * will be retrieved.
1262
+ *
1263
+ * When paginating, all other parameters provided to `ListWarehouses` must match
1264
+ * the call that provided the page token.
1265
+ */
1266
+ pageToken?: string | undefined;
1415
1267
  }
1416
1268
  /**
1417
1269
  * Starts a SQL warehouse.
1418
1270
  * This API is idempotent.
1419
1271
  */
1420
- export interface StartRequest {
1421
- /** Required. Id of the SQL warehouse. */
1422
- id?: string | undefined;
1272
+ interface StartRequest {
1273
+ /** Required. Id of the SQL warehouse. */
1274
+ id?: string | undefined;
1423
1275
  }
1424
1276
  /**
1425
1277
  * Stops a SQL warehouse.
1426
1278
  * This API is idempotent.
1427
1279
  */
1428
- export interface StopRequest {
1429
- /** Required. Id of the SQL warehouse. */
1430
- id?: string | undefined;
1280
+ interface StopRequest {
1281
+ /** Required. Id of the SQL warehouse. */
1282
+ id?: string | undefined;
1431
1283
  }
1432
- export declare const unmarshalChannelSchema: z.ZodType<Channel>;
1433
- export declare const unmarshalCreateWarehouseResponseSchema: z.ZodType<CreateWarehouseResponse>;
1434
- export declare const unmarshalDefaultWarehouseOverrideSchema: z.ZodType<DefaultWarehouseOverride>;
1435
- export declare const unmarshalDeleteWarehouseResponseSchema: z.ZodType<DeleteWarehouseResponse>;
1436
- export declare const unmarshalEditWarehouseResponseSchema: z.ZodType<EditWarehouseResponse>;
1437
- export declare const unmarshalEndpointConfPairSchema: z.ZodType<EndpointConfPair>;
1438
- export declare const unmarshalEndpointHealthSchema: z.ZodType<EndpointHealth>;
1439
- export declare const unmarshalEndpointInfoSchema: z.ZodType<EndpointInfo>;
1440
- export declare const unmarshalEndpointTagPairSchema: z.ZodType<EndpointTagPair>;
1441
- export declare const unmarshalEndpointTagsSchema: z.ZodType<EndpointTags>;
1442
- export declare const unmarshalGetWarehouseResponseSchema: z.ZodType<GetWarehouseResponse>;
1443
- export declare const unmarshalGetWorkspaceWarehouseConfigResponseSchema: z.ZodType<GetWorkspaceWarehouseConfigResponse>;
1444
- export declare const unmarshalListDefaultWarehouseOverridesResponseSchema: z.ZodType<ListDefaultWarehouseOverridesResponse>;
1445
- export declare const unmarshalListWarehousesResponseSchema: z.ZodType<ListWarehousesResponse>;
1446
- export declare const unmarshalOdbcParamsSchema: z.ZodType<OdbcParams>;
1447
- export declare const unmarshalRepeatedEndpointConfPairsSchema: z.ZodType<RepeatedEndpointConfPairs>;
1448
- export declare const unmarshalSetWorkspaceWarehouseConfigResponseSchema: z.ZodType<SetWorkspaceWarehouseConfigResponse>;
1449
- export declare const unmarshalStartResponseSchema: z.ZodType<StartResponse>;
1450
- export declare const unmarshalStopResponseSchema: z.ZodType<StopResponse>;
1451
- export declare const unmarshalTerminationReasonSchema: z.ZodType<TerminationReason>;
1452
- export declare const unmarshalWarehouseTypePairSchema: z.ZodType<WarehouseTypePair>;
1453
- export declare const marshalChannelSchema: z.ZodType;
1454
- export declare const marshalCreateWarehouseRequestSchema: z.ZodType;
1455
- export declare const marshalDefaultWarehouseOverrideSchema: z.ZodType;
1456
- export declare const marshalEditWarehouseRequestSchema: z.ZodType;
1457
- export declare const marshalEndpointConfPairSchema: z.ZodType;
1458
- export declare const marshalEndpointTagPairSchema: z.ZodType;
1459
- export declare const marshalEndpointTagsSchema: z.ZodType;
1460
- export declare const marshalRepeatedEndpointConfPairsSchema: z.ZodType;
1461
- export declare const marshalSetWorkspaceWarehouseConfigRequestSchema: z.ZodType;
1462
- export declare const marshalWarehouseTypePairSchema: z.ZodType;
1463
- export declare const marshalStartRequestSchema: z.ZodType;
1464
- export declare const marshalStopRequestSchema: z.ZodType;
1465
- export declare function defaultWarehouseOverrideFieldMask(...paths: string[]): FieldMask<DefaultWarehouseOverride>;
1284
+ declare const unmarshalChannelSchema: z.ZodType<Channel>;
1285
+ declare const unmarshalCreateWarehouseResponseSchema: z.ZodType<CreateWarehouseResponse>;
1286
+ declare const unmarshalDefaultWarehouseOverrideSchema: z.ZodType<DefaultWarehouseOverride>;
1287
+ declare const unmarshalDeleteWarehouseResponseSchema: z.ZodType<DeleteWarehouseResponse>;
1288
+ declare const unmarshalEditWarehouseResponseSchema: z.ZodType<EditWarehouseResponse>;
1289
+ declare const unmarshalEndpointConfPairSchema: z.ZodType<EndpointConfPair>;
1290
+ declare const unmarshalEndpointHealthSchema: z.ZodType<EndpointHealth>;
1291
+ declare const unmarshalEndpointInfoSchema: z.ZodType<EndpointInfo>;
1292
+ declare const unmarshalEndpointTagPairSchema: z.ZodType<EndpointTagPair>;
1293
+ declare const unmarshalEndpointTagsSchema: z.ZodType<EndpointTags>;
1294
+ declare const unmarshalGetWarehouseResponseSchema: z.ZodType<GetWarehouseResponse>;
1295
+ declare const unmarshalGetWorkspaceWarehouseConfigResponseSchema: z.ZodType<GetWorkspaceWarehouseConfigResponse>;
1296
+ declare const unmarshalListDefaultWarehouseOverridesResponseSchema: z.ZodType<ListDefaultWarehouseOverridesResponse>;
1297
+ declare const unmarshalListWarehousesResponseSchema: z.ZodType<ListWarehousesResponse>;
1298
+ declare const unmarshalOdbcParamsSchema: z.ZodType<OdbcParams>;
1299
+ declare const unmarshalRepeatedEndpointConfPairsSchema: z.ZodType<RepeatedEndpointConfPairs>;
1300
+ declare const unmarshalSetWorkspaceWarehouseConfigResponseSchema: z.ZodType<SetWorkspaceWarehouseConfigResponse>;
1301
+ declare const unmarshalStartResponseSchema: z.ZodType<StartResponse>;
1302
+ declare const unmarshalStopResponseSchema: z.ZodType<StopResponse>;
1303
+ declare const unmarshalTerminationReasonSchema: z.ZodType<TerminationReason>;
1304
+ declare const unmarshalWarehouseTypePairSchema: z.ZodType<WarehouseTypePair>;
1305
+ declare const marshalChannelSchema: z.ZodType;
1306
+ declare const marshalCreateWarehouseRequestSchema: z.ZodType;
1307
+ declare const marshalDefaultWarehouseOverrideSchema: z.ZodType;
1308
+ declare const marshalEditWarehouseRequestSchema: z.ZodType;
1309
+ declare const marshalEndpointConfPairSchema: z.ZodType;
1310
+ declare const marshalEndpointTagPairSchema: z.ZodType;
1311
+ declare const marshalEndpointTagsSchema: z.ZodType;
1312
+ declare const marshalRepeatedEndpointConfPairsSchema: z.ZodType;
1313
+ declare const marshalSetWorkspaceWarehouseConfigRequestSchema: z.ZodType;
1314
+ declare const marshalWarehouseTypePairSchema: z.ZodType;
1315
+ declare const marshalStartRequestSchema: z.ZodType;
1316
+ declare const marshalStopRequestSchema: z.ZodType;
1317
+ declare function defaultWarehouseOverrideFieldMask(...paths: string[]): FieldMask<DefaultWarehouseOverride>;
1318
+ //#endregion
1319
+ export { Channel, ChannelName, CreateDefaultWarehouseOverrideRequest, CreateWarehouseRequest, CreateWarehouseResponse, DefaultWarehouseOverride, DefaultWarehouseOverrideType, DeleteDefaultWarehouseOverrideRequest, DeleteWarehouseRequest, DeleteWarehouseResponse, EditWarehouseRequest, EditWarehouseResponse, EndpointConfPair, EndpointHealth, EndpointHealth_Status, EndpointInfo, EndpointSecurityPolicy, EndpointSpotInstancePolicy, EndpointState, EndpointTagPair, EndpointTags, GetDefaultWarehouseOverrideRequest, GetWarehouseRequest, GetWarehouseResponse, GetWorkspaceWarehouseConfigRequest, GetWorkspaceWarehouseConfigResponse, ListDefaultWarehouseOverridesRequest, ListDefaultWarehouseOverridesResponse, ListWarehousesRequest, ListWarehousesResponse, OdbcParams, RepeatedEndpointConfPairs, SetWorkspaceWarehouseConfigRequest, SetWorkspaceWarehouseConfigResponse, StartRequest, StartResponse, StopRequest, StopResponse, TerminationCode, TerminationReason, TerminationType, UpdateDefaultWarehouseOverrideRequest, WarehouseType, WarehouseTypePair, defaultWarehouseOverrideFieldMask, marshalChannelSchema, marshalCreateWarehouseRequestSchema, marshalDefaultWarehouseOverrideSchema, marshalEditWarehouseRequestSchema, marshalEndpointConfPairSchema, marshalEndpointTagPairSchema, marshalEndpointTagsSchema, marshalRepeatedEndpointConfPairsSchema, marshalSetWorkspaceWarehouseConfigRequestSchema, marshalStartRequestSchema, marshalStopRequestSchema, marshalWarehouseTypePairSchema, unmarshalChannelSchema, unmarshalCreateWarehouseResponseSchema, unmarshalDefaultWarehouseOverrideSchema, unmarshalDeleteWarehouseResponseSchema, unmarshalEditWarehouseResponseSchema, unmarshalEndpointConfPairSchema, unmarshalEndpointHealthSchema, unmarshalEndpointInfoSchema, unmarshalEndpointTagPairSchema, unmarshalEndpointTagsSchema, unmarshalGetWarehouseResponseSchema, unmarshalGetWorkspaceWarehouseConfigResponseSchema, unmarshalListDefaultWarehouseOverridesResponseSchema, unmarshalListWarehousesResponseSchema, unmarshalOdbcParamsSchema, unmarshalRepeatedEndpointConfPairsSchema, unmarshalSetWorkspaceWarehouseConfigResponseSchema, unmarshalStartResponseSchema, unmarshalStopResponseSchema, unmarshalTerminationReasonSchema, unmarshalWarehouseTypePairSchema };
1466
1320
  //# sourceMappingURL=model.d.ts.map