@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/DsgDesensPlanDeleteResponseBody.ts

@@ -6,9 +6,8 @@ export class DsgDesensPlanDeleteResponseBody extends $dara.Model {
   /**
    * @remarks
    * The operation result. Valid values:
-   * 
-   * *   true: The operation is successful.
-   * *   false: The operation fails.
+   * - true: The operation succeeded.
+   * - false: The operation failed.
    * 
    * @example
    * true
@@ -40,7 +39,7 @@ export class DsgDesensPlanDeleteResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID. You can locate logs and troubleshoot issues based on the ID.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -48,10 +47,9 @@ export class DsgDesensPlanDeleteResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the call is successful. Valid values:
+   * - true: The call succeeded.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DsgDesensPlanDeleteShrinkRequest.ts

@@ -5,21 +5,20 @@ import * as $dara from '@darabonba/typescript';
 export class DsgDesensPlanDeleteShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * A collection of data masking rules.
+   * The IDs of the masking rules.
    * 
    * This parameter is required.
    */
   idsShrink?: string;
   /**
    * @remarks
-   * The code of the level-1 data masking scenario to which the rule belongs. Valid values:
-   * 
-   * *   dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map
-   * *   maxcompute_desense_code: data masking at the MaxCompute compute engine layer
-   * *   maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)
-   * *   hologres_display_desense_code: data masking at the Hologres compute engine layer
-   * *   dataworks_data_integration_desense_code: static data masking in Data Integration
-   * *   dataworks_analysis_desense_code: masking of displayed data in DataAnalysis
+   * The code of the level-1 masking scenario to which the masking rule belongs. Valid values:
+   * - dataworks_display_desense_code: Data Studio and Data Map display masking
+   * - maxcompute_desense_code: MaxCompute engine-level masking
+   * - maxcompute_new_desense_code: MaxCompute engine-level masking (new)
+   * - hologres_display_desense_code: Hologres engine-level masking
+   * - dataworks_data_integration_desense_code: Data Integration static data masking
+   * - dataworks_analysis_desense_code: Data Analysis display masking
    * 
    * This parameter is required.
    * 

package/src/models/DsgDesensPlanQueryListRequest.ts

@@ -3,9 +3,37 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DsgDesensPlanQueryListRequestColumns extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the column.
+   * 
+   * @example
+   * test_col_dev
+   */
   column?: string;
+  /**
+   * @remarks
+   * The type of the data source.
+   * 
+   * @example
+   * ODPS.ODPS
+   */
   dbType?: string;
+  /**
+   * @remarks
+   * The name of the workspace.
+   * 
+   * @example
+   * test_dev
+   */
   project?: string;
+  /**
+   * @remarks
+   * The name of the table.
+   * 
+   * @example
+   * test_table_dev
+   */
   table?: string;
   static names(): { [key: string]: string } {
     return {
@@ -37,7 +65,7 @@ export class DsgDesensPlanQueryListRequestColumns extends $dara.Model {
 export class DsgDesensPlanQueryListRequest extends $dara.Model {
   /**
    * @remarks
-   * The owner of the desensitization rule.
+   * The owner of the data masking rule.
    * 
    * @example
    * user1
@@ -55,7 +83,7 @@ export class DsgDesensPlanQueryListRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The maximum value is 100.
+   * The number of entries per page. Maximum value: 100.
    * 
    * This parameter is required.
    * 
@@ -65,7 +93,7 @@ export class DsgDesensPlanQueryListRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The name of the desensitization rule.
+   * The name of the sensitive field.
    * 
    * @example
    * phone
@@ -73,7 +101,7 @@ export class DsgDesensPlanQueryListRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The ID of the Level-2 data desensitization scene. You can call the [DsgSceneQuerySceneListByName](https://help.aliyun.com/document_detail/2786322.html) operation to obtain this ID.
+   * The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](https://help.aliyun.com/document_detail/2786322.html) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -83,18 +111,34 @@ export class DsgDesensPlanQueryListRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * The status of the desensitization rule. Valid values:
-   * 
-   * - 0: Inactive
-   * 
-   * - 1: Active
+   * The effective status of the data masking rule. Valid values:
+   * - 0: Inactive.
+   * - 1: Active.
    * 
    * @example
    * 1
    */
   status?: number;
+  /**
+   * @remarks
+   * The list of columns associated with data masking.
+   */
   columns?: DsgDesensPlanQueryListRequestColumns[];
+  /**
+   * @remarks
+   * The sensitive data type.
+   * 
+   * @example
+   * phone
+   */
   dataType?: string;
+  /**
+   * @remarks
+   * Specifies whether null values are not masked. Default value: false.
+   * 
+   * @example
+   * true
+   */
   emptyNotDesesn?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DsgDesensPlanQueryListResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgDesensPlanQueryListResponseBodyPageDataDataDesensPlan extends $dara.Model {
   /**
    * @remarks
-   * The type of the desensitization plan.
+   * The type of the data masking rule.
    * 
    * @example
    * hash
@@ -13,7 +13,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataDataDesensPlan extends $d
   desensPlanType?: string;
   /**
    * @remarks
-   * The parameters for the desensitization rule. For details, see the [DsgDesensPlanAddOrUpdate](https://help.aliyun.com/document_detail/2786295.html) operation.
+   * The parameters of the data masking rule. For more information about the parameters, see the [DsgDesensPlanAddOrUpdate](https://help.aliyun.com/document_detail/2786295.html) operation.
    */
   extParam?: { [key: string]: any };
   static names(): { [key: string]: string } {
@@ -43,9 +43,37 @@ export class DsgDesensPlanQueryListResponseBodyPageDataDataDesensPlan extends $d
 }
 
 export class DsgDesensPlanQueryListResponseBodyPageDataDataColumns extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the column.
+   * 
+   * @example
+   * test_col_dev
+   */
   column?: string;
+  /**
+   * @remarks
+   * The type of the data source.
+   * 
+   * @example
+   * ODPS.ODPS
+   */
   dbType?: string;
+  /**
+   * @remarks
+   * The name of the workspace.
+   * 
+   * @example
+   * test_dev
+   */
   project?: string;
+  /**
+   * @remarks
+   * The name of the table.
+   * 
+   * @example
+   * test_table_dev
+   */
   table?: string;
   static names(): { [key: string]: string } {
     return {
@@ -77,11 +105,9 @@ export class DsgDesensPlanQueryListResponseBodyPageDataDataColumns extends $dara
 export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether to add a watermark. Valid values:
-   * 
-   * - true: A watermark is added.
-   * 
-   * - false: No watermark is added.
+   * Specifies whether to add a watermark. Valid values:
+   * - true: Added.
+   * - false: Not added.
    * 
    * @example
    * true
@@ -89,7 +115,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   checkWatermark?: boolean;
   /**
    * @remarks
-   * The sensitive data type.
+   * The type of the sensitive field.
    * 
    * @example
    * phone
@@ -97,7 +123,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   dataType?: string;
   /**
    * @remarks
-   * The desensitization method.
+   * The type of the data masking method.
    * 
    * @example
    * HASH
@@ -105,12 +131,12 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   desenMode?: string;
   /**
    * @remarks
-   * The details of the desensitization plan.
+   * The details of the data masking rule.
    */
   desensPlan?: DsgDesensPlanQueryListResponseBodyPageDataDataDesensPlan;
   /**
    * @remarks
-   * The desensitization rule.
+   * The data masking rule.
    * 
    * @example
    * HASH
@@ -118,7 +144,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   desensRule?: string;
   /**
    * @remarks
-   * The desensitization method.
+   * The data masking method.
    * 
    * @example
    * HASH
@@ -126,7 +152,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   desensWay?: string;
   /**
    * @remarks
-   * The time when the rule was created.
+   * The time when the data masking rule was created.
    * 
    * @example
    * 2024-05-09 15:46:20
@@ -134,7 +160,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   gmtCreate?: string;
   /**
    * @remarks
-   * The time when the rule was last modified.
+   * The time when the data masking rule was updated.
    * 
    * @example
    * 2024-05-09 15:46:20
@@ -142,7 +168,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   gmtModified?: string;
   /**
    * @remarks
-   * The ID of the desensitization rule.
+   * The ID of the data masking rule.
    * 
    * @example
    * 123
@@ -150,7 +176,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   id?: number;
   /**
    * @remarks
-   * The owner of the desensitization rule.
+   * The owner of the data masking rule.
    * 
    * @example
    * user1
@@ -158,7 +184,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   owner?: string;
   /**
    * @remarks
-   * The name of the desensitization rule.
+   * The name of the data masking rule.
    * 
    * @example
    * phone_hash
@@ -166,19 +192,13 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   ruleName?: string;
   /**
    * @remarks
-   * The level-1 desensitization scene code. Valid values:
-   * 
-   * - Desensitization for display in Data Development and Data Map: dataworks_display_desense_code
-   * 
-   * - Desensitization at the MaxCompute engine layer: maxcompute_desense_code
-   * 
-   * - Desensitization at the MaxCompute engine layer (New): maxcompute_new_desense_code
-   * 
-   * - Desensitization at the Hologres engine layer: hologres_display_desense_code
-   * 
-   * - Static desensitization in Data Integration: dataworks_data_integration_desense_code
-   * 
-   * - Desensitization for display in Data Analysis: dataworks_analysis_desense_code
+   * The code of the level-1 data masking scenario to which the data masking rule belongs. Valid values:
+   * - dataworks_display_desense_code: Data masking for Data Studio and Data Map display.
+   * - maxcompute_desense_code: Data masking at the MaxCompute engine layer.
+   * - maxcompute_new_desense_code: Data masking at the MaxCompute engine layer (new).
+   * - hologres_display_desense_code: Data masking at the Hologres engine layer.
+   * - dataworks_data_integration_desense_code: Static data masking for Data Integration.
+   * - dataworks_analysis_desense_code: Data masking for Data Analysis display.
    * 
    * @example
    * dataworks_display_desense_code
@@ -186,7 +206,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   sceneCode?: string;
   /**
    * @remarks
-   * The name of the level-2 desensitization scene.
+   * The name of the level-2 data masking scenario to which the data masking rule belongs.
    * 
    * @example
    * test_scene
@@ -194,17 +214,23 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
   sceneName?: string;
   /**
    * @remarks
-   * The status of the rule. Valid values:
-   * 
+   * The effective status of the data masking rule. Valid values:
    * - 0: Inactive.
-   * 
    * - 1: Active.
    * 
    * @example
    * 1
    */
   status?: number;
+  /**
+   * @remarks
+   * The list of columns associated with data masking.
+   */
   columns?: DsgDesensPlanQueryListResponseBodyPageDataDataColumns[];
+  /**
+   * @remarks
+   * Specifies whether null values are not masked. Default value: false.
+   */
   emptyNotDesesn?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -266,7 +292,7 @@ export class DsgDesensPlanQueryListResponseBodyPageDataData extends $dara.Model
 export class DsgDesensPlanQueryListResponseBodyPageData extends $dara.Model {
   /**
    * @remarks
-   * The details of the desensitization rules.
+   * The data masking rule information.
    */
   data?: DsgDesensPlanQueryListResponseBodyPageDataData[];
   /**
@@ -287,7 +313,7 @@ export class DsgDesensPlanQueryListResponseBodyPageData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of matching desensitization rules.
+   * The total number of returned data masking rules.
    * 
    * @example
    * 100
@@ -350,12 +376,12 @@ export class DsgDesensPlanQueryListResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The paginated data.
+   * The pagination data.
    */
   pageData?: DsgDesensPlanQueryListResponseBodyPageData;
   /**
    * @remarks
-   * The request ID. You can use this ID to locate logs and troubleshoot issues.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -363,11 +389,9 @@ export class DsgDesensPlanQueryListResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - true: The request was successful.
-   * 
-   * - false: The request failed.
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DsgDesensPlanQueryListShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DsgDesensPlanQueryListShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The owner of the desensitization rule.
+   * The owner of the data masking rule.
    * 
    * @example
    * user1
@@ -23,7 +23,7 @@ export class DsgDesensPlanQueryListShrinkRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. The maximum value is 100.
+   * The number of entries per page. Maximum value: 100.
    * 
    * This parameter is required.
    * 
@@ -33,7 +33,7 @@ export class DsgDesensPlanQueryListShrinkRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The name of the desensitization rule.
+   * The name of the sensitive field.
    * 
    * @example
    * phone
@@ -41,7 +41,7 @@ export class DsgDesensPlanQueryListShrinkRequest extends $dara.Model {
   ruleName?: string;
   /**
    * @remarks
-   * The ID of the Level-2 data desensitization scene. You can call the [DsgSceneQuerySceneListByName](https://help.aliyun.com/document_detail/2786322.html) operation to obtain this ID.
+   * The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](https://help.aliyun.com/document_detail/2786322.html) operation to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -51,18 +51,34 @@ export class DsgDesensPlanQueryListShrinkRequest extends $dara.Model {
   sceneId?: number;
   /**
    * @remarks
-   * The status of the desensitization rule. Valid values:
-   * 
-   * - 0: Inactive
-   * 
-   * - 1: Active
+   * The effective status of the data masking rule. Valid values:
+   * - 0: Inactive.
+   * - 1: Active.
    * 
    * @example
    * 1
    */
   status?: number;
+  /**
+   * @remarks
+   * The list of columns associated with data masking.
+   */
   columnsShrink?: string;
+  /**
+   * @remarks
+   * The sensitive data type.
+   * 
+   * @example
+   * phone
+   */
   dataType?: string;
+  /**
+   * @remarks
+   * Specifies whether null values are not masked. Default value: false.
+   * 
+   * @example
+   * true
+   */
   emptyNotDesesn?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DsgDesensPlanUpdateStatusRequest.ts

@@ -5,21 +5,20 @@ import * as $dara from '@darabonba/typescript';
 export class DsgDesensPlanUpdateStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * A collection of IDs of the data masking rules of which the status you want to modify.
+   * The IDs of the masking rules whose status you want to modify.
    * 
    * This parameter is required.
    */
   ids?: number[];
   /**
    * @remarks
-   * The code of the level-1 data masking scenario to which the rule belongs. Valid values:
-   * 
-   * *   dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map
-   * *   maxcompute_desense_code: data masking at the MaxCompute compute engine layer
-   * *   maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)
-   * *   hologres_display_desense_code: data masking at the Hologres compute engine layer
-   * *   dataworks_data_integration_desense_code: static data masking in Data Integration
-   * *   dataworks_analysis_desense_code: masking of displayed data in DataAnalysis
+   * The code of the level-1 masking scenario to which the masking rule belongs. Valid values:
+   * - dataworks_display_desense_code: Data Studio and Data Map display masking.
+   * - maxcompute_desense_code: MaxCompute engine layer masking.
+   * - maxcompute_new_desense_code: MaxCompute engine layer masking (new).
+   * - hologres_display_desense_code: Hologres engine layer masking.
+   * - dataworks_data_integration_desense_code: Data Integration static data masking.
+   * - dataworks_analysis_desense_code: Data Analysis display masking.
    * 
    * This parameter is required.
    * 
@@ -29,10 +28,9 @@ export class DsgDesensPlanUpdateStatusRequest extends $dara.Model {
   sceneCode?: string;
   /**
    * @remarks
-   * The status of the data masking rule. Valid values:
-   * 
-   * *   0: expired
-   * *   1: effective
+   * The effective status of the masking rule. Valid values:
+   * - 0: Inactive.
+   * - 1: Active.
    * 
    * This parameter is required.
    * 

package/src/models/DsgDesensPlanUpdateStatusResponseBody.ts

@@ -6,9 +6,8 @@ export class DsgDesensPlanUpdateStatusResponseBody extends $dara.Model {
   /**
    * @remarks
    * The operation result. Valid values:
-   * 
-   * *   true: The operation is successful.
-   * *   false: The operation fails.
+   * - true: The operation succeeded.
+   * - false: The operation failed.
    * 
    * @example
    * true
@@ -40,7 +39,7 @@ export class DsgDesensPlanUpdateStatusResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID. You can locate logs and troubleshoot issues based on the ID.
+   * The ID of the request. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 102400001
@@ -48,10 +47,9 @@ export class DsgDesensPlanUpdateStatusResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the call is successful. Valid values:
+   * - true: The call succeeded.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/DsgDesensPlanUpdateStatusShrinkRequest.ts

@@ -5,21 +5,20 @@ import * as $dara from '@darabonba/typescript';
 export class DsgDesensPlanUpdateStatusShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * A collection of IDs of the data masking rules of which the status you want to modify.
+   * The IDs of the masking rules whose status you want to modify.
    * 
    * This parameter is required.
    */
   idsShrink?: string;
   /**
    * @remarks
-   * The code of the level-1 data masking scenario to which the rule belongs. Valid values:
-   * 
-   * *   dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map
-   * *   maxcompute_desense_code: data masking at the MaxCompute compute engine layer
-   * *   maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)
-   * *   hologres_display_desense_code: data masking at the Hologres compute engine layer
-   * *   dataworks_data_integration_desense_code: static data masking in Data Integration
-   * *   dataworks_analysis_desense_code: masking of displayed data in DataAnalysis
+   * The code of the level-1 masking scenario to which the masking rule belongs. Valid values:
+   * - dataworks_display_desense_code: Data Studio and Data Map display masking.
+   * - maxcompute_desense_code: MaxCompute engine layer masking.
+   * - maxcompute_new_desense_code: MaxCompute engine layer masking (new).
+   * - hologres_display_desense_code: Hologres engine layer masking.
+   * - dataworks_data_integration_desense_code: Data Integration static data masking.
+   * - dataworks_analysis_desense_code: Data Analysis display masking.
    * 
    * This parameter is required.
    * 
@@ -29,10 +28,9 @@ export class DsgDesensPlanUpdateStatusShrinkRequest extends $dara.Model {
   sceneCode?: string;
   /**
    * @remarks
-   * The status of the data masking rule. Valid values:
-   * 
-   * *   0: expired
-   * *   1: effective
+   * The effective status of the masking rule. Valid values:
+   * - 0: Inactive.
+   * - 1: Active.
    * 
    * This parameter is required.
    *