@alicloud/dataworks-public20240518 9.10.1 → 9.10.2

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.
Files changed (32) hide show
  1. package/dist/client.d.ts +34 -34
  2. package/dist/client.js +34 -34
  3. package/dist/models/Column.d.ts +44 -58
  4. package/dist/models/Column.js +28 -1
  5. package/dist/models/Column.js.map +1 -1
  6. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +1 -1
  7. package/dist/models/CreateWorkflowDefinitionResponseBody.d.ts +1 -1
  8. package/dist/models/CreateWorkflowInstancesRequest.d.ts +15 -15
  9. package/dist/models/CreateWorkflowInstancesShrinkRequest.d.ts +5 -5
  10. package/dist/models/GetColumnRequest.d.ts +9 -9
  11. package/dist/models/GetColumnResponseBody.d.ts +2 -2
  12. package/dist/models/ListColumnsRequest.d.ts +11 -11
  13. package/dist/models/ListColumnsResponseBody.d.ts +5 -5
  14. package/dist/models/ListLineagesRequest.d.ts +5 -5
  15. package/dist/models/MoveResourceRequest.d.ts +2 -2
  16. package/dist/models/model.d.ts +1 -0
  17. package/dist/models/model.js +52 -50
  18. package/dist/models/model.js.map +1 -1
  19. package/package.json +1 -1
  20. package/src/client.ts +34 -34
  21. package/src/models/Column.ts +60 -58
  22. package/src/models/CreateWorkflowDefinitionRequest.ts +1 -1
  23. package/src/models/CreateWorkflowDefinitionResponseBody.ts +1 -1
  24. package/src/models/CreateWorkflowInstancesRequest.ts +15 -15
  25. package/src/models/CreateWorkflowInstancesShrinkRequest.ts +5 -5
  26. package/src/models/GetColumnRequest.ts +9 -9
  27. package/src/models/GetColumnResponseBody.ts +2 -2
  28. package/src/models/ListColumnsRequest.ts +11 -11
  29. package/src/models/ListColumnsResponseBody.ts +5 -5
  30. package/src/models/ListLineagesRequest.ts +5 -5
  31. package/src/models/MoveResourceRequest.ts +2 -2
  32. package/src/models/model.ts +1 -0
package/dist/client.d.ts CHANGED
@@ -490,7 +490,7 @@ export default class Client extends OpenApi {
490
490
  *
491
491
  * @remarks
492
492
  * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
493
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If the new data development feature is not used, use the corresponding operation of the 2020-05-18 version.
493
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If the new Data Studio feature is not used, use the corresponding operation of the 2020-05-18 version.
494
494
  *
495
495
  * @param request - CreateComponentRequest
496
496
  * @param runtime - runtime options for this request RuntimeOptions
@@ -502,7 +502,7 @@ export default class Client extends OpenApi {
502
502
  *
503
503
  * @remarks
504
504
  * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
505
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If the new data development feature is not used, use the corresponding operation of the 2020-05-18 version.
505
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If the new Data Studio feature is not used, use the corresponding operation of the 2020-05-18 version.
506
506
  *
507
507
  * @param request - CreateComponentRequest
508
508
  * @returns CreateComponentResponse
@@ -1514,11 +1514,11 @@ export default class Client extends OpenApi {
1514
1514
  */
1515
1515
  createUdfFile(request: $_model.CreateUdfFileRequest): Promise<$_model.CreateUdfFileResponse>;
1516
1516
  /**
1517
- * Creates a workflow in a specified directory in DataStudio.
1517
+ * Creates a workflow in a specified directory in Data Studio.
1518
1518
  *
1519
1519
  * @remarks
1520
1520
  * >Notice: This operation does not support batch operations. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also directly ignored. Call the CreateNode operation to create internal nodes one by one.</notice>
1521
- * This operation is part of the new DataStudio capabilities and applies only to workspaces that use the new DataStudio. If you do not use the new DataStudio, use the corresponding operation of the 2020-05-18 version.
1521
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio. If you do not use the new Data Studio, use the corresponding operation of the 2020-05-18 version.
1522
1522
  *
1523
1523
  * @param request - CreateWorkflowDefinitionRequest
1524
1524
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1526,11 +1526,11 @@ export default class Client extends OpenApi {
1526
1526
  */
1527
1527
  createWorkflowDefinitionWithOptions(request: $_model.CreateWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateWorkflowDefinitionResponse>;
1528
1528
  /**
1529
- * Creates a workflow in a specified directory in DataStudio.
1529
+ * Creates a workflow in a specified directory in Data Studio.
1530
1530
  *
1531
1531
  * @remarks
1532
1532
  * >Notice: This operation does not support batch operations. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also directly ignored. Call the CreateNode operation to create internal nodes one by one.</notice>
1533
- * This operation is part of the new DataStudio capabilities and applies only to workspaces that use the new DataStudio. If you do not use the new DataStudio, use the corresponding operation of the 2020-05-18 version.
1533
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio. If you do not use the new Data Studio, use the corresponding operation of the 2020-05-18 version.
1534
1534
  *
1535
1535
  * @param request - CreateWorkflowDefinitionRequest
1536
1536
  * @returns CreateWorkflowDefinitionResponse
@@ -1540,7 +1540,7 @@ export default class Client extends OpenApi {
1540
1540
  * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
1541
1541
  *
1542
1542
  * @remarks
1543
- * You must purchase DataWorks Basic Edition or a later edition to use this feature.
1543
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
1544
1544
  *
1545
1545
  * @param tmpReq - CreateWorkflowInstancesRequest
1546
1546
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1551,7 +1551,7 @@ export default class Client extends OpenApi {
1551
1551
  * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
1552
1552
  *
1553
1553
  * @remarks
1554
- * You must purchase DataWorks Basic Edition or a later edition to use this feature.
1554
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
1555
1555
  *
1556
1556
  * @param request - CreateWorkflowInstancesRequest
1557
1557
  * @returns CreateWorkflowInstancesResponse
@@ -1660,8 +1660,8 @@ export default class Client extends OpenApi {
1660
1660
  * Deletes a component.
1661
1661
  *
1662
1662
  * @remarks
1663
- * <notice>After a UDF function is published, it cannot be deleted. You must take it offline before deleting it.</notice>
1664
- * This API operation belongs to the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding API operation of the 2020-05-18 version.
1663
+ * <notice>After a UDF function is deployed, it cannot be deleted. You must undeploy it before deleting it.</notice>
1664
+ * This API operation belongs to the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding API operation of the 2020-05-18 version.
1665
1665
  *
1666
1666
  * @param request - DeleteComponentRequest
1667
1667
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1672,8 +1672,8 @@ export default class Client extends OpenApi {
1672
1672
  * Deletes a component.
1673
1673
  *
1674
1674
  * @remarks
1675
- * <notice>After a UDF function is published, it cannot be deleted. You must take it offline before deleting it.</notice>
1676
- * This API operation belongs to the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding API operation of the 2020-05-18 version.
1675
+ * <notice>After a UDF function is deployed, it cannot be deleted. You must undeploy it before deleting it.</notice>
1676
+ * This API operation belongs to the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding API operation of the 2020-05-18 version.
1677
1677
  *
1678
1678
  * @param request - DeleteComponentRequest
1679
1679
  * @returns DeleteComponentResponse
@@ -3129,10 +3129,10 @@ export default class Client extends OpenApi {
3129
3129
  */
3130
3130
  getCertificate(request: $_model.GetCertificateRequest): Promise<$_model.GetCertificateResponse>;
3131
3131
  /**
3132
- * Retrieves the details of a specified column in a Data Map table.
3132
+ * Retrieves the details of a specified column in a DataWorks Data Map table.
3133
3133
  *
3134
3134
  * @remarks
3135
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3135
+ * 1. You must purchase DataWorks Basic Edition or a later edition to use this operation.
3136
3136
  *
3137
3137
  * @param request - GetColumnRequest
3138
3138
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3140,10 +3140,10 @@ export default class Client extends OpenApi {
3140
3140
  */
3141
3141
  getColumnWithOptions(request: $_model.GetColumnRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetColumnResponse>;
3142
3142
  /**
3143
- * Retrieves the details of a specified column in a Data Map table.
3143
+ * Retrieves the details of a specified column in a DataWorks Data Map table.
3144
3144
  *
3145
3145
  * @remarks
3146
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3146
+ * 1. You must purchase DataWorks Basic Edition or a later edition to use this operation.
3147
3147
  *
3148
3148
  * @param request - GetColumnRequest
3149
3149
  * @returns GetColumnResponse
@@ -4862,10 +4862,10 @@ export default class Client extends OpenApi {
4862
4862
  */
4863
4863
  listCertificates(request: $_model.ListCertificatesRequest): Promise<$_model.ListCertificatesResponse>;
4864
4864
  /**
4865
- * Queries the column list of a specified table in DataWorks Data Map.
4865
+ * Queries the columns of a specified table in DataWorks Data Map.
4866
4866
  *
4867
4867
  * @remarks
4868
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4868
+ * 1. You must purchase DataWorks Basic Edition or later to use this API.
4869
4869
  *
4870
4870
  * @param request - ListColumnsRequest
4871
4871
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4873,10 +4873,10 @@ export default class Client extends OpenApi {
4873
4873
  */
4874
4874
  listColumnsWithOptions(request: $_model.ListColumnsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListColumnsResponse>;
4875
4875
  /**
4876
- * Queries the column list of a specified table in DataWorks Data Map.
4876
+ * Queries the columns of a specified table in DataWorks Data Map.
4877
4877
  *
4878
4878
  * @remarks
4879
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4879
+ * 1. You must purchase DataWorks Basic Edition or later to use this API.
4880
4880
  *
4881
4881
  * @param request - ListColumnsRequest
4882
4882
  * @returns ListColumnsResponse
@@ -5848,11 +5848,11 @@ export default class Client extends OpenApi {
5848
5848
  */
5849
5849
  listLineageRelationships(request: $_model.ListLineageRelationshipsRequest): Promise<$_model.ListLineageRelationshipsResponse>;
5850
5850
  /**
5851
- * Queries the list of upstream and downstream lineage entities for a given entity in DataWorks Data Map, with an option to include specific lineage relationship information.
5851
+ * Queries the upstream and downstream lineage entities of a given entity in DataWorks Data Map. You can specify whether to include detailed lineage relationship information.
5852
5852
  *
5853
5853
  * @remarks
5854
- * 1. You must purchase DataWorks Standard Edition or later to use this operation.
5855
- * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between entities.
5854
+ * 1. You must purchase DataWorks Standard Edition or a more advanced edition to use this operation.
5855
+ * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between the entities.
5856
5856
  *
5857
5857
  * @param request - ListLineagesRequest
5858
5858
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5860,11 +5860,11 @@ export default class Client extends OpenApi {
5860
5860
  */
5861
5861
  listLineagesWithOptions(request: $_model.ListLineagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListLineagesResponse>;
5862
5862
  /**
5863
- * Queries the list of upstream and downstream lineage entities for a given entity in DataWorks Data Map, with an option to include specific lineage relationship information.
5863
+ * Queries the upstream and downstream lineage entities of a given entity in DataWorks Data Map. You can specify whether to include detailed lineage relationship information.
5864
5864
  *
5865
5865
  * @remarks
5866
- * 1. You must purchase DataWorks Standard Edition or later to use this operation.
5867
- * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between entities.
5866
+ * 1. You must purchase DataWorks Standard Edition or a more advanced edition to use this operation.
5867
+ * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between the entities.
5868
5868
  *
5869
5869
  * @param request - ListLineagesRequest
5870
5870
  * @returns ListLineagesResponse
@@ -6283,7 +6283,7 @@ export default class Client extends OpenApi {
6283
6283
  * Queries the details of workspace roles by paging.
6284
6284
  *
6285
6285
  * @remarks
6286
- * You must purchase DataWorks Basic Edition or later to use this operation.
6286
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6287
6287
  *
6288
6288
  * @param tmpReq - ListProjectRolesRequest
6289
6289
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6294,7 +6294,7 @@ export default class Client extends OpenApi {
6294
6294
  * Queries the details of workspace roles by paging.
6295
6295
  *
6296
6296
  * @remarks
6297
- * You must purchase DataWorks Basic Edition or later to use this operation.
6297
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6298
6298
  *
6299
6299
  * @param request - ListProjectRolesRequest
6300
6300
  * @returns ListProjectRolesResponse
@@ -6663,7 +6663,7 @@ export default class Client extends OpenApi {
6663
6663
  * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
6664
6664
  *
6665
6665
  * @remarks
6666
- * 1. You must purchase DataWorks Basic Edition or later to use this API.
6666
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
6667
6667
  *
6668
6668
  * @param tmpReq - ListTablesRequest
6669
6669
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6674,7 +6674,7 @@ export default class Client extends OpenApi {
6674
6674
  * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
6675
6675
  *
6676
6676
  * @remarks
6677
- * 1. You must purchase DataWorks Basic Edition or later to use this API.
6677
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
6678
6678
  *
6679
6679
  * @param request - ListTablesRequest
6680
6680
  * @returns ListTablesResponse
@@ -6945,10 +6945,10 @@ export default class Client extends OpenApi {
6945
6945
  */
6946
6946
  moveNode(request: $_model.MoveNodeRequest): Promise<$_model.MoveNodeResponse>;
6947
6947
  /**
6948
- * Moves a specified data development file resource to a specified data development folder.
6948
+ * Moves a specified Data Studio file resource to a specified Data Studio folder.
6949
6949
  *
6950
6950
  * @remarks
6951
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding operation in the 2020-05-18 version.
6951
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding operation in the 2020-05-18 version.
6952
6952
  *
6953
6953
  * @param request - MoveResourceRequest
6954
6954
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6956,10 +6956,10 @@ export default class Client extends OpenApi {
6956
6956
  */
6957
6957
  moveResourceWithOptions(request: $_model.MoveResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.MoveResourceResponse>;
6958
6958
  /**
6959
- * Moves a specified data development file resource to a specified data development folder.
6959
+ * Moves a specified Data Studio file resource to a specified Data Studio folder.
6960
6960
  *
6961
6961
  * @remarks
6962
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding operation in the 2020-05-18 version.
6962
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding operation in the 2020-05-18 version.
6963
6963
  *
6964
6964
  * @param request - MoveResourceRequest
6965
6965
  * @returns MoveResourceResponse
package/dist/client.js CHANGED
@@ -1411,7 +1411,7 @@ class Client extends openapi_core_1.default {
1411
1411
  *
1412
1412
  * @remarks
1413
1413
  * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
1414
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If the new data development feature is not used, use the corresponding operation of the 2020-05-18 version.
1414
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If the new Data Studio feature is not used, use the corresponding operation of the 2020-05-18 version.
1415
1415
  *
1416
1416
  * @param request - CreateComponentRequest
1417
1417
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1450,7 +1450,7 @@ class Client extends openapi_core_1.default {
1450
1450
  *
1451
1451
  * @remarks
1452
1452
  * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
1453
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If the new data development feature is not used, use the corresponding operation of the 2020-05-18 version.
1453
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If the new Data Studio feature is not used, use the corresponding operation of the 2020-05-18 version.
1454
1454
  *
1455
1455
  * @param request - CreateComponentRequest
1456
1456
  * @returns CreateComponentResponse
@@ -4789,11 +4789,11 @@ class Client extends openapi_core_1.default {
4789
4789
  return await this.createUdfFileWithOptions(request, runtime);
4790
4790
  }
4791
4791
  /**
4792
- * Creates a workflow in a specified directory in DataStudio.
4792
+ * Creates a workflow in a specified directory in Data Studio.
4793
4793
  *
4794
4794
  * @remarks
4795
4795
  * >Notice: This operation does not support batch operations. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also directly ignored. Call the CreateNode operation to create internal nodes one by one.</notice>
4796
- * This operation is part of the new DataStudio capabilities and applies only to workspaces that use the new DataStudio. If you do not use the new DataStudio, use the corresponding operation of the 2020-05-18 version.
4796
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio. If you do not use the new Data Studio, use the corresponding operation of the 2020-05-18 version.
4797
4797
  *
4798
4798
  * @param request - CreateWorkflowDefinitionRequest
4799
4799
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4825,11 +4825,11 @@ class Client extends openapi_core_1.default {
4825
4825
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateWorkflowDefinitionResponse({}));
4826
4826
  }
4827
4827
  /**
4828
- * Creates a workflow in a specified directory in DataStudio.
4828
+ * Creates a workflow in a specified directory in Data Studio.
4829
4829
  *
4830
4830
  * @remarks
4831
4831
  * >Notice: This operation does not support batch operations. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also directly ignored. Call the CreateNode operation to create internal nodes one by one.</notice>
4832
- * This operation is part of the new DataStudio capabilities and applies only to workspaces that use the new DataStudio. If you do not use the new DataStudio, use the corresponding operation of the 2020-05-18 version.
4832
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio. If you do not use the new Data Studio, use the corresponding operation of the 2020-05-18 version.
4833
4833
  *
4834
4834
  * @param request - CreateWorkflowDefinitionRequest
4835
4835
  * @returns CreateWorkflowDefinitionResponse
@@ -4842,7 +4842,7 @@ class Client extends openapi_core_1.default {
4842
4842
  * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
4843
4843
  *
4844
4844
  * @remarks
4845
- * You must purchase DataWorks Basic Edition or a later edition to use this feature.
4845
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4846
4846
  *
4847
4847
  * @param tmpReq - CreateWorkflowInstancesRequest
4848
4848
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4921,7 +4921,7 @@ class Client extends openapi_core_1.default {
4921
4921
  * Creates a workflow instance based on configurations, such as a data backfill workflow instance.
4922
4922
  *
4923
4923
  * @remarks
4924
- * You must purchase DataWorks Basic Edition or a later edition to use this feature.
4924
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4925
4925
  *
4926
4926
  * @param request - CreateWorkflowInstancesRequest
4927
4927
  * @returns CreateWorkflowInstancesResponse
@@ -5162,8 +5162,8 @@ class Client extends openapi_core_1.default {
5162
5162
  * Deletes a component.
5163
5163
  *
5164
5164
  * @remarks
5165
- * <notice>After a UDF function is published, it cannot be deleted. You must take it offline before deleting it.</notice>
5166
- * This API operation belongs to the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding API operation of the 2020-05-18 version.
5165
+ * <notice>After a UDF function is deployed, it cannot be deleted. You must undeploy it before deleting it.</notice>
5166
+ * This API operation belongs to the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding API operation of the 2020-05-18 version.
5167
5167
  *
5168
5168
  * @param request - DeleteComponentRequest
5169
5169
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5198,8 +5198,8 @@ class Client extends openapi_core_1.default {
5198
5198
  * Deletes a component.
5199
5199
  *
5200
5200
  * @remarks
5201
- * <notice>After a UDF function is published, it cannot be deleted. You must take it offline before deleting it.</notice>
5202
- * This API operation belongs to the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding API operation of the 2020-05-18 version.
5201
+ * <notice>After a UDF function is deployed, it cannot be deleted. You must undeploy it before deleting it.</notice>
5202
+ * This API operation belongs to the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding API operation of the 2020-05-18 version.
5203
5203
  *
5204
5204
  * @param request - DeleteComponentRequest
5205
5205
  * @returns DeleteComponentResponse
@@ -8385,10 +8385,10 @@ class Client extends openapi_core_1.default {
8385
8385
  return await this.getCertificateWithOptions(request, runtime);
8386
8386
  }
8387
8387
  /**
8388
- * Retrieves the details of a specified column in a Data Map table.
8388
+ * Retrieves the details of a specified column in a DataWorks Data Map table.
8389
8389
  *
8390
8390
  * @remarks
8391
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
8391
+ * 1. You must purchase DataWorks Basic Edition or a later edition to use this operation.
8392
8392
  *
8393
8393
  * @param request - GetColumnRequest
8394
8394
  * @param runtime - runtime options for this request RuntimeOptions
@@ -8414,10 +8414,10 @@ class Client extends openapi_core_1.default {
8414
8414
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetColumnResponse({}));
8415
8415
  }
8416
8416
  /**
8417
- * Retrieves the details of a specified column in a Data Map table.
8417
+ * Retrieves the details of a specified column in a DataWorks Data Map table.
8418
8418
  *
8419
8419
  * @remarks
8420
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
8420
+ * 1. You must purchase DataWorks Basic Edition or a later edition to use this operation.
8421
8421
  *
8422
8422
  * @param request - GetColumnRequest
8423
8423
  * @returns GetColumnResponse
@@ -12218,10 +12218,10 @@ class Client extends openapi_core_1.default {
12218
12218
  return await this.listCertificatesWithOptions(request, runtime);
12219
12219
  }
12220
12220
  /**
12221
- * Queries the column list of a specified table in DataWorks Data Map.
12221
+ * Queries the columns of a specified table in DataWorks Data Map.
12222
12222
  *
12223
12223
  * @remarks
12224
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
12224
+ * 1. You must purchase DataWorks Basic Edition or later to use this API.
12225
12225
  *
12226
12226
  * @param request - ListColumnsRequest
12227
12227
  * @param runtime - runtime options for this request RuntimeOptions
@@ -12247,10 +12247,10 @@ class Client extends openapi_core_1.default {
12247
12247
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListColumnsResponse({}));
12248
12248
  }
12249
12249
  /**
12250
- * Queries the column list of a specified table in DataWorks Data Map.
12250
+ * Queries the columns of a specified table in DataWorks Data Map.
12251
12251
  *
12252
12252
  * @remarks
12253
- * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
12253
+ * 1. You must purchase DataWorks Basic Edition or later to use this API.
12254
12254
  *
12255
12255
  * @param request - ListColumnsRequest
12256
12256
  * @returns ListColumnsResponse
@@ -14790,11 +14790,11 @@ class Client extends openapi_core_1.default {
14790
14790
  return await this.listLineageRelationshipsWithOptions(request, runtime);
14791
14791
  }
14792
14792
  /**
14793
- * Queries the list of upstream and downstream lineage entities for a given entity in DataWorks Data Map, with an option to include specific lineage relationship information.
14793
+ * Queries the upstream and downstream lineage entities of a given entity in DataWorks Data Map. You can specify whether to include detailed lineage relationship information.
14794
14794
  *
14795
14795
  * @remarks
14796
- * 1. You must purchase DataWorks Standard Edition or later to use this operation.
14797
- * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between entities.
14796
+ * 1. You must purchase DataWorks Standard Edition or a more advanced edition to use this operation.
14797
+ * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between the entities.
14798
14798
  *
14799
14799
  * @param request - ListLineagesRequest
14800
14800
  * @param runtime - runtime options for this request RuntimeOptions
@@ -14820,11 +14820,11 @@ class Client extends openapi_core_1.default {
14820
14820
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListLineagesResponse({}));
14821
14821
  }
14822
14822
  /**
14823
- * Queries the list of upstream and downstream lineage entities for a given entity in DataWorks Data Map, with an option to include specific lineage relationship information.
14823
+ * Queries the upstream and downstream lineage entities of a given entity in DataWorks Data Map. You can specify whether to include detailed lineage relationship information.
14824
14824
  *
14825
14825
  * @remarks
14826
- * 1. You must purchase DataWorks Standard Edition or later to use this operation.
14827
- * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between entities.
14826
+ * 1. You must purchase DataWorks Standard Edition or a more advanced edition to use this operation.
14827
+ * 2. This operation queries the upstream and downstream entities of the current entity and the lineage relationships between the entities.
14828
14828
  *
14829
14829
  * @param request - ListLineagesRequest
14830
14830
  * @returns ListLineagesResponse
@@ -15874,7 +15874,7 @@ class Client extends openapi_core_1.default {
15874
15874
  * Queries the details of workspace roles by paging.
15875
15875
  *
15876
15876
  * @remarks
15877
- * You must purchase DataWorks Basic Edition or later to use this operation.
15877
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
15878
15878
  *
15879
15879
  * @param tmpReq - ListProjectRolesRequest
15880
15880
  * @param runtime - runtime options for this request RuntimeOptions
@@ -15929,7 +15929,7 @@ class Client extends openapi_core_1.default {
15929
15929
  * Queries the details of workspace roles by paging.
15930
15930
  *
15931
15931
  * @remarks
15932
- * You must purchase DataWorks Basic Edition or later to use this operation.
15932
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
15933
15933
  *
15934
15934
  * @param request - ListProjectRolesRequest
15935
15935
  * @returns ListProjectRolesResponse
@@ -16815,7 +16815,7 @@ class Client extends openapi_core_1.default {
16815
16815
  * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
16816
16816
  *
16817
16817
  * @remarks
16818
- * 1. You must purchase DataWorks Basic Edition or later to use this API.
16818
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
16819
16819
  *
16820
16820
  * @param tmpReq - ListTablesRequest
16821
16821
  * @param runtime - runtime options for this request RuntimeOptions
@@ -16849,7 +16849,7 @@ class Client extends openapi_core_1.default {
16849
16849
  * Queries the tables in Data Map. For types that do not support the schema level, this operation queries the tables in a specified database. For types that support the schema level, this operation queries the tables in a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical or business metadata. For non-MaxCompute types, the response is not real-time and may be delayed by up to 1 hour compared to the metadata collection results.
16850
16850
  *
16851
16851
  * @remarks
16852
- * 1. You must purchase DataWorks Basic Edition or later to use this API.
16852
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this API.
16853
16853
  *
16854
16854
  * @param request - ListTablesRequest
16855
16855
  * @returns ListTablesResponse
@@ -17672,10 +17672,10 @@ class Client extends openapi_core_1.default {
17672
17672
  return await this.moveNodeWithOptions(request, runtime);
17673
17673
  }
17674
17674
  /**
17675
- * Moves a specified data development file resource to a specified data development folder.
17675
+ * Moves a specified Data Studio file resource to a specified Data Studio folder.
17676
17676
  *
17677
17677
  * @remarks
17678
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding operation in the 2020-05-18 version.
17678
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding operation in the 2020-05-18 version.
17679
17679
  *
17680
17680
  * @param request - MoveResourceRequest
17681
17681
  * @param runtime - runtime options for this request RuntimeOptions
@@ -17710,10 +17710,10 @@ class Client extends openapi_core_1.default {
17710
17710
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.MoveResourceResponse({}));
17711
17711
  }
17712
17712
  /**
17713
- * Moves a specified data development file resource to a specified data development folder.
17713
+ * Moves a specified Data Studio file resource to a specified Data Studio folder.
17714
17714
  *
17715
17715
  * @remarks
17716
- * This operation is part of the new data development capabilities and applies only to workspaces that use the new data development feature. If you do not use the new data development feature, use the corresponding operation in the 2020-05-18 version.
17716
+ * This operation is part of the new Data Studio capabilities and applies only to workspaces that use the new Data Studio feature. If you do not use the new Data Studio feature, use the corresponding operation in the 2020-05-18 version.
17717
17717
  *
17718
17718
  * @param request - MoveResourceRequest
17719
17719
  * @returns MoveResourceResponse
@@ -4,17 +4,17 @@ import * as $dara from '@darabonba/typescript';
4
4
  export declare class ColumnBusinessMetadata extends $dara.Model {
5
5
  /**
6
6
  * @remarks
7
- * The custom attribute values, where key is the custom attribute identifier and value is the attribute value list.
7
+ * The custom attribute values, where the key is the custom attribute identifier and the value is a list of attribute values.
8
8
  */
9
9
  customAttributes?: {
10
10
  [key: string]: string[];
11
11
  };
12
12
  /**
13
13
  * @remarks
14
- * The business description of the field. Currently, only MaxCompute, HMS (EMR cluster), and DLF types are supported.
14
+ * The business description of the column. Currently, only MaxCompute, HMS (EMR cluster), and DLF types are supported.
15
15
  *
16
16
  * @example
17
- * Business description of column 1
17
+ * Business description of Column 1
18
18
  */
19
19
  description?: string;
20
20
  static names(): {
@@ -28,6 +28,25 @@ export declare class ColumnBusinessMetadata extends $dara.Model {
28
28
  [key: string]: any;
29
29
  });
30
30
  }
31
+ export declare class ColumnTechnicalMetadata extends $dara.Model {
32
+ /**
33
+ * @remarks
34
+ * The technical parameters of the column, where the key is the parameter name and the value is a string. Objects or arrays are represented as JSON strings.
35
+ */
36
+ parameters?: {
37
+ [key: string]: string;
38
+ };
39
+ static names(): {
40
+ [key: string]: string;
41
+ };
42
+ static types(): {
43
+ [key: string]: any;
44
+ };
45
+ validate(): void;
46
+ constructor(map?: {
47
+ [key: string]: any;
48
+ });
49
+ }
31
50
  export declare class Column extends $dara.Model {
32
51
  /**
33
52
  * @remarks
@@ -44,7 +63,7 @@ export declare class Column extends $dara.Model {
44
63
  comment?: string;
45
64
  /**
46
65
  * @remarks
47
- * Indicates whether the column is a foreign key. Currently, only MaxCompute is supported.
66
+ * Specifies whether the column is a foreign key. Currently, only the MaxCompute type is supported.
48
67
  *
49
68
  * @example
50
69
  * false
@@ -54,71 +73,33 @@ export declare class Column extends $dara.Model {
54
73
  * @remarks
55
74
  * The ID. For more information, see [Metadata entity concepts](https://help.aliyun.com/document_detail/2880092.html).
56
75
  *
76
+ * The format is `${EntityType}:${Instance ID or URL-encoded URL}:${Catalog ID}:${Database name}:${Schema name}:${Table name}:${Column name}`. Use an empty string as a placeholder for non-existent levels.
57
77
  *
78
+ * > For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For the MaxCompute type, the database name is the MaxCompute project name. Projects with the three-tier model enabled require the schema name. For projects without the three-tier model enabled, use an empty string as a placeholder for the schema name.
58
79
  *
80
+ * > For the StarRocks type, the catalog ID is the catalog name. For the DLF type, the catalog ID is the catalog ID. Other types do not support the catalog level, and an empty string can be used as a placeholder.
59
81
  *
60
- * The format is `${EntityType}:${instance ID or encoded URL}:${DataCatalogIdentity}:${DatabaseName}:${SchemaName}:${TableName}:${ColumnName}`. Use an empty character as a placeholder for levels that do not exist.
61
- *
62
- *
63
- *
64
- *
65
- * > For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name.
66
- *
67
- *
68
- *
69
- *
70
- * > For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level, and you can use an empty string as a placeholder.
71
- *
72
- *
73
- *
74
- *
75
- * The following examples show the ID formats for several common types:
76
- *
77
- *
78
- *
82
+ * The following are the ID formats for several common types:
79
83
  *
80
84
  * `maxcompute-column:::project_name:[schema_name]:table_name:column_name`
81
85
  *
82
- *
83
- *
84
- *
85
86
  * `dlf-column::catalog_id:database_name::table_name:column_name`
86
87
  *
87
- *
88
- *
89
- *
90
88
  * `hms-column:instance_id::database_name::table_name:column_name`
91
89
  *
92
- *
93
- *
94
- *
95
90
  * `holo-column:instance_id::database_name:schema_name:table_name:column_name`
96
91
  *
97
- *
98
- *
99
- *
100
92
  * `mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`
101
93
  *
102
- *
103
- *
104
- *
105
- * > Where
106
- * >
107
- * > `instance_id`: The instance ID. This is required when the data source is registered in instance mode.
108
- * >
109
- * > `encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered by using a connection string.
110
- * >
111
- * > `catalog_id`: The DLF catalog ID.
112
- * >
113
- * > `project_name`: The MaxCompute project name.
114
- * >
115
- * > `database_name`: The database name.
116
- * >
117
- * > `schema_name`: The schema name. For MaxCompute, this is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder.
118
- * >
119
- * > `table_name`: The table name.
120
- * >
121
- * > `column_name`: The column name.
94
+ * > Where:
95
+ * `instance_id`: The instance ID, which is required when the data source is registered in instance mode.
96
+ * `encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered in connection string mode.
97
+ * `catalog_id`: The DLF catalog ID.
98
+ * `project_name`: The MaxCompute project name.
99
+ * `database_name`: The database name.
100
+ * `schema_name`: The schema name. For the MaxCompute type, this is required only if the three-tier model is enabled for the project. If it is not enabled, use an empty string as a placeholder.
101
+ * `table_name`: The table name.
102
+ * `column_name`: The column name.
122
103
  *
123
104
  * @example
124
105
  * maxcompute-column:::project_name:[schema_name]:table_name:column_name
@@ -134,7 +115,7 @@ export declare class Column extends $dara.Model {
134
115
  name?: string;
135
116
  /**
136
117
  * @remarks
137
- * Indicates whether the column is a partition key.
118
+ * Specifies whether the column is a partition key.
138
119
  *
139
120
  * @example
140
121
  * false
@@ -150,7 +131,7 @@ export declare class Column extends $dara.Model {
150
131
  position?: number;
151
132
  /**
152
133
  * @remarks
153
- * Indicates whether the column is a primary key. Currently, only MaxCompute is supported.
134
+ * Specifies whether the column is a primary key. Currently, only the MaxCompute type is supported.
154
135
  *
155
136
  * @example
156
137
  * false
@@ -161,12 +142,17 @@ export declare class Column extends $dara.Model {
161
142
  };
162
143
  /**
163
144
  * @remarks
164
- * The table ID. For more information, see the `Table` object.
145
+ * The ID of the table. Refer to the Table object.
165
146
  *
166
147
  * @example
167
148
  * maxcompute-table:::project_name:[schema_name]:table_name
168
149
  */
169
150
  tableId?: string;
151
+ /**
152
+ * @remarks
153
+ * The technical metadata.
154
+ */
155
+ technicalMetadata?: ColumnTechnicalMetadata;
170
156
  /**
171
157
  * @remarks
172
158
  * The type.