@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/CreateProjectMemberRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateProjectMemberRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID.
+   * The client token used to ensure idempotence. We recommend that you use a UUID.
    * 
    * @example
    * 1AFAE64E-D1BE-432B-A9****
@@ -13,7 +13,7 @@ export class CreateProjectMemberRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The DataWorks workspace ID.
+   * The ID of the DataWorks workspace.
    * 
    * This parameter is required.
    * 
@@ -23,7 +23,7 @@ export class CreateProjectMemberRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The code of the role. This parameter is optional. If you configure the RoleCode parameter, the user is assigned the role.
+   * The code of the role. This parameter is optional. If you specify this parameter, the user is also added to the specified role.
    * 
    * @example
    * role_project_guest

package/src/models/CreateProjectRequest.ts

@@ -49,7 +49,7 @@ export class CreateProjectRequestTags extends $dara.Model {
 export class CreateProjectRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. This parameter can be left empty.
+   * The idempotency parameter. This parameter can be left empty.
    * 
    * @example
    * ABFUOEUOTRTRJKE
@@ -57,10 +57,10 @@ export class CreateProjectRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Specifies whether to disable the Develop role. Valid values:
+   * Specifies whether to disable the development role. Valid values:
    * 
-   * *   **false** (default)
-   * *   **true**
+   * - **false** (default): enables the development role.
+   * - **true**: disables the development role.
    * 
    * @example
    * false
@@ -68,10 +68,10 @@ export class CreateProjectRequest extends $dara.Model {
   disableDevelopment?: boolean;
   /**
    * @remarks
-   * Specifies whether to allow you to download the query result from DataStudio. Valid values:
+   * Specifies whether to allow downloading query results from the IDE. Valid values:
    * 
-   * *   **1** (default): allows you to download the query result from DataStudio.
-   * *   **0**: does not allow you to download the query result from DataStudio.
+   * - **1** (default): allows downloading.
+   * - **0**: does not allow downloading.
    * 
    * @example
    * 1
@@ -79,7 +79,7 @@ export class CreateProjectRequest extends $dara.Model {
   isAllowDownload?: number;
   /**
    * @remarks
-   * The description of the workspace.
+   * The detailed description of the workspace.
    * 
    * @example
    * test_describe
@@ -87,7 +87,7 @@ export class CreateProjectRequest extends $dara.Model {
   projectDescription?: string;
   /**
    * @remarks
-   * The name of the workspace. The name can contain only letters, digits, and underscores (_) and must start with a letter or digit.
+   * The name of the workspace. The name can contain only letters, digits, and underscores (_), and must start with a letter or digit.
    * 
    * This parameter is required.
    * 
@@ -97,12 +97,18 @@ export class CreateProjectRequest extends $dara.Model {
   projectIdentifier?: string;
   /**
    * @remarks
-   * The mode of the workspace. For more information about the differences between the modes of workspaces, see [Differences between workspaces in basic mode and workspaces in standard mode](https://help.aliyun.com/document_detail/85772.html).
+   * The mode of the workspace. For more information about the differences between modes, see [Must-read: Differences between basic mode and standard mode](https://help.aliyun.com/document_detail/85772.html).
+   * 
+   * 
+   * 
    * 
    * Valid values:
    * 
-   * *   **2** (default): basic mode
-   * *   **3**: standard mode
+   * 
+   * 
+   * 
+   * - **2** (default): basic workspace mode.
+   * - **3**: standard workspace mode.
    * 
    * @example
    * 3
@@ -128,7 +134,7 @@ export class CreateProjectRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The tags added to the workspace.
+   * The list of tags bound to the workspace.
    */
   tags?: CreateProjectRequestTags[];
   static names(): { [key: string]: string } {

package/src/models/CreateProjectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateProjectResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The workspace ID.
+   * The ID of the DataWorks workspace that was created.
    * 
    * @example
    * 466230
@@ -31,8 +31,8 @@ export class CreateProjectResponseBody 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/CreateProjectShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateProjectShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. This parameter can be left empty.
+   * The idempotency parameter. This parameter can be left empty.
    * 
    * @example
    * ABFUOEUOTRTRJKE
@@ -13,10 +13,10 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Specifies whether to disable the Develop role. Valid values:
+   * Specifies whether to disable the development role. Valid values:
    * 
-   * *   **false** (default)
-   * *   **true**
+   * - **false** (default): enables the development role.
+   * - **true**: disables the development role.
    * 
    * @example
    * false
@@ -24,10 +24,10 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   disableDevelopment?: boolean;
   /**
    * @remarks
-   * Specifies whether to allow you to download the query result from DataStudio. Valid values:
+   * Specifies whether to allow downloading query results from the IDE. Valid values:
    * 
-   * *   **1** (default): allows you to download the query result from DataStudio.
-   * *   **0**: does not allow you to download the query result from DataStudio.
+   * - **1** (default): allows downloading.
+   * - **0**: does not allow downloading.
    * 
    * @example
    * 1
@@ -35,7 +35,7 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   isAllowDownload?: number;
   /**
    * @remarks
-   * The description of the workspace.
+   * The detailed description of the workspace.
    * 
    * @example
    * test_describe
@@ -43,7 +43,7 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   projectDescription?: string;
   /**
    * @remarks
-   * The name of the workspace. The name can contain only letters, digits, and underscores (_) and must start with a letter or digit.
+   * The name of the workspace. The name can contain only letters, digits, and underscores (_), and must start with a letter or digit.
    * 
    * This parameter is required.
    * 
@@ -53,12 +53,18 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   projectIdentifier?: string;
   /**
    * @remarks
-   * The mode of the workspace. For more information about the differences between the modes of workspaces, see [Differences between workspaces in basic mode and workspaces in standard mode](https://help.aliyun.com/document_detail/85772.html).
+   * The mode of the workspace. For more information about the differences between modes, see [Must-read: Differences between basic mode and standard mode](https://help.aliyun.com/document_detail/85772.html).
+   * 
+   * 
+   * 
    * 
    * Valid values:
    * 
-   * *   **2** (default): basic mode
-   * *   **3**: standard mode
+   * 
+   * 
+   * 
+   * - **2** (default): basic workspace mode.
+   * - **3**: standard workspace mode.
    * 
    * @example
    * 3
@@ -84,7 +90,7 @@ export class CreateProjectShrinkRequest extends $dara.Model {
   resourceManagerResourceGroupId?: string;
   /**
    * @remarks
-   * The tags added to the workspace.
+   * The list of tags bound to the workspace.
    */
   tagsShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateQualityEntityRequest.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityEntityRequest extends $dara.Model {
   /**
    * @remarks
-   * This parameter is deprecated.
+   * **[Deprecated]**
+   * Includes 0 (verified upon SQL completion).
    * 
    * @example
    * 0
@@ -13,7 +14,7 @@ export class CreateQualityEntityRequest extends $dara.Model {
   entityLevel?: number;
   /**
    * @remarks
-   * The type of the engine or data source. Valid values: ODPS, EMR, CDH, and HOLO.
+   * The type of the engine or data source.
    * 
    * This parameter is required.
    * 
@@ -33,7 +34,7 @@ export class CreateQualityEntityRequest extends $dara.Model {
   matchExpression?: string;
   /**
    * @remarks
-   * The ID of the DataWorks workspace. You can go to the DataWorks console to obtain the workspace ID.
+   * The ID of the DataWorks workspace. You can obtain the ID from the DataWorks console.
    * 
    * @example
    * 123
@@ -41,7 +42,7 @@ export class CreateQualityEntityRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the engine or data source.
+   * The name of the project for the engine or the name of the data source.
    * 
    * This parameter is required.
    * 

package/src/models/CreateQualityEntityResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityEntityResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the created partition expression.
+   * The ID of the newly created partition expression.
    * 
    * @example
    * 12345
@@ -45,7 +45,7 @@ export class CreateQualityEntityResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call is successful.
    * 
    * @example
    * true

package/src/models/CreateQualityFollowerRequest.ts

@@ -5,7 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityFollowerRequest extends $dara.Model {
   /**
    * @remarks
-   * The alert method. Valid values: 1 (email), 2 (email and SMS), 4 (DingTalk Group Bot), 5 (DingTalk Group Bot with an @all message), 6 (Lark), 7 (WeCom), 8 (webhook), and 9 (Phone Alert).
+   * The notification method. Valid values:
+   * 
+   * - 1: email.
+   * - 2: email and text message.
+   * - 4: DingTalk chatbot.
+   * - 5: DingTalk chatbot @ALL.
+   * - 6: Lark.
+   * - 7: WeCom.
+   * - 8: WEBHOOK.
+   * - 9: phone call alert.
    * 
    * This parameter is required.
    * 
@@ -25,7 +34,7 @@ export class CreateQualityFollowerRequest extends $dara.Model {
   entityId?: number;
   /**
    * @remarks
-   * The Alibaba Cloud account ID of the follower.
+   * The account ID of the subscriber.
    * 
    * This parameter is required.
    * 
@@ -35,7 +44,7 @@ export class CreateQualityFollowerRequest extends $dara.Model {
   follower?: string;
   /**
    * @remarks
-   * The ID of the DataWorks workspace. To find the workspace ID, log in to the DataWorks console.
+   * The ID of the DataWorks workspace. You can obtain the ID from the DataWorks console.
    * 
    * @example
    * 123
@@ -43,7 +52,7 @@ export class CreateQualityFollowerRequest 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/CreateQualityFollowerResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityFollowerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The subscription ID.
+   * The ID of the newly created subscription.
    * 
    * @example
    * 12345
@@ -45,7 +45,7 @@ export class CreateQualityFollowerResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true

package/src/models/CreateQualityRelativeNodeRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityRelativeNodeRequest extends $dara.Model {
   /**
    * @remarks
-   * The type of the compute engine or data source.
+   * The type of the engine or data source.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreateQualityRelativeNodeRequest extends $dara.Model {
   matchExpression?: string;
   /**
    * @remarks
-   * The ID of the scheduling node. You can call the [ListNodes](https://help.aliyun.com/document_detail/173979.html) API to obtain the node ID.
+   * The ID of the scheduling node. You can call the [ListNodes](https://help.aliyun.com/document_detail/173979.html) operation to obtain the node ID.
    * 
    * This parameter is required.
    * 
@@ -45,7 +45,7 @@ export class CreateQualityRelativeNodeRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the compute engine instance or data source.
+   * The name of the engine or data source.
    * 
    * This parameter is required.
    * 
@@ -65,7 +65,7 @@ export class CreateQualityRelativeNodeRequest extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The ID of the project to which the node belongs.
+   * The ID of the workspace to which the node belongs.
    * 
    * This parameter is required.
    * 
@@ -75,7 +75,7 @@ export class CreateQualityRelativeNodeRequest extends $dara.Model {
   targetNodeProjectId?: number;
   /**
    * @remarks
-   * The name of the project to which the scheduling node belongs.
+   * The project of the associated scheduling node.
    * 
    * This parameter is required.
    * 

package/src/models/CreateQualityRelativeNodeResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityRelativeNodeResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the association was created successfully.
+   * Indicates whether the association was successful.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class CreateQualityRelativeNodeResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The error code returned if the request fails.
+   * The error code.
    * 
    * @example
    * 401
@@ -21,7 +21,7 @@ export class CreateQualityRelativeNodeResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the request fails.
+   * The error message.
    * 
    * @example
    * You have no permission.
@@ -45,7 +45,7 @@ export class CreateQualityRelativeNodeResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true

package/src/models/CreateQualityRuleRequest.ts

@@ -8,7 +8,6 @@ export class CreateQualityRuleRequest extends $dara.Model {
    * The strength of the rule. Valid values:
    * 
    * - 0: weak rule
-   * 
    * - 1: strong rule
    * 
    * This parameter is required.
@@ -22,24 +21,15 @@ export class CreateQualityRuleRequest extends $dara.Model {
    * The ID of the checker. Valid values:
    * 
    * - 2: 7-day average fluctuation
-   * 
    * - 3: 30-day average fluctuation
-   * 
-   * - 4: day-over-day comparison
-   * 
-   * - 5: week-over-week comparison
-   * 
-   * - 6: month-over-month comparison
-   * 
+   * - 4: 1-day cycle comparison
+   * - 5: 7-day cycle comparison
+   * - 6: 30-day cycle comparison
    * - 7: 7-day variance fluctuation
-   * 
    * - 8: 30-day variance fluctuation
-   * 
    * - 9: comparison with a fixed value
-   * 
-   * - 10: fluctuation detection over 1, 7, and 30 days
-   * 
-   * - 11: comparison with the previous cycle
+   * - 10: 1-day, 7-day, and 30-day fluctuation detection
+   * - 11: previous cycle comparison
    * 
    * @example
    * 9
@@ -47,7 +37,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   checker?: number;
   /**
    * @remarks
-   * The comments of the rule.
+   * The description of the rule.
    * 
    * @example
    * Verification
@@ -55,7 +45,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   comment?: string;
   /**
    * @remarks
-   * The critical threshold. It indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, the scheduling task is blocked.
+   * The threshold for a critical alert, which indicates the degree of deviation from the expected sample value. You can customize this threshold based on your business requirements. If a strong rule is used and the critical threshold is triggered, the scheduling task is blocked.
    * 
    * @example
    * 20
@@ -63,7 +53,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   criticalThreshold?: string;
   /**
    * @remarks
-   * The ID of the partition filter expression.
+   * The ID of the partition expression.
    * 
    * This parameter is required.
    * 
@@ -81,7 +71,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   expectValue?: string;
   /**
    * @remarks
-   * The check method. If you use a custom SQL statement, set this parameter to `user_defined`.
+   * The sampling method. If custom SQL is used, the value of this parameter is user_defined.
    * 
    * @example
    * count/table_count
@@ -89,9 +79,9 @@ export class CreateQualityRuleRequest extends $dara.Model {
   methodName?: string;
   /**
    * @remarks
-   * The comparison operator. Examples: `>`, `>=`, `=`, `<>`, `<`, and `<=`.
+   * The comparison operator. Valid values include >, >=, =, ≠, <, and <=.
    * 
-   * > If you set the Checker parameter to 9, you must specify the Operator parameter.
+   * > When Checker is set to 9, Operator is required.
    * 
    * @example
    * >
@@ -99,7 +89,9 @@ export class CreateQualityRuleRequest extends $dara.Model {
   operator?: string;
   /**
    * @remarks
-   * Specifies whether to use a dynamic threshold. Valid values:
+   * Specifies whether the threshold is dynamic. Valid values:
+   * - 0: non-dynamic threshold
+   * - 2: dynamic threshold
    * 
    * This parameter is required.
    * 
@@ -109,7 +101,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   predictType?: number;
   /**
    * @remarks
-   * The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.
+   * The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the workspace configuration page to obtain the workspace ID.
    * 
    * @example
    * 10000
@@ -117,7 +109,7 @@ export class CreateQualityRuleRequest 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.
    * 
@@ -127,7 +119,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The field that is monitored by the rule. To perform a table-level check, set this parameter to `table_count` for the number of rows or `table_size` for the table size.
+   * The column to which the rule applies. For table-level checks, the columns are table_count for the number of rows and table_size for the table size.
    * 
    * @example
    * table_id
@@ -135,7 +127,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   property?: string;
   /**
    * @remarks
-   * The data type of the field. For a table-level check, set this parameter to `table`. For a field-level check, set this parameter to a specific data type, such as `bigint`.
+   * The type of the column. Enter table for table-level checks, or a data type such as bigint for column-level checks.
    * 
    * @example
    * bigint
@@ -154,12 +146,9 @@ export class CreateQualityRuleRequest extends $dara.Model {
   /**
    * @remarks
    * The type of the rule. Valid values:
-   * 
-   * - 0: system template
-   * 
-   * - 1: custom SQL
-   * 
-   * - 2: custom template
+   * - 0: system template rule
+   * - 1: custom SQL rule
+   * - 4: custom template rule
    * 
    * This parameter is required.
    * 
@@ -169,7 +158,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   ruleType?: number;
   /**
    * @remarks
-   * The variable settings that are inserted before the custom rule. Format: x=a,y=b.
+   * The variable settings inserted before the custom rule. Format: x=a,y=b.
    * 
    * @example
    * x=a,y=b
@@ -186,12 +175,9 @@ export class CreateQualityRuleRequest extends $dara.Model {
   /**
    * @remarks
    * The trend of the check result. Valid values:
-   * 
-   * - `up`: upward trend
-   * 
-   * - `down`: downward trend
-   * 
-   * - `abs`: absolute value
+   * - up: upward trend
+   * - down: downward trend
+   * - abs: absolute value
    * 
    * @example
    * abs
@@ -199,7 +185,7 @@ export class CreateQualityRuleRequest extends $dara.Model {
   trend?: string;
   /**
    * @remarks
-   * The warning threshold. It indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.
+   * The threshold for a warning alert, which indicates the degree of deviation from the expected sample value. You can customize this threshold based on your business requirements.
    * 
    * @example
    * 10

package/src/models/CreateQualityRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateQualityRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the new rule.
+   * The ID of the created rule.
    * 
    * @example
    * 12345
@@ -45,7 +45,7 @@ export class CreateQualityRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the request succeeded.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true