@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/ExportDataSourcesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   /**
    * @remarks
-   * The ID of the compute engine that is added as the data source.
+   * The ID of the engine to which the data source is bound.
    * 
    * @example
    * 123
@@ -13,10 +13,9 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   bindingCalcEngineId?: number;
   /**
    * @remarks
-   * Indicates whether the data source is connected to an exclusive resource group. Valid values:
-   * 
-   * *   1: The data source is connected to at least one exclusive resource group.
-   * *   0: The data source is not connected to any exclusive resource group.
+   * The connectivity status between the data source and exclusive resource groups. Valid values:
+   * - 1: The data source is connected to at least one exclusive resource group.
+   * - 0: The data source is not connected to any exclusive resource group.
    * 
    * @example
    * 1
@@ -24,7 +23,7 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   connectStatus?: number;
   /**
    * @remarks
-   * The configuration of the data source.
+   * The detailed configurations of the data source.
    * 
    * @example
    * {"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}
@@ -32,21 +31,20 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The type of the data source. Valid values:
-   * 
-   * *   odps
-   * *   mysql
-   * *   rds
-   * *   oss
-   * *   sqlserver
-   * *   polardb
-   * *   oracle
-   * *   mongodb
-   * *   emr
-   * *   postgresql
-   * *   analyticdb_for_mysql
-   * *   hybriddb_for_postgresql
-   * *   holo
+   * The type of the data source. Common types include:
+   * - odps
+   * - mysql
+   * - rds
+   * - oss
+   * - sqlserver
+   * - polardb
+   * - oracle
+   * - mongodb
+   * - emr
+   * - postgresql
+   * - analyticdb_for_mysql
+   * - hybriddb_for_postgresql
+   * - holo
    * 
    * @example
    * rds
@@ -54,10 +52,9 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   dataSourceType?: string;
   /**
    * @remarks
-   * Indicates whether the compute engine that is added as the data source is the default compute engine. Valid values:
-   * 
-   * *   true: The compute engine is the default compute engine.
-   * *   false: The compute engine is not the default compute engine.
+   * Indicates whether the engine where the data source resides is the default engine. Valid values:
+   * - true: The engine is the default engine.
+   * - false: The engine is not the default engine.
    * 
    * @example
    * false
@@ -73,10 +70,9 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The environment in which the data source resides. Valid values:
-   * 
-   * *   0: development environment
-   * *   1: production environment
+   * The environment to which the data source belongs. Valid values:
+   * - 0: development environment
+   * - 1: production environment
    * 
    * @example
    * 1
@@ -100,7 +96,7 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   gmtModified?: string;
   /**
    * @remarks
-   * The data source ID.
+   * The ID of the data source.
    * 
    * @example
    * 1
@@ -116,7 +112,7 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The ID of the user who exported the data source.
+   * The ID of the user who manages the data source.
    * 
    * @example
    * 193543050****
@@ -132,7 +128,7 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The sequence number of the data source.
+   * The sequence of the data source.
    * 
    * @example
    * 300
@@ -141,9 +137,8 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the data source can be shared. Valid values:
-   * 
-   * *   true: The data source can be shared.
-   * *   false: The data source cannot be shared.
+   * - true: The data source can be shared.
+   * - false: The data source cannot be shared.
    * 
    * @example
    * false
@@ -152,9 +147,8 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the data source is available. Valid values:
-   * 
-   * *   1: The data source is available.
-   * *   0: The data source is unavailable.
+   * - 1: The data source is available.
+   * - 0: The data source is unavailable.
    * 
    * @example
    * 1
@@ -162,9 +156,9 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   status?: number;
   /**
    * @remarks
-   * The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.
+   * The subtype of the data source. This parameter takes effect only when the parameter settings for DataSourceType are set to RDS.
    * 
-   * If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.
+   * When the parameter settings for DataSourceType are set to RDS, this parameter can be set to mysql, sqlserver, or postgresql.
    * 
    * @example
    * mysql
@@ -172,7 +166,7 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
   subType?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account to which the data source belongs.
+   * The ID of the tenant to which the data source belongs.
    * 
    * @example
    * 1234567
@@ -236,12 +230,12 @@ export class ExportDataSourcesResponseBodyDataDataSources extends $dara.Model {
 export class ExportDataSourcesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The details of the exported data sources. The value is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a sample data source.
+   * The details of the data sources in the batch export. When you invoke this operation, the return result is an array of data source details. The following information is an example of the details of a single data source in the array.
    */
   dataSources?: ExportDataSourcesResponseBodyDataDataSources[];
   /**
    * @remarks
-   * The page number. Pages start from page 1.
+   * The page number for the paged query. The value must be a positive integer greater than or equal to 1.
    * 
    * @example
    * 10
@@ -249,7 +243,7 @@ export class ExportDataSourcesResponseBodyData extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries returned on each page.
    * 
    * @example
    * 1
@@ -257,7 +251,7 @@ export class ExportDataSourcesResponseBodyData extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of data sources that meet the specified conditions.
    * 
    * @example
    * 100
@@ -296,15 +290,14 @@ export class ExportDataSourcesResponseBodyData extends $dara.Model {
 export class ExportDataSourcesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the exported data sources.
+   * The return result of the batch export of data sources.
    */
   data?: ExportDataSourcesResponseBodyData;
   /**
    * @remarks
    * The HTTP status code returned. Valid values:
-   * 
-   * *   200: The request was successful.
-   * *   Other values: The request failed. You can troubleshoot issues based on the HTTP status code returned.
+   * - 200: The call is successful.
+   * - Other values: The call fails. You can troubleshoot the issue based on the corresponding error code.
    * 
    * @example
    * 200
@@ -312,7 +305,7 @@ export class ExportDataSourcesResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The request ID. You can locate logs and troubleshoot issues based on the ID.
+   * The request ID. You can use the ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 0bc14115159376359****
@@ -320,10 +313,9 @@ export class ExportDataSourcesResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the request is successful. Valid values:
+   * - true: The request is successful.
+   * - false: The request fails.
    * 
    * @example
    * true

package/src/models/GenerateDisyncTaskConfigForCreatingRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GenerateDISyncTaskConfigForCreatingRequest extends $dara.Model {
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.
+   * The idempotency token. This parameter prevents duplicate operations caused by repeated calls.
    * 
    * @example
    * ABFUOEUOTRTRJKE
@@ -13,9 +13,9 @@ export class GenerateDISyncTaskConfigForCreatingRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @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 obtain 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 Configuration page to obtain the workspace ID.
    * 
-   * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
+   * This parameter specifies the DataWorks workspace for the current API call.
    * 
    * This parameter is required.
    * 
@@ -25,179 +25,177 @@ export class GenerateDISyncTaskConfigForCreatingRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The script for the synchronization task. DataWorks allows you to create the following types of synchronization tasks:
-   * 
-   * *   Synchronization task that is used to synchronize data from MySQL to MaxCompute
-   * *   Synchronization task that is used to synchronize data from MySQL data to Kafka
-   * *   Synchronization task that is used to synchronize data from MySQL to Hologres
-   * 
-   * The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.
-   * 
-   * *   If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.
-   * *   If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.
-   * 
-   * The following sample code provides a script for data synchronization from MySQL to MaxCompute:
-   * 
+   * The script of the Data Integration synchronization task.
+   * The following types of synchronization tasks can be created: 
+   * - Synchronize data from MySQL to MaxCompute.
+   * - Synchronize data from MySQL to Kafka.
+   * - Synchronize data from MySQL to Hologres.
+   * 
+   * SelectedTables is used to select synchronization tables in multi-database mode, and Tables is used to select synchronization tables in single-database mode.
+   * - If the script contains the SelectedTables statement, the system uses the table information in the SelectedTables statement for synchronization.
+   * - If the script contains the Tables statement, the system uses the field information of Tables for synchronization.
+   * 
+   * 
+   * The following example shows the script for synchronizing data from MySQL to MaxCompute:
+   * ```
+   * {
+   *   "type": "realtime",
+   *   "version": "1.0",
+   *   "setting": {
+   *     "resourceGroup": "S_res_group_280749521950784_1623033752022",
+   *     "taskType": "oneclick_to_odps"
+   *   },
+   *   "steps": [
    *     {
-   *       "type": "realtime",
-   *       "version": "1.0",
-   *       "setting": {
-   *         "resourceGroup": "S_res_group_280749521950784_1623033752022",
-   *         "taskType": "oneclick_to_odps"
-   *       },
-   *       "steps": [
-   *         {
-   *           "stepType": "mysql",
-   *           "parameter": {
-   *             "connection": [
+   *       "stepType": "mysql",
+   *       "parameter": {
+   *         "connection": [
+   *           {
+   *             "datasourceType": "mysql",
+   *             "datasource": "mysql_pub1",
+   *             "selectedTables": [
    *               {
-   *                 "datasourceType": "mysql",
-   *                 "datasource": "mysql_pub1",
-   *                 "selectedTables": [
+   *                 "dbName": "mysql_db",
+   *                 "schema": [
    *                   {
-   *                     "dbName": "mysql_db",
-   *                     "schema": [
+   *                     "tableInfos": [
    *                       {
-   *                         "tableInfos": [
-   *                           {
-   *                             "table": "molin_di_test_in_pk_v4"
-   *                           }
-   *                         ]
+   *                         "table": "molin_di_test_in_pk_v4"
    *                       }
    *                     ]
    *                   }
    *                 ]
    *               }
    *             ]
-   *           },
-   *           "name": "Reader",
-   *           "category": "reader"
-   *         },
-   *         {
-   *           "stepType": "odps",
-   *           "parameter": {
-   *             "datasource": "odps_source"
-   *           },
-   *           "name": "Writer",
-   *           "category": "writer"
-   *         }
-   *       ]
-   *     }
-   * 
-   * The following sample code provides a script for data synchronization from MySQL to Kafka:
-   * 
+   *           }
+   *         ]
+   *       },
+   *       "name": "Reader",
+   *       "category": "reader"
+   *     },
    *     {
-   *       "type": "realtime",
-   *       "version": "1.0",
-   *       "setting": {
-   *         "resourceGroup": "S_res_group_280749521950784_1623033752022",
-   *         "taskType": "oneclick_to_kafka"
+   *       "stepType": "odps",
+   *       "parameter": {
+   *         "datasource": "odps_source"
    *       },
-   *       "steps": [
-   *         {
-   *           "stepType": "mysql",
-   *           "parameter": {
-   *             "connection": [
+   *       "name": "Writer",
+   *       "category": "writer"
+   *     }
+   *   ]
+   * }
+   * ```
+   * 
+   * The following example shows the script for synchronizing data from MySQL to Kafka:
+   * ```
+   * {
+   *   "type": "realtime",
+   *   "version": "1.0",
+   *   "setting": {
+   *     "resourceGroup": "S_res_group_280749521950784_1623033752022",
+   *     "taskType": "oneclick_to_kafka"
+   *   },
+   *   "steps": [
+   *     {
+   *       "stepType": "mysql",
+   *       "parameter": {
+   *         "connection": [
+   *           {
+   *             "datasourceType": "mysql",
+   *             "datasource": "pkset_test",
+   *             "selectedTables": [
    *               {
-   *                 "datasourceType": "mysql",
-   *                 "datasource": "pkset_test",
-   *                 "selectedTables": [
+   *                 "dbName": "mysql_db",
+   *                 "schema": [
    *                   {
-   *                     "dbName": "mysql_db",
-   *                     "schema": [
+   *                     "tableInfos": [
    *                       {
-   *                         "tableInfos": [
-   *                           {
-   *                             "table": "molin_di_test_in_pk_v4"
-   *                           }
-   *                         ]
+   *                         "table": "molin_di_test_in_pk_v4"
    *                       }
    *                     ]
    *                   }
    *                 ]
    *               }
    *             ]
-   *           },
-   *           "name": "Reader",
-   *           "category": "reader"
-   *         },
-   *         {
-   *           "stepType": "kafka",
-   *           "parameter": {
-   *             "datasource": "azn_kafka"
-   *           },
-   *           "name": "Writer",
-   *           "category": "writer"
-   *         }
-   *       ]
-   *     }
-   * 
-   * The following sample code provides a script for data synchronization from MySQL to Hologres:
-   * 
+   *           }
+   *         ]
+   *       },
+   *       "name": "Reader",
+   *       "category": "reader"
+   *     },
    *     {
-   *       "type": "realtime",
-   *       "version": "1.0",
-   *       "setting": {
-   *         "resourceGroup": "S_res_group_280749521950784_1623033752022",
-   *         "taskType": "oneclick_to_holo"
+   *       "stepType": "kafka",
+   *       "parameter": {
+   *         "datasource": "azn_kafka"
    *       },
-   *       "steps": [
-   *         {
-   *           "stepType": "mysql",
-   *           "parameter": {
-   *             "connection": [
+   *       "name": "Writer",
+   *       "category": "writer"
+   *     }
+   *   ]
+   * }
+   * ```
+   * 
+   * The following example shows the script for synchronizing data from MySQL to Hologres:
+   * ```
+   * {
+   *   "type": "realtime",
+   *   "version": "1.0",
+   *   "setting": {
+   *     "resourceGroup": "S_res_group_280749521950784_1623033752022",
+   *     "taskType": "oneclick_to_holo"
+   *   },
+   *   "steps": [
+   *     {
+   *       "stepType": "mysql",
+   *       "parameter": {
+   *         "connection": [
+   *           {
+   *             "datasourceType": "mysql",
+   *             "datasource": "mysql_pub",
+   *             "selectedTables": [
    *               {
-   *                 "datasourceType": "mysql",
-   *                 "datasource": "mysql_pub",
-   *                 "selectedTables": [
+   *                 "dbName": "mysql_db",
+   *                 "schema": [
    *                   {
-   *                     "dbName": "mysql_db",
-   *                     "schema": [
+   *                     "tableInfos": [
    *                       {
-   *                         "tableInfos": [
-   *                           {
-   *                             "table": "molin_di_test_in2_pk_v3"
-   *                           }
-   *                         ]
+   *                         "table": "molin_di_test_in2_pk_v3"
    *                       }
    *                     ]
    *                   }
    *                 ]
    *               }
    *             ]
-   *           },
-   *           "name": "Reader",
-   *           "category": "reader"
-   *         },
-   *         {
-   *           "stepType": "holo",
-   *           "parameter": {
-   *             "datasource": "holo"
-   *           },
-   *           "name": "Writer",
-   *           "category": "writer"
-   *         }
-   *       ]
+   *           }
+   *         ]
+   *       },
+   *       "name": "Reader",
+   *       "category": "reader"
+   *     },
+   *     {
+   *       "stepType": "holo",
+   *       "parameter": {
+   *         "datasource": "holo"
+   *       },
+   *       "name": "Writer",
+   *       "category": "writer"
    *     }
+   *   ]
+   * }
+   * ```
    * 
    * This parameter is required.
    * 
    * @example
-   * {    "type": "realtime",     "version": "1.0",        "setting": {       "resourceGroup":       "S_res_group_280749521950784_1623033752022",        "scheduleResgroupId": 30003913,       "name": "openapi_realtime_solution_0813_1739",       "taskType": "oneclick_to_odps"     },     "steps": [         {             "stepType": "mysql",             "parameter": {                 "connection": [                     {                        "datasourceType": "mysql",                         "datasource": "mysql_pub",                         "table": [                             "xyx"                         ]                     }                 ]             },             "name": "Reader",             "category": "reader"         },         {             "stepType": "odps",             "parameter": {                 "datasource": "odps_first"             },             "name": "Writer",             "category": "writer"         }     ] }
+   * {  "type": "realtime",  "version": "1.0",  "setting": {  "resourceGroup": "S_res_group_280749521950784_1623033752022",  "taskType": "oneclick_to_odps"  },  "steps": [{ "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub1", "selectedTables": [ { "dbName": "mysql_db", "schema": [ { "tableInfos": [ { "table": "molin_di_test_in_pk_v4" }]  }  ]  }  ]  }  ]  },  "name": "Reader",  "category": "reader"  },  {  "stepType": "odps",  "parameter": {  "datasource": "odps_source"  },  "name": "Writer",  "category": "writer"  }  ]  }
    */
   taskParam?: string;
   /**
    * @remarks
-   * The type of task that you want to create in Data Integration in asynchronous mode. Valid values:
-   * 
-   * *   DI_REALTIME: real-time synchronization task
-   * *   DI_SOLUTION: another type of synchronization task
-   * 
-   * DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.
+   * The type of the Data Integration synchronization task created by using the asynchronous method. Valid values:
+   * - DI_REALTIME: real-time synchronization task
+   * - DI_SOLUTION: other types of synchronization tasks
    * 
-   * *   DI_OFFLINE
-   * *   DI_REALTIME
-   * *   DI_SOLUTION
+   * Only the asynchronous method is supported for generating real-time synchronization tasks and other types of synchronization tasks in Data Integration.
    * 
    * This parameter is required.
    * 

package/src/models/GenerateDisyncTaskConfigForCreatingResponseBody.ts

@@ -5,7 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GenerateDISyncTaskConfigForCreatingResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.
+   * The description of the cause for the failure to generate the asynchronous thread ID.
+   * If the asynchronous thread ID is generated, this parameter is left empty.
    * 
    * @example
    * XXX is invalid.
@@ -13,7 +14,7 @@ export class GenerateDISyncTaskConfigForCreatingResponseBodyData extends $dara.M
   message?: string;
   /**
    * @remarks
-   * The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](https://help.aliyun.com/document_detail/383465.html) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to create a synchronization task in Data Integration.
+   * The asynchronous thread ID. You must use this ID to call the [QueryDISyncTaskConfigProcessResult](https://help.aliyun.com/document_detail/383465.html) operation to obtain the parameters required for asynchronously generating the configuration of the Data Integration synchronization task, and then use the parameters to create the task.
    * 
    * @example
    * 10
@@ -21,10 +22,9 @@ export class GenerateDISyncTaskConfigForCreatingResponseBodyData extends $dara.M
   processId?: number;
   /**
    * @remarks
-   * Indicates whether the ID of the asynchronous thread is generated. Valid values: Valid values:
-   * 
-   * *   success: indicates that the ID of the asynchronous thread is generated.
-   * *   fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.
+   * The status of generating the asynchronous thread ID. Valid values:
+   * - success: The asynchronous thread ID is generated.
+   * - fail: The asynchronous thread ID fails to be generated. You can view the cause of the failure and troubleshoot the issue.
    * 
    * @example
    * true
@@ -58,12 +58,12 @@ export class GenerateDISyncTaskConfigForCreatingResponseBodyData extends $dara.M
 export class GenerateDISyncTaskConfigForCreatingResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information returned for the ID of the asynchronous thread.
+   * The generation result of the asynchronous thread ID.
    */
   data?: GenerateDISyncTaskConfigForCreatingResponseBodyData;
   /**
    * @remarks
-   * The request ID.
+   * The request ID. You can use this ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 0bc1411515937635973****
@@ -71,10 +71,9 @@ export class GenerateDISyncTaskConfigForCreatingResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   true
-   * *   false
+   * Indicates whether the request is successful. Valid values:
+   * - true: The request is successful.
+   * - false: The request fails.
    * 
    * @example
    * true