@alicloud/dataworks-public20200518 5.4.0 → 5.4.1

package/dist/client.d.ts

@@ -18178,11 +18178,16 @@ export declare class GetNodeResponseBodyData extends $tea.Model {
     baselineId?: number;
     businessId?: number;
     connection?: string;
+    createTime?: number;
     cronExpress?: string;
+    deployDate?: number;
     description?: string;
     dqcDescription?: string;
     dqcType?: number;
+    fileId?: number;
     fileType?: number;
+    fileVersion?: number;
+    modifyTime?: number;
     nodeId?: number;
     nodeName?: string;
     ownerId?: string;
@@ -18217,6 +18222,7 @@ export declare class GetNodeChildrenResponseBodyDataNodes extends $tea.Model {
     projectId?: number;
     repeatability?: boolean;
     schedulerType?: string;
+    stepType?: string;
     static names(): {
         [key: string]: string;
     };
@@ -18265,6 +18271,7 @@ export declare class GetNodeParentsResponseBodyDataNodes extends $tea.Model {
     projectId?: number;
     repeatability?: boolean;
     schedulerType?: string;
+    stepType?: string;
     static names(): {
         [key: string]: string;
     };
@@ -20683,11 +20690,16 @@ export declare class ListNodesResponseBodyDataNodes extends $tea.Model {
     baselineId?: number;
     businessId?: number;
     connection?: string;
+    createTime?: number;
     cronExpress?: string;
+    deployDate?: number;
     description?: string;
     dqcDescription?: string;
     dqcType?: number;
+    fileId?: number;
     fileType?: number;
+    fileVersion?: number;
+    modifyTime?: number;
     nodeId?: number;
     nodeName?: string;
     ownerId?: string;
@@ -22241,7 +22253,7 @@ export default class Client extends OpenApi {
      */
     abolishDataServiceApi(request: AbolishDataServiceApiRequest): Promise<AbolishDataServiceApiResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **AddMetaCollectionEntity**.
+     * @summary Adds an entity to a collection.
      *
      * @param request AddMetaCollectionEntityRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -22249,7 +22261,7 @@ export default class Client extends OpenApi {
      */
     addMetaCollectionEntityWithOptions(request: AddMetaCollectionEntityRequest, runtime: $Util.RuntimeOptions): Promise<AddMetaCollectionEntityResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **AddMetaCollectionEntity**.
+     * @summary Adds an entity to a collection.
      *
      * @param request AddMetaCollectionEntityRequest
      * @return AddMetaCollectionEntityResponse
@@ -22462,7 +22474,7 @@ export default class Client extends OpenApi {
      */
     createDIJob(request: CreateDIJobRequest): Promise<CreateDIJobResponse>;
     /**
-     * @description DataWorks allows you to use only the CreateDISyncTask operation to create a batch synchronization node in Data Integration. To create a real-time synchronization node or a synchronization solution, you must first call the [GenerateDISyncTaskConfigForCreating](https://help.aliyun.com/document_detail/383463.html) operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](https://help.aliyun.com/document_detail/383465.html) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the CreateDISyncTask operation and use the parameters as request parameters to create a real-time synchronization node or a synchronization solution in Data Integration.
+     * @summary Creates a data synchronization task.
      *
      * @param request CreateDISyncTaskRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -22470,7 +22482,7 @@ export default class Client extends OpenApi {
      */
     createDISyncTaskWithOptions(request: CreateDISyncTaskRequest, runtime: $Util.RuntimeOptions): Promise<CreateDISyncTaskResponse>;
     /**
-     * @description DataWorks allows you to use only the CreateDISyncTask operation to create a batch synchronization node in Data Integration. To create a real-time synchronization node or a synchronization solution, you must first call the [GenerateDISyncTaskConfigForCreating](https://help.aliyun.com/document_detail/383463.html) operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](https://help.aliyun.com/document_detail/383465.html) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the CreateDISyncTask operation and use the parameters as request parameters to create a real-time synchronization node or a synchronization solution in Data Integration.
+     * @summary Creates a data synchronization task.
      *
      * @param request CreateDISyncTaskRequest
      * @return CreateDISyncTaskResponse
@@ -22856,12 +22868,16 @@ export default class Client extends OpenApi {
      */
     createTableLevel(request: CreateTableLevelRequest): Promise<CreateTableLevelResponse>;
     /**
+     * @summary Creates a table folder. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request CreateTableThemeRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return CreateTableThemeResponse
      */
     createTableThemeWithOptions(request: CreateTableThemeRequest, runtime: $Util.RuntimeOptions): Promise<CreateTableThemeResponse>;
     /**
+     * @summary Creates a table folder. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request CreateTableThemeRequest
      * @return CreateTableThemeResponse
      */
@@ -24220,9 +24236,7 @@ export default class Client extends OpenApi {
      */
     getMetaDBTableList(request: GetMetaDBTableListRequest): Promise<GetMetaDBTableListResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **GetMetaTableBasicInfo**.
-     *
-     * @description ****
+     * @summary Queries the basic information about a metatable.
      *
      * @param request GetMetaTableBasicInfoRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -24230,9 +24244,7 @@ export default class Client extends OpenApi {
      */
     getMetaTableBasicInfoWithOptions(request: GetMetaTableBasicInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMetaTableBasicInfoResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **GetMetaTableBasicInfo**.
-     *
-     * @description ****
+     * @summary Queries the basic information about a metatable.
      *
      * @param request GetMetaTableBasicInfoRequest
      * @return GetMetaTableBasicInfoResponse
@@ -24314,12 +24326,16 @@ export default class Client extends OpenApi {
      */
     getMetaTableLineage(request: GetMetaTableLineageRequest): Promise<GetMetaTableLineageResponse>;
     /**
+     * @summary Queries metatables in a specified category.
+     *
      * @param request GetMetaTableListByCategoryRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return GetMetaTableListByCategoryResponse
      */
     getMetaTableListByCategoryWithOptions(request: GetMetaTableListByCategoryRequest, runtime: $Util.RuntimeOptions): Promise<GetMetaTableListByCategoryResponse>;
     /**
+     * @summary Queries metatables in a specified category.
+     *
      * @param request GetMetaTableListByCategoryRequest
      * @return GetMetaTableListByCategoryResponse
      */
@@ -24336,9 +24352,9 @@ export default class Client extends OpenApi {
      */
     getMetaTableOutput(request: GetMetaTableOutputRequest): Promise<GetMetaTableOutputResponse>;
     /**
-     * @summary For more information about the example on how to use the GetMetaTablePartition operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).
+     * @summary Queries the partitions of a metatable.
      *
-     * @description The operation that you want to perform. Set the value to **GetMetaTablePartition**.
+     * @description You can call this operation to query only the partitions of a metatable in a MaxCompute or E-MapReduce (EMR) compute engine instance.
      *
      * @param tmpReq GetMetaTablePartitionRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -24346,9 +24362,9 @@ export default class Client extends OpenApi {
      */
     getMetaTablePartitionWithOptions(tmpReq: GetMetaTablePartitionRequest, runtime: $Util.RuntimeOptions): Promise<GetMetaTablePartitionResponse>;
     /**
-     * @summary For more information about the example on how to use the GetMetaTablePartition operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).
+     * @summary Queries the partitions of a metatable.
      *
-     * @description The operation that you want to perform. Set the value to **GetMetaTablePartition**.
+     * @description You can call this operation to query only the partitions of a metatable in a MaxCompute or E-MapReduce (EMR) compute engine instance.
      *
      * @param request GetMetaTablePartitionRequest
      * @return GetMetaTablePartitionResponse
@@ -24467,12 +24483,16 @@ export default class Client extends OpenApi {
      */
     getNodeOnBaseline(request: GetNodeOnBaselineRequest): Promise<GetNodeOnBaselineResponse>;
     /**
+     * @summary Queries the ancestor nodes of a node.
+     *
      * @param request GetNodeParentsRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return GetNodeParentsResponse
      */
     getNodeParentsWithOptions(request: GetNodeParentsRequest, runtime: $Util.RuntimeOptions): Promise<GetNodeParentsResponse>;
     /**
+     * @summary Queries the ancestor nodes of a node.
+     *
      * @param request GetNodeParentsRequest
      * @return GetNodeParentsResponse
      */
@@ -24612,12 +24632,22 @@ export default class Client extends OpenApi {
      */
     getQualityRule(request: GetQualityRuleRequest): Promise<GetQualityRuleResponse>;
     /**
+     * @summary Queries the details of a custom alert rule.
+     *
+     * @description ## Debugging
+     * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetRemind\\&type=RPC\\&version=2020-05-18)
+     *
      * @param request GetRemindRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return GetRemindResponse
      */
     getRemindWithOptions(request: GetRemindRequest, runtime: $Util.RuntimeOptions): Promise<GetRemindResponse>;
     /**
+     * @summary Queries the details of a custom alert rule.
+     *
+     * @description ## Debugging
+     * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetRemind\\&type=RPC\\&version=2020-05-18)
+     *
      * @param request GetRemindRequest
      * @return GetRemindResponse
      */
@@ -24761,12 +24791,16 @@ export default class Client extends OpenApi {
      */
     listBusiness(request: ListBusinessRequest): Promise<ListBusinessResponse>;
     /**
+     * @summary Queries compute engine instances.
+     *
      * @param request ListCalcEnginesRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return ListCalcEnginesResponse
      */
     listCalcEnginesWithOptions(request: ListCalcEnginesRequest, runtime: $Util.RuntimeOptions): Promise<ListCalcEnginesResponse>;
     /**
+     * @summary Queries compute engine instances.
+     *
      * @param request ListCalcEnginesRequest
      * @return ListCalcEnginesResponse
      */
@@ -25209,7 +25243,7 @@ export default class Client extends OpenApi {
      */
     listManualDagInstances(request: ListManualDagInstancesRequest): Promise<ListManualDagInstancesResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **ListMetaCollectionEntities**.
+     * @summary Queries the entities in a collection.
      *
      * @param request ListMetaCollectionEntitiesRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -25217,16 +25251,16 @@ export default class Client extends OpenApi {
      */
     listMetaCollectionEntitiesWithOptions(request: ListMetaCollectionEntitiesRequest, runtime: $Util.RuntimeOptions): Promise<ListMetaCollectionEntitiesResponse>;
     /**
-     * @summary The operation that you want to perform. Set the value to **ListMetaCollectionEntities**.
+     * @summary Queries the entities in a collection.
      *
      * @param request ListMetaCollectionEntitiesRequest
      * @return ListMetaCollectionEntitiesResponse
      */
     listMetaCollectionEntities(request: ListMetaCollectionEntitiesRequest): Promise<ListMetaCollectionEntitiesResponse>;
     /**
-     * @summary The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.
+     * @summary Queries information about collections. Collections include data albums that are displayed on the DataMap page and categories that are created in the data albums. You can call this API operation to query collections by type.
      *
-     * @description You can configure only one of the Creator, Administrator, and Follower parameters.
+     * @description The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.
      *
      * @param request ListMetaCollectionsRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -25234,9 +25268,9 @@ export default class Client extends OpenApi {
      */
     listMetaCollectionsWithOptions(request: ListMetaCollectionsRequest, runtime: $Util.RuntimeOptions): Promise<ListMetaCollectionsResponse>;
     /**
-     * @summary The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.
+     * @summary Queries information about collections. Collections include data albums that are displayed on the DataMap page and categories that are created in the data albums. You can call this API operation to query collections by type.
      *
-     * @description You can configure only one of the Creator, Administrator, and Follower parameters.
+     * @description The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.
      *
      * @param request ListMetaCollectionsRequest
      * @return ListMetaCollectionsResponse
@@ -25373,18 +25407,25 @@ export default class Client extends OpenApi {
      */
     listProjectIds(request: ListProjectIdsRequest): Promise<ListProjectIdsResponse>;
     /**
+     * @summary Queries members in a DataWorks workspace.
+     *
      * @param request ListProjectMembersRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return ListProjectMembersResponse
      */
     listProjectMembersWithOptions(request: ListProjectMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListProjectMembersResponse>;
     /**
+     * @summary Queries members in a DataWorks workspace.
+     *
      * @param request ListProjectMembersRequest
      * @return ListProjectMembersResponse
      */
     listProjectMembers(request: ListProjectMembersRequest): Promise<ListProjectMembersResponse>;
     /**
-     * @summary Dataworks ID of the workspace.
+     * @summary A topic is added to describe how to call the ListProjectRoles operation to query all roles in a workspace.
+     *
+     * @description ## Debugging
+     * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=ListProjectRoles\\&type=RPC\\&version=2020-05-18)
      *
      * @param request ListProjectRolesRequest
      * @param runtime runtime options for this request RuntimeOptions
@@ -25392,7 +25433,10 @@ export default class Client extends OpenApi {
      */
     listProjectRolesWithOptions(request: ListProjectRolesRequest, runtime: $Util.RuntimeOptions): Promise<ListProjectRolesResponse>;
     /**
-     * @summary Dataworks ID of the workspace.
+     * @summary A topic is added to describe how to call the ListProjectRoles operation to query all roles in a workspace.
+     *
+     * @description ## Debugging
+     * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=ListProjectRoles\\&type=RPC\\&version=2020-05-18)
      *
      * @param request ListProjectRolesRequest
      * @return ListProjectRolesResponse
@@ -25537,23 +25581,31 @@ export default class Client extends OpenApi {
      */
     listSuccessInstanceAmount(request: ListSuccessInstanceAmountRequest): Promise<ListSuccessInstanceAmountResponse>;
     /**
+     * @summary Queries table levels. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request ListTableLevelRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return ListTableLevelResponse
      */
     listTableLevelWithOptions(request: ListTableLevelRequest, runtime: $Util.RuntimeOptions): Promise<ListTableLevelResponse>;
     /**
+     * @summary Queries table levels. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request ListTableLevelRequest
      * @return ListTableLevelResponse
      */
     listTableLevel(request: ListTableLevelRequest): Promise<ListTableLevelResponse>;
     /**
+     * @summary Queries table folders. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request ListTableThemeRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return ListTableThemeResponse
      */
     listTableThemeWithOptions(request: ListTableThemeRequest, runtime: $Util.RuntimeOptions): Promise<ListTableThemeResponse>;
     /**
+     * @summary Queries table folders. This API operation will be replaced soon. We recommend that you do not call this API operation.
+     *
      * @param request ListTableThemeRequest
      * @return ListTableThemeResponse
      */
@@ -26422,12 +26474,16 @@ export default class Client extends OpenApi {
      */
     updateMetaCollection(request: UpdateMetaCollectionRequest): Promise<UpdateMetaCollectionResponse>;
     /**
+     * @summary Updates the metadata information about a table.
+     *
      * @param request UpdateMetaTableRequest
      * @param runtime runtime options for this request RuntimeOptions
      * @return UpdateMetaTableResponse
      */
     updateMetaTableWithOptions(request: UpdateMetaTableRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMetaTableResponse>;
     /**
+     * @summary Updates the metadata information about a table.
+     *
      * @param request UpdateMetaTableRequest
      * @return UpdateMetaTableResponse
      */