@databricks/sdk-workspaces 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.
@@ -0,0 +1,7 @@
1
+ //#region package.json
2
+ var name = "@databricks/sdk-workspaces";
3
+ var version = "0.35.0";
4
+
5
+ //#endregion
6
+ export { name, version };
7
+ //# sourceMappingURL=package.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}
@@ -1,80 +1,84 @@
1
- import type { CallOptions } from '@databricks/sdk-options/call';
2
- import type { ClientOptions } from '@databricks/sdk-options/client';
3
- import type { LroOptions } from '@databricks/sdk-options/lro';
4
- import type { CreateWorkspaceRequest, DeleteWorkspaceRequest, GetWorkspaceRequest, ListWorkspacesRequest, ListWorkspacesResponse, UpdateWorkspaceRequest, Workspace } from './model';
5
- export declare class WorkspacesClient {
6
- private readonly options;
7
- private readonly logger;
8
- private readonly userAgent;
9
- private config;
10
- constructor(options: ClientOptions);
11
- private resolveConfig;
12
- /**
13
- * Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.
14
- *
15
- * Important: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace status is typically PROVISIONING. Use the workspace ID (workspace_id) field in the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING.
16
- *
17
- * You can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to share one VPC with multiple workspaces, make sure you size your VPC and subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces.
18
- *
19
- * For information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
20
- *
21
- * Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your <Databricks> representative.
22
- *
23
- * This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.
24
- */
25
- private createWorkspacePublicBase;
26
- /**
27
- * Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.
28
- *
29
- * Important: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace status is typically PROVISIONING. Use the workspace ID (workspace_id) field in the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING.
30
- *
31
- * You can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to share one VPC with multiple workspaces, make sure you size your VPC and subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces.
32
- *
33
- * For information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
34
- *
35
- * Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your <Databricks> representative.
36
- *
37
- * This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.
38
- */
39
- createWorkspacePublic(req: CreateWorkspaceRequest, options?: CallOptions): Promise<CreateWorkspacePublicWaiter>;
40
- /** Deletes a <Databricks> workspace, both specified by ID. */
41
- deleteWorkspacePublic(req: DeleteWorkspaceRequest, options?: CallOptions): Promise<Workspace>;
42
- /**
43
- * Gets information including status for a <Databricks> workspace, specified by ID. In the response, the `workspace_status` field indicates the current status. After initial workspace creation (which is asynchronous), make repeated `GET` requests with the workspace ID and check its status. The workspace becomes available when the status changes to `RUNNING`.
44
- * For information about how to create a new workspace with this API **including error handling**, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
45
- */
46
- getWorkspacePublic(req: GetWorkspaceRequest, options?: CallOptions): Promise<Workspace>;
47
- /** Lists <Databricks> workspaces for an account. */
48
- listWorkspacesPublic(req: ListWorkspacesRequest, options?: CallOptions): Promise<ListWorkspacesResponse>;
49
- /** Updates a workspace. */
50
- private updateWorkspacePublicBase;
51
- /** Updates a workspace. */
52
- updateWorkspacePublic(req: UpdateWorkspaceRequest, options?: CallOptions): Promise<UpdateWorkspacePublicWaiter>;
1
+ import { CreateWorkspaceRequest, DeleteWorkspaceRequest, GetWorkspaceRequest, ListWorkspacesRequest, ListWorkspacesResponse, UpdateWorkspaceRequest, Workspace } from "./model.js";
2
+ import { CallOptions } from "@databricks/sdk-options/call";
3
+ import { ClientOptions } from "@databricks/sdk-options/client";
4
+ import { LroOptions } from "@databricks/sdk-options/lro";
5
+
6
+ //#region src/v1/client.d.ts
7
+ declare class WorkspacesClient {
8
+ private readonly options;
9
+ private readonly logger;
10
+ private readonly userAgent;
11
+ private config;
12
+ constructor(options: ClientOptions);
13
+ private resolveConfig;
14
+ /**
15
+ * Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.
16
+ *
17
+ * Important: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace status is typically PROVISIONING. Use the workspace ID (workspace_id) field in the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING.
18
+ *
19
+ * You can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to share one VPC with multiple workspaces, make sure you size your VPC and subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces.
20
+ *
21
+ * For information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
22
+ *
23
+ * Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your <Databricks> representative.
24
+ *
25
+ * This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.
26
+ */
27
+ private createWorkspacePublicBase;
28
+ /**
29
+ * Creates a new workspace using a credential configuration and a storage configuration, an optional network configuration (if using a customer-managed VPC), an optional managed services key configuration (if using customer-managed keys for managed services), and an optional storage key configuration (if using customer-managed keys for storage). The key configurations used for managed services and storage encryption can be the same or different.
30
+ *
31
+ * Important: This operation is asynchronous. A response with HTTP status code 200 means the request has been accepted and is in progress, but does not mean that the workspace deployed successfully and is running. The initial workspace status is typically PROVISIONING. Use the workspace ID (workspace_id) field in the response to identify the new workspace and make repeated GET requests with the workspace ID and check its status. The workspace becomes available when the status changes to RUNNING.
32
+ *
33
+ * You can share one customer-managed VPC with multiple workspaces in a single account. It is not required to create a new VPC for each workspace. However, you cannot reuse subnets or Security Groups between workspaces. If you plan to share one VPC with multiple workspaces, make sure you size your VPC and subnets accordingly. Because a Databricks Account API network configuration encapsulates this information, you cannot reuse a Databricks Account API network configuration across workspaces.
34
+ *
35
+ * For information about how to create a new workspace with this API including error handling, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
36
+ *
37
+ * Important: Customer-managed VPCs, PrivateLink, and customer-managed keys are supported on a limited set of deployment and subscription types. If you have questions about availability, contact your <Databricks> representative.
38
+ *
39
+ * This operation is available only if your account is on the E2 version of the platform or on a select custom plan that allows multiple workspaces per account.
40
+ */
41
+ createWorkspacePublic(req: CreateWorkspaceRequest, options?: CallOptions): Promise<CreateWorkspacePublicWaiter>;
42
+ /** Deletes a <Databricks> workspace, both specified by ID. */
43
+ deleteWorkspacePublic(req: DeleteWorkspaceRequest, options?: CallOptions): Promise<Workspace>;
44
+ /**
45
+ * Gets information including status for a <Databricks> workspace, specified by ID. In the response, the `workspace_status` field indicates the current status. After initial workspace creation (which is asynchronous), make repeated `GET` requests with the workspace ID and check its status. The workspace becomes available when the status changes to `RUNNING`.
46
+ * For information about how to create a new workspace with this API **including error handling**, see [Create a new workspace using the Account API](http://docs.databricks.com/administration-guide/account-api/new-workspace.html).
47
+ */
48
+ getWorkspacePublic(req: GetWorkspaceRequest, options?: CallOptions): Promise<Workspace>;
49
+ /** Lists <Databricks> workspaces for an account. */
50
+ listWorkspacesPublic(req: ListWorkspacesRequest, options?: CallOptions): Promise<ListWorkspacesResponse>;
51
+ /** Updates a workspace. */
52
+ private updateWorkspacePublicBase;
53
+ /** Updates a workspace. */
54
+ updateWorkspacePublic(req: UpdateWorkspaceRequest, options?: CallOptions): Promise<UpdateWorkspacePublicWaiter>;
53
55
  }
54
- export declare class CreateWorkspacePublicWaiter {
55
- private readonly client;
56
- readonly workspaceId: bigint;
57
- constructor(client: WorkspacesClient, workspaceId: bigint);
58
- /**
59
- * Polls until the operation reaches a terminal state.
60
- *
61
- * Throws if a failure state is reached.
62
- */
63
- wait(options?: LroOptions): Promise<Workspace>;
64
- /** Checks whether the operation has reached a terminal state. */
65
- done(options?: CallOptions): Promise<boolean>;
56
+ declare class CreateWorkspacePublicWaiter {
57
+ private readonly client;
58
+ readonly workspaceId: bigint;
59
+ constructor(client: WorkspacesClient, workspaceId: bigint);
60
+ /**
61
+ * Polls until the operation reaches a terminal state.
62
+ *
63
+ * Throws if a failure state is reached.
64
+ */
65
+ wait(options?: LroOptions): Promise<Workspace>;
66
+ /** Checks whether the operation has reached a terminal state. */
67
+ done(options?: CallOptions): Promise<boolean>;
66
68
  }
67
- export declare class UpdateWorkspacePublicWaiter {
68
- private readonly client;
69
- readonly workspaceId: bigint;
70
- constructor(client: WorkspacesClient, workspaceId: bigint);
71
- /**
72
- * Polls until the operation reaches a terminal state.
73
- *
74
- * Throws if a failure state is reached.
75
- */
76
- wait(options?: LroOptions): Promise<Workspace>;
77
- /** Checks whether the operation has reached a terminal state. */
78
- done(options?: CallOptions): Promise<boolean>;
69
+ declare class UpdateWorkspacePublicWaiter {
70
+ private readonly client;
71
+ readonly workspaceId: bigint;
72
+ constructor(client: WorkspacesClient, workspaceId: bigint);
73
+ /**
74
+ * Polls until the operation reaches a terminal state.
75
+ *
76
+ * Throws if a failure state is reached.
77
+ */
78
+ wait(options?: LroOptions): Promise<Workspace>;
79
+ /** Checks whether the operation has reached a terminal state. */
80
+ done(options?: CallOptions): Promise<boolean>;
79
81
  }
82
+ //#endregion
83
+ export { CreateWorkspacePublicWaiter, UpdateWorkspacePublicWaiter, WorkspacesClient };
80
84
  //# sourceMappingURL=client.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/v1/client.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAc5D,OAAO,KAAK,EACV,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,SAAS,EACV,MAAM,SAAS,CAAC;AAcjB,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IACxC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAIhC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAInC,OAAO,CAAC,MAAM,CAA4C;gBAE9C,OAAO,EAAE,aAAa;IAUlC,OAAO,CAAC,aAAa;IAKrB;;;;;;;;;;;;OAYG;YACW,yBAAyB;IA0BvC;;;;;;;;;;;;OAYG;IACG,qBAAqB,CACzB,GAAG,EAAE,sBAAsB,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;IAUvC,8DAA8D;IACxD,qBAAqB,CACzB,GAAG,EAAE,sBAAsB,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IAsBrB;;;OAGG;IACG,kBAAkB,CACtB,GAAG,EAAE,mBAAmB,EACxB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,SAAS,CAAC;IAsBrB,oDAAoD;IAC9C,oBAAoB,CACxB,GAAG,EAAE,qBAAqB,EAC1B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,sBAAsB,CAAC;IA2BlC,2BAA2B;YACb,yBAAyB;IAyCvC,2BAA2B;IACrB,qBAAqB,CACzB,GAAG,EAAE,sBAAsB,EAC3B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,2BAA2B,CAAC;CASxC;AAED,qBAAa,2BAA2B;IAEpC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM;gBADX,MAAM,EAAE,gBAAgB,EAChC,WAAW,EAAE,MAAM;IAG9B;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAqCpD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD;AAED,qBAAa,2BAA2B;IAEpC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM;gBADX,MAAM,EAAE,gBAAgB,EAChC,WAAW,EAAE,MAAM;IAG9B;;;;OAIG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;IAqCpD,iEAAiE;IAC3D,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;CAsBpD"}
1
+ {"version":3,"file":"client.d.ts","names":[],"sources":["../../src/v1/client.ts"],"mappings":";;;;;;cA4Ca,gBAAA;EAAA,iBACM,OAAA;EAAA,iBACA,MAAA;EAAA,iBAIA,SAAA;EAAA,QAIT,MAAA;cAEI,OAAA,EAAS,aAAA;EAAA,QAUb,aAAA;EA2DI;;;;;;;;;;;;;EAAA,QAzCE,yBAAA;EA+GX;;;;;;;;;;;;;EAxEG,qBAAA,CACJ,GAAA,EAAK,sBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,2BAAA;EA5DH;EAuEF,qBAAA,CACJ,GAAA,EAAK,sBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,SAAA;EAjBL;;;;EA2CA,kBAAA,CACJ,GAAA,EAAK,mBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,SAAA;EA3CR;EAkEG,oBAAA,CACJ,GAAA,EAAK,qBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,sBAAA;EA1DL;EAAA,QAsFQ,yBAAA;EArFZ;EA+HI,qBAAA,CACJ,GAAA,EAAK,sBAAA,EACL,OAAA,GAAU,WAAA,GACT,OAAA,CAAQ,2BAAA;AAAA;AAAA,cAWA,2BAAA;EAAA,iBAEQ,MAAA;EAAA,SACR,WAAA;cADQ,MAAA,EAAQ,gBAAA,EAChB,WAAA;EAnHT;;;;;EA2HI,IAAA,CAAK,OAAA,GAAU,UAAA,GAAa,OAAA,CAAQ,SAAA;EAjGnC;EAuID,IAAA,CAAK,OAAA,GAAU,WAAA,GAAc,OAAA;AAAA;AAAA,cAwBxB,2BAAA;EAAA,iBAEQ,MAAA;EAAA,SACR,WAAA;cADQ,MAAA,EAAQ,gBAAA,EAChB,WAAA;EA1FL;;;;;EAkGA,IAAA,CAAK,OAAA,GAAU,UAAA,GAAa,OAAA,CAAQ,SAAA;EA/F/B;EAqIL,IAAA,CAAK,OAAA,GAAU,WAAA,GAAc,OAAA;AAAA"}