@alicloud/dataworks-public20240518 2.2.0 → 2.2.1

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.
package/dist/client.d.ts CHANGED
@@ -3472,6 +3472,10 @@ export declare class GetNodeResponse extends $tea.Model {
3472
3472
  export declare class GetProjectRequest extends $tea.Model {
3473
3473
  /**
3474
3474
  * @remarks
3475
+ * The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the ID.
3476
+ *
3477
+ * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
3478
+ *
3475
3479
  * This parameter is required.
3476
3480
  *
3477
3481
  * @example
@@ -3489,8 +3493,15 @@ export declare class GetProjectRequest extends $tea.Model {
3489
3493
  });
3490
3494
  }
3491
3495
  export declare class GetProjectResponseBody extends $tea.Model {
3496
+ /**
3497
+ * @remarks
3498
+ * The information about the workspace.
3499
+ */
3492
3500
  project?: GetProjectResponseBodyProject;
3493
3501
  /**
3502
+ * @remarks
3503
+ * The request ID.
3504
+ *
3494
3505
  * @example
3495
3506
  * 22C97E95-F023-56B5-8852-B1A77A17XXXX
3496
3507
  */
@@ -11567,11 +11578,17 @@ export declare class GetNodeResponseBodyNode extends $tea.Model {
11567
11578
  }
11568
11579
  export declare class GetProjectResponseBodyProjectAliyunResourceTags extends $tea.Model {
11569
11580
  /**
11581
+ * @remarks
11582
+ * The tag key.
11583
+ *
11570
11584
  * @example
11571
11585
  * batch
11572
11586
  */
11573
11587
  key?: string;
11574
11588
  /**
11589
+ * @remarks
11590
+ * The tag value.
11591
+ *
11575
11592
  * @example
11576
11593
  * blue
11577
11594
  */
@@ -11588,44 +11605,111 @@ export declare class GetProjectResponseBodyProjectAliyunResourceTags extends $te
11588
11605
  }
11589
11606
  export declare class GetProjectResponseBodyProject extends $tea.Model {
11590
11607
  /**
11608
+ * @remarks
11609
+ * The ID of the Alibaba Cloud resource group to which the workspace belongs.
11610
+ *
11591
11611
  * @example
11592
11612
  * rg-acfmzbn7pti3zfa
11593
11613
  */
11594
11614
  aliyunResourceGroupId?: string;
11615
+ /**
11616
+ * @remarks
11617
+ * The tags.
11618
+ */
11595
11619
  aliyunResourceTags?: GetProjectResponseBodyProjectAliyunResourceTags[];
11620
+ /**
11621
+ * @remarks
11622
+ * The description of the workspace.
11623
+ */
11596
11624
  description?: string;
11597
11625
  /**
11626
+ * @remarks
11627
+ * Indicates whether the development environment is enabled. Valid values:
11628
+ *
11629
+ * * true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace.
11630
+ * * false: The development environment is disabled. In this case, only the production environment is used in the workspace.
11631
+ *
11598
11632
  * @example
11599
11633
  * true
11600
11634
  */
11601
11635
  devEnvironmentEnabled?: boolean;
11602
11636
  /**
11637
+ * @remarks
11638
+ * Indicates whether the Develop role is disabled. Valid values:
11639
+ *
11640
+ * * false
11641
+ * * true
11642
+ *
11603
11643
  * @example
11604
11644
  * false
11605
11645
  */
11606
11646
  devRoleDisabled?: boolean;
11647
+ /**
11648
+ * @remarks
11649
+ * The display name of the workspace.
11650
+ */
11607
11651
  displayName?: string;
11608
11652
  /**
11653
+ * @remarks
11654
+ * The workspace ID.
11655
+ *
11609
11656
  * @example
11610
11657
  * 28477242
11611
11658
  */
11612
11659
  id?: number;
11613
11660
  /**
11661
+ * @remarks
11662
+ * The name of the workspace.
11663
+ *
11614
11664
  * @example
11615
11665
  * sora_finance
11616
11666
  */
11617
11667
  name?: string;
11618
11668
  /**
11669
+ * @remarks
11670
+ * The ID of the Alibaba Cloud account to which the workspace belongs.
11671
+ *
11619
11672
  * @example
11620
11673
  * 207947397706614299
11621
11674
  */
11622
11675
  owner?: string;
11623
11676
  /**
11677
+ * @remarks
11678
+ * Indicates whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values:
11679
+ *
11680
+ * * true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.
11681
+ * * false: Scheduling of PAI tasks is disabled.
11682
+ *
11624
11683
  * @example
11625
11684
  * true
11626
11685
  */
11627
11686
  paiTaskEnabled?: boolean;
11628
11687
  /**
11688
+ * @remarks
11689
+ * The status of the workspace. Valid values:
11690
+ *
11691
+ * * Available
11692
+ * * Initializing
11693
+ * * InitFailed
11694
+ * * Forbidden
11695
+ * * Deleting
11696
+ * * DeleteFailed
11697
+ * * Frozen
11698
+ * * Updating
11699
+ * * UpdateFailed
11700
+ *
11701
+ * <!---->
11702
+ *
11703
+ * *
11704
+ * *
11705
+ * *
11706
+ * *
11707
+ * *
11708
+ * *
11709
+ * *
11710
+ * *
11711
+ * *
11712
+ *
11629
11713
  * @example
11630
11714
  * Available
11631
11715
  */
@@ -12736,7 +12820,7 @@ export declare class GetTaskInstanceResponseBodyTaskInstance extends $tea.Model
12736
12820
  projectId?: number;
12737
12821
  /**
12738
12822
  * @example
12739
- * AllAllowed
12823
+ * AllAllowed
12740
12824
  */
12741
12825
  rerunMode?: string;
12742
12826
  /**
@@ -20308,7 +20392,7 @@ export default class Client extends OpenApi {
20308
20392
  */
20309
20393
  getNode(request: GetNodeRequest): Promise<GetNodeResponse>;
20310
20394
  /**
20311
- * 查询工作空间详情
20395
+ * Queries the information about a DataWorks workspace.
20312
20396
  *
20313
20397
  * @param request - GetProjectRequest
20314
20398
  * @param runtime - runtime options for this request RuntimeOptions
@@ -20316,7 +20400,7 @@ export default class Client extends OpenApi {
20316
20400
  */
20317
20401
  getProjectWithOptions(request: GetProjectRequest, runtime: $Util.RuntimeOptions): Promise<GetProjectResponse>;
20318
20402
  /**
20319
- * 查询工作空间详情
20403
+ * Queries the information about a DataWorks workspace.
20320
20404
  *
20321
20405
  * @param request - GetProjectRequest
20322
20406
  * @returns GetProjectResponse
package/dist/client.js CHANGED
@@ -16279,7 +16279,7 @@ class Client extends openapi_client_1.default {
16279
16279
  return await this.getNodeWithOptions(request, runtime);
16280
16280
  }
16281
16281
  /**
16282
- * 查询工作空间详情
16282
+ * Queries the information about a DataWorks workspace.
16283
16283
  *
16284
16284
  * @param request - GetProjectRequest
16285
16285
  * @param runtime - runtime options for this request RuntimeOptions
@@ -16305,7 +16305,7 @@ class Client extends openapi_client_1.default {
16305
16305
  return $tea.cast(await this.callApi(params, req, runtime), new GetProjectResponse({}));
16306
16306
  }
16307
16307
  /**
16308
- * 查询工作空间详情
16308
+ * Queries the information about a DataWorks workspace.
16309
16309
  *
16310
16310
  * @param request - GetProjectRequest
16311
16311
  * @returns GetProjectResponse