@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/CheckMetaPartitionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckMetaPartitionRequest extends $dara.Model {
   /**
    * @remarks
-   * This parameter is deprecated.
+   * **[Deprecated]** This parameter is deprecated.
    * 
    * @example
    * abc
@@ -13,7 +13,7 @@ export class CheckMetaPartitionRequest extends $dara.Model {
   clusterId?: string;
   /**
    * @remarks
-   * The type of the data source. Set the value to odps.
+   * The data source type. Currently, only odps is supported.
    * 
    * @example
    * odps
@@ -21,7 +21,7 @@ export class CheckMetaPartitionRequest extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The name of the metadatabase.
+   * The name of the database.
    * 
    * @example
    * abc
@@ -29,7 +29,7 @@ export class CheckMetaPartitionRequest extends $dara.Model {
   databaseName?: string;
   /**
    * @remarks
-   * The name of the partition in the MaxCompute metatable.
+   * The name of the partition in the MaxCompute table.
    * 
    * This parameter is required.
    * 
@@ -39,7 +39,7 @@ export class CheckMetaPartitionRequest extends $dara.Model {
   partition?: string;
   /**
    * @remarks
-   * The GUID of the MaxCompute metatable.
+   * The unique identifier of the MaxCompute table.
    * 
    * @example
    * odps.engine_name.table_name
@@ -47,7 +47,7 @@ export class CheckMetaPartitionRequest extends $dara.Model {
   tableGuid?: string;
   /**
    * @remarks
-   * The name of the metatable.
+   * The name of the table.
    * 
    * @example
    * abc

package/src/models/CheckMetaPartitionResponseBody.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class CheckMetaPartitionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the partition in the MaxCompute metatable exists. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the partition in the MaxCompute table exists. Valid values:
+   * - true: The partition exists.
+   * - false: The partition does not exist.
    * 
    * @example
    * true
@@ -48,7 +47,7 @@ export class CheckMetaPartitionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/CheckMetaTableRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckMetaTableRequest extends $dara.Model {
   /**
    * @remarks
-   * The E-MapReduce (EMR) cluster ID.
+   * The ID of the EMR cluster.
    * 
    * @example
    * abc
@@ -21,7 +21,7 @@ export class CheckMetaTableRequest extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * The name of the metadatabase of the EMR cluster.
+   * The name of the EMR database.
    * 
    * @example
    * abc
@@ -29,7 +29,7 @@ export class CheckMetaTableRequest extends $dara.Model {
   databaseName?: string;
   /**
    * @remarks
-   * The GUID of the metatable.
+   * The unique identifier of the table.
    * 
    * @example
    * odps.engine_name.table_name
@@ -37,7 +37,7 @@ export class CheckMetaTableRequest extends $dara.Model {
   tableGuid?: string;
   /**
    * @remarks
-   * The name of the EMR metatable.
+   * The name of the EMR table.
    * 
    * @example
    * abc

package/src/models/CheckMetaTableResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CheckMetaTableResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the metatable exists.
+   * Indicates whether the table exists.
    * 
    * @example
    * true
@@ -13,7 +13,7 @@ export class CheckMetaTableResponseBody extends $dara.Model {
   data?: boolean;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 0bc1ec92159376

package/src/models/Cluster.ts

@@ -15,7 +15,7 @@ export class Cluster extends $dara.Model {
   clusterBizId?: string;
   /**
    * @remarks
-   * The ID of the cluster associated with DataWorks.
+   * The cluster ID generated by DataWorks.
    * 
    * This parameter is required.
    * 

package/src/models/ClusterConfig.ts

@@ -13,10 +13,13 @@ export class ClusterConfig extends $dara.Model {
   configValue?: string;
   /**
    * @remarks
-   * Specifies whether to overwrite the advanced settings of nodes in DataStudio. Valid values:
+   * Specifies whether to overwrite the advanced settings of nodes in Data Studio. Valid values:
    * 
-   * *   true
-   * *   false
+   * 
+   * 
+   * 
+   * - true: overwrite.
+   * - false: do not overwrite.
    * 
    * @example
    * false
@@ -26,12 +29,15 @@ export class ClusterConfig extends $dara.Model {
    * @remarks
    * The module in which the cluster is configured. Valid values:
    * 
-   * *   ide: DataStudio.
-   * *   da: DataAnalysis.
-   * *   scheduler.auto: Operation Center - auto triggered instances.
-   * *   scheduler.backfill: Operation Center - data backfill instances.
-   * *   scheduler.test: Operation Center - test instances.
-   * *   scheduler.manual: Operation Center - manually triggered instances.
+   * 
+   * 
+   * 
+   * - ide: Data Studio.
+   * - da: DataAnalysis.
+   * - scheduler.auto: Operation Center - auto triggered instances.
+   * - scheduler.backfill: Operation Center - data backfill instances.
+   * - scheduler.test: Operation Center - test instances.
+   * - scheduler.manual: Operation Center - manually triggered instances.
    * 
    * @example
    * ide

package/src/models/Collection.ts

@@ -32,7 +32,7 @@ export class Collection extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The level of the collection. This parameter takes effect only if the CollectionType parameter is set to ALBUM_CATEGORY. Maximum value: 4.
+   * The level of the collection. This parameter is returned only for collections of the ALBUM_CATEGORY type. Maximum value: 4.
    * 
    * @example
    * 1

package/src/models/CreateBaselineRequest.ts

@@ -7,7 +7,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateBaselineRequestOvertimeSettings extends $dara.Model {
   /**
    * @remarks
-   * The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.
+   * The cycle corresponding to the committed time. Set this parameter to 1 for a daily baseline. For an hourly baseline, you can configure up to 24 cycles.
    * 
    * @example
    * 1
@@ -15,7 +15,7 @@ export class CreateBaselineRequestOvertimeSettings extends $dara.Model {
   cycle?: number;
   /**
    * @remarks
-   * The committed completion time in the hh:mm format. Valid values of hh: [0,47]. Valid values of mm: [0,59].
+   * The committed time in the hh:mm format. The valid values for hh are [0,47], and the valid values for mm are [0,59].
    * 
    * @example
    * 00:00
@@ -47,7 +47,7 @@ export class CreateBaselineRequestOvertimeSettings extends $dara.Model {
 export class CreateBaselineRequest extends $dara.Model {
   /**
    * @remarks
-   * The alert margin threshold of the baseline. Unit: minutes.
+   * The alert margin for the baseline, in minutes.
    * 
    * @example
    * 30
@@ -65,7 +65,7 @@ export class CreateBaselineRequest extends $dara.Model {
   baselineName?: string;
   /**
    * @remarks
-   * The type of the baseline. Valid values: DAILY and HOURLY.
+   * The type of the baseline. Valid values: DAILY (daily baseline) and HOURLY (hourly baseline).
    * 
    * This parameter is required.
    * 
@@ -75,7 +75,7 @@ export class CreateBaselineRequest extends $dara.Model {
   baselineType?: string;
   /**
    * @remarks
-   * The ancestor nodes of nodes in the baseline.
+   * The upstream nodes of the baseline.
    * 
    * @example
    * 210001233239,210001236482
@@ -83,14 +83,14 @@ export class CreateBaselineRequest extends $dara.Model {
   nodeIds?: string;
   /**
    * @remarks
-   * The settings of the committed completion time of the baseline.
+   * The committed time configuration of the baseline.
    * 
    * This parameter is required.
    */
   overtimeSettings?: CreateBaselineRequestOvertimeSettings[];
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account used by the baseline owner.
+   * The Alibaba Cloud UID of the baseline owner.
    * 
    * This parameter is required.
    * 
@@ -100,7 +100,7 @@ export class CreateBaselineRequest extends $dara.Model {
   owner?: string;
   /**
    * @remarks
-   * The priority of the baseline. Valid values: {1,3,5,7,8}.
+   * The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.
    * 
    * This parameter is required.
    * 
@@ -110,7 +110,7 @@ export class CreateBaselineRequest extends $dara.Model {
   priority?: 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 page to query the 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 Management page to view the ID.
    * 
    * This parameter is required.
    * 

package/src/models/CreateBaselineResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateBaselineResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The baseline ID.
+   * The ID of the baseline.
    * 
    * @example
    * 100003
@@ -37,7 +37,7 @@ export class CreateBaselineResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request. The ID is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.
    * 
    * @example
    * F05080B0-CCE6-5D22-B284-34A51C5D4E28
@@ -45,10 +45,9 @@ export class CreateBaselineResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
    * 
    * @example
    * true

package/src/models/CreateBusinessRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateBusinessRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the business process. The name of the business process in the same project must be unique.
+   * The name of the workflow. The name must be unique within the same workspace.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateBusinessRequest extends $dara.Model {
   businessName?: string;
   /**
    * @remarks
-   * The description of the business process.
+   * The description of the workflow.
    * 
    * @example
    * This is a business process created through an interface.
@@ -23,7 +23,7 @@ export class CreateBusinessRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The Alibaba Cloud account ID of the owner of the business process. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and hover over the user avatar on the right side of the top menu bar to view the account ID. If this parameter is empty, the caller\\"s Alibaba Cloud account ID is used by default.
+   * The Alibaba Cloud account ID of the owner of the workflow. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and move the pointer over the profile picture in the upper-right corner of the top menu bar to view the account ID. If this parameter is left empty, the Alibaba Cloud account ID of the caller is used by default.
    * 
    * @example
    * 1000000000001
@@ -31,7 +31,7 @@ export class CreateBusinessRequest extends $dara.Model {
   owner?: string;
   /**
    * @remarks
-   * 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 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 management page to view the ID.
    * 
    * @example
    * 10000
@@ -39,7 +39,7 @@ export class CreateBusinessRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The name of the DataWorks workspace. 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 name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.
+   * The unique identifier of the DataWorks workspace, which is the workspace name. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Configuration page to view the name. You must specify either this parameter or the ProjectId parameter to determine the DataWorks project for this API call.
    * 
    * @example
    * dw_project
@@ -47,10 +47,9 @@ export class CreateBusinessRequest extends $dara.Model {
   projectIdentifier?: string;
   /**
    * @remarks
-   * The module to which the workflow belongs. Valid values:
-   * 
-   * *   NORMAL: The workflow belongs to auto triggered workflows.
-   * *   MANUAL_BIZ: The workflow belongs to manually triggered workflows.
+   * The functional module to which the workflow belongs. Valid values:
+   * - NORMAL: Data Studio.
+   * - MANUAL_BIZ: Manual workflow.
    * 
    * @example
    * NORMAL

package/src/models/CreateBusinessResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateBusinessResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The workflow ID.
+   * The ID of the workflow.
    * 
    * @example
    * 100001
@@ -37,7 +37,7 @@ export class CreateBusinessResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID.
+   * The unique ID of the request. You can use the ID to troubleshoot issues if an error occurs.
    * 
    * @example
    * 0000-ABCD-EFG****
@@ -45,7 +45,7 @@ export class CreateBusinessResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true