@databricks/sdk-instancepools 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,69 +1,63 @@
1
- import { z } from 'zod';
1
+ import { z } from "zod";
2
+
3
+ //#region src/v2/model.d.ts
2
4
  /**
3
5
  * Availability type used for all subsequent nodes past the `first_on_demand` ones.
4
6
  *
5
7
  * Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster.
6
8
  */
7
- export declare const AwsAvailability: {
8
- /** Use spot instances. */
9
- readonly SPOT: "SPOT";
10
- /** Use on-demand instances. */
11
- readonly ON_DEMAND: "ON_DEMAND";
12
- /**
13
- * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
14
- * be acquired (e.g., if AWS spot prices are too high).
15
- */
16
- readonly SPOT_WITH_FALLBACK: "SPOT_WITH_FALLBACK";
9
+ declare const AwsAvailability: {
10
+ /** Use spot instances. */readonly SPOT: "SPOT"; /** Use on-demand instances. */
11
+ readonly ON_DEMAND: "ON_DEMAND";
12
+ /**
13
+ * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
14
+ * be acquired (e.g., if AWS spot prices are too high).
15
+ */
16
+ readonly SPOT_WITH_FALLBACK: "SPOT_WITH_FALLBACK";
17
17
  };
18
- export type AwsAvailability = (typeof AwsAvailability)[keyof typeof AwsAvailability] | (string & {});
18
+ type AwsAvailability = (typeof AwsAvailability)[keyof typeof AwsAvailability] | (string & {});
19
19
  /**
20
20
  * Availability type used for all subsequent nodes past the `first_on_demand` ones.
21
21
  * Note: If `first_on_demand` is zero, this availability type will be used for the entire cluster.
22
22
  */
23
- export declare const AzureAvailability: {
24
- /** Use spot instances. */
25
- readonly SPOT_AZURE: "SPOT_AZURE";
26
- /** Use on-demand instances. */
27
- readonly ON_DEMAND_AZURE: "ON_DEMAND_AZURE";
28
- /**
29
- * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
30
- * be acquired (e.g., if Azure is out of Quota).
31
- */
32
- readonly SPOT_WITH_FALLBACK_AZURE: "SPOT_WITH_FALLBACK_AZURE";
23
+ declare const AzureAvailability: {
24
+ /** Use spot instances. */readonly SPOT_AZURE: "SPOT_AZURE"; /** Use on-demand instances. */
25
+ readonly ON_DEMAND_AZURE: "ON_DEMAND_AZURE";
26
+ /**
27
+ * Preferably use spot instances, but fall back to on-demand instances if spot instances cannot
28
+ * be acquired (e.g., if Azure is out of Quota).
29
+ */
30
+ readonly SPOT_WITH_FALLBACK_AZURE: "SPOT_WITH_FALLBACK_AZURE";
33
31
  };
34
- export type AzureAvailability = (typeof AzureAvailability)[keyof typeof AzureAvailability] | (string & {});
32
+ type AzureAvailability = (typeof AzureAvailability)[keyof typeof AzureAvailability] | (string & {});
35
33
  /**
36
34
  * All Azure Disk types that <Databricks> supports.
37
35
  * See https://docs.microsoft.com/en-us/azure/storage/storage-about-disks-and-vhds-linux#types-of-disks
38
36
  */
39
- export declare const AzureDiskVolumeType: {
40
- /** Premium storage tier, backed by SSDs. */
41
- readonly PREMIUM_LRS: "PREMIUM_LRS";
42
- /** Standard storage tier, backed by HDDs. */
43
- readonly STANDARD_LRS: "STANDARD_LRS";
37
+ declare const AzureDiskVolumeType: {
38
+ /** Premium storage tier, backed by SSDs. */readonly PREMIUM_LRS: "PREMIUM_LRS"; /** Standard storage tier, backed by HDDs. */
39
+ readonly STANDARD_LRS: "STANDARD_LRS";
44
40
  };
45
- export type AzureDiskVolumeType = (typeof AzureDiskVolumeType)[keyof typeof AzureDiskVolumeType] | (string & {});
41
+ type AzureDiskVolumeType = (typeof AzureDiskVolumeType)[keyof typeof AzureDiskVolumeType] | (string & {});
46
42
  /**
47
43
  * All EBS volume types that <Databricks> supports.
48
44
  * See https://aws.amazon.com/ebs/details/ for details.
49
45
  */
50
- export declare const EbsVolumeType: {
51
- /** Provision extra storage using AWS gp2 EBS volumes. */
52
- readonly GENERAL_PURPOSE_SSD: "GENERAL_PURPOSE_SSD";
53
- /** Provision extra storage using AWS st1 volumes. */
54
- readonly THROUGHPUT_OPTIMIZED_HDD: "THROUGHPUT_OPTIMIZED_HDD";
46
+ declare const EbsVolumeType: {
47
+ /** Provision extra storage using AWS gp2 EBS volumes. */readonly GENERAL_PURPOSE_SSD: "GENERAL_PURPOSE_SSD"; /** Provision extra storage using AWS st1 volumes. */
48
+ readonly THROUGHPUT_OPTIMIZED_HDD: "THROUGHPUT_OPTIMIZED_HDD";
55
49
  };
56
- export type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType] | (string & {});
50
+ type EbsVolumeType = (typeof EbsVolumeType)[keyof typeof EbsVolumeType] | (string & {});
57
51
  /**
58
52
  * This field determines whether the instance pool will contain preemptible
59
53
  * VMs, on-demand VMs, or preemptible VMs with a fallback to on-demand VMs if the former is unavailable.
60
54
  */
61
- export declare const GcpAvailability: {
62
- readonly PREEMPTIBLE_GCP: "PREEMPTIBLE_GCP";
63
- readonly ON_DEMAND_GCP: "ON_DEMAND_GCP";
64
- readonly PREEMPTIBLE_WITH_FALLBACK_GCP: "PREEMPTIBLE_WITH_FALLBACK_GCP";
55
+ declare const GcpAvailability: {
56
+ readonly PREEMPTIBLE_GCP: "PREEMPTIBLE_GCP";
57
+ readonly ON_DEMAND_GCP: "ON_DEMAND_GCP";
58
+ readonly PREEMPTIBLE_WITH_FALLBACK_GCP: "PREEMPTIBLE_WITH_FALLBACK_GCP";
65
59
  };
66
- export type GcpAvailability = (typeof GcpAvailability)[keyof typeof GcpAvailability] | (string & {});
60
+ type GcpAvailability = (typeof GcpAvailability)[keyof typeof GcpAvailability] | (string & {});
67
61
  /**
68
62
  * The state of a Cluster. The current allowable state transitions are as follows:
69
63
  *
@@ -72,600 +66,596 @@ export type GcpAvailability = (typeof GcpAvailability)[keyof typeof GcpAvailabil
72
66
  * - ``STOPPED`` -> ``ACTIVE``
73
67
  * - ``STOPPED`` -> ``DELETED``
74
68
  */
75
- export declare const InstancePoolState: {
76
- /** Indicates an instance pool is active for use. */
77
- readonly ACTIVE: "ACTIVE";
78
- /**
79
- * Indicates an instance pool has been stopped so no more clusters should be able to get instances
80
- * from the pool.
81
- */
82
- readonly STOPPED: "STOPPED";
83
- /** Indicates the instance pool has been deleted and should no longer exist. */
84
- readonly DELETED: "DELETED";
69
+ declare const InstancePoolState: {
70
+ /** Indicates an instance pool is active for use. */readonly ACTIVE: "ACTIVE";
71
+ /**
72
+ * Indicates an instance pool has been stopped so no more clusters should be able to get instances
73
+ * from the pool.
74
+ */
75
+ readonly STOPPED: "STOPPED"; /** Indicates the instance pool has been deleted and should no longer exist. */
76
+ readonly DELETED: "DELETED";
85
77
  };
86
- export type InstancePoolState = (typeof InstancePoolState)[keyof typeof InstancePoolState] | (string & {});
87
- export interface CreateInstancePoolRequest {
88
- /**
89
- * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
90
- * characters.
91
- */
92
- instancePoolName?: string | undefined;
93
- /** Minimum number of idle instances to keep in the instance pool */
94
- minIdleInstances?: number | undefined;
95
- /**
96
- * Maximum number of outstanding instances to keep in the pool, including both instances used by
97
- * clusters and idle instances. Clusters that require further instance provisioning will fail during
98
- * upsize requests.
99
- */
100
- maxCapacity?: number | undefined;
101
- /**
102
- * Attributes related to instance pools running on Amazon Web Services.
103
- * If not specified at pool creation, a set of default values will be used.
104
- */
105
- awsAttributes?: InstancePoolAwsAttributes | undefined;
106
- /**
107
- * This field encodes, through a single value, the resources available to each of
108
- * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
109
- * and optimized for memory or compute intensive workloads. A list of available node
110
- * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
111
- */
112
- nodeTypeId?: string | undefined;
113
- /**
114
- * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
115
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
116
- *
117
- * - Currently, <Databricks> allows at most 45 custom tags
118
- */
119
- customTags?: Record<string, string> | undefined;
120
- /**
121
- * Automatically terminates the extra instances in the pool cache after they are inactive for this
122
- * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
123
- * instances will be automatically terminated after a default timeout. If specified, the
124
- * threshold must be between 0 and 10000 minutes.
125
- * Users can also set this value to 0 to instantly remove idle instances from the cache if
126
- * min cache size could still hold.
127
- */
128
- idleInstanceAutoterminationMinutes?: number | undefined;
129
- /**
130
- * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
131
- * additional disk space when its Spark workers are running low on disk space. In AWS, this
132
- * feature requires specific AWS permissions to function correctly - refer to the User Guide for
133
- * more details.
134
- */
135
- enableElasticDisk?: boolean | undefined;
136
- /** Defines the specification of the disks that will be attached to all spark containers. */
137
- diskSpec?: DiskSpec | undefined;
138
- /** Custom Docker Image BYOC */
139
- preloadedDockerImages?: DockerImage[] | undefined;
140
- /**
141
- * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
142
- * with the preloaded Spark version will start faster. A list of available Spark versions
143
- * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
144
- */
145
- preloadedSparkVersions?: string[] | undefined;
146
- /**
147
- * Attributes related to instance pools running on Azure.
148
- * If not specified at pool creation, a set of default values will be used.
149
- */
150
- azureAttributes?: InstancePoolAzureAttributes | undefined;
151
- /**
152
- * Attributes related to instance pools running on Google Cloud Platform.
153
- * If not specified at pool creation, a set of default values will be used.
154
- */
155
- gcpAttributes?: InstancePoolGcpAttributes | undefined;
156
- /** Flexible node type configuration for the pool. */
157
- nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
158
- /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
159
- remoteDiskThroughput?: number | undefined;
160
- /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
161
- totalInitialRemoteDiskSize?: number | undefined;
78
+ type InstancePoolState = (typeof InstancePoolState)[keyof typeof InstancePoolState] | (string & {});
79
+ interface CreateInstancePoolRequest {
80
+ /**
81
+ * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
82
+ * characters.
83
+ */
84
+ instancePoolName?: string | undefined;
85
+ /** Minimum number of idle instances to keep in the instance pool */
86
+ minIdleInstances?: number | undefined;
87
+ /**
88
+ * Maximum number of outstanding instances to keep in the pool, including both instances used by
89
+ * clusters and idle instances. Clusters that require further instance provisioning will fail during
90
+ * upsize requests.
91
+ */
92
+ maxCapacity?: number | undefined;
93
+ /**
94
+ * Attributes related to instance pools running on Amazon Web Services.
95
+ * If not specified at pool creation, a set of default values will be used.
96
+ */
97
+ awsAttributes?: InstancePoolAwsAttributes | undefined;
98
+ /**
99
+ * This field encodes, through a single value, the resources available to each of
100
+ * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
101
+ * and optimized for memory or compute intensive workloads. A list of available node
102
+ * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
103
+ */
104
+ nodeTypeId?: string | undefined;
105
+ /**
106
+ * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
107
+ * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
108
+ *
109
+ * - Currently, <Databricks> allows at most 45 custom tags
110
+ */
111
+ customTags?: Record<string, string> | undefined;
112
+ /**
113
+ * Automatically terminates the extra instances in the pool cache after they are inactive for this
114
+ * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
115
+ * instances will be automatically terminated after a default timeout. If specified, the
116
+ * threshold must be between 0 and 10000 minutes.
117
+ * Users can also set this value to 0 to instantly remove idle instances from the cache if
118
+ * min cache size could still hold.
119
+ */
120
+ idleInstanceAutoterminationMinutes?: number | undefined;
121
+ /**
122
+ * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
123
+ * additional disk space when its Spark workers are running low on disk space. In AWS, this
124
+ * feature requires specific AWS permissions to function correctly - refer to the User Guide for
125
+ * more details.
126
+ */
127
+ enableElasticDisk?: boolean | undefined;
128
+ /** Defines the specification of the disks that will be attached to all spark containers. */
129
+ diskSpec?: DiskSpec | undefined;
130
+ /** Custom Docker Image BYOC */
131
+ preloadedDockerImages?: DockerImage[] | undefined;
132
+ /**
133
+ * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
134
+ * with the preloaded Spark version will start faster. A list of available Spark versions
135
+ * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
136
+ */
137
+ preloadedSparkVersions?: string[] | undefined;
138
+ /**
139
+ * Attributes related to instance pools running on Azure.
140
+ * If not specified at pool creation, a set of default values will be used.
141
+ */
142
+ azureAttributes?: InstancePoolAzureAttributes | undefined;
143
+ /**
144
+ * Attributes related to instance pools running on Google Cloud Platform.
145
+ * If not specified at pool creation, a set of default values will be used.
146
+ */
147
+ gcpAttributes?: InstancePoolGcpAttributes | undefined;
148
+ /** Flexible node type configuration for the pool. */
149
+ nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
150
+ /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
151
+ remoteDiskThroughput?: number | undefined;
152
+ /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
153
+ totalInitialRemoteDiskSize?: number | undefined;
162
154
  }
163
- export interface CreateInstancePoolResponse {
164
- /** The ID of the created instance pool. */
165
- instancePoolId?: string | undefined;
155
+ interface CreateInstancePoolResponse {
156
+ /** The ID of the created instance pool. */
157
+ instancePoolId?: string | undefined;
166
158
  }
167
- export interface DeleteInstancePoolRequest {
168
- /** The instance pool to be terminated. */
169
- instancePoolId?: string | undefined;
170
- }
171
- export interface DeleteInstancePoolResponse {
159
+ interface DeleteInstancePoolRequest {
160
+ /** The instance pool to be terminated. */
161
+ instancePoolId?: string | undefined;
172
162
  }
163
+ interface DeleteInstancePoolResponse {}
173
164
  /**
174
165
  * Describes the disks that are launched for each instance in the spark cluster.
175
166
  * For example, if the cluster has 3 instances, each instance is configured to launch
176
167
  * 2 disks, 100 GiB each, then <Databricks> will launch a total of 6 disks,
177
168
  * 100 GiB each, for this cluster.
178
169
  */
179
- export interface DiskSpec {
180
- /** The type of disks that will be launched with this cluster. */
181
- diskType?: DiskType | undefined;
182
- /**
183
- * The number of disks launched for each instance:
184
- * - This feature is only enabled for supported node types.
185
- * - Users can choose up to the limit of the disks supported by the node type.
186
- * - For node types with no OS disk, at least one disk must be specified;
187
- * otherwise, cluster creation will fail.
188
- *
189
- * If disks are attached, <Databricks> will configure Spark to use only the disks for
190
- * scratch storage, because heterogenously sized scratch devices can lead to inefficient disk
191
- * utilization. If no disks are attached, <Databricks> will configure Spark to use
192
- * instance store disks.
193
- *
194
- * Note: If disks are specified, then the Spark configuration
195
- * `spark.local.dir` will be overridden.
196
- *
197
- * Disks will be mounted at:
198
- * - For AWS: `/ebs0`, `/ebs1`, and etc.
199
- * - For Azure: `/remote_volume0`, `/remote_volume1`, and etc.
200
- */
201
- diskCount?: number | undefined;
202
- /**
203
- * The size of each disk (in GiB) launched for each instance.
204
- * Values must fall into the supported range for a particular instance type.
205
- *
206
- * For AWS:
207
- * - General Purpose SSD: 100 - 4096 GiB
208
- * - Throughput Optimized HDD: 500 - 4096 GiB
209
- *
210
- * For Azure:
211
- * - Premium LRS (SSD): 1 - 1023 GiB
212
- * - Standard LRS (HDD): 1- 1023 GiB
213
- */
214
- diskSize?: number | undefined;
215
- diskIops?: number | undefined;
216
- diskThroughput?: number | undefined;
170
+ interface DiskSpec {
171
+ /** The type of disks that will be launched with this cluster. */
172
+ diskType?: DiskType | undefined;
173
+ /**
174
+ * The number of disks launched for each instance:
175
+ * - This feature is only enabled for supported node types.
176
+ * - Users can choose up to the limit of the disks supported by the node type.
177
+ * - For node types with no OS disk, at least one disk must be specified;
178
+ * otherwise, cluster creation will fail.
179
+ *
180
+ * If disks are attached, <Databricks> will configure Spark to use only the disks for
181
+ * scratch storage, because heterogenously sized scratch devices can lead to inefficient disk
182
+ * utilization. If no disks are attached, <Databricks> will configure Spark to use
183
+ * instance store disks.
184
+ *
185
+ * Note: If disks are specified, then the Spark configuration
186
+ * `spark.local.dir` will be overridden.
187
+ *
188
+ * Disks will be mounted at:
189
+ * - For AWS: `/ebs0`, `/ebs1`, and etc.
190
+ * - For Azure: `/remote_volume0`, `/remote_volume1`, and etc.
191
+ */
192
+ diskCount?: number | undefined;
193
+ /**
194
+ * The size of each disk (in GiB) launched for each instance.
195
+ * Values must fall into the supported range for a particular instance type.
196
+ *
197
+ * For AWS:
198
+ * - General Purpose SSD: 100 - 4096 GiB
199
+ * - Throughput Optimized HDD: 500 - 4096 GiB
200
+ *
201
+ * For Azure:
202
+ * - Premium LRS (SSD): 1 - 1023 GiB
203
+ * - Standard LRS (HDD): 1- 1023 GiB
204
+ */
205
+ diskSize?: number | undefined;
206
+ diskIops?: number | undefined;
207
+ diskThroughput?: number | undefined;
217
208
  }
218
209
  /** Describes the disk type. */
219
- export interface DiskType {
220
- remoteVolumeType?: {
221
- $case: 'ebsVolumeType';
222
- ebsVolumeType: EbsVolumeType;
223
- } | {
224
- $case: 'azureDiskVolumeType';
225
- azureDiskVolumeType: AzureDiskVolumeType;
226
- } | undefined;
227
- }
228
- export interface DockerBasicAuth {
229
- /** Name of the user */
230
- username?: string | undefined;
231
- /** Password of the user */
232
- password?: string | undefined;
210
+ interface DiskType {
211
+ remoteVolumeType?: {
212
+ $case: 'ebsVolumeType';
213
+ ebsVolumeType: EbsVolumeType;
214
+ } | {
215
+ $case: 'azureDiskVolumeType';
216
+ azureDiskVolumeType: AzureDiskVolumeType;
217
+ } | undefined;
233
218
  }
234
- export interface DockerImage {
235
- /** URL of the docker image. */
236
- url?: string | undefined;
237
- credsOneof?: {
238
- $case: 'basicAuth';
239
- /** Basic auth with username and password */
240
- basicAuth: DockerBasicAuth;
241
- } | undefined;
219
+ interface DockerBasicAuth {
220
+ /** Name of the user */
221
+ username?: string | undefined;
222
+ /** Password of the user */
223
+ password?: string | undefined;
242
224
  }
243
- export interface EditInstancePoolRequest {
244
- /** Instance pool ID */
245
- instancePoolId?: string | undefined;
246
- /**
247
- * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
248
- * characters.
249
- */
250
- instancePoolName?: string | undefined;
251
- /** Minimum number of idle instances to keep in the instance pool */
252
- minIdleInstances?: number | undefined;
253
- /**
254
- * Maximum number of outstanding instances to keep in the pool, including both instances used by
255
- * clusters and idle instances. Clusters that require further instance provisioning will fail during
256
- * upsize requests.
257
- */
258
- maxCapacity?: number | undefined;
259
- /**
260
- * Attributes related to instance pools running on Amazon Web Services.
261
- * If not specified at pool creation, a set of default values will be used.
262
- */
263
- awsAttributes?: InstancePoolAwsAttributes | undefined;
264
- /**
265
- * This field encodes, through a single value, the resources available to each of
266
- * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
267
- * and optimized for memory or compute intensive workloads. A list of available node
268
- * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
269
- */
270
- nodeTypeId?: string | undefined;
271
- /**
272
- * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
273
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
274
- *
275
- * - Currently, <Databricks> allows at most 45 custom tags
276
- */
277
- customTags?: Record<string, string> | undefined;
278
- /**
279
- * Automatically terminates the extra instances in the pool cache after they are inactive for this
280
- * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
281
- * instances will be automatically terminated after a default timeout. If specified, the
282
- * threshold must be between 0 and 10000 minutes.
283
- * Users can also set this value to 0 to instantly remove idle instances from the cache if
284
- * min cache size could still hold.
285
- */
286
- idleInstanceAutoterminationMinutes?: number | undefined;
287
- /**
288
- * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
289
- * additional disk space when its Spark workers are running low on disk space. In AWS, this
290
- * feature requires specific AWS permissions to function correctly - refer to the User Guide for
291
- * more details.
292
- */
293
- enableElasticDisk?: boolean | undefined;
294
- /** Defines the specification of the disks that will be attached to all spark containers. */
295
- diskSpec?: DiskSpec | undefined;
296
- /** Custom Docker Image BYOC */
297
- preloadedDockerImages?: DockerImage[] | undefined;
298
- /**
299
- * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
300
- * with the preloaded Spark version will start faster. A list of available Spark versions
301
- * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
302
- */
303
- preloadedSparkVersions?: string[] | undefined;
304
- /**
305
- * Attributes related to instance pools running on Azure.
306
- * If not specified at pool creation, a set of default values will be used.
307
- */
308
- azureAttributes?: InstancePoolAzureAttributes | undefined;
309
- /**
310
- * Attributes related to instance pools running on Google Cloud Platform.
311
- * If not specified at pool creation, a set of default values will be used.
312
- */
313
- gcpAttributes?: InstancePoolGcpAttributes | undefined;
314
- /** Flexible node type configuration for the pool. */
315
- nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
316
- /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
317
- remoteDiskThroughput?: number | undefined;
318
- /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
319
- totalInitialRemoteDiskSize?: number | undefined;
225
+ interface DockerImage {
226
+ /** URL of the docker image. */
227
+ url?: string | undefined;
228
+ credsOneof?: {
229
+ $case: 'basicAuth'; /** Basic auth with username and password */
230
+ basicAuth: DockerBasicAuth;
231
+ } | undefined;
320
232
  }
321
- export interface EditInstancePoolResponse {
233
+ interface EditInstancePoolRequest {
234
+ /** Instance pool ID */
235
+ instancePoolId?: string | undefined;
236
+ /**
237
+ * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
238
+ * characters.
239
+ */
240
+ instancePoolName?: string | undefined;
241
+ /** Minimum number of idle instances to keep in the instance pool */
242
+ minIdleInstances?: number | undefined;
243
+ /**
244
+ * Maximum number of outstanding instances to keep in the pool, including both instances used by
245
+ * clusters and idle instances. Clusters that require further instance provisioning will fail during
246
+ * upsize requests.
247
+ */
248
+ maxCapacity?: number | undefined;
249
+ /**
250
+ * Attributes related to instance pools running on Amazon Web Services.
251
+ * If not specified at pool creation, a set of default values will be used.
252
+ */
253
+ awsAttributes?: InstancePoolAwsAttributes | undefined;
254
+ /**
255
+ * This field encodes, through a single value, the resources available to each of
256
+ * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
257
+ * and optimized for memory or compute intensive workloads. A list of available node
258
+ * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
259
+ */
260
+ nodeTypeId?: string | undefined;
261
+ /**
262
+ * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
263
+ * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
264
+ *
265
+ * - Currently, <Databricks> allows at most 45 custom tags
266
+ */
267
+ customTags?: Record<string, string> | undefined;
268
+ /**
269
+ * Automatically terminates the extra instances in the pool cache after they are inactive for this
270
+ * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
271
+ * instances will be automatically terminated after a default timeout. If specified, the
272
+ * threshold must be between 0 and 10000 minutes.
273
+ * Users can also set this value to 0 to instantly remove idle instances from the cache if
274
+ * min cache size could still hold.
275
+ */
276
+ idleInstanceAutoterminationMinutes?: number | undefined;
277
+ /**
278
+ * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
279
+ * additional disk space when its Spark workers are running low on disk space. In AWS, this
280
+ * feature requires specific AWS permissions to function correctly - refer to the User Guide for
281
+ * more details.
282
+ */
283
+ enableElasticDisk?: boolean | undefined;
284
+ /** Defines the specification of the disks that will be attached to all spark containers. */
285
+ diskSpec?: DiskSpec | undefined;
286
+ /** Custom Docker Image BYOC */
287
+ preloadedDockerImages?: DockerImage[] | undefined;
288
+ /**
289
+ * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
290
+ * with the preloaded Spark version will start faster. A list of available Spark versions
291
+ * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
292
+ */
293
+ preloadedSparkVersions?: string[] | undefined;
294
+ /**
295
+ * Attributes related to instance pools running on Azure.
296
+ * If not specified at pool creation, a set of default values will be used.
297
+ */
298
+ azureAttributes?: InstancePoolAzureAttributes | undefined;
299
+ /**
300
+ * Attributes related to instance pools running on Google Cloud Platform.
301
+ * If not specified at pool creation, a set of default values will be used.
302
+ */
303
+ gcpAttributes?: InstancePoolGcpAttributes | undefined;
304
+ /** Flexible node type configuration for the pool. */
305
+ nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
306
+ /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
307
+ remoteDiskThroughput?: number | undefined;
308
+ /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
309
+ totalInitialRemoteDiskSize?: number | undefined;
322
310
  }
323
- export interface GetInstancePoolRequest {
324
- /** The canonical unique identifier for the instance pool. */
325
- instancePoolId?: string | undefined;
311
+ interface EditInstancePoolResponse {}
312
+ interface GetInstancePoolRequest {
313
+ /** The canonical unique identifier for the instance pool. */
314
+ instancePoolId?: string | undefined;
326
315
  }
327
- export interface GetInstancePoolResponse {
328
- /** Usage statistics about the instance pool. */
329
- stats?: InstancePoolStats | undefined;
330
- /** Status of failed pending instances in the pool. */
331
- status?: InstancePoolStatus | undefined;
332
- /** Canonical unique identifier for the pool. */
333
- instancePoolId?: string | undefined;
334
- /**
335
- * Tags that are added by <Databricks> regardless of any ``custom_tags``, including:
336
- *
337
- * - Vendor: <Databricks>
338
- *
339
- * - InstancePoolCreator: <user_id_of_creator>
340
- *
341
- * - InstancePoolName: <name_of_pool>
342
- *
343
- * - InstancePoolId: <id_of_pool>
344
- */
345
- defaultTags?: Record<string, string> | undefined;
346
- /** Current state of the instance pool. */
347
- state?: InstancePoolState | undefined;
348
- /**
349
- * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
350
- * characters.
351
- */
352
- instancePoolName?: string | undefined;
353
- /** Minimum number of idle instances to keep in the instance pool */
354
- minIdleInstances?: number | undefined;
355
- /**
356
- * Maximum number of outstanding instances to keep in the pool, including both instances used by
357
- * clusters and idle instances. Clusters that require further instance provisioning will fail during
358
- * upsize requests.
359
- */
360
- maxCapacity?: number | undefined;
361
- /**
362
- * Attributes related to instance pools running on Amazon Web Services.
363
- * If not specified at pool creation, a set of default values will be used.
364
- */
365
- awsAttributes?: InstancePoolAwsAttributes | undefined;
366
- /**
367
- * This field encodes, through a single value, the resources available to each of
368
- * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
369
- * and optimized for memory or compute intensive workloads. A list of available node
370
- * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
371
- */
372
- nodeTypeId?: string | undefined;
373
- /**
374
- * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
375
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
376
- *
377
- * - Currently, <Databricks> allows at most 45 custom tags
378
- */
379
- customTags?: Record<string, string> | undefined;
380
- /**
381
- * Automatically terminates the extra instances in the pool cache after they are inactive for this
382
- * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
383
- * instances will be automatically terminated after a default timeout. If specified, the
384
- * threshold must be between 0 and 10000 minutes.
385
- * Users can also set this value to 0 to instantly remove idle instances from the cache if
386
- * min cache size could still hold.
387
- */
388
- idleInstanceAutoterminationMinutes?: number | undefined;
389
- /**
390
- * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
391
- * additional disk space when its Spark workers are running low on disk space. In AWS, this
392
- * feature requires specific AWS permissions to function correctly - refer to the User Guide for
393
- * more details.
394
- */
395
- enableElasticDisk?: boolean | undefined;
396
- /** Defines the specification of the disks that will be attached to all spark containers. */
397
- diskSpec?: DiskSpec | undefined;
398
- /** Custom Docker Image BYOC */
399
- preloadedDockerImages?: DockerImage[] | undefined;
400
- /**
401
- * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
402
- * with the preloaded Spark version will start faster. A list of available Spark versions
403
- * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
404
- */
405
- preloadedSparkVersions?: string[] | undefined;
406
- /**
407
- * Attributes related to instance pools running on Azure.
408
- * If not specified at pool creation, a set of default values will be used.
409
- */
410
- azureAttributes?: InstancePoolAzureAttributes | undefined;
411
- /**
412
- * Attributes related to instance pools running on Google Cloud Platform.
413
- * If not specified at pool creation, a set of default values will be used.
414
- */
415
- gcpAttributes?: InstancePoolGcpAttributes | undefined;
416
- /** Flexible node type configuration for the pool. */
417
- nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
418
- /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
419
- remoteDiskThroughput?: number | undefined;
420
- /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
421
- totalInitialRemoteDiskSize?: number | undefined;
316
+ interface GetInstancePoolResponse {
317
+ /** Usage statistics about the instance pool. */
318
+ stats?: InstancePoolStats | undefined;
319
+ /** Status of failed pending instances in the pool. */
320
+ status?: InstancePoolStatus | undefined;
321
+ /** Canonical unique identifier for the pool. */
322
+ instancePoolId?: string | undefined;
323
+ /**
324
+ * Tags that are added by <Databricks> regardless of any ``custom_tags``, including:
325
+ *
326
+ * - Vendor: <Databricks>
327
+ *
328
+ * - InstancePoolCreator: <user_id_of_creator>
329
+ *
330
+ * - InstancePoolName: <name_of_pool>
331
+ *
332
+ * - InstancePoolId: <id_of_pool>
333
+ */
334
+ defaultTags?: Record<string, string> | undefined;
335
+ /** Current state of the instance pool. */
336
+ state?: InstancePoolState | undefined;
337
+ /**
338
+ * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
339
+ * characters.
340
+ */
341
+ instancePoolName?: string | undefined;
342
+ /** Minimum number of idle instances to keep in the instance pool */
343
+ minIdleInstances?: number | undefined;
344
+ /**
345
+ * Maximum number of outstanding instances to keep in the pool, including both instances used by
346
+ * clusters and idle instances. Clusters that require further instance provisioning will fail during
347
+ * upsize requests.
348
+ */
349
+ maxCapacity?: number | undefined;
350
+ /**
351
+ * Attributes related to instance pools running on Amazon Web Services.
352
+ * If not specified at pool creation, a set of default values will be used.
353
+ */
354
+ awsAttributes?: InstancePoolAwsAttributes | undefined;
355
+ /**
356
+ * This field encodes, through a single value, the resources available to each of
357
+ * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
358
+ * and optimized for memory or compute intensive workloads. A list of available node
359
+ * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
360
+ */
361
+ nodeTypeId?: string | undefined;
362
+ /**
363
+ * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
364
+ * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
365
+ *
366
+ * - Currently, <Databricks> allows at most 45 custom tags
367
+ */
368
+ customTags?: Record<string, string> | undefined;
369
+ /**
370
+ * Automatically terminates the extra instances in the pool cache after they are inactive for this
371
+ * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
372
+ * instances will be automatically terminated after a default timeout. If specified, the
373
+ * threshold must be between 0 and 10000 minutes.
374
+ * Users can also set this value to 0 to instantly remove idle instances from the cache if
375
+ * min cache size could still hold.
376
+ */
377
+ idleInstanceAutoterminationMinutes?: number | undefined;
378
+ /**
379
+ * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
380
+ * additional disk space when its Spark workers are running low on disk space. In AWS, this
381
+ * feature requires specific AWS permissions to function correctly - refer to the User Guide for
382
+ * more details.
383
+ */
384
+ enableElasticDisk?: boolean | undefined;
385
+ /** Defines the specification of the disks that will be attached to all spark containers. */
386
+ diskSpec?: DiskSpec | undefined;
387
+ /** Custom Docker Image BYOC */
388
+ preloadedDockerImages?: DockerImage[] | undefined;
389
+ /**
390
+ * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
391
+ * with the preloaded Spark version will start faster. A list of available Spark versions
392
+ * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
393
+ */
394
+ preloadedSparkVersions?: string[] | undefined;
395
+ /**
396
+ * Attributes related to instance pools running on Azure.
397
+ * If not specified at pool creation, a set of default values will be used.
398
+ */
399
+ azureAttributes?: InstancePoolAzureAttributes | undefined;
400
+ /**
401
+ * Attributes related to instance pools running on Google Cloud Platform.
402
+ * If not specified at pool creation, a set of default values will be used.
403
+ */
404
+ gcpAttributes?: InstancePoolGcpAttributes | undefined;
405
+ /** Flexible node type configuration for the pool. */
406
+ nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
407
+ /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
408
+ remoteDiskThroughput?: number | undefined;
409
+ /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
410
+ totalInitialRemoteDiskSize?: number | undefined;
422
411
  }
423
- export interface InstancePoolAndStats {
424
- /** Usage statistics about the instance pool. */
425
- stats?: InstancePoolStats | undefined;
426
- /** Status of failed pending instances in the pool. */
427
- status?: InstancePoolStatus | undefined;
428
- /** Canonical unique identifier for the pool. */
429
- instancePoolId?: string | undefined;
430
- /**
431
- * Tags that are added by <Databricks> regardless of any ``custom_tags``, including:
432
- *
433
- * - Vendor: <Databricks>
434
- *
435
- * - InstancePoolCreator: <user_id_of_creator>
436
- *
437
- * - InstancePoolName: <name_of_pool>
438
- *
439
- * - InstancePoolId: <id_of_pool>
440
- */
441
- defaultTags?: Record<string, string> | undefined;
442
- /** Current state of the instance pool. */
443
- state?: InstancePoolState | undefined;
444
- /**
445
- * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
446
- * characters.
447
- */
448
- instancePoolName?: string | undefined;
449
- /** Minimum number of idle instances to keep in the instance pool */
450
- minIdleInstances?: number | undefined;
451
- /**
452
- * Maximum number of outstanding instances to keep in the pool, including both instances used by
453
- * clusters and idle instances. Clusters that require further instance provisioning will fail during
454
- * upsize requests.
455
- */
456
- maxCapacity?: number | undefined;
457
- /**
458
- * Attributes related to instance pools running on Amazon Web Services.
459
- * If not specified at pool creation, a set of default values will be used.
460
- */
461
- awsAttributes?: InstancePoolAwsAttributes | undefined;
462
- /**
463
- * This field encodes, through a single value, the resources available to each of
464
- * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
465
- * and optimized for memory or compute intensive workloads. A list of available node
466
- * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
467
- */
468
- nodeTypeId?: string | undefined;
469
- /**
470
- * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
471
- * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
472
- *
473
- * - Currently, <Databricks> allows at most 45 custom tags
474
- */
475
- customTags?: Record<string, string> | undefined;
476
- /**
477
- * Automatically terminates the extra instances in the pool cache after they are inactive for this
478
- * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
479
- * instances will be automatically terminated after a default timeout. If specified, the
480
- * threshold must be between 0 and 10000 minutes.
481
- * Users can also set this value to 0 to instantly remove idle instances from the cache if
482
- * min cache size could still hold.
483
- */
484
- idleInstanceAutoterminationMinutes?: number | undefined;
485
- /**
486
- * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
487
- * additional disk space when its Spark workers are running low on disk space. In AWS, this
488
- * feature requires specific AWS permissions to function correctly - refer to the User Guide for
489
- * more details.
490
- */
491
- enableElasticDisk?: boolean | undefined;
492
- /** Defines the specification of the disks that will be attached to all spark containers. */
493
- diskSpec?: DiskSpec | undefined;
494
- /** Custom Docker Image BYOC */
495
- preloadedDockerImages?: DockerImage[] | undefined;
496
- /**
497
- * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
498
- * with the preloaded Spark version will start faster. A list of available Spark versions
499
- * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
500
- */
501
- preloadedSparkVersions?: string[] | undefined;
502
- /**
503
- * Attributes related to instance pools running on Azure.
504
- * If not specified at pool creation, a set of default values will be used.
505
- */
506
- azureAttributes?: InstancePoolAzureAttributes | undefined;
507
- /**
508
- * Attributes related to instance pools running on Google Cloud Platform.
509
- * If not specified at pool creation, a set of default values will be used.
510
- */
511
- gcpAttributes?: InstancePoolGcpAttributes | undefined;
512
- /** Flexible node type configuration for the pool. */
513
- nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
514
- /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
515
- remoteDiskThroughput?: number | undefined;
516
- /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
517
- totalInitialRemoteDiskSize?: number | undefined;
412
+ interface InstancePoolAndStats {
413
+ /** Usage statistics about the instance pool. */
414
+ stats?: InstancePoolStats | undefined;
415
+ /** Status of failed pending instances in the pool. */
416
+ status?: InstancePoolStatus | undefined;
417
+ /** Canonical unique identifier for the pool. */
418
+ instancePoolId?: string | undefined;
419
+ /**
420
+ * Tags that are added by <Databricks> regardless of any ``custom_tags``, including:
421
+ *
422
+ * - Vendor: <Databricks>
423
+ *
424
+ * - InstancePoolCreator: <user_id_of_creator>
425
+ *
426
+ * - InstancePoolName: <name_of_pool>
427
+ *
428
+ * - InstancePoolId: <id_of_pool>
429
+ */
430
+ defaultTags?: Record<string, string> | undefined;
431
+ /** Current state of the instance pool. */
432
+ state?: InstancePoolState | undefined;
433
+ /**
434
+ * Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100
435
+ * characters.
436
+ */
437
+ instancePoolName?: string | undefined;
438
+ /** Minimum number of idle instances to keep in the instance pool */
439
+ minIdleInstances?: number | undefined;
440
+ /**
441
+ * Maximum number of outstanding instances to keep in the pool, including both instances used by
442
+ * clusters and idle instances. Clusters that require further instance provisioning will fail during
443
+ * upsize requests.
444
+ */
445
+ maxCapacity?: number | undefined;
446
+ /**
447
+ * Attributes related to instance pools running on Amazon Web Services.
448
+ * If not specified at pool creation, a set of default values will be used.
449
+ */
450
+ awsAttributes?: InstancePoolAwsAttributes | undefined;
451
+ /**
452
+ * This field encodes, through a single value, the resources available to each of
453
+ * the Spark nodes in this cluster. For example, the Spark nodes can be provisioned
454
+ * and optimized for memory or compute intensive workloads. A list of available node
455
+ * types can be retrieved by using the [clusters/listNodeTypes](https://docs.databricks.com/api/workspace/clusters/listnodetypes) API call.
456
+ */
457
+ nodeTypeId?: string | undefined;
458
+ /**
459
+ * Additional tags for pool resources. <Databricks> will tag all pool resources (e.g., AWS
460
+ * instances and EBS volumes) with these tags in addition to `default_tags`. Notes:
461
+ *
462
+ * - Currently, <Databricks> allows at most 45 custom tags
463
+ */
464
+ customTags?: Record<string, string> | undefined;
465
+ /**
466
+ * Automatically terminates the extra instances in the pool cache after they are inactive for this
467
+ * time in minutes if min_idle_instances requirement is already met. If not set, the extra pool
468
+ * instances will be automatically terminated after a default timeout. If specified, the
469
+ * threshold must be between 0 and 10000 minutes.
470
+ * Users can also set this value to 0 to instantly remove idle instances from the cache if
471
+ * min cache size could still hold.
472
+ */
473
+ idleInstanceAutoterminationMinutes?: number | undefined;
474
+ /**
475
+ * Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire
476
+ * additional disk space when its Spark workers are running low on disk space. In AWS, this
477
+ * feature requires specific AWS permissions to function correctly - refer to the User Guide for
478
+ * more details.
479
+ */
480
+ enableElasticDisk?: boolean | undefined;
481
+ /** Defines the specification of the disks that will be attached to all spark containers. */
482
+ diskSpec?: DiskSpec | undefined;
483
+ /** Custom Docker Image BYOC */
484
+ preloadedDockerImages?: DockerImage[] | undefined;
485
+ /**
486
+ * A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started
487
+ * with the preloaded Spark version will start faster. A list of available Spark versions
488
+ * can be retrieved by using the [clusters/sparkVersions](https://docs.databricks.com/api/workspace/clusters/sparkversions) API call.
489
+ */
490
+ preloadedSparkVersions?: string[] | undefined;
491
+ /**
492
+ * Attributes related to instance pools running on Azure.
493
+ * If not specified at pool creation, a set of default values will be used.
494
+ */
495
+ azureAttributes?: InstancePoolAzureAttributes | undefined;
496
+ /**
497
+ * Attributes related to instance pools running on Google Cloud Platform.
498
+ * If not specified at pool creation, a set of default values will be used.
499
+ */
500
+ gcpAttributes?: InstancePoolGcpAttributes | undefined;
501
+ /** Flexible node type configuration for the pool. */
502
+ nodeTypeFlexibility?: NodeTypeFlexibility | undefined;
503
+ /** If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types. */
504
+ remoteDiskThroughput?: number | undefined;
505
+ /** If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types. */
506
+ totalInitialRemoteDiskSize?: number | undefined;
518
507
  }
519
508
  /** Attributes set during instance pool creation which are related to Amazon Web Services. */
520
- export interface InstancePoolAwsAttributes {
521
- /** Availability type used for the spot nodes. */
522
- availability?: AwsAvailability | undefined;
523
- /**
524
- * Identifier for the availability zone/datacenter in which the cluster resides.
525
- * This string will be of a form like "us-west-2a". The provided availability
526
- * zone must be in the same region as the <Databricks> deployment. For example, "us-west-2a"
527
- * is not a valid zone id if the <Databricks> deployment resides in the "us-east-1" region.
528
- * This is an optional field at cluster creation, and if not specified, a default zone will be used.
529
- * The list of available zones as well as the default value can be found by using the
530
- * `List Zones` method.
531
- */
532
- zoneId?: string | undefined;
533
- /**
534
- * Calculates the bid price for AWS spot instances, as a percentage of the corresponding instance type's
535
- * on-demand price.
536
- * For example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot
537
- * instance, then the bid price is half of the price of
538
- * on-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice
539
- * the price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.
540
- * When spot instances are requested for this cluster, only spot instances whose bid price
541
- * percentage matches this field will be considered.
542
- * Note that, for safety, we enforce this field to be no more than 10000.
543
- */
544
- spotBidPricePercent?: number | undefined;
545
- /**
546
- * All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances
547
- * will initially be launched with the workspace's default instance profile. If defined, clusters that use the
548
- * pool will inherit the instance profile, and must not specify their own instance profile on cluster creation or
549
- * update. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.
550
- * The instance profile must have previously been added to the <Databricks> environment by an account administrator.
551
- *
552
- * This feature may only be available to certain customer plans.
553
- */
554
- instanceProfileArn?: string | undefined;
509
+ interface InstancePoolAwsAttributes {
510
+ /** Availability type used for the spot nodes. */
511
+ availability?: AwsAvailability | undefined;
512
+ /**
513
+ * Identifier for the availability zone/datacenter in which the cluster resides.
514
+ * This string will be of a form like "us-west-2a". The provided availability
515
+ * zone must be in the same region as the <Databricks> deployment. For example, "us-west-2a"
516
+ * is not a valid zone id if the <Databricks> deployment resides in the "us-east-1" region.
517
+ * This is an optional field at cluster creation, and if not specified, a default zone will be used.
518
+ * The list of available zones as well as the default value can be found by using the
519
+ * `List Zones` method.
520
+ */
521
+ zoneId?: string | undefined;
522
+ /**
523
+ * Calculates the bid price for AWS spot instances, as a percentage of the corresponding instance type's
524
+ * on-demand price.
525
+ * For example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot
526
+ * instance, then the bid price is half of the price of
527
+ * on-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice
528
+ * the price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.
529
+ * When spot instances are requested for this cluster, only spot instances whose bid price
530
+ * percentage matches this field will be considered.
531
+ * Note that, for safety, we enforce this field to be no more than 10000.
532
+ */
533
+ spotBidPricePercent?: number | undefined;
534
+ /**
535
+ * All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances
536
+ * will initially be launched with the workspace's default instance profile. If defined, clusters that use the
537
+ * pool will inherit the instance profile, and must not specify their own instance profile on cluster creation or
538
+ * update. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile.
539
+ * The instance profile must have previously been added to the <Databricks> environment by an account administrator.
540
+ *
541
+ * This feature may only be available to certain customer plans.
542
+ */
543
+ instanceProfileArn?: string | undefined;
555
544
  }
556
545
  /** Attributes set during instance pool creation which are related to Azure. */
557
- export interface InstancePoolAzureAttributes {
558
- /** Availability type used for the spot nodes. */
559
- availability?: AzureAvailability | undefined;
560
- /**
561
- * With variable pricing, you have option to set a max price, in US dollars (USD)
562
- * For example, the value 2 would be a max price of $2.00 USD per hour.
563
- * If you set the max price to be -1, the VM won't be evicted based on price.
564
- * The price for the VM will be the current price for spot or the price for a standard VM,
565
- * which ever is less, as long as there is capacity and quota available.
566
- */
567
- spotBidMaxPrice?: number | undefined;
568
- /**
569
- * The Azure capacity reservation group resource ID to use for launching VMs in this pool.
570
- * When specified, VMs will be launched using the provided capacity reservation.
571
- *
572
- * NOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.
573
- *
574
- * Capacity reservations can only be specified when the workspace uses injected vnet (i.e. customer defined vnet not
575
- * managed by databricks). Ensure the databricks-login-prod Enterprise Application is granted the following four permissions:
576
- * 1. Microsoft.Compute/capacityReservationGroups/read
577
- * 2. Microsoft.Compute/capacityReservationGroups/deploy/action
578
- * 3. Microsoft.Compute/capacityReservationGroups/capacityReservations/read
579
- * 4. Microsoft.Compute/capacityReservationGroups/capacityReservations/deploy/action
580
- *
581
- * Format: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}`
582
- */
583
- capacityReservationGroup?: string | undefined;
546
+ interface InstancePoolAzureAttributes {
547
+ /** Availability type used for the spot nodes. */
548
+ availability?: AzureAvailability | undefined;
549
+ /**
550
+ * With variable pricing, you have option to set a max price, in US dollars (USD)
551
+ * For example, the value 2 would be a max price of $2.00 USD per hour.
552
+ * If you set the max price to be -1, the VM won't be evicted based on price.
553
+ * The price for the VM will be the current price for spot or the price for a standard VM,
554
+ * which ever is less, as long as there is capacity and quota available.
555
+ */
556
+ spotBidMaxPrice?: number | undefined;
557
+ /**
558
+ * The Azure capacity reservation group resource ID to use for launching VMs in this pool.
559
+ * When specified, VMs will be launched using the provided capacity reservation.
560
+ *
561
+ * NOTE: Omitting this field will clear any existing configured capacity reservation group on the pool.
562
+ *
563
+ * Capacity reservations can only be specified when the workspace uses injected vnet (i.e. customer defined vnet not
564
+ * managed by databricks). Ensure the databricks-login-prod Enterprise Application is granted the following four permissions:
565
+ * 1. Microsoft.Compute/capacityReservationGroups/read
566
+ * 2. Microsoft.Compute/capacityReservationGroups/deploy/action
567
+ * 3. Microsoft.Compute/capacityReservationGroups/capacityReservations/read
568
+ * 4. Microsoft.Compute/capacityReservationGroups/capacityReservations/deploy/action
569
+ *
570
+ * Format: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}`
571
+ */
572
+ capacityReservationGroup?: string | undefined;
584
573
  }
585
574
  /** Attributes set during instance pool creation which are related to GCP. */
586
- export interface InstancePoolGcpAttributes {
587
- gcpAvailability?: GcpAvailability | undefined;
588
- /**
589
- * If provided, each node in the instance pool will have this number of local SSDs attached.
590
- * Each local SSD is 375GB in size. Refer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds)
591
- * for the supported number of local SSDs for each instance type.
592
- */
593
- localSsdCount?: number | undefined;
594
- /**
595
- * Identifier for the availability zone/datacenter in which the cluster resides.
596
- * This string will be of a form like "us-west1-a". The provided availability
597
- * zone must be in the same region as the <Databricks> workspace. For example, "us-west1-a"
598
- * is not a valid zone id if the <Databricks> workspace resides in the "us-east1" region.
599
- * This is an optional field at instance pool creation, and if not specified, a default zone will be used.
600
- *
601
- * This field can be one of the following:
602
- * - "HA" => High availability, spread nodes across availability zones for a <Databricks> deployment region
603
- * - A GCP availability zone => Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. "us-west1-a").
604
- *
605
- * If empty, <Databricks> picks an availability zone to schedule the cluster on.
606
- */
607
- zoneId?: string | undefined;
608
- }
609
- export interface InstancePoolStats {
610
- /** Number of active instances in the pool that are part of a cluster. */
611
- usedCount?: number | undefined;
612
- /** Number of active instances in the pool that are NOT part of a cluster. */
613
- idleCount?: number | undefined;
614
- /** Number of pending instances in the pool that are part of a cluster. */
615
- pendingUsedCount?: number | undefined;
616
- /** Number of pending instances in the pool that are NOT part of a cluster. */
617
- pendingIdleCount?: number | undefined;
575
+ interface InstancePoolGcpAttributes {
576
+ gcpAvailability?: GcpAvailability | undefined;
577
+ /**
578
+ * If provided, each node in the instance pool will have this number of local SSDs attached.
579
+ * Each local SSD is 375GB in size. Refer to [GCP documentation](https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds)
580
+ * for the supported number of local SSDs for each instance type.
581
+ */
582
+ localSsdCount?: number | undefined;
583
+ /**
584
+ * Identifier for the availability zone/datacenter in which the cluster resides.
585
+ * This string will be of a form like "us-west1-a". The provided availability
586
+ * zone must be in the same region as the <Databricks> workspace. For example, "us-west1-a"
587
+ * is not a valid zone id if the <Databricks> workspace resides in the "us-east1" region.
588
+ * This is an optional field at instance pool creation, and if not specified, a default zone will be used.
589
+ *
590
+ * This field can be one of the following:
591
+ * - "HA" => High availability, spread nodes across availability zones for a <Databricks> deployment region
592
+ * - A GCP availability zone => Pick One of the available zones for (machine type + region) from https://cloud.google.com/compute/docs/regions-zones (e.g. "us-west1-a").
593
+ *
594
+ * If empty, <Databricks> picks an availability zone to schedule the cluster on.
595
+ */
596
+ zoneId?: string | undefined;
618
597
  }
619
- export interface InstancePoolStatus {
620
- /**
621
- * List of error messages for the failed pending instances.
622
- * The pending_instance_errors follows FIFO with maximum length of the min_idle of the pool.
623
- * The pending_instance_errors is emptied once the number of exiting available instances reaches
624
- * the min_idle of the pool.
625
- */
626
- pendingInstanceErrors?: PendingInstanceError[] | undefined;
598
+ interface InstancePoolStats {
599
+ /** Number of active instances in the pool that are part of a cluster. */
600
+ usedCount?: number | undefined;
601
+ /** Number of active instances in the pool that are NOT part of a cluster. */
602
+ idleCount?: number | undefined;
603
+ /** Number of pending instances in the pool that are part of a cluster. */
604
+ pendingUsedCount?: number | undefined;
605
+ /** Number of pending instances in the pool that are NOT part of a cluster. */
606
+ pendingIdleCount?: number | undefined;
627
607
  }
628
- export interface ListInstancePoolsRequest {
608
+ interface InstancePoolStatus {
609
+ /**
610
+ * List of error messages for the failed pending instances.
611
+ * The pending_instance_errors follows FIFO with maximum length of the min_idle of the pool.
612
+ * The pending_instance_errors is emptied once the number of exiting available instances reaches
613
+ * the min_idle of the pool.
614
+ */
615
+ pendingInstanceErrors?: PendingInstanceError[] | undefined;
629
616
  }
630
- export interface ListInstancePoolsResponse {
631
- instancePools?: InstancePoolAndStats[] | undefined;
617
+ interface ListInstancePoolsRequest {}
618
+ interface ListInstancePoolsResponse {
619
+ instancePools?: InstancePoolAndStats[] | undefined;
632
620
  }
633
621
  /** Configuration for flexible node types, allowing fallback to alternate node types during cluster launch and upscale. */
634
- export interface NodeTypeFlexibility {
635
- /** A list of node type IDs to use as fallbacks when the primary node type is unavailable. */
636
- alternateNodeTypeIds?: string[] | undefined;
622
+ interface NodeTypeFlexibility {
623
+ /** A list of node type IDs to use as fallbacks when the primary node type is unavailable. */
624
+ alternateNodeTypeIds?: string[] | undefined;
637
625
  }
638
626
  /** Error message of a failed pending instances */
639
- export interface PendingInstanceError {
640
- instanceId?: string | undefined;
641
- message?: string | undefined;
627
+ interface PendingInstanceError {
628
+ instanceId?: string | undefined;
629
+ message?: string | undefined;
642
630
  }
643
- export declare const unmarshalCreateInstancePoolResponseSchema: z.ZodType<CreateInstancePoolResponse>;
644
- export declare const unmarshalDeleteInstancePoolResponseSchema: z.ZodType<DeleteInstancePoolResponse>;
645
- export declare const unmarshalDiskSpecSchema: z.ZodType<DiskSpec>;
646
- export declare const unmarshalDiskTypeSchema: z.ZodType<DiskType>;
647
- export declare const unmarshalDockerBasicAuthSchema: z.ZodType<DockerBasicAuth>;
648
- export declare const unmarshalDockerImageSchema: z.ZodType<DockerImage>;
649
- export declare const unmarshalEditInstancePoolResponseSchema: z.ZodType<EditInstancePoolResponse>;
650
- export declare const unmarshalGetInstancePoolResponseSchema: z.ZodType<GetInstancePoolResponse>;
651
- export declare const unmarshalInstancePoolAndStatsSchema: z.ZodType<InstancePoolAndStats>;
652
- export declare const unmarshalInstancePoolAwsAttributesSchema: z.ZodType<InstancePoolAwsAttributes>;
653
- export declare const unmarshalInstancePoolAzureAttributesSchema: z.ZodType<InstancePoolAzureAttributes>;
654
- export declare const unmarshalInstancePoolGcpAttributesSchema: z.ZodType<InstancePoolGcpAttributes>;
655
- export declare const unmarshalInstancePoolStatsSchema: z.ZodType<InstancePoolStats>;
656
- export declare const unmarshalInstancePoolStatusSchema: z.ZodType<InstancePoolStatus>;
657
- export declare const unmarshalListInstancePoolsResponseSchema: z.ZodType<ListInstancePoolsResponse>;
658
- export declare const unmarshalNodeTypeFlexibilitySchema: z.ZodType<NodeTypeFlexibility>;
659
- export declare const unmarshalPendingInstanceErrorSchema: z.ZodType<PendingInstanceError>;
660
- export declare const marshalCreateInstancePoolRequestSchema: z.ZodType;
661
- export declare const marshalDeleteInstancePoolRequestSchema: z.ZodType;
662
- export declare const marshalDiskSpecSchema: z.ZodType;
663
- export declare const marshalDiskTypeSchema: z.ZodType;
664
- export declare const marshalDockerBasicAuthSchema: z.ZodType;
665
- export declare const marshalDockerImageSchema: z.ZodType;
666
- export declare const marshalEditInstancePoolRequestSchema: z.ZodType;
667
- export declare const marshalInstancePoolAwsAttributesSchema: z.ZodType;
668
- export declare const marshalInstancePoolAzureAttributesSchema: z.ZodType;
669
- export declare const marshalInstancePoolGcpAttributesSchema: z.ZodType;
670
- export declare const marshalNodeTypeFlexibilitySchema: z.ZodType;
631
+ declare const unmarshalCreateInstancePoolResponseSchema: z.ZodType<CreateInstancePoolResponse>;
632
+ declare const unmarshalDeleteInstancePoolResponseSchema: z.ZodType<DeleteInstancePoolResponse>;
633
+ declare const unmarshalDiskSpecSchema: z.ZodType<DiskSpec>;
634
+ declare const unmarshalDiskTypeSchema: z.ZodType<DiskType>;
635
+ declare const unmarshalDockerBasicAuthSchema: z.ZodType<DockerBasicAuth>;
636
+ declare const unmarshalDockerImageSchema: z.ZodType<DockerImage>;
637
+ declare const unmarshalEditInstancePoolResponseSchema: z.ZodType<EditInstancePoolResponse>;
638
+ declare const unmarshalGetInstancePoolResponseSchema: z.ZodType<GetInstancePoolResponse>;
639
+ declare const unmarshalInstancePoolAndStatsSchema: z.ZodType<InstancePoolAndStats>;
640
+ declare const unmarshalInstancePoolAwsAttributesSchema: z.ZodType<InstancePoolAwsAttributes>;
641
+ declare const unmarshalInstancePoolAzureAttributesSchema: z.ZodType<InstancePoolAzureAttributes>;
642
+ declare const unmarshalInstancePoolGcpAttributesSchema: z.ZodType<InstancePoolGcpAttributes>;
643
+ declare const unmarshalInstancePoolStatsSchema: z.ZodType<InstancePoolStats>;
644
+ declare const unmarshalInstancePoolStatusSchema: z.ZodType<InstancePoolStatus>;
645
+ declare const unmarshalListInstancePoolsResponseSchema: z.ZodType<ListInstancePoolsResponse>;
646
+ declare const unmarshalNodeTypeFlexibilitySchema: z.ZodType<NodeTypeFlexibility>;
647
+ declare const unmarshalPendingInstanceErrorSchema: z.ZodType<PendingInstanceError>;
648
+ declare const marshalCreateInstancePoolRequestSchema: z.ZodType;
649
+ declare const marshalDeleteInstancePoolRequestSchema: z.ZodType;
650
+ declare const marshalDiskSpecSchema: z.ZodType;
651
+ declare const marshalDiskTypeSchema: z.ZodType;
652
+ declare const marshalDockerBasicAuthSchema: z.ZodType;
653
+ declare const marshalDockerImageSchema: z.ZodType;
654
+ declare const marshalEditInstancePoolRequestSchema: z.ZodType;
655
+ declare const marshalInstancePoolAwsAttributesSchema: z.ZodType;
656
+ declare const marshalInstancePoolAzureAttributesSchema: z.ZodType;
657
+ declare const marshalInstancePoolGcpAttributesSchema: z.ZodType;
658
+ declare const marshalNodeTypeFlexibilitySchema: z.ZodType;
659
+ //#endregion
660
+ export { AwsAvailability, AzureAvailability, AzureDiskVolumeType, CreateInstancePoolRequest, CreateInstancePoolResponse, DeleteInstancePoolRequest, DeleteInstancePoolResponse, DiskSpec, DiskType, DockerBasicAuth, DockerImage, EbsVolumeType, EditInstancePoolRequest, EditInstancePoolResponse, GcpAvailability, GetInstancePoolRequest, GetInstancePoolResponse, InstancePoolAndStats, InstancePoolAwsAttributes, InstancePoolAzureAttributes, InstancePoolGcpAttributes, InstancePoolState, InstancePoolStats, InstancePoolStatus, ListInstancePoolsRequest, ListInstancePoolsResponse, NodeTypeFlexibility, PendingInstanceError, marshalCreateInstancePoolRequestSchema, marshalDeleteInstancePoolRequestSchema, marshalDiskSpecSchema, marshalDiskTypeSchema, marshalDockerBasicAuthSchema, marshalDockerImageSchema, marshalEditInstancePoolRequestSchema, marshalInstancePoolAwsAttributesSchema, marshalInstancePoolAzureAttributesSchema, marshalInstancePoolGcpAttributesSchema, marshalNodeTypeFlexibilitySchema, unmarshalCreateInstancePoolResponseSchema, unmarshalDeleteInstancePoolResponseSchema, unmarshalDiskSpecSchema, unmarshalDiskTypeSchema, unmarshalDockerBasicAuthSchema, unmarshalDockerImageSchema, unmarshalEditInstancePoolResponseSchema, unmarshalGetInstancePoolResponseSchema, unmarshalInstancePoolAndStatsSchema, unmarshalInstancePoolAwsAttributesSchema, unmarshalInstancePoolAzureAttributesSchema, unmarshalInstancePoolGcpAttributesSchema, unmarshalInstancePoolStatsSchema, unmarshalInstancePoolStatusSchema, unmarshalListInstancePoolsResponseSchema, unmarshalNodeTypeFlexibilitySchema, unmarshalPendingInstanceErrorSchema };
671
661
  //# sourceMappingURL=model.d.ts.map