@alicloud/dataworks-public20240518 8.8.3 → 8.8.4

package/dist/client.d.ts

@@ -1009,11 +1009,11 @@ export default class Client extends OpenApi {
      */
     createParameter(request: $_model.CreateParameterRequest): Promise<$_model.CreateParameterResponse>;
     /**
-     * Creates a deployment process for entities in the Data Studio (new version).
+     * Creates a publish process for an entity in the new-version DataStudio.
      *
      * @remarks
-     * >Notice: This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
-     * >Notice: This API may not be available in earlier versions of the SDK. In that case, use the CreateDeployment API, which accepts the same parameters.
+     * >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.
+     * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters are the same as those described in this topic.
      *
      * @param tmpReq - CreatePipelineRunRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1021,11 +1021,11 @@ export default class Client extends OpenApi {
      */
     createPipelineRunWithOptions(tmpReq: $_model.CreatePipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreatePipelineRunResponse>;
     /**
-     * Creates a deployment process for entities in the Data Studio (new version).
+     * Creates a publish process for an entity in the new-version DataStudio.
      *
      * @remarks
-     * >Notice: This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
-     * >Notice: This API may not be available in earlier versions of the SDK. In that case, use the CreateDeployment API, which accepts the same parameters.
+     * >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.
+     * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters are the same as those described in this topic.
      *
      * @param request - CreatePipelineRunRequest
      * @returns CreatePipelineRunResponse
@@ -2611,10 +2611,10 @@ export default class Client extends OpenApi {
      */
     getCertificate(request: $_model.GetCertificateRequest): Promise<$_model.GetCertificateResponse>;
     /**
-     * Queries the information about a specific field of a table in Data Map.
+     * Retrieves the details of a specified column in a Data Map table.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetColumnRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -2622,10 +2622,10 @@ export default class Client extends OpenApi {
      */
     getColumnWithOptions(request: $_model.GetColumnRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetColumnResponse>;
     /**
-     * Queries the information about a specific field of a table in Data Map.
+     * Retrieves the details of a specified column in a Data Map table.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetColumnRequest
      * @returns GetColumnResponse
@@ -3635,10 +3635,10 @@ export default class Client extends OpenApi {
      */
     getSkill(request: $_model.GetSkillRequest): Promise<$_model.GetSkillResponse>;
     /**
-     * Queries the information about a specific table in Data Map.
+     * Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetTableRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3646,10 +3646,10 @@ export default class Client extends OpenApi {
      */
     getTableWithOptions(request: $_model.GetTableRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableResponse>;
     /**
-     * Queries the information about a specific table in Data Map.
+     * Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetTableRequest
      * @returns GetTableResponse
@@ -3815,12 +3815,12 @@ export default class Client extends OpenApi {
     importCertificate(request: $_model.ImportCertificateRequest): Promise<$_model.ImportCertificateResponse>;
     importCertificateAdvance(request: $_model.ImportCertificateAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportCertificateResponse>;
     /**
-     * Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.
+     * Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
      *
      * @remarks
      * >Notice:
-     * - This API does not support importing multiple workflow definitions. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored.
-     * - This is an asynchronous API. Calling this API returns an asynchronous task object. You must call the GetJobStatus API to query the execution status of the task.
+     * - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored.
+     * - This is an asynchronous operation. The response returns an asynchronous task object. Call GetJobStatus to query the execution status of the task.
      *
      * @param request - ImportWorkflowDefinitionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3828,12 +3828,12 @@ export default class Client extends OpenApi {
      */
     importWorkflowDefinitionWithOptions(request: $_model.ImportWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportWorkflowDefinitionResponse>;
     /**
-     * Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.
+     * Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
      *
      * @remarks
      * >Notice:
-     * - This API does not support importing multiple workflow definitions. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored.
-     * - This is an asynchronous API. Calling this API returns an asynchronous task object. You must call the GetJobStatus API to query the execution status of the task.
+     * - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored.
+     * - This is an asynchronous operation. The response returns an asynchronous task object. Call GetJobStatus to query the execution status of the task.
      *
      * @param request - ImportWorkflowDefinitionRequest
      * @returns ImportWorkflowDefinitionResponse
@@ -3997,10 +3997,10 @@ export default class Client extends OpenApi {
      */
     listCertificates(request: $_model.ListCertificatesRequest): Promise<$_model.ListCertificatesResponse>;
     /**
-     * Queries the column list of a specified table in Data Map.
+     * Queries the column list of a specified data table in DataWorks Data Map.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - ListColumnsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -4008,10 +4008,10 @@ export default class Client extends OpenApi {
      */
     listColumnsWithOptions(request: $_model.ListColumnsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListColumnsResponse>;
     /**
-     * Queries the column list of a specified table in Data Map.
+     * Queries the column list of a specified data table in DataWorks Data Map.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - ListColumnsRequest
      * @returns ListColumnsResponse
@@ -5470,10 +5470,10 @@ export default class Client extends OpenApi {
      */
     listSkills(request: $_model.ListSkillsRequest): Promise<$_model.ListSkillsResponse>;
     /**
-     * Queries a list of tables in the data map. For data source types that do not support schemas, this operation queries tables within a specified database. For data source types that support schemas, you can query tables within a specified database, MaxCompute project, or schema. The response includes basic table information, technical metadata, and business metadata.
+     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * 1. DataWorks Basic Edition or a higher edition is required.
      *
      * @param tmpReq - ListTablesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -5481,10 +5481,10 @@ export default class Client extends OpenApi {
      */
     listTablesWithOptions(tmpReq: $_model.ListTablesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTablesResponse>;
     /**
-     * Queries a list of tables in the data map. For data source types that do not support schemas, this operation queries tables within a specified database. For data source types that support schemas, you can query tables within a specified database, MaxCompute project, or schema. The response includes basic table information, technical metadata, and business metadata.
+     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * 1. DataWorks Basic Edition or a higher edition is required.
      *
      * @param request - ListTablesRequest
      * @returns ListTablesResponse

package/dist/client.js

@@ -3104,11 +3104,11 @@ class Client extends openapi_core_1.default {
         return await this.createParameterWithOptions(request, runtime);
     }
     /**
-     * Creates a deployment process for entities in the Data Studio (new version).
+     * Creates a publish process for an entity in the new-version DataStudio.
      *
      * @remarks
-     * >Notice: This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
-     * >Notice: This API may not be available in earlier versions of the SDK. In that case, use the CreateDeployment API, which accepts the same parameters.
+     * >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.
+     * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters are the same as those described in this topic.
      *
      * @param tmpReq - CreatePipelineRunRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -3122,6 +3122,9 @@ class Client extends openapi_core_1.default {
             request.objectIdsShrink = openapi_core_2.OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.objectIds, "ObjectIds", "json");
         }
         let body = {};
+        if (!$dara.isNull(request.autoRunUntilStage)) {
+            body["AutoRunUntilStage"] = request.autoRunUntilStage;
+        }
         if (!$dara.isNull(request.description)) {
             body["Description"] = request.description;
         }
@@ -3131,6 +3134,9 @@ class Client extends openapi_core_1.default {
         if (!$dara.isNull(request.projectId)) {
             body["ProjectId"] = request.projectId;
         }
+        if (!$dara.isNull(request.runMode)) {
+            body["RunMode"] = request.runMode;
+        }
         if (!$dara.isNull(request.type)) {
             body["Type"] = request.type;
         }
@@ -3151,11 +3157,11 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreatePipelineRunResponse({}));
     }
     /**
-     * Creates a deployment process for entities in the Data Studio (new version).
+     * Creates a publish process for an entity in the new-version DataStudio.
      *
      * @remarks
-     * >Notice: This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
-     * >Notice: This API may not be available in earlier versions of the SDK. In that case, use the CreateDeployment API, which accepts the same parameters.
+     * >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.
+     * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters are the same as those described in this topic.
      *
      * @param request - CreatePipelineRunRequest
      * @returns CreatePipelineRunResponse
@@ -7147,10 +7153,10 @@ class Client extends openapi_core_1.default {
         return await this.getCertificateWithOptions(request, runtime);
     }
     /**
-     * Queries the information about a specific field of a table in Data Map.
+     * Retrieves the details of a specified column in a Data Map table.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetColumnRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -7176,10 +7182,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetColumnResponse({}));
     }
     /**
-     * Queries the information about a specific field of a table in Data Map.
+     * Retrieves the details of a specified column in a Data Map table.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetColumnRequest
      * @returns GetColumnResponse
@@ -9360,10 +9366,10 @@ class Client extends openapi_core_1.default {
         return await this.getSkillWithOptions(request, runtime);
     }
     /**
-     * Queries the information about a specific table in Data Map.
+     * Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetTableRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9389,10 +9395,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetTableResponse({}));
     }
     /**
-     * Queries the information about a specific table in Data Map.
+     * Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - GetTableRequest
      * @returns GetTableResponse
@@ -9835,12 +9841,12 @@ class Client extends openapi_core_1.default {
         return importCertificateResp;
     }
     /**
-     * Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.
+     * Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
      *
      * @remarks
      * >Notice:
-     * - This API does not support importing multiple workflow definitions. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored.
-     * - This is an asynchronous API. Calling this API returns an asynchronous task object. You must call the GetJobStatus API to query the execution status of the task.
+     * - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored.
+     * - This is an asynchronous operation. The response returns an asynchronous task object. Call GetJobStatus to query the execution status of the task.
      *
      * @param request - ImportWorkflowDefinitionRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -9849,6 +9855,9 @@ class Client extends openapi_core_1.default {
     async importWorkflowDefinitionWithOptions(request, runtime) {
         request.validate();
         let body = {};
+        if (!$dara.isNull(request.dryRun)) {
+            body["DryRun"] = request.dryRun;
+        }
         if (!$dara.isNull(request.projectId)) {
             body["ProjectId"] = request.projectId;
         }
@@ -9872,12 +9881,12 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ImportWorkflowDefinitionResponse({}));
     }
     /**
-     * Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.
+     * Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
      *
      * @remarks
      * >Notice:
-     * - This API does not support importing multiple workflow definitions. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored.
-     * - This is an asynchronous API. Calling this API returns an asynchronous task object. You must call the GetJobStatus API to query the execution status of the task.
+     * - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored.
+     * - This is an asynchronous operation. The response returns an asynchronous task object. Call GetJobStatus to query the execution status of the task.
      *
      * @param request - ImportWorkflowDefinitionRequest
      * @returns ImportWorkflowDefinitionResponse
@@ -10282,10 +10291,10 @@ class Client extends openapi_core_1.default {
         return await this.listCertificatesWithOptions(request, runtime);
     }
     /**
-     * Queries the column list of a specified table in Data Map.
+     * Queries the column list of a specified data table in DataWorks Data Map.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - ListColumnsRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -10311,10 +10320,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListColumnsResponse({}));
     }
     /**
-     * Queries the column list of a specified table in Data Map.
+     * Queries the column list of a specified data table in DataWorks Data Map.
      *
      * @remarks
-     * 1. DataWorks Basic Edition or a higher edition is required.
+     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
      *
      * @param request - ListColumnsRequest
      * @returns ListColumnsResponse
@@ -14048,10 +14057,10 @@ class Client extends openapi_core_1.default {
         return await this.listSkillsWithOptions(request, runtime);
     }
     /**
-     * Queries a list of tables in the data map. For data source types that do not support schemas, this operation queries tables within a specified database. For data source types that support schemas, you can query tables within a specified database, MaxCompute project, or schema. The response includes basic table information, technical metadata, and business metadata.
+     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * 1. DataWorks Basic Edition or a higher edition is required.
      *
      * @param tmpReq - ListTablesRequest
      * @param runtime - runtime options for this request RuntimeOptions
@@ -14082,10 +14091,10 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListTablesResponse({}));
     }
     /**
-     * Queries a list of tables in the data map. For data source types that do not support schemas, this operation queries tables within a specified database. For data source types that support schemas, you can query tables within a specified database, MaxCompute project, or schema. The response includes basic table information, technical metadata, and business metadata.
+     * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
      *
      * @remarks
-     * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
+     * 1. DataWorks Basic Edition or a higher edition is required.
      *
      * @param request - ListTablesRequest
      * @returns ListTablesResponse