tencentcloud-sdk-nodejs-intl-en 3.0.1450 → 3.0.1452

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,913 @@
1
+ /*
2
+ * Copyright (c) 2018 Tencent. All Rights Reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing,
11
+ * software distributed under the License is distributed on an
12
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
+ * KIND, either express or implied. See the License for the
14
+ * specific language governing permissions and limitations
15
+ * under the License.
16
+ */
17
+ const models = require("./models");
18
+ const AbstractClient = require('../../common/abstract_client')
19
+ const CreateWorkspaceRoleResponse = models.CreateWorkspaceRoleResponse;
20
+ const AddWorkspaceGroupsRequest = models.AddWorkspaceGroupsRequest;
21
+ const GetFolderRsp = models.GetFolderRsp;
22
+ const DependOnBrief = models.DependOnBrief;
23
+ const ListConsoleGroupUsersRequest = models.ListConsoleGroupUsersRequest;
24
+ const DeleteFolderResponse = models.DeleteFolderResponse;
25
+ const FolderLocator = models.FolderLocator;
26
+ const ListWorkspaceGroupsResponse = models.ListWorkspaceGroupsResponse;
27
+ const ListConsoleGroupsRequest = models.ListConsoleGroupsRequest;
28
+ const InnerWorkflowTaskRunListOption = models.InnerWorkflowTaskRunListOption;
29
+ const RemoveWorkspaceGroupsResponse = models.RemoveWorkspaceGroupsResponse;
30
+ const PermissionDetail = models.PermissionDetail;
31
+ const UpdateConsoleUsersResponse = models.UpdateConsoleUsersResponse;
32
+ const ListWorkflowTaskRunsRequest = models.ListWorkflowTaskRunsRequest;
33
+ const WorkspaceUserInfo = models.WorkspaceUserInfo;
34
+ const Workflow = models.Workflow;
35
+ const TaskRetryStrategy = models.TaskRetryStrategy;
36
+ const FileStorage = models.FileStorage;
37
+ const ScheduledTimeConfig = models.ScheduledTimeConfig;
38
+ const Catalog = models.Catalog;
39
+ const WorkflowRun = models.WorkflowRun;
40
+ const FetchOption = models.FetchOption;
41
+ const DeleteWorkflowResponse = models.DeleteWorkflowResponse;
42
+ const GetWorkspaceResponse = models.GetWorkspaceResponse;
43
+ const ListConsoleUsersResponse = models.ListConsoleUsersResponse;
44
+ const RemoveConsoleUsersResponse = models.RemoveConsoleUsersResponse;
45
+ const InnerWorkflowTaskBrief = models.InnerWorkflowTaskBrief;
46
+ const MonitorMetricBrief = models.MonitorMetricBrief;
47
+ const ListCatalogsResponse = models.ListCatalogsResponse;
48
+ const UpdateWorkspaceResponse = models.UpdateWorkspaceResponse;
49
+ const PlatformStatusRsp = models.PlatformStatusRsp;
50
+ const AddWorkspaceUsersResponse = models.AddWorkspaceUsersResponse;
51
+ const InnerWorkflowTaskRunIteration = models.InnerWorkflowTaskRunIteration;
52
+ const CreateCatalogRequest = models.CreateCatalogRequest;
53
+ const SparseCheckoutConfig = models.SparseCheckoutConfig;
54
+ const StartComputeRsp = models.StartComputeRsp;
55
+ const DeleteWorkflowRequest = models.DeleteWorkflowRequest;
56
+ const WorkspaceInfo = models.WorkspaceInfo;
57
+ const CreateSchemaRsp = models.CreateSchemaRsp;
58
+ const GetWorkspaceRequest = models.GetWorkspaceRequest;
59
+ const ListConsoleGroupsRsp = models.ListConsoleGroupsRsp;
60
+ const AlarmBrief = models.AlarmBrief;
61
+ const CreateWorkspaceRsp = models.CreateWorkspaceRsp;
62
+ const RerunWorkflowRunResponse = models.RerunWorkflowRunResponse;
63
+ const ListWorkspacesRequest = models.ListWorkspacesRequest;
64
+ const WorkflowTaskNodeBrief = models.WorkflowTaskNodeBrief;
65
+ const UpdateWorkspaceRsp = models.UpdateWorkspaceRsp;
66
+ const CreateWorkspaceRoleRequest = models.CreateWorkspaceRoleRequest;
67
+ const ListSchemasResponse = models.ListSchemasResponse;
68
+ const CreateWorkflowRequest = models.CreateWorkflowRequest;
69
+ const ListFilesRequest = models.ListFilesRequest;
70
+ const WorkflowRunBrief = models.WorkflowRunBrief;
71
+ const WorkflowTriggerAdvancedConfiguration = models.WorkflowTriggerAdvancedConfiguration;
72
+ const UpdateWorkspaceRoleResult = models.UpdateWorkspaceRoleResult;
73
+ const AsyncActionRsp = models.AsyncActionRsp;
74
+ const CreateFileResponse = models.CreateFileResponse;
75
+ const TaskSchedulingParameterBrief = models.TaskSchedulingParameterBrief;
76
+ const UpdateWorkflowRequest = models.UpdateWorkflowRequest;
77
+ const ListWorkspaceGroupsRsp = models.ListWorkspaceGroupsRsp;
78
+ const KVPair = models.KVPair;
79
+ const TaskRunConditionRule = models.TaskRunConditionRule;
80
+ const ResourceGroupInfo = models.ResourceGroupInfo;
81
+ const UnbindWorkflowBundleResponse = models.UnbindWorkflowBundleResponse;
82
+ const UpdateConsoleGroupRsp = models.UpdateConsoleGroupRsp;
83
+ const UnbindWorkflowBundleRsp = models.UnbindWorkflowBundleRsp;
84
+ const CreateFolderRequest = models.CreateFolderRequest;
85
+ const KillWorkflowRunResponse = models.KillWorkflowRunResponse;
86
+ const ListSchemasRsp = models.ListSchemasRsp;
87
+ const DeleteFolderRequest = models.DeleteFolderRequest;
88
+ const CommonTagInfo = models.CommonTagInfo;
89
+ const AddConsoleUsersRsp = models.AddConsoleUsersRsp;
90
+ const RemoveConsoleUsersRequest = models.RemoveConsoleUsersRequest;
91
+ const DeleteConsoleGroupsRsp = models.DeleteConsoleGroupsRsp;
92
+ const ListWorkflowRunsRequest = models.ListWorkflowRunsRequest;
93
+ const WorkflowTriggerConfiguration = models.WorkflowTriggerConfiguration;
94
+ const GetWorkflowTaskRunResponse = models.GetWorkflowTaskRunResponse;
95
+ const DeleteWorkspaceResponse = models.DeleteWorkspaceResponse;
96
+ const GetFileRequest = models.GetFileRequest;
97
+ const WorkflowBaseInfo = models.WorkflowBaseInfo;
98
+ const TaskType = models.TaskType;
99
+ const TaskTypeNotebookExt = models.TaskTypeNotebookExt;
100
+ const GetFolderResponse = models.GetFolderResponse;
101
+ const DeleteCatalogRsp = models.DeleteCatalogRsp;
102
+ const CreateWorkflowRsp = models.CreateWorkflowRsp;
103
+ const GetFileResponse = models.GetFileResponse;
104
+ const AsyncOperation = models.AsyncOperation;
105
+ const UpdateWorkspaceRequest = models.UpdateWorkspaceRequest;
106
+ const ListFilesRsp = models.ListFilesRsp;
107
+ const RoleMetaData = models.RoleMetaData;
108
+ const GetWorkflowRunRsp = models.GetWorkflowRunRsp;
109
+ const GetCatalogRsp = models.GetCatalogRsp;
110
+ const DeleteWorkspaceRoleResponse = models.DeleteWorkspaceRoleResponse;
111
+ const DeleteSchemaResponse = models.DeleteSchemaResponse;
112
+ const ListConsoleGroupUsersResponse = models.ListConsoleGroupUsersResponse;
113
+ const ListWorkflowTaskRunsRsp = models.ListWorkflowTaskRunsRsp;
114
+ const ScheduleBizEnumBrief = models.ScheduleBizEnumBrief;
115
+ const AddWorkspaceGroupsResponse = models.AddWorkspaceGroupsResponse;
116
+ const CreateCatalogRsp = models.CreateCatalogRsp;
117
+ const GetWorkspaceRsp = models.GetWorkspaceRsp;
118
+ const TagValueInfo = models.TagValueInfo;
119
+ const CreateSchemaResponse = models.CreateSchemaResponse;
120
+ const CreateFolderResponse = models.CreateFolderResponse;
121
+ const InnerWorkflowTaskRunIterationBrief = models.InnerWorkflowTaskRunIterationBrief;
122
+ const CreateConsoleGroupRequest = models.CreateConsoleGroupRequest;
123
+ const RemoveConsoleUsersRsp = models.RemoveConsoleUsersRsp;
124
+ const ListWorkflowsResponse = models.ListWorkflowsResponse;
125
+ const ListWorkflowsRsp = models.ListWorkflowsRsp;
126
+ const UpdateFolderResponse = models.UpdateFolderResponse;
127
+ const RerunWorkflowRunRequest = models.RerunWorkflowRunRequest;
128
+ const DeleteWorkspaceRequest = models.DeleteWorkspaceRequest;
129
+ const StartComputeResponse = models.StartComputeResponse;
130
+ const LabelBrief = models.LabelBrief;
131
+ const DeleteWorkspaceRoleRequest = models.DeleteWorkspaceRoleRequest;
132
+ const CreateSchemaRequest = models.CreateSchemaRequest;
133
+ const AddConsoleUsersRequest = models.AddConsoleUsersRequest;
134
+ const CreateConsoleGroupRsp = models.CreateConsoleGroupRsp;
135
+ const WorkflowTaskRun = models.WorkflowTaskRun;
136
+ const DeleteCatalogResponse = models.DeleteCatalogResponse;
137
+ const DeleteWorkspaceRsp = models.DeleteWorkspaceRsp;
138
+ const WorkflowBaseInfoDetail = models.WorkflowBaseInfoDetail;
139
+ const WorkflowBrief = models.WorkflowBrief;
140
+ const StopComputeRequest = models.StopComputeRequest;
141
+ const KillWorkflowRunRequest = models.KillWorkflowRunRequest;
142
+ const GetCatalogRequest = models.GetCatalogRequest;
143
+ const ListWorkflowTaskRunsResponse = models.ListWorkflowTaskRunsResponse;
144
+ const AddConsoleUsersResponse = models.AddConsoleUsersResponse;
145
+ const ListConsoleUsersRsp = models.ListConsoleUsersRsp;
146
+ const FileMeta = models.FileMeta;
147
+ const MetaOwner = models.MetaOwner;
148
+ const UnbindWorkflowBundleRequest = models.UnbindWorkflowBundleRequest;
149
+ const ConsoleRoleInfo = models.ConsoleRoleInfo;
150
+ const ConsoleGroupUserInfo = models.ConsoleGroupUserInfo;
151
+ const DeleteFileResult = models.DeleteFileResult;
152
+ const RunActionBrief = models.RunActionBrief;
153
+ const FileOutputConf = models.FileOutputConf;
154
+ const RunWorkflowRequest = models.RunWorkflowRequest;
155
+ const ListWorkflowRunsRsp = models.ListWorkflowRunsRsp;
156
+ const UpdateConsoleGroupRequest = models.UpdateConsoleGroupRequest;
157
+ const ConsoleGroupInfo = models.ConsoleGroupInfo;
158
+ const UpdateWorkspaceRoleResponse = models.UpdateWorkspaceRoleResponse;
159
+ const ListConsoleRolesRsp = models.ListConsoleRolesRsp;
160
+ const UserTagInfo = models.UserTagInfo;
161
+ const GetWorkflowResponse = models.GetWorkflowResponse;
162
+ const GetWorkflowTaskRunRequest = models.GetWorkflowTaskRunRequest;
163
+ const DeleteFileResponse = models.DeleteFileResponse;
164
+ const UpdateConsoleUsersRsp = models.UpdateConsoleUsersRsp;
165
+ const AddWorkspaceUsersRequest = models.AddWorkspaceUsersRequest;
166
+ const ListFilesResponse = models.ListFilesResponse;
167
+ const WorkflowTask = models.WorkflowTask;
168
+ const DeleteSchemaRsp = models.DeleteSchemaRsp;
169
+ const StopComputeResponse = models.StopComputeResponse;
170
+ const AdvancedDependencyConfig = models.AdvancedDependencyConfig;
171
+ const StopComputeRsp = models.StopComputeRsp;
172
+ const DeleteConsoleGroupsRequest = models.DeleteConsoleGroupsRequest;
173
+ const ListCatalogsRsp = models.ListCatalogsRsp;
174
+ const UpdateWorkflowResponse = models.UpdateWorkflowResponse;
175
+ const GetWorkflowRequest = models.GetWorkflowRequest;
176
+ const FileInfo = models.FileInfo;
177
+ const UpdateWorkspaceRoleRequest = models.UpdateWorkspaceRoleRequest;
178
+ const ListWorkspaceUsersResponse = models.ListWorkspaceUsersResponse;
179
+ const FileNode = models.FileNode;
180
+ const UpdateFolderRsp = models.UpdateFolderRsp;
181
+ const TaskTypeProperty = models.TaskTypeProperty;
182
+ const GetFolderRequest = models.GetFolderRequest;
183
+ const CreateFileRequest = models.CreateFileRequest;
184
+ const UpdateFileRequest = models.UpdateFileRequest;
185
+ const GetWorkflowRunRequest = models.GetWorkflowRunRequest;
186
+ const UserInfo = models.UserInfo;
187
+ const ListWorkflowsRequest = models.ListWorkflowsRequest;
188
+ const RolePermission = models.RolePermission;
189
+ const ListCatalogsRequest = models.ListCatalogsRequest;
190
+ const FileConfig = models.FileConfig;
191
+ const CreateWorkspaceRoleResult = models.CreateWorkspaceRoleResult;
192
+ const RunWorkflowResponse = models.RunWorkflowResponse;
193
+ const ListConsoleUsersRequest = models.ListConsoleUsersRequest;
194
+ const ListWorkflowRunsResponse = models.ListWorkflowRunsResponse;
195
+ const RemoveWorkspaceGroupsRequest = models.RemoveWorkspaceGroupsRequest;
196
+ const ListWorkspaceGroupsRequest = models.ListWorkspaceGroupsRequest;
197
+ const AdvancedParameter = models.AdvancedParameter;
198
+ const DeleteWorkspaceRoleResult = models.DeleteWorkspaceRoleResult;
199
+ const UpdateConsoleGroupResponse = models.UpdateConsoleGroupResponse;
200
+ const StandardUserInfo = models.StandardUserInfo;
201
+ const ConsoleUserInfo = models.ConsoleUserInfo;
202
+ const UpdateWorkflowRsp = models.UpdateWorkflowRsp;
203
+ const DeleteCatalogRequest = models.DeleteCatalogRequest;
204
+ const Schema = models.Schema;
205
+ const OrderBy = models.OrderBy;
206
+ const UpdateFolderRequest = models.UpdateFolderRequest;
207
+ const DeleteFolderRsp = models.DeleteFolderRsp;
208
+ const WorkflowAdvanceConfig = models.WorkflowAdvanceConfig;
209
+ const ListSchemasRequest = models.ListSchemasRequest;
210
+ const ParamInfo = models.ParamInfo;
211
+ const CreateCatalogResponse = models.CreateCatalogResponse;
212
+ const DeleteConsoleGroupsResponse = models.DeleteConsoleGroupsResponse;
213
+ const InnerWorkflowTaskRun = models.InnerWorkflowTaskRun;
214
+ const MonitorMetricItem = models.MonitorMetricItem;
215
+ const ListWorkspaceUsersRsp = models.ListWorkspaceUsersRsp;
216
+ const CreateWorkflowResponse = models.CreateWorkflowResponse;
217
+ const ListConsoleRolesRequest = models.ListConsoleRolesRequest;
218
+ const ListConsoleGroupUsersRsp = models.ListConsoleGroupUsersRsp;
219
+ const Audit = models.Audit;
220
+ const AlarmGroup = models.AlarmGroup;
221
+ const DeleteFileRequest = models.DeleteFileRequest;
222
+ const DeleteWorkflowRsp = models.DeleteWorkflowRsp;
223
+ const CommonFailItem = models.CommonFailItem;
224
+ const ListWorkspacesResponse = models.ListWorkspacesResponse;
225
+ const GetCatalogResponse = models.GetCatalogResponse;
226
+ const GetWorkflowRunResponse = models.GetWorkflowRunResponse;
227
+ const ListConsoleGroupsResponse = models.ListConsoleGroupsResponse;
228
+ const GetWorkflowRsp = models.GetWorkflowRsp;
229
+ const CreateWorkspaceRequest = models.CreateWorkspaceRequest;
230
+ const WorkspaceGroupInfo = models.WorkspaceGroupInfo;
231
+ const RoleBasicInfo = models.RoleBasicInfo;
232
+ const GitRepoConfig = models.GitRepoConfig;
233
+ const ListConsoleRolesResponse = models.ListConsoleRolesResponse;
234
+ const ListWorkspacesRsp = models.ListWorkspacesRsp;
235
+ const CreateWorkspaceResponse = models.CreateWorkspaceResponse;
236
+ const ListWorkspaceUsersRequest = models.ListWorkspaceUsersRequest;
237
+ const UpdateFileResponse = models.UpdateFileResponse;
238
+ const CreateFolderRsp = models.CreateFolderRsp;
239
+ const DeleteSchemaRequest = models.DeleteSchemaRequest;
240
+ const StartComputeRequest = models.StartComputeRequest;
241
+ const UpdateConsoleUsersRequest = models.UpdateConsoleUsersRequest;
242
+ const CreateConsoleGroupResponse = models.CreateConsoleGroupResponse;
243
+ const GetWorkflowTaskRunRsp = models.GetWorkflowTaskRunRsp;
244
+
245
+
246
+ /**
247
+ * databuddy client
248
+ * @class
249
+ */
250
+ class DatabuddyClient extends AbstractClient {
251
+
252
+ constructor(credential, region, profile) {
253
+ super("databuddy.intl.tencentcloudapi.com", "2026-07-15", credential, region, profile);
254
+ }
255
+
256
+ /**
257
+ * Unbind workflow Bundle info
258
+ Description: This interface is semantically equivalent to Detach in the standard verb list. The name Unbind is retained for compatibility with existing product forms.
259
+ * @param {UnbindWorkflowBundleRequest} req
260
+ * @param {function(string, UnbindWorkflowBundleResponse):void} cb
261
+ * @public
262
+ */
263
+ UnbindWorkflowBundle(req, cb) {
264
+ let resp = new UnbindWorkflowBundleResponse();
265
+ this.request("UnbindWorkflowBundle", req, resp, cb);
266
+ }
267
+
268
+ /**
269
+ * Updating a Workflow
270
+ * @param {UpdateWorkflowRequest} req
271
+ * @param {function(string, UpdateWorkflowResponse):void} cb
272
+ * @public
273
+ */
274
+ UpdateWorkflow(req, cb) {
275
+ let resp = new UpdateWorkflowResponse();
276
+ this.request("UpdateWorkflow", req, resp, cb);
277
+ }
278
+
279
+ /**
280
+ * Add a console user
281
+ * @param {AddConsoleUsersRequest} req
282
+ * @param {function(string, AddConsoleUsersResponse):void} cb
283
+ * @public
284
+ */
285
+ AddConsoleUsers(req, cb) {
286
+ let resp = new AddConsoleUsersResponse();
287
+ this.request("AddConsoleUsers", req, resp, cb);
288
+ }
289
+
290
+ /**
291
+ * This API is used to query workflow details.
292
+ * @param {GetWorkflowRequest} req
293
+ * @param {function(string, GetWorkflowResponse):void} cb
294
+ * @public
295
+ */
296
+ GetWorkflow(req, cb) {
297
+ let resp = new GetWorkflowResponse();
298
+ this.request("GetWorkflow", req, resp, cb);
299
+ }
300
+
301
+ /**
302
+ * Create a schema
303
+ * @param {CreateSchemaRequest} req
304
+ * @param {function(string, CreateSchemaResponse):void} cb
305
+ * @public
306
+ */
307
+ CreateSchema(req, cb) {
308
+ let resp = new CreateSchemaResponse();
309
+ this.request("CreateSchema", req, resp, cb);
310
+ }
311
+
312
+ /**
313
+ * Query task execution details
314
+ * @param {GetWorkflowTaskRunRequest} req
315
+ * @param {function(string, GetWorkflowTaskRunResponse):void} cb
316
+ * @public
317
+ */
318
+ GetWorkflowTaskRun(req, cb) {
319
+ let resp = new GetWorkflowTaskRunResponse();
320
+ this.request("GetWorkflowTaskRun", req, resp, cb);
321
+ }
322
+
323
+ /**
324
+ * Query the historical operation list of workflow tasks
325
+ * @param {ListWorkflowTaskRunsRequest} req
326
+ * @param {function(string, ListWorkflowTaskRunsResponse):void} cb
327
+ * @public
328
+ */
329
+ ListWorkflowTaskRuns(req, cb) {
330
+ let resp = new ListWorkflowTaskRunsResponse();
331
+ this.request("ListWorkflowTaskRuns", req, resp, cb);
332
+ }
333
+
334
+ /**
335
+ * Queries the details of a workspace.
336
+ * @param {GetWorkspaceRequest} req
337
+ * @param {function(string, GetWorkspaceResponse):void} cb
338
+ * @public
339
+ */
340
+ GetWorkspace(req, cb) {
341
+ let resp = new GetWorkspaceResponse();
342
+ this.request("GetWorkspace", req, resp, cb);
343
+ }
344
+
345
+ /**
346
+ * Queries workflow running details.
347
+ * @param {GetWorkflowRunRequest} req
348
+ * @param {function(string, GetWorkflowRunResponse):void} cb
349
+ * @public
350
+ */
351
+ GetWorkflowRun(req, cb) {
352
+ let resp = new GetWorkflowRunResponse();
353
+ this.request("GetWorkflowRun", req, resp, cb);
354
+ }
355
+
356
+ /**
357
+ * Get folder details.
358
+ * @param {GetFolderRequest} req
359
+ * @param {function(string, GetFolderResponse):void} cb
360
+ * @public
361
+ */
362
+ GetFolder(req, cb) {
363
+ let resp = new GetFolderResponse();
364
+ this.request("GetFolder", req, resp, cb);
365
+ }
366
+
367
+ /**
368
+ * Delete a console user group
369
+ * @param {DeleteConsoleGroupsRequest} req
370
+ * @param {function(string, DeleteConsoleGroupsResponse):void} cb
371
+ * @public
372
+ */
373
+ DeleteConsoleGroups(req, cb) {
374
+ let resp = new DeleteConsoleGroupsResponse();
375
+ this.request("DeleteConsoleGroups", req, resp, cb);
376
+ }
377
+
378
+ /**
379
+ * This API is used to create user groups.
380
+ * @param {AddWorkspaceUsersRequest} req
381
+ * @param {function(string, AddWorkspaceUsersResponse):void} cb
382
+ * @public
383
+ */
384
+ AddWorkspaceUsers(req, cb) {
385
+ let resp = new AddWorkspaceUsersResponse();
386
+ this.request("AddWorkspaceUsers", req, resp, cb);
387
+ }
388
+
389
+ /**
390
+ * Queries the workspace list.
391
+ * @param {ListWorkspacesRequest} req
392
+ * @param {function(string, ListWorkspacesResponse):void} cb
393
+ * @public
394
+ */
395
+ ListWorkspaces(req, cb) {
396
+ let resp = new ListWorkspacesResponse();
397
+ this.request("ListWorkspaces", req, resp, cb);
398
+ }
399
+
400
+ /**
401
+ * Get the file's metadata, optionally including file content, and read historical snapshots by version.
402
+
403
+ **Prerequisite**
404
+ 1. Pass at least one of FileId and FilePath. If both are passed, FileId takes precedence.
405
+ 2. The corresponding file must exist, and the caller must have read permission for the file;
406
+ 3. If VersionId is passed, the version must exist.
407
+
408
+ **Error codes (Module: `Studio`)**
409
+
410
+ | Error Code | Inner Code | Description | Handling Suggestion |
411
+ | --- | --- | --- | --- |
412
+ | `MissingParameter.WorkspaceId` | 1030001 | Lack of WorkspaceId | Please input WorkspaceId |
413
+ | `MissingParameter.FileId` | 1030003 | FileId and FilePath cannot be empty at the same time | Pass at least one of FileId and FilePath |
414
+ | `InvalidParameterValue.FileType` | 1030102 | FileType value unsupported | FileType takes FILE/NOTEBOOK_FILE/SQL_FILE |
415
+ | `ResourceNotFound.FileNotFound` | 1030203 | File does not exist or has been deleted | Confirm the FileId or FilePath |
416
+ | `ResourceNotFound.FileVersionNotFound` | 1030205 | The specified file version does not exist | Confirm the VersionId or call ListFileVersions to retrieve |
417
+ | `UnauthorizedOperation.FileReadDenied` | 1030304 | No read permission for this file | Contact the file owner or space admin for authorization |
418
+ | `InternalError` | 1030900 | Internal service error | Please carry the RequestId and contact support |
419
+ * @param {GetFileRequest} req
420
+ * @param {function(string, GetFileResponse):void} cb
421
+ * @public
422
+ */
423
+ GetFile(req, cb) {
424
+ let resp = new GetFileResponse();
425
+ this.request("GetFile", req, resp, cb);
426
+ }
427
+
428
+ /**
429
+ * This API is used to query the list of workflows.
430
+ * @param {ListWorkflowsRequest} req
431
+ * @param {function(string, ListWorkflowsResponse):void} cb
432
+ * @public
433
+ */
434
+ ListWorkflows(req, cb) {
435
+ let resp = new ListWorkflowsResponse();
436
+ this.request("ListWorkflows", req, resp, cb);
437
+ }
438
+
439
+ /**
440
+ * Remove a user group from a workspace.
441
+ * @param {RemoveWorkspaceGroupsRequest} req
442
+ * @param {function(string, RemoveWorkspaceGroupsResponse):void} cb
443
+ * @public
444
+ */
445
+ RemoveWorkspaceGroups(req, cb) {
446
+ let resp = new RemoveWorkspaceGroupsResponse();
447
+ this.request("RemoveWorkspaceGroups", req, resp, cb);
448
+ }
449
+
450
+ /**
451
+ * Delete a catalog.
452
+ * @param {DeleteCatalogRequest} req
453
+ * @param {function(string, DeleteCatalogResponse):void} cb
454
+ * @public
455
+ */
456
+ DeleteCatalog(req, cb) {
457
+ let resp = new DeleteCatalogResponse();
458
+ this.request("DeleteCatalog", req, resp, cb);
459
+ }
460
+
461
+ /**
462
+ * This API is used to create a workspace.
463
+ * @param {CreateWorkspaceRequest} req
464
+ * @param {function(string, CreateWorkspaceResponse):void} cb
465
+ * @public
466
+ */
467
+ CreateWorkspace(req, cb) {
468
+ let resp = new CreateWorkspaceResponse();
469
+ this.request("CreateWorkspace", req, resp, cb);
470
+ }
471
+
472
+ /**
473
+ * Terminate the operation of a workflow.
474
+ * @param {KillWorkflowRunRequest} req
475
+ * @param {function(string, KillWorkflowRunResponse):void} cb
476
+ * @public
477
+ */
478
+ KillWorkflowRun(req, cb) {
479
+ let resp = new KillWorkflowRunResponse();
480
+ this.request("KillWorkflowRun", req, resp, cb);
481
+ }
482
+
483
+ /**
484
+ * Deletes a workflow
485
+ * @param {DeleteWorkflowRequest} req
486
+ * @param {function(string, DeleteWorkflowResponse):void} cb
487
+ * @public
488
+ */
489
+ DeleteWorkflow(req, cb) {
490
+ let resp = new DeleteWorkflowResponse();
491
+ this.request("DeleteWorkflow", req, resp, cb);
492
+ }
493
+
494
+ /**
495
+ * Get schema list
496
+ * @param {ListSchemasRequest} req
497
+ * @param {function(string, ListSchemasResponse):void} cb
498
+ * @public
499
+ */
500
+ ListSchemas(req, cb) {
501
+ let resp = new ListSchemasResponse();
502
+ this.request("ListSchemas", req, resp, cb);
503
+ }
504
+
505
+ /**
506
+ * Modifies a workspace
507
+ * @param {UpdateWorkspaceRequest} req
508
+ * @param {function(string, UpdateWorkspaceResponse):void} cb
509
+ * @public
510
+ */
511
+ UpdateWorkspace(req, cb) {
512
+ let resp = new UpdateWorkspaceResponse();
513
+ this.request("UpdateWorkspace", req, resp, cb);
514
+ }
515
+
516
+ /**
517
+ * Move the file to Recycle Bin (soft deletion) and clear its version history and execution result snapshots.
518
+
519
+ **Prerequisite**
520
+ 1. The file corresponding to FileId must exist and be in active status;
521
+ 2. The caller has permission to delete the file;
522
+ 3. The file hasn't been referenced by a workflow task.
523
+
524
+ **Error codes (Module are all `Studio`)**
525
+
526
+ | Error Code (Code) | InnerCode | Description | Handling Suggestion |
527
+ | --- | --- | --- | --- |
528
+ | `MissingParameter.WorkspaceId` | 1030001 | lack of WorkspaceId | Please input WorkspaceId |
529
+ | `MissingParameter.FileId` | 1030003 | lack of FileId | Please import FileId |
530
+ | `InvalidParameterValue.FileType` | 1030102 | FileType value not supported | FileType takes FILE/NOTEBOOK_FILE/SQL_FILE |
531
+ | `ResourceNotFound.FileNotFound` | 1030203 | File does not exist or has been deleted | Please confirm the FileId |
532
+ | `ResourceInUse.FileReferencedByTask` | 1030204 | The file is referenced by a workflow task and cannot be deleted. | Disassociate the task reference first. |
533
+ | `UnauthorizedOperation.FileDeleteDenied` | 1030303 | No deletion permission for this file | Contact the file owner or space admin for authorization |
534
+ | `InternalError` | 1030900 | Internal service error | Please carry the RequestId and contact support |
535
+ * @param {DeleteFileRequest} req
536
+ * @param {function(string, DeleteFileResponse):void} cb
537
+ * @public
538
+ */
539
+ DeleteFile(req, cb) {
540
+ let resp = new DeleteFileResponse();
541
+ this.request("DeleteFile", req, resp, cb);
542
+ }
543
+
544
+ /**
545
+ * Create a console user group
546
+ * @param {CreateConsoleGroupRequest} req
547
+ * @param {function(string, CreateConsoleGroupResponse):void} cb
548
+ * @public
549
+ */
550
+ CreateConsoleGroup(req, cb) {
551
+ let resp = new CreateConsoleGroupResponse();
552
+ this.request("CreateConsoleGroup", req, resp, cb);
553
+ }
554
+
555
+ /**
556
+ * This API is used to create a data catalog.
557
+ * @param {CreateCatalogRequest} req
558
+ * @param {function(string, CreateCatalogResponse):void} cb
559
+ * @public
560
+ */
561
+ CreateCatalog(req, cb) {
562
+ let resp = new CreateCatalogResponse();
563
+ this.request("CreateCatalog", req, resp, cb);
564
+ }
565
+
566
+ /**
567
+ * Delete schema
568
+ * @param {DeleteSchemaRequest} req
569
+ * @param {function(string, DeleteSchemaResponse):void} cb
570
+ * @public
571
+ */
572
+ DeleteSchema(req, cb) {
573
+ let resp = new DeleteSchemaResponse();
574
+ this.request("DeleteSchema", req, resp, cb);
575
+ }
576
+
577
+ /**
578
+ * Creates a workspace role
579
+ * @param {CreateWorkspaceRoleRequest} req
580
+ * @param {function(string, CreateWorkspaceRoleResponse):void} cb
581
+ * @public
582
+ */
583
+ CreateWorkspaceRole(req, cb) {
584
+ let resp = new CreateWorkspaceRoleResponse();
585
+ this.request("CreateWorkspaceRole", req, resp, cb);
586
+ }
587
+
588
+ /**
589
+ * Start up the computational resource.
590
+ * @param {StartComputeRequest} req
591
+ * @param {function(string, StartComputeResponse):void} cb
592
+ * @public
593
+ */
594
+ StartCompute(req, cb) {
595
+ let resp = new StartComputeResponse();
596
+ this.request("StartCompute", req, resp, cb);
597
+ }
598
+
599
+ /**
600
+ * Create a folder
601
+ * @param {CreateFolderRequest} req
602
+ * @param {function(string, CreateFolderResponse):void} cb
603
+ * @public
604
+ */
605
+ CreateFolder(req, cb) {
606
+ let resp = new CreateFolderResponse();
607
+ this.request("CreateFolder", req, resp, cb);
608
+ }
609
+
610
+ /**
611
+ * Queries the console user list. This API is a console-level API and is only supported in the central region: use ap-guangzhou for the Chinese site and ap-singapore for the international site. Calls from other regions will return UnsupportedRegion.
612
+ * @param {ListConsoleUsersRequest} req
613
+ * @param {function(string, ListConsoleUsersResponse):void} cb
614
+ * @public
615
+ */
616
+ ListConsoleUsers(req, cb) {
617
+ let resp = new ListConsoleUsersResponse();
618
+ this.request("ListConsoleUsers", req, resp, cb);
619
+ }
620
+
621
+ /**
622
+ * <p>Batch remove console users (up to 10 at a time; pre-verification rejects the entire request if any fails; during the Execution Phase, a single failure does not interrupt subsequent deletion, and success or failure is determined by SuccessUins/FailItems)</p>
623
+ * @param {RemoveConsoleUsersRequest} req
624
+ * @param {function(string, RemoveConsoleUsersResponse):void} cb
625
+ * @public
626
+ */
627
+ RemoveConsoleUsers(req, cb) {
628
+ let resp = new RemoveConsoleUsersResponse();
629
+ this.request("RemoveConsoleUsers", req, resp, cb);
630
+ }
631
+
632
+ /**
633
+ * Terminate computational resources
634
+ * @param {StopComputeRequest} req
635
+ * @param {function(string, StopComputeResponse):void} cb
636
+ * @public
637
+ */
638
+ StopCompute(req, cb) {
639
+ let resp = new StopComputeResponse();
640
+ this.request("StopCompute", req, resp, cb);
641
+ }
642
+
643
+ /**
644
+ * Runs the workflow
645
+ * @param {RunWorkflowRequest} req
646
+ * @param {function(string, RunWorkflowResponse):void} cb
647
+ * @public
648
+ */
649
+ RunWorkflow(req, cb) {
650
+ let resp = new RunWorkflowResponse();
651
+ this.request("RunWorkflow", req, resp, cb);
652
+ }
653
+
654
+ /**
655
+ * Get the folder and file list
656
+ * @param {ListFilesRequest} req
657
+ * @param {function(string, ListFilesResponse):void} cb
658
+ * @public
659
+ */
660
+ ListFiles(req, cb) {
661
+ let resp = new ListFilesResponse();
662
+ this.request("ListFiles", req, resp, cb);
663
+ }
664
+
665
+ /**
666
+ * Updates a workspace role
667
+ * @param {UpdateWorkspaceRoleRequest} req
668
+ * @param {function(string, UpdateWorkspaceRoleResponse):void} cb
669
+ * @public
670
+ */
671
+ UpdateWorkspaceRole(req, cb) {
672
+ let resp = new UpdateWorkspaceRoleResponse();
673
+ this.request("UpdateWorkspaceRole", req, resp, cb);
674
+ }
675
+
676
+ /**
677
+ * Pagination fetch data catalog list
678
+ * @param {ListCatalogsRequest} req
679
+ * @param {function(string, ListCatalogsResponse):void} cb
680
+ * @public
681
+ */
682
+ ListCatalogs(req, cb) {
683
+ let resp = new ListCatalogsResponse();
684
+ this.request("ListCatalogs", req, resp, cb);
685
+ }
686
+
687
+ /**
688
+ * Delete folder
689
+ * @param {DeleteFolderRequest} req
690
+ * @param {function(string, DeleteFolderResponse):void} cb
691
+ * @public
692
+ */
693
+ DeleteFolder(req, cb) {
694
+ let resp = new DeleteFolderResponse();
695
+ this.request("DeleteFolder", req, resp, cb);
696
+ }
697
+
698
+ /**
699
+ * Queries the console user group list. This API is a console-level API and is only supported in the central region: use ap-guangzhou for the Chinese site and ap-singapore for the international site. Calls from other regions will return UnsupportedRegion.
700
+ * @param {ListConsoleGroupsRequest} req
701
+ * @param {function(string, ListConsoleGroupsResponse):void} cb
702
+ * @public
703
+ */
704
+ ListConsoleGroups(req, cb) {
705
+ let resp = new ListConsoleGroupsResponse();
706
+ this.request("ListConsoleGroups", req, resp, cb);
707
+ }
708
+
709
+ /**
710
+ * Query catalog description
711
+ * @param {GetCatalogRequest} req
712
+ * @param {function(string, GetCatalogResponse):void} cb
713
+ * @public
714
+ */
715
+ GetCatalog(req, cb) {
716
+ let resp = new GetCatalogResponse();
717
+ this.request("GetCatalog", req, resp, cb);
718
+ }
719
+
720
+ /**
721
+ * This API is used to query the list of user groups in a workspace.
722
+ * @param {ListWorkspaceGroupsRequest} req
723
+ * @param {function(string, ListWorkspaceGroupsResponse):void} cb
724
+ * @public
725
+ */
726
+ ListWorkspaceGroups(req, cb) {
727
+ let resp = new ListWorkspaceGroupsResponse();
728
+ this.request("ListWorkspaceGroups", req, resp, cb);
729
+ }
730
+
731
+ /**
732
+ * Queries the console role list. This API is a console-level API and is only supported in the central region: use ap-guangzhou for the Chinese site and ap-singapore for the international site. Calls from other regions will return UnsupportedRegion.
733
+ * @param {ListConsoleRolesRequest} req
734
+ * @param {function(string, ListConsoleRolesResponse):void} cb
735
+ * @public
736
+ */
737
+ ListConsoleRoles(req, cb) {
738
+ let resp = new ListConsoleRolesResponse();
739
+ this.request("ListConsoleRoles", req, resp, cb);
740
+ }
741
+
742
+ /**
743
+ * Rerun a workflow
744
+ * @param {RerunWorkflowRunRequest} req
745
+ * @param {function(string, RerunWorkflowRunResponse):void} cb
746
+ * @public
747
+ */
748
+ RerunWorkflowRun(req, cb) {
749
+ let resp = new RerunWorkflowRunResponse();
750
+ this.request("RerunWorkflowRun", req, resp, cb);
751
+ }
752
+
753
+ /**
754
+ * Modify a console user group
755
+ * @param {UpdateConsoleGroupRequest} req
756
+ * @param {function(string, UpdateConsoleGroupResponse):void} cb
757
+ * @public
758
+ */
759
+ UpdateConsoleGroup(req, cb) {
760
+ let resp = new UpdateConsoleGroupResponse();
761
+ this.request("UpdateConsoleGroup", req, resp, cb);
762
+ }
763
+
764
+ /**
765
+ * Queries the list of users in a workspace.
766
+ * @param {ListWorkspaceUsersRequest} req
767
+ * @param {function(string, ListWorkspaceUsersResponse):void} cb
768
+ * @public
769
+ */
770
+ ListWorkspaceUsers(req, cb) {
771
+ let resp = new ListWorkspaceUsersResponse();
772
+ this.request("ListWorkspaceUsers", req, resp, cb);
773
+ }
774
+
775
+ /**
776
+ * Create a workflow
777
+ * @param {CreateWorkflowRequest} req
778
+ * @param {function(string, CreateWorkflowResponse):void} cb
779
+ * @public
780
+ */
781
+ CreateWorkflow(req, cb) {
782
+ let resp = new CreateWorkflowResponse();
783
+ this.request("CreateWorkflow", req, resp, cb);
784
+ }
785
+
786
+ /**
787
+ * Update file contents and running configuration (computational resource, default catalog/schema, parameters), and return the file metadata after the update.
788
+
789
+ **Prerequisite**
790
+ 1. The file corresponding to FileId must exist and be in active status;
791
+ 2. The caller has write permission on the file;
792
+ 3. To update only the configuration, do not pass in Storage. To update only the content, do not pass in FileConfig.
793
+ 4. If FileConfig.ResourceId is not empty, the match between the resource type and file type will be validated.
794
+
795
+ **Error codes (Module: `Studio`)**
796
+
797
+ | Error Code (Code) | InnerCode | Description | Handling Suggestions |
798
+ | --- | --- | --- | --- |
799
+ | `MissingParameter.WorkspaceId` | 1030001 | lack of WorkspaceId | Please input WorkspaceId |
800
+ | `MissingParameter.FileId` | 1030003 | lack of FileId | Please import FileId |
801
+ | `InvalidParameterValue.FileType` | 1030102 | FileType value not supported | FileType takes FILE/NOTEBOOK_FILE/SQL_FILE |
802
+ | `InvalidParameterValue.ResourceId` | 1030104 | Compute resource type and file type mismatch | Select a computational resource for Python/Notebook and a data analysis resource for SQL |
803
+ | `ResourceNotFound.FileNotFound` | 1030203 | File does not exist or has been deleted | confirm the FileId or call GetFile to check the file status |
804
+ | `UnauthorizedOperation.FileWriteDenied` | 1030302 | No write permission for this file | Contact the file owner or space admin for authorization |
805
+ | `FailedOperation.FileStorageUpdateFailed` | 1030401 | Failed to write file content to storage | Try again later. If the failure persists, contact support with the RequestId. |
806
+ | `InternalError` | 1030900 | Internal service error | Please carry the RequestId and contact support |
807
+ * @param {UpdateFileRequest} req
808
+ * @param {function(string, UpdateFileResponse):void} cb
809
+ * @public
810
+ */
811
+ UpdateFile(req, cb) {
812
+ let resp = new UpdateFileResponse();
813
+ this.request("UpdateFile", req, resp, cb);
814
+ }
815
+
816
+ /**
817
+ * Modify a console user role
818
+ * @param {UpdateConsoleUsersRequest} req
819
+ * @param {function(string, UpdateConsoleUsersResponse):void} cb
820
+ * @public
821
+ */
822
+ UpdateConsoleUsers(req, cb) {
823
+ let resp = new UpdateConsoleUsersResponse();
824
+ this.request("UpdateConsoleUsers", req, resp, cb);
825
+ }
826
+
827
+ /**
828
+ * This API is used to add a user group to a workspace.
829
+ * @param {AddWorkspaceGroupsRequest} req
830
+ * @param {function(string, AddWorkspaceGroupsResponse):void} cb
831
+ * @public
832
+ */
833
+ AddWorkspaceGroups(req, cb) {
834
+ let resp = new AddWorkspaceGroupsResponse();
835
+ this.request("AddWorkspaceGroups", req, resp, cb);
836
+ }
837
+
838
+ /**
839
+ * Create a new file (Notebook/SQL/Python, etc.) in the workspace file tree of Studio (unified development IDE), and return the complete meta-information of the file upon success.
840
+
841
+ **Prerequisite**
842
+ 1. WorkspaceId corresponds to an existent workspace, and the caller is a space member of this workspace;
843
+ 2. The parent folder corresponding to ParentFolderPath must exist, and the caller must have write permission on it (pass `/` for the root directory);
844
+ 3. FileName must be unique under the same parent folder, including suffix comparison.
845
+ 4. The FileName suffix must be consistent with FileType (`.ipynb`↔`NOTEBOOK_FILE`, `.sql`↔`SQL_FILE`);
846
+ 5. To create with file content, pass it through Storage (large files are transferred via COS, and small files are placed in Storage.Content).
847
+ * @param {CreateFileRequest} req
848
+ * @param {function(string, CreateFileResponse):void} cb
849
+ * @public
850
+ */
851
+ CreateFile(req, cb) {
852
+ let resp = new CreateFileResponse();
853
+ this.request("CreateFile", req, resp, cb);
854
+ }
855
+
856
+ /**
857
+ * Queries the console user group member list. This API is a console-level API and is only supported in the central region: use ap-guangzhou for the Chinese site and ap-singapore for the international site. Calls from other regions will return UnsupportedRegion.
858
+ * @param {ListConsoleGroupUsersRequest} req
859
+ * @param {function(string, ListConsoleGroupUsersResponse):void} cb
860
+ * @public
861
+ */
862
+ ListConsoleGroupUsers(req, cb) {
863
+ let resp = new ListConsoleGroupUsersResponse();
864
+ this.request("ListConsoleGroupUsers", req, resp, cb);
865
+ }
866
+
867
+ /**
868
+ * Delete a workspace role.
869
+ * @param {DeleteWorkspaceRoleRequest} req
870
+ * @param {function(string, DeleteWorkspaceRoleResponse):void} cb
871
+ * @public
872
+ */
873
+ DeleteWorkspaceRole(req, cb) {
874
+ let resp = new DeleteWorkspaceRoleResponse();
875
+ this.request("DeleteWorkspaceRole", req, resp, cb);
876
+ }
877
+
878
+ /**
879
+ * Workflow run list
880
+ * @param {ListWorkflowRunsRequest} req
881
+ * @param {function(string, ListWorkflowRunsResponse):void} cb
882
+ * @public
883
+ */
884
+ ListWorkflowRuns(req, cb) {
885
+ let resp = new ListWorkflowRunsResponse();
886
+ this.request("ListWorkflowRuns", req, resp, cb);
887
+ }
888
+
889
+ /**
890
+ * Update folder (supports rename and move)
891
+ * @param {UpdateFolderRequest} req
892
+ * @param {function(string, UpdateFolderResponse):void} cb
893
+ * @public
894
+ */
895
+ UpdateFolder(req, cb) {
896
+ let resp = new UpdateFolderResponse();
897
+ this.request("UpdateFolder", req, resp, cb);
898
+ }
899
+
900
+ /**
901
+ * Delete a workspace.
902
+ * @param {DeleteWorkspaceRequest} req
903
+ * @param {function(string, DeleteWorkspaceResponse):void} cb
904
+ * @public
905
+ */
906
+ DeleteWorkspace(req, cb) {
907
+ let resp = new DeleteWorkspaceResponse();
908
+ this.request("DeleteWorkspace", req, resp, cb);
909
+ }
910
+
911
+
912
+ }
913
+ module.exports = DatabuddyClient;