@databricks/sdk-workspaces 0.34.0 → 0.36.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,16 +1,16 @@
1
- import { FieldMask } from '@databricks/sdk-core/wkt';
2
- import { z } from 'zod';
1
+ import { z } from "zod";
2
+ import { FieldMask } from "@databricks/sdk-core/wkt";
3
+
4
+ //#region src/v1/model.d.ts
3
5
  /**
4
6
  * Corresponds to compute mode defined here:
5
7
  * https://src.dev.databricks.com/databricks/universe@9076536b18479afd639d1c1f9dd5a59f72215e69/-/blob/central/api/common.proto?L872
6
8
  */
7
- export declare const ComputeMode: {
8
- /** Classic + Serverless */
9
- readonly HYBRID: "HYBRID";
10
- /** Serverless-only. */
11
- readonly SERVERLESS: "SERVERLESS";
9
+ declare const ComputeMode: {
10
+ /** Classic + Serverless */readonly HYBRID: "HYBRID"; /** Serverless-only. */
11
+ readonly SERVERLESS: "SERVERLESS";
12
12
  };
13
- export type ComputeMode = (typeof ComputeMode)[keyof typeof ComputeMode] | (string & {});
13
+ type ComputeMode = (typeof ComputeMode)[keyof typeof ComputeMode] | (string & {});
14
14
  /**
15
15
  * Specifies the network connectivity types for the GKE nodes and the GKE master network.
16
16
  *
@@ -20,38 +20,29 @@ export type ComputeMode = (typeof ComputeMode)[keyof typeof ComputeMode] | (stri
20
20
  * Set to `PUBLIC_NODE_PUBLIC_MASTER` for a public GKE cluster.
21
21
  * The nodes of a public GKE cluster have public IP addresses.
22
22
  */
23
- export declare const GkeConnectivityType: {
24
- /**
25
- * The nodes of the GKE cluster will have private IP only. GKE master will still have a public
26
- * IP.
27
- */
28
- readonly PRIVATE_NODE_PUBLIC_MASTER: "PRIVATE_NODE_PUBLIC_MASTER";
29
- /** The GKE cluster will have public IPs for both its nodes and GKE master. */
30
- readonly PUBLIC_NODE_PUBLIC_MASTER: "PUBLIC_NODE_PUBLIC_MASTER";
23
+ declare const GkeConnectivityType: {
24
+ /**
25
+ * The nodes of the GKE cluster will have private IP only. GKE master will still have a public
26
+ * IP.
27
+ */
28
+ readonly PRIVATE_NODE_PUBLIC_MASTER: "PRIVATE_NODE_PUBLIC_MASTER"; /** The GKE cluster will have public IPs for both its nodes and GKE master. */
29
+ readonly PUBLIC_NODE_PUBLIC_MASTER: "PUBLIC_NODE_PUBLIC_MASTER";
31
30
  };
32
- export type GkeConnectivityType = (typeof GkeConnectivityType)[keyof typeof GkeConnectivityType] | (string & {});
33
- export declare const PricingTier: {
34
- /** unknown tier that signifies invalid tier values */
35
- readonly UNKNOWN: "UNKNOWN";
36
- /** Tier for CE workspaces */
37
- readonly COMMUNITY_EDITION: "COMMUNITY_EDITION";
38
- /** Standard pricing tier that maps to STANDARD_TIER feature tier */
39
- readonly STANDARD: "STANDARD";
40
- /** Premium pricing tier that maps to STANDARD_W_SEC_TIER feature tier */
41
- readonly PREMIUM: "PREMIUM";
42
- /** Enterprise pricing tier that maps to ENTERPRISE_TIER_V2 feature tier */
43
- readonly ENTERPRISE: "ENTERPRISE";
44
- /** Dedicated pricing tier that maps to the DEDICATED feature tier */
45
- readonly DEDICATED: "DEDICATED";
31
+ type GkeConnectivityType = (typeof GkeConnectivityType)[keyof typeof GkeConnectivityType] | (string & {});
32
+ declare const PricingTier: {
33
+ /** unknown tier that signifies invalid tier values */readonly UNKNOWN: "UNKNOWN"; /** Tier for CE workspaces */
34
+ readonly COMMUNITY_EDITION: "COMMUNITY_EDITION"; /** Standard pricing tier that maps to STANDARD_TIER feature tier */
35
+ readonly STANDARD: "STANDARD"; /** Premium pricing tier that maps to STANDARD_W_SEC_TIER feature tier */
36
+ readonly PREMIUM: "PREMIUM"; /** Enterprise pricing tier that maps to ENTERPRISE_TIER_V2 feature tier */
37
+ readonly ENTERPRISE: "ENTERPRISE"; /** Dedicated pricing tier that maps to the DEDICATED feature tier */
38
+ readonly DEDICATED: "DEDICATED";
46
39
  };
47
- export type PricingTier = (typeof PricingTier)[keyof typeof PricingTier] | (string & {});
48
- export declare const StorageMode: {
49
- /** The storage resources of the workspace are hosted by customers. */
50
- readonly CUSTOMER_HOSTED: "CUSTOMER_HOSTED";
51
- /** The storage resources of the workspace are hosted by Databricks. */
52
- readonly DEFAULT_STORAGE: "DEFAULT_STORAGE";
40
+ type PricingTier = (typeof PricingTier)[keyof typeof PricingTier] | (string & {});
41
+ declare const StorageMode: {
42
+ /** The storage resources of the workspace are hosted by customers. */readonly CUSTOMER_HOSTED: "CUSTOMER_HOSTED"; /** The storage resources of the workspace are hosted by Databricks. */
43
+ readonly DEFAULT_STORAGE: "DEFAULT_STORAGE";
53
44
  };
54
- export type StorageMode = (typeof StorageMode)[keyof typeof StorageMode] | (string & {});
45
+ type StorageMode = (typeof StorageMode)[keyof typeof StorageMode] | (string & {});
55
46
  /**
56
47
  * The different statuses of a workspace. The following represents the current set of valid
57
48
  * transitions from status to status:
@@ -74,270 +65,269 @@ export type StorageMode = (typeof StorageMode)[keyof typeof StorageMode] | (stri
74
65
  * -> CANCELLED
75
66
  * Note that a transition from any state to itself is also valid.
76
67
  */
77
- export declare const WorkspaceStatus: {
78
- /**
79
- * Status for workspaces that have been created but not provisioned yet. It is technically
80
- * possible for an Azure workspace to be in this state, but only for less than a second in almost
81
- * all cases, as it will almost immediately transition to PROVISIONING. AWS workspaces may be in
82
- * NOT_PROVISIONED state for much longer.
83
- */
84
- readonly NOT_PROVISIONED: "NOT_PROVISIONED";
85
- /** Status for workspaces being provisioned. */
86
- readonly PROVISIONING: "PROVISIONING";
87
- /** Status for running workspaces. */
88
- readonly RUNNING: "RUNNING";
89
- /**
90
- * Status for workspaces that have failed to be provisioned. This is currently an AWS-only state
91
- * since an Azure customer can easily retry to launch a workspace that failed to launch, whereas
92
- * this process is different in AWS.
93
- */
94
- readonly FAILED: "FAILED";
95
- /**
96
- * Status for banned workspaces. This is intended for use with CE workspaces, although there is no
97
- * code to enforce this restriction. These workspaces can be unbanned at a later time.
98
- */
99
- readonly BANNED: "BANNED";
100
- /** Status for cancelling workspaces. This state always comes before the CANCELLED status. */
101
- readonly CANCELLING: "CANCELLING";
68
+ declare const WorkspaceStatus: {
69
+ /**
70
+ * Status for workspaces that have been created but not provisioned yet. It is technically
71
+ * possible for an Azure workspace to be in this state, but only for less than a second in almost
72
+ * all cases, as it will almost immediately transition to PROVISIONING. AWS workspaces may be in
73
+ * NOT_PROVISIONED state for much longer.
74
+ */
75
+ readonly NOT_PROVISIONED: "NOT_PROVISIONED"; /** Status for workspaces being provisioned. */
76
+ readonly PROVISIONING: "PROVISIONING"; /** Status for running workspaces. */
77
+ readonly RUNNING: "RUNNING";
78
+ /**
79
+ * Status for workspaces that have failed to be provisioned. This is currently an AWS-only state
80
+ * since an Azure customer can easily retry to launch a workspace that failed to launch, whereas
81
+ * this process is different in AWS.
82
+ */
83
+ readonly FAILED: "FAILED";
84
+ /**
85
+ * Status for banned workspaces. This is intended for use with CE workspaces, although there is no
86
+ * code to enforce this restriction. These workspaces can be unbanned at a later time.
87
+ */
88
+ readonly BANNED: "BANNED"; /** Status for cancelling workspaces. This state always comes before the CANCELLED status. */
89
+ readonly CANCELLING: "CANCELLING";
102
90
  };
103
- export type WorkspaceStatus = (typeof WorkspaceStatus)[keyof typeof WorkspaceStatus] | (string & {});
104
- export interface AzureWorkspaceInfo {
105
- /** Azure Resource Group name */
106
- resourceGroup?: string | undefined;
107
- /** Azure Subscription ID */
108
- subscriptionId?: string | undefined;
91
+ type WorkspaceStatus = (typeof WorkspaceStatus)[keyof typeof WorkspaceStatus] | (string & {});
92
+ interface AzureWorkspaceInfo {
93
+ /** Azure Resource Group name */
94
+ resourceGroup?: string | undefined;
95
+ /** Azure Subscription ID */
96
+ subscriptionId?: string | undefined;
109
97
  }
110
- export interface CloudResourceContainer {
111
- cloudResourceContainer?: {
112
- $case: 'gcp';
113
- gcp: GcpCloudResourceContainer;
114
- } | undefined;
98
+ interface CloudResourceContainer {
99
+ cloudResourceContainer?: {
100
+ $case: 'gcp';
101
+ gcp: GcpCloudResourceContainer;
102
+ } | undefined;
115
103
  }
116
- export interface CreateWorkspaceRequest {
117
- accountId?: string | undefined;
118
- /** The human-readable name of the workspace. */
119
- workspaceName?: string | undefined;
120
- /**
121
- * The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is <workspace-deployment-name>.cloud.databricks.com. For example, if the deployment name is abcsales, your workspace URL will be https://abcsales.cloud.databricks.com. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain.
122
- * To set this value, you must have a deployment name prefix. Contact your <Databricks> account team to add an account deployment name prefix to your account.
123
- * Workspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is acme and the workspace deployment name is workspace-1, the JSON response for the deployment_name field becomes acme-workspace-1. The workspace URL would be acme-workspace-1.cloud.databricks.com.
124
- * You can also set the deployment_name to the reserved keyword EMPTY if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is acme and the workspace deployment name is EMPTY, the deployment_name becomes acme only and the workspace URL is acme.cloud.databricks.com.
125
- * This value must be unique across all non-deleted deployments across all AWS regions.
126
- * If a new workspace omits this property, the server generates a unique deployment name for you with the pattern dbc-xxxxxxxx-xxxx.
127
- */
128
- deploymentName?: string | undefined;
129
- awsRegion?: string | undefined;
130
- /** The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`). */
131
- location?: string | undefined;
132
- /**
133
- * DEPRECATED: This field is being ignored by the server and will be removed in the future.
134
- * The cloud name. This field always has the value `gcp`.
135
- */
136
- cloud?: string | undefined;
137
- pricingTier?: PricingTier | undefined;
138
- cloudResourceContainer?: CloudResourceContainer | undefined;
139
- /** ID of the workspace's credential configuration object. */
140
- credentialsId?: string | undefined;
141
- /** ID of the workspace's storage configuration object. */
142
- storageConfigurationId?: string | undefined;
143
- /** The ID of the workspace's network configuration object. To use AWS PrivateLink, this field is required. */
144
- networkId?: string | undefined;
145
- gcpManagedNetworkConfig?: GcpManagedNetworkConfig | undefined;
146
- gkeConfig?: GkeConfig | undefined;
147
- /**
148
- * ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.
149
- * Before configuring PrivateLink, read the [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).",
150
- */
151
- privateAccessSettingsId?: string | undefined;
152
- /** The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property use_cases must contain MANAGED_SERVICES. */
153
- managedServicesCustomerManagedKeyId?: string | undefined;
154
- /** The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property use_cases must contain STORAGE. */
155
- storageCustomerManagedKeyId?: string | undefined;
156
- /**
157
- * The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The
158
- * value can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.
159
- */
160
- customTags?: Record<string, string> | undefined;
161
- /**
162
- * If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don't need to provide any resources managed by you, such as credentials, storage, or network.
163
- * If the compute mode is `HYBRID` (which is the default option), a classic workspace is created that uses customer-managed resources.
164
- */
165
- computeMode?: ComputeMode | undefined;
166
- /** The object ID of network connectivity config. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks and optional private link to access your resources. */
167
- networkConnectivityConfigId?: string | undefined;
104
+ interface CreateWorkspaceRequest {
105
+ accountId?: string | undefined;
106
+ /** The human-readable name of the workspace. */
107
+ workspaceName?: string | undefined;
108
+ /**
109
+ * The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is <workspace-deployment-name>.cloud.databricks.com. For example, if the deployment name is abcsales, your workspace URL will be https://abcsales.cloud.databricks.com. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain.
110
+ * To set this value, you must have a deployment name prefix. Contact your <Databricks> account team to add an account deployment name prefix to your account.
111
+ * Workspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is acme and the workspace deployment name is workspace-1, the JSON response for the deployment_name field becomes acme-workspace-1. The workspace URL would be acme-workspace-1.cloud.databricks.com.
112
+ * You can also set the deployment_name to the reserved keyword EMPTY if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is acme and the workspace deployment name is EMPTY, the deployment_name becomes acme only and the workspace URL is acme.cloud.databricks.com.
113
+ * This value must be unique across all non-deleted deployments across all AWS regions.
114
+ * If a new workspace omits this property, the server generates a unique deployment name for you with the pattern dbc-xxxxxxxx-xxxx.
115
+ */
116
+ deploymentName?: string | undefined;
117
+ awsRegion?: string | undefined;
118
+ /** The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`). */
119
+ location?: string | undefined;
120
+ /**
121
+ * DEPRECATED: This field is being ignored by the server and will be removed in the future.
122
+ * The cloud name. This field always has the value `gcp`.
123
+ */
124
+ cloud?: string | undefined;
125
+ pricingTier?: PricingTier | undefined;
126
+ cloudResourceContainer?: CloudResourceContainer | undefined;
127
+ /** ID of the workspace's credential configuration object. */
128
+ credentialsId?: string | undefined;
129
+ /** ID of the workspace's storage configuration object. */
130
+ storageConfigurationId?: string | undefined;
131
+ /** The ID of the workspace's network configuration object. To use AWS PrivateLink, this field is required. */
132
+ networkId?: string | undefined;
133
+ gcpManagedNetworkConfig?: GcpManagedNetworkConfig | undefined;
134
+ gkeConfig?: GkeConfig | undefined;
135
+ /**
136
+ * ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.
137
+ * Before configuring PrivateLink, read the [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).",
138
+ */
139
+ privateAccessSettingsId?: string | undefined;
140
+ /** The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property use_cases must contain MANAGED_SERVICES. */
141
+ managedServicesCustomerManagedKeyId?: string | undefined;
142
+ /** The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property use_cases must contain STORAGE. */
143
+ storageCustomerManagedKeyId?: string | undefined;
144
+ /**
145
+ * The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The
146
+ * value can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.
147
+ */
148
+ customTags?: Record<string, string> | undefined;
149
+ /**
150
+ * If the compute mode is `SERVERLESS`, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don't need to provide any resources managed by you, such as credentials, storage, or network.
151
+ * If the compute mode is `HYBRID` (which is the default option), a classic workspace is created that uses customer-managed resources.
152
+ */
153
+ computeMode?: ComputeMode | undefined;
154
+ /** The object ID of network connectivity config. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks and optional private link to access your resources. */
155
+ networkConnectivityConfigId?: string | undefined;
168
156
  }
169
- export interface DeleteWorkspaceRequest {
170
- workspaceId?: bigint | undefined;
171
- accountId?: string | undefined;
157
+ interface DeleteWorkspaceRequest {
158
+ workspaceId?: bigint | undefined;
159
+ accountId?: string | undefined;
172
160
  }
173
- export interface GcpCloudResourceContainer {
174
- projectId?: string | undefined;
161
+ interface GcpCloudResourceContainer {
162
+ projectId?: string | undefined;
175
163
  }
176
164
  /**
177
165
  * The shared network config for GCP workspace.
178
166
  * This object has common network configurations that are network attributions of a workspace.
179
167
  * DEPRECATED. Use GkeConfig instead.
180
168
  */
181
- export interface GcpCommonNetworkConfig {
182
- /** The type of network connectivity of the GKE cluster. */
183
- gkeConnectivityType?: GkeConnectivityType | undefined;
184
- /**
185
- * The IP range that will be used to allocate GKE cluster master resources from.
186
- * This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
187
- */
188
- gkeClusterMasterIpRange?: string | undefined;
169
+ interface GcpCommonNetworkConfig {
170
+ /** The type of network connectivity of the GKE cluster. */
171
+ gkeConnectivityType?: GkeConnectivityType | undefined;
172
+ /**
173
+ * The IP range that will be used to allocate GKE cluster master resources from.
174
+ * This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
175
+ */
176
+ gkeClusterMasterIpRange?: string | undefined;
189
177
  }
190
178
  /** The network configuration for the workspace. */
191
- export interface GcpManagedNetworkConfig {
192
- /**
193
- * The IP range which will be used to allocate GKE cluster nodes from.
194
- * Note: Pods, services and master IP range must be mutually exclusive.
195
- */
196
- subnetCidr?: string | undefined;
197
- /** The IP range that will be used to allocate GKE cluster Pods from. */
198
- gkeClusterPodIpRange?: string | undefined;
199
- /** The IP range that will be used to allocate GKE cluster Services from. */
200
- gkeClusterServiceIpRange?: string | undefined;
179
+ interface GcpManagedNetworkConfig {
180
+ /**
181
+ * The IP range which will be used to allocate GKE cluster nodes from.
182
+ * Note: Pods, services and master IP range must be mutually exclusive.
183
+ */
184
+ subnetCidr?: string | undefined;
185
+ /** The IP range that will be used to allocate GKE cluster Pods from. */
186
+ gkeClusterPodIpRange?: string | undefined;
187
+ /** The IP range that will be used to allocate GKE cluster Services from. */
188
+ gkeClusterServiceIpRange?: string | undefined;
201
189
  }
202
- export interface GetWorkspaceRequest {
203
- workspaceId?: bigint | undefined;
204
- accountId?: string | undefined;
190
+ interface GetWorkspaceRequest {
191
+ workspaceId?: bigint | undefined;
192
+ accountId?: string | undefined;
205
193
  }
206
194
  /** The configurations of the GKE cluster used by the GCP workspace. */
207
- export interface GkeConfig {
208
- /** The type of network connectivity of the GKE cluster. */
209
- connectivityType?: GkeConnectivityType | undefined;
210
- /**
211
- * The IP range that will be used to allocate GKE cluster master resources from.
212
- * This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
213
- */
214
- masterIpRange?: string | undefined;
195
+ interface GkeConfig {
196
+ /** The type of network connectivity of the GKE cluster. */
197
+ connectivityType?: GkeConnectivityType | undefined;
198
+ /**
199
+ * The IP range that will be used to allocate GKE cluster master resources from.
200
+ * This field must not be set if gke_cluster_type=PUBLIC_NODE_PUBLIC_MASTER.
201
+ */
202
+ masterIpRange?: string | undefined;
215
203
  }
216
- export interface ListWorkspacesRequest {
217
- accountId?: string | undefined;
204
+ interface ListWorkspacesRequest {
205
+ accountId?: string | undefined;
218
206
  }
219
- export interface ListWorkspacesResponse {
220
- workspaces?: Workspace[] | undefined;
207
+ interface ListWorkspacesResponse {
208
+ workspaces?: Workspace[] | undefined;
221
209
  }
222
- export interface UpdateWorkspaceRequest {
223
- customerFacingWorkspace?: Workspace | undefined;
224
- updateMask?: FieldMask<Workspace> | undefined;
210
+ interface UpdateWorkspaceRequest {
211
+ customerFacingWorkspace?: Workspace | undefined;
212
+ updateMask?: FieldMask<Workspace> | undefined;
225
213
  }
226
- export interface Workspace {
227
- /** A unique integer ID for the workspace */
228
- workspaceId?: bigint | undefined;
229
- /** The human-readable name of the workspace. */
230
- workspaceName?: string | undefined;
231
- awsRegion?: string | undefined;
232
- /** Time in epoch milliseconds when the workspace was created. */
233
- creationTime?: bigint | undefined;
234
- deploymentName?: string | undefined;
235
- /** The status of a workspace */
236
- workspaceStatus?: WorkspaceStatus | undefined;
237
- /** <Databricks> account ID. */
238
- accountId?: string | undefined;
239
- /** ID of the workspace's credential configuration object. */
240
- credentialsId?: string | undefined;
241
- /** ID of the workspace's storage configuration object. */
242
- storageConfigurationId?: string | undefined;
243
- /** Message describing the current workspace status. */
244
- workspaceStatusMessage?: string | undefined;
245
- networkConfig?: {
246
- $case: 'networkId';
247
- /**
248
- * If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not
249
- * BYO VPC, then the network_id will be empty.
250
- */
251
- networkId: string;
252
- } | {
253
- $case: 'gcpManagedNetworkConfig';
254
- gcpManagedNetworkConfig: GcpManagedNetworkConfig;
255
- } | undefined;
256
- pricingTier?: PricingTier | undefined;
214
+ interface Workspace {
215
+ /** A unique integer ID for the workspace */
216
+ workspaceId?: bigint | undefined;
217
+ /** The human-readable name of the workspace. */
218
+ workspaceName?: string | undefined;
219
+ awsRegion?: string | undefined;
220
+ /** Time in epoch milliseconds when the workspace was created. */
221
+ creationTime?: bigint | undefined;
222
+ deploymentName?: string | undefined;
223
+ /** The status of a workspace */
224
+ workspaceStatus?: WorkspaceStatus | undefined;
225
+ /** <Databricks> account ID. */
226
+ accountId?: string | undefined;
227
+ /** ID of the workspace's credential configuration object. */
228
+ credentialsId?: string | undefined;
229
+ /** ID of the workspace's storage configuration object. */
230
+ storageConfigurationId?: string | undefined;
231
+ /** Message describing the current workspace status. */
232
+ workspaceStatusMessage?: string | undefined;
233
+ networkConfig?: {
234
+ $case: 'networkId';
257
235
  /**
258
- * ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.
259
- *
260
- * Before configuring PrivateLink, read the [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).",
236
+ * If this workspace is BYO VPC, then the network_id will be populated. If this workspace is not
237
+ * BYO VPC, then the network_id will be empty.
261
238
  */
262
- privateAccessSettingsId?: string | undefined;
263
- /** ID of the key configuration for encrypting managed services. */
264
- managedServicesCustomerManagedKeyId?: string | undefined;
265
- /** ID of the key configuration for encrypting workspace storage. */
266
- storageCustomerManagedKeyId?: string | undefined;
267
- /** The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`). */
268
- location?: string | undefined;
269
- /** The cloud name. This field can have values like `azure`, `gcp`. */
270
- cloud?: string | undefined;
271
- /**
272
- * The network configuration for the workspace.
273
- *
274
- * DEPRECATED. Use `network_id` instead.
275
- */
276
- network?: WorkspaceNetwork | undefined;
277
- azureWorkspaceInfo?: AzureWorkspaceInfo | undefined;
278
- gkeConfig?: GkeConfig | undefined;
279
- cloudResourceContainer?: CloudResourceContainer | undefined;
280
- /**
281
- * The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string,
282
- * with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.
283
- */
284
- customTags?: Record<string, string> | undefined;
285
- /** The object ID of network connectivity config. */
286
- networkConnectivityConfigId?: string | undefined;
287
- /** The storage mode of the workspace. */
288
- storageMode?: StorageMode | undefined;
289
- /** The compute mode of the workspace. */
290
- computeMode?: ComputeMode | undefined;
291
- /**
292
- * A client owned field used to indicate the workspace status that the client expects to be in.
293
- * For now this is only used to unblock Temporal workflow for GCP least privileged workspace.
294
- */
295
- expectedWorkspaceStatus?: WorkspaceStatus | undefined;
239
+ networkId: string;
240
+ } | {
241
+ $case: 'gcpManagedNetworkConfig';
242
+ gcpManagedNetworkConfig: GcpManagedNetworkConfig;
243
+ } | undefined;
244
+ pricingTier?: PricingTier | undefined;
245
+ /**
246
+ * ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using [AWS PrivateLink](https://aws.amazon.com/privatelink/) for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types.
247
+ *
248
+ * Before configuring PrivateLink, read the [<Databricks> article about PrivateLink](https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html).",
249
+ */
250
+ privateAccessSettingsId?: string | undefined;
251
+ /** ID of the key configuration for encrypting managed services. */
252
+ managedServicesCustomerManagedKeyId?: string | undefined;
253
+ /** ID of the key configuration for encrypting workspace storage. */
254
+ storageCustomerManagedKeyId?: string | undefined;
255
+ /** The Google Cloud region of the workspace data plane in your Google account (for example, `us-east4`). */
256
+ location?: string | undefined;
257
+ /** The cloud name. This field can have values like `azure`, `gcp`. */
258
+ cloud?: string | undefined;
259
+ /**
260
+ * The network configuration for the workspace.
261
+ *
262
+ * DEPRECATED. Use `network_id` instead.
263
+ */
264
+ network?: WorkspaceNetwork | undefined;
265
+ azureWorkspaceInfo?: AzureWorkspaceInfo | undefined;
266
+ gkeConfig?: GkeConfig | undefined;
267
+ cloudResourceContainer?: CloudResourceContainer | undefined;
268
+ /**
269
+ * The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string,
270
+ * with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.
271
+ */
272
+ customTags?: Record<string, string> | undefined;
273
+ /** The object ID of network connectivity config. */
274
+ networkConnectivityConfigId?: string | undefined;
275
+ /** The storage mode of the workspace. */
276
+ storageMode?: StorageMode | undefined;
277
+ /** The compute mode of the workspace. */
278
+ computeMode?: ComputeMode | undefined;
279
+ /**
280
+ * A client owned field used to indicate the workspace status that the client expects to be in.
281
+ * For now this is only used to unblock Temporal workflow for GCP least privileged workspace.
282
+ */
283
+ expectedWorkspaceStatus?: WorkspaceStatus | undefined;
296
284
  }
297
285
  /** The network configuration for workspaces. */
298
- export interface WorkspaceNetwork {
299
- network?: {
300
- $case: 'gcpManagedNetworkConfig';
301
- /**
302
- * The mutually exclusive network deployment modes. The option decides which network mode the
303
- * workspace will use.
304
- * The network config for GCP workspace with <Databricks> managed network.
305
- * This object is input-only and will not be provided when listing workspaces.
306
- */
307
- gcpManagedNetworkConfig: GcpManagedNetworkConfig;
308
- } | {
309
- $case: 'networkId';
310
- /**
311
- * The ID of the network object, if the workspace is a BYOVPC workspace.
312
- * This should apply to workspaces on all clouds in internal services. In accounts-rest-api, user will use
313
- * workspace.network_id for input and output instead.
314
- * Currently (2021-06-19) the network ID is only used by GCP.
315
- */
316
- networkId: string;
317
- } | undefined;
286
+ interface WorkspaceNetwork {
287
+ network?: {
288
+ $case: 'gcpManagedNetworkConfig';
289
+ /**
290
+ * The mutually exclusive network deployment modes. The option decides which network mode the
291
+ * workspace will use.
292
+ * The network config for GCP workspace with <Databricks> managed network.
293
+ * This object is input-only and will not be provided when listing workspaces.
294
+ */
295
+ gcpManagedNetworkConfig: GcpManagedNetworkConfig;
296
+ } | {
297
+ $case: 'networkId';
318
298
  /**
319
- * The shared network config for GCP workspace.
320
- * This object has common network configurations that are network attributions of a workspace.
321
- * This object is input-only.
299
+ * The ID of the network object, if the workspace is a BYOVPC workspace.
300
+ * This should apply to workspaces on all clouds in internal services. In accounts-rest-api, user will use
301
+ * workspace.network_id for input and output instead.
302
+ * Currently (2021-06-19) the network ID is only used by GCP.
322
303
  */
323
- gcpCommonNetworkConfig?: GcpCommonNetworkConfig | undefined;
304
+ networkId: string;
305
+ } | undefined;
306
+ /**
307
+ * The shared network config for GCP workspace.
308
+ * This object has common network configurations that are network attributions of a workspace.
309
+ * This object is input-only.
310
+ */
311
+ gcpCommonNetworkConfig?: GcpCommonNetworkConfig | undefined;
324
312
  }
325
- export declare const unmarshalAzureWorkspaceInfoSchema: z.ZodType<AzureWorkspaceInfo>;
326
- export declare const unmarshalCloudResourceContainerSchema: z.ZodType<CloudResourceContainer>;
327
- export declare const unmarshalGcpCloudResourceContainerSchema: z.ZodType<GcpCloudResourceContainer>;
328
- export declare const unmarshalGcpCommonNetworkConfigSchema: z.ZodType<GcpCommonNetworkConfig>;
329
- export declare const unmarshalGcpManagedNetworkConfigSchema: z.ZodType<GcpManagedNetworkConfig>;
330
- export declare const unmarshalGkeConfigSchema: z.ZodType<GkeConfig>;
331
- export declare const unmarshalWorkspaceSchema: z.ZodType<Workspace>;
332
- export declare const unmarshalWorkspaceNetworkSchema: z.ZodType<WorkspaceNetwork>;
333
- export declare const marshalAzureWorkspaceInfoSchema: z.ZodType;
334
- export declare const marshalCloudResourceContainerSchema: z.ZodType;
335
- export declare const marshalCreateWorkspaceRequestSchema: z.ZodType;
336
- export declare const marshalGcpCloudResourceContainerSchema: z.ZodType;
337
- export declare const marshalGcpCommonNetworkConfigSchema: z.ZodType;
338
- export declare const marshalGcpManagedNetworkConfigSchema: z.ZodType;
339
- export declare const marshalGkeConfigSchema: z.ZodType;
340
- export declare const marshalWorkspaceSchema: z.ZodType;
341
- export declare const marshalWorkspaceNetworkSchema: z.ZodType;
342
- export declare function workspaceFieldMask(...paths: string[]): FieldMask<Workspace>;
313
+ declare const unmarshalAzureWorkspaceInfoSchema: z.ZodType<AzureWorkspaceInfo>;
314
+ declare const unmarshalCloudResourceContainerSchema: z.ZodType<CloudResourceContainer>;
315
+ declare const unmarshalGcpCloudResourceContainerSchema: z.ZodType<GcpCloudResourceContainer>;
316
+ declare const unmarshalGcpCommonNetworkConfigSchema: z.ZodType<GcpCommonNetworkConfig>;
317
+ declare const unmarshalGcpManagedNetworkConfigSchema: z.ZodType<GcpManagedNetworkConfig>;
318
+ declare const unmarshalGkeConfigSchema: z.ZodType<GkeConfig>;
319
+ declare const unmarshalWorkspaceSchema: z.ZodType<Workspace>;
320
+ declare const unmarshalWorkspaceNetworkSchema: z.ZodType<WorkspaceNetwork>;
321
+ declare const marshalAzureWorkspaceInfoSchema: z.ZodType;
322
+ declare const marshalCloudResourceContainerSchema: z.ZodType;
323
+ declare const marshalCreateWorkspaceRequestSchema: z.ZodType;
324
+ declare const marshalGcpCloudResourceContainerSchema: z.ZodType;
325
+ declare const marshalGcpCommonNetworkConfigSchema: z.ZodType;
326
+ declare const marshalGcpManagedNetworkConfigSchema: z.ZodType;
327
+ declare const marshalGkeConfigSchema: z.ZodType;
328
+ declare const marshalWorkspaceSchema: z.ZodType;
329
+ declare const marshalWorkspaceNetworkSchema: z.ZodType;
330
+ declare function workspaceFieldMask(...paths: string[]): FieldMask<Workspace>;
331
+ //#endregion
332
+ export { AzureWorkspaceInfo, CloudResourceContainer, ComputeMode, CreateWorkspaceRequest, DeleteWorkspaceRequest, GcpCloudResourceContainer, GcpCommonNetworkConfig, GcpManagedNetworkConfig, GetWorkspaceRequest, GkeConfig, GkeConnectivityType, ListWorkspacesRequest, ListWorkspacesResponse, PricingTier, StorageMode, UpdateWorkspaceRequest, Workspace, WorkspaceNetwork, WorkspaceStatus, marshalAzureWorkspaceInfoSchema, marshalCloudResourceContainerSchema, marshalCreateWorkspaceRequestSchema, marshalGcpCloudResourceContainerSchema, marshalGcpCommonNetworkConfigSchema, marshalGcpManagedNetworkConfigSchema, marshalGkeConfigSchema, marshalWorkspaceNetworkSchema, marshalWorkspaceSchema, unmarshalAzureWorkspaceInfoSchema, unmarshalCloudResourceContainerSchema, unmarshalGcpCloudResourceContainerSchema, unmarshalGcpCommonNetworkConfigSchema, unmarshalGcpManagedNetworkConfigSchema, unmarshalGkeConfigSchema, unmarshalWorkspaceNetworkSchema, unmarshalWorkspaceSchema, workspaceFieldMask };
343
333
  //# sourceMappingURL=model.d.ts.map