@alicloud/dataworks-public20200518 9.0.0 → 10.1.0

package/src/models/CreateTableRequest.ts

@@ -18,7 +18,7 @@ export class CreateTableRequestColumns extends $dara.Model {
    * The display name of the field.
    * 
    * @example
-   * columnName in chinese
+   * 中文名
    */
   columnNameCn?: string;
   /**
@@ -36,7 +36,7 @@ export class CreateTableRequestColumns extends $dara.Model {
    * The comment of the field.
    * 
    * @example
-   * comment
+   * 备注
    */
   comment?: string;
   /**
@@ -158,7 +158,7 @@ export class CreateTableRequest extends $dara.Model {
    * A reserved parameter.
    * 
    * @example
-   * reserved
+   * Reserved field
    */
   clientToken?: string;
   /**
@@ -173,7 +173,7 @@ export class CreateTableRequest extends $dara.Model {
    * The comment.
    * 
    * @example
-   * comment
+   * Remarks
    */
   comment?: string;
   /**
@@ -188,8 +188,9 @@ export class CreateTableRequest extends $dara.Model {
    * @remarks
    * The environment type of the DataWorks workspace. Valid values:
    * 
-   * *   0: development environment
-   * *   1: production environment
+   * - 0: development environment
+   * 
+   * - 1: production environment
    * 
    * @example
    * 1
@@ -199,10 +200,13 @@ export class CreateTableRequest extends $dara.Model {
    * @remarks
    * The storage type of the external table. Valid values:
    * 
-   * *   0: Object Storage Service (OSS)
-   * *   1: Tablestore
-   * *   2: Volume
-   * *   3: MySQL
+   * - 0: Object Storage Service (OSS)
+   * 
+   * - 1: Tablestore
+   * 
+   * - 2: Volume
+   * 
+   * - 3: MySQL
    * 
    * @example
    * 0
@@ -220,8 +224,9 @@ export class CreateTableRequest extends $dara.Model {
    * @remarks
    * Specifies whether to create a view or table. Valid values:
    * 
-   * *   0: Create a table.
-   * *   1: Create a view.
+   * - 0: Create a table.
+   * 
+   * - 1: Create a view.
    * 
    * @example
    * 0
@@ -298,9 +303,11 @@ export class CreateTableRequest extends $dara.Model {
    * @remarks
    * Specifies whether the table or workspace is visible. Valid values:
    * 
-   * *   0: Both the table and workspace are invisible.
-   * *   1: Both the table and workspace are visible.
-   * *   2: Only the workspace is visible.
+   * - 0: Both the table and workspace are invisible.
+   * 
+   * - 1: Both the table and workspace are visible.
+   * 
+   * - 2: Only the workspace is visible.
    * 
    * @example
    * 1

package/src/models/CreateTableResponseBody.ts

@@ -7,8 +7,9 @@ export class CreateTableResponseBodyTaskInfo extends $dara.Model {
    * @remarks
    * The details about the status of the current subtask.
    * 
-   * *   If the current subtask is successful, success is returned.
-   * *   If the current subtask fails, the error details are displayed.
+   * - If the current subtask is successful, success is returned.
+   * 
+   * - If the current subtask fails, the error details are displayed.
    * 
    * @example
    * success
@@ -26,9 +27,11 @@ export class CreateTableResponseBodyTaskInfo extends $dara.Model {
    * @remarks
    * The status of the current subtask. Valid values:
    * 
-   * *   operating: The subtask is running.
-   * *   success: The subtask succeeds.
-   * *   failure: The subtask fails to run. For more information about the error details, see the Content parameter.
+   * - operating: The subtask is running.
+   * 
+   * - success: The subtask succeeds.
+   * 
+   * - failure: The subtask fails to run. For more information about the error details, see the Content parameter.
    * 
    * @example
    * success
@@ -84,8 +87,9 @@ export class CreateTableResponseBody extends $dara.Model {
    * 
    * If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:
    * 
-   * *   The request task fails to be submitted.
-   * *   After the request task is submitted, a subtask fails to run.
+   * - The request task fails to be submitted.
+   * 
+   * - After the request task is submitted, a subtask fails to run.
    */
   taskInfo?: CreateTableResponseBodyTaskInfo;
   static names(): { [key: string]: string } {

package/src/models/CreateTableThemeRequest.ts

@@ -20,7 +20,7 @@ export class CreateTableThemeRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * test
+   * Topic name
    */
   name?: string;
   /**

package/src/models/DataDesensPlanTemplateValue.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DataDesensPlanTemplateValue extends $dara.Model {
   /**
    * @remarks
-   * The name of the data masking method.
+   * The name of the Desensitization Method.
    * 
    * @example
    * hash
@@ -13,10 +13,11 @@ export class DataDesensPlanTemplateValue extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * Indicates whether a watermark is added. Valid values:
+   * Indicates whether watermarking is supported. Valid values:
    * 
-   * *   true: allow
-   * *   false: disallow
+   * - true: Watermarking is supported.
+   * 
+   * - false: Watermarking is not supported.
    * 
    * @example
    * true
@@ -24,7 +25,7 @@ export class DataDesensPlanTemplateValue extends $dara.Model {
   supportWaterMark?: boolean;
   /**
    * @remarks
-   * The data masking parameters and their descriptions.
+   * A list of Desensitization Parameters and their descriptions.
    */
   extParamTemplate?: any[];
   static names(): { [key: string]: string } {

package/src/models/DeleteDisyncTaskResponseBody.ts

@@ -15,8 +15,9 @@ export class DeleteDISyncTaskResponseBodyData extends $dara.Model {
    * @remarks
    * Indicates whether the synchronization task is deleted. Valid values:
    * 
-   * *   success: The synchronization task is deleted.
-   * *   fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.
+   * - success: The synchronization task is deleted.
+   * 
+   * - fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.
    * 
    * @example
    * fail
@@ -63,8 +64,9 @@ export class DeleteDISyncTaskResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * true

package/src/models/DeleteFileRequest.ts

@@ -10,7 +10,7 @@ export class DeleteFileRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * 10000001
+   * 10000201
    */
   fileId?: number;
   /**

package/src/models/DeleteFolderRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteFolderRequest extends $dara.Model {
   /**
    * @remarks
-   * DeleteFolder
+   * The ID of the folder. For more information about how to obtain the folder ID, see [ListFolders](https://help.aliyun.com/document_detail/173955.html).
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteFolderRequest extends $dara.Model {
   folderId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful.
+   * The ID of the DataWorks workspace. To obtain the workspace ID, log on to the DataWorks console and go to the Workspace Management page. You must set this parameter or ProjectIdentifier to specify the DataWorks workspace for the API call.
    * 
    * @example
    * 10000
@@ -23,7 +23,7 @@ export class DeleteFolderRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * http://100.67.165.184/business/api/folders/delete
+   * The name of the DataWorks workspace. To obtain the workspace name, log on to the DataWorks console and go to the Workspace Management page. You must set this parameter or ProjectId to specify the DataWorks workspace for the API call.
    * 
    * @example
    * dw_project

package/src/models/DeleteFolderResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteFolderResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * Invalid.Tenant.ConnectionNotExists
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * The connection does not exist.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The ID of the request. You can use the ID to troubleshoot issues.
+   * 
    * @example
    * 0000-ABCD-EFG****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DeleteQualityEntityRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityEntityRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the partition filter expression.
+   * The ID of the partition expression.
    * 
    * This parameter is required.
    * 
@@ -15,26 +15,17 @@ export class DeleteQualityEntityRequest extends $dara.Model {
   entityId?: number;
   /**
    * @remarks
-   * The type of the compute engine or data source. The following types are supported: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.
-   * 
-   * Valid values:
-   * 
-   * *   odps
-   * *   emr
-   * *   hadoop
-   * *   cdh
-   * *   hybriddb_for_postgresql
-   * *   holodb
+   * The type of the engine or data source. Valid values: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.
    * 
    * This parameter is required.
    * 
    * @example
-   * ODPS
+   * odps
    */
   envType?: string;
   /**
    * @remarks
-   * The DataWorks workspace ID.
+   * The ID of the DataWorks workspace.
    * 
    * @example
    * 12345
@@ -42,7 +33,7 @@ export class DeleteQualityEntityRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the compute engine or data source.
+   * The name of the engine or data source.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityEntityResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityEntityResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned result.
+   * Indicates whether the partition expression was successfully deleted.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code.
+   * The error code returned if the request fails.
    * 
    * @example
    * 401
@@ -21,7 +21,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message.
+   * The error message returned if the request fails.
    * 
    * @example
    * You have no permission.
@@ -37,7 +37,7 @@ export class DeleteQualityEntityResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * ecb967ec-c137-48****

package/src/models/DeleteQualityFollowerRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityFollowerRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the subscription relationship between the partition filter expression and the subscriber. You can call the [GetQualityFollower](https://help.aliyun.com/document_detail/174000.html) operation to obtain the ID of the subscription relationship.
+   * The ID of the follower. You can call the [GetQualityFollower](https://help.aliyun.com/document_detail/174000.html) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DeleteQualityFollowerRequest extends $dara.Model {
   followerId?: number;
   /**
    * @remarks
-   * The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.
+   * The ID of the DataWorks workspace. You can log in to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.
    * 
    * @example
    * 10000
@@ -23,7 +23,7 @@ export class DeleteQualityFollowerRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the compute engine or data source for which the partition filter expression is configured. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the rule configuration page of Data Quality page to obtain the name.
+   * The name of the engine or data source where the partition expression is located. You can log in to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Quality page to obtain the name.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityFollowerResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityFollowerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the subscriber was successfully deleted. Valid values:
+   * Indicates whether the follower of the partition filter expression was deleted. Valid values:
    * 
-   * *   true: The subscriber was successfully deleted.
-   * *   false: The subscriber failed to be deleted. You can troubleshoot errors based on the error message returned.
+   * - `true`: The follower was deleted.
+   * 
+   * - `false`: The follower failed to be deleted. You can troubleshoot the issue based on the error message.
    * 
    * @example
    * true
@@ -24,7 +25,7 @@ export class DeleteQualityFollowerResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the subscriber failed to be deleted.
+   * The error message returned if the follower of the partition filter expression fails to be deleted.
    * 
    * @example
    * You have no permission.
@@ -40,7 +41,7 @@ export class DeleteQualityFollowerResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID. You can troubleshoot errors based on the ID.
+   * The request ID. This parameter is used to troubleshoot issues.
    * 
    * @example
    * 6d739ef6-098a-47****
@@ -50,8 +51,9 @@ export class DeleteQualityFollowerResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the request was successful. Valid values:
    * 
-   * *   true
-   * *   false
+   * - `true`: The request was successful.
+   * 
+   * - `false`: The request failed.
    * 
    * @example
    * true

package/src/models/DeleteQualityRelativeNodeRequest.ts

@@ -5,15 +5,21 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   /**
    * @remarks
-   * The type of the compute engine or data source. Valid values:
+   * The type of the engine or data source. Valid values:
    * 
-   * *   cdh
-   * *   analyticdb_for_mysql
-   * *   odps
-   * *   emr
-   * *   hadoop
-   * *   holodb
-   * *   hybriddb_for_postgresql
+   * - cdh
+   * 
+   * - analyticdb_for_mysql
+   * 
+   * - odps
+   * 
+   * - emr
+   * 
+   * - hadoop
+   * 
+   * - holodb
+   * 
+   * - hybriddb_for_postgresql
    * 
    * This parameter is required.
    * 
@@ -33,7 +39,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   matchExpression?: string;
   /**
    * @remarks
-   * The ID of the node.
+   * The node ID.
    * 
    * This parameter is required.
    * 
@@ -43,7 +49,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   nodeId?: number;
   /**
    * @remarks
-   * The ID of the workspace.
+   * The workspace ID.
    * 
    * This parameter is required.
    * 
@@ -53,7 +59,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the compute engine instance or data source.
+   * The name of the workspace.
    * 
    * This parameter is required.
    * 
@@ -63,7 +69,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The name of the table that is generated by the node.
+   * The table name.
    * 
    * This parameter is required.
    * 
@@ -73,7 +79,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The ID of the workspace to which the node associated with the partition filter expression belongs.
+   * The ID of the workspace that contains the associated scheduling node.
    * 
    * This parameter is required.
    * 
@@ -83,7 +89,7 @@ export class DeleteQualityRelativeNodeRequest extends $dara.Model {
   targetNodeProjectId?: number;
   /**
    * @remarks
-   * The name of the workspace to which the node associated with the partition filter expression belongs.
+   * The name of the workspace that contains the associated scheduling node.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityRelativeNodeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the node is disassociated from the partition filter expression.
+   * Indicates whether the scheduling association was successfully deleted.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code returned.
+   * The error code.
    * 
    * @example
    * 401
@@ -21,7 +21,7 @@ export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned.
+   * The error message.
    * 
    * @example
    * You have no permission.
@@ -29,7 +29,7 @@ export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The HTTP status code returned.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -37,7 +37,7 @@ export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 6d739ef6-098a-47****
@@ -45,7 +45,7 @@ export class DeleteQualityRelativeNodeResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the API call was successful.
    * 
    * @example
    * true

package/src/models/DeleteQualityRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.
+   * The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.
    * 
    * @example
    * 10000
@@ -23,7 +23,7 @@ export class DeleteQualityRuleRequest extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The monitoring rule ID.
+   * The ID of the data quality rule.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteQualityRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteQualityRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the monitoring rule was deleted.
+   * Indicates whether the data quality rule was successfully deleted.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DeleteQualityRuleResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code.
+   * The error code returned if the request fails.
    * 
    * @example
    * 401
@@ -21,7 +21,7 @@ export class DeleteQualityRuleResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message.
+   * The error message returned if the request fails.
    * 
    * @example
    * You have no permission.
@@ -37,7 +37,7 @@ export class DeleteQualityRuleResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 6d739ef6-098a-47****

package/src/models/DeleteRemindRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteRemindRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the custom alert rule.
+   * The ID of the custom monitoring alert rule.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteRemindResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteRemindResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the custom alert rule is deleted. Valid values: true and false. The value true indicates that the custom alert rule is deleted. The value false indicates that the custom alert rule fails to be deleted.
+   * Indicates whether the deletion was successful. Valid values: true (success) and false (failure).
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class DeleteRemindResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code returned.
+   * The error code.
    * 
    * @example
    * 1031203110005
@@ -21,7 +21,7 @@ export class DeleteRemindResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned.
+   * The error message.
    * 
    * @example
    * The specified parameters are invalid.
@@ -29,7 +29,7 @@ export class DeleteRemindResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The HTTP status code returned.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -37,7 +37,7 @@ export class DeleteRemindResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request. You can use the ID to troubleshoot issues.
+   * The unique request ID. Use this ID to troubleshoot issues.
    * 
    * @example
    * 0000-ABCD-EFG****