Generated ts 2024-05-18 for dataworks-public.

Author: sdk-team

dataworks-public-20240518/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alicloud/dataworks-public20240518",
-  "version": "7.2.1",
+  "version": "7.2.2",
   "description": "",
   "main": "dist/client.js",
   "scripts": {

dataworks-public-20240518/src/client.ts

@@ -594,16 +594,72 @@ export default class Client extends OpenApi {
       request.transformationRulesShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.transformationRules, "TransformationRules", "json");
     }
 
-    let query = OpenApiUtil.query(request.toMap());
+    let body : {[key: string ]: any} = { };
+    if (!$dara.isNull(request.description)) {
+      body["Description"] = request.description;
+    }
+
+    if (!$dara.isNull(request.destinationDataSourceSettingsShrink)) {
+      body["DestinationDataSourceSettings"] = request.destinationDataSourceSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.destinationDataSourceType)) {
+      body["DestinationDataSourceType"] = request.destinationDataSourceType;
+    }
+
+    if (!$dara.isNull(request.jobName)) {
+      body["JobName"] = request.jobName;
+    }
+
+    if (!$dara.isNull(request.jobSettingsShrink)) {
+      body["JobSettings"] = request.jobSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.jobType)) {
+      body["JobType"] = request.jobType;
+    }
+
+    if (!$dara.isNull(request.migrationType)) {
+      body["MigrationType"] = request.migrationType;
+    }
+
+    if (!$dara.isNull(request.name)) {
+      body["Name"] = request.name;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      body["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.resourceSettingsShrink)) {
+      body["ResourceSettings"] = request.resourceSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.sourceDataSourceSettingsShrink)) {
+      body["SourceDataSourceSettings"] = request.sourceDataSourceSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.sourceDataSourceType)) {
+      body["SourceDataSourceType"] = request.sourceDataSourceType;
+    }
+
+    if (!$dara.isNull(request.tableMappingsShrink)) {
+      body["TableMappings"] = request.tableMappingsShrink;
+    }
+
+    if (!$dara.isNull(request.transformationRulesShrink)) {
+      body["TransformationRules"] = request.transformationRulesShrink;
+    }
+
     let req = new $OpenApiUtil.OpenApiRequest({
-      query: OpenApiUtil.query(query),
+      body: OpenApiUtil.parseToMap(body),
     });
     let params = new $OpenApiUtil.Params({
       action: "CreateDIJob",
       version: "2024-05-18",
       protocol: "HTTPS",
       pathname: "/",
-      method: "GET",
+      method: "POST",
       authType: "AK",
       style: "RPC",
       reqBodyType: "formData",
@@ -10888,16 +10944,50 @@ export default class Client extends OpenApi {
       request.transformationRulesShrink = OpenApiUtil.arrayToStringWithSpecifiedStyle(tmpReq.transformationRules, "TransformationRules", "json");
     }
 
-    let query = OpenApiUtil.query(request.toMap());
+    let query = { };
+    if (!$dara.isNull(request.id)) {
+      query["Id"] = request.id;
+    }
+
+    let body : {[key: string ]: any} = { };
+    if (!$dara.isNull(request.DIJobId)) {
+      body["DIJobId"] = request.DIJobId;
+    }
+
+    if (!$dara.isNull(request.description)) {
+      body["Description"] = request.description;
+    }
+
+    if (!$dara.isNull(request.jobSettingsShrink)) {
+      body["JobSettings"] = request.jobSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.projectId)) {
+      body["ProjectId"] = request.projectId;
+    }
+
+    if (!$dara.isNull(request.resourceSettingsShrink)) {
+      body["ResourceSettings"] = request.resourceSettingsShrink;
+    }
+
+    if (!$dara.isNull(request.tableMappingsShrink)) {
+      body["TableMappings"] = request.tableMappingsShrink;
+    }
+
+    if (!$dara.isNull(request.transformationRulesShrink)) {
+      body["TransformationRules"] = request.transformationRulesShrink;
+    }
+
     let req = new $OpenApiUtil.OpenApiRequest({
       query: OpenApiUtil.query(query),
+      body: OpenApiUtil.parseToMap(body),
     });
     let params = new $OpenApiUtil.Params({
       action: "UpdateDIJob",
       version: "2024-05-18",
       protocol: "HTTPS",
       pathname: "/",
-      method: "GET",
+      method: "POST",
       authType: "AK",
       style: "RPC",
       reqBodyType: "formData",

dataworks-public-20240518/src/models/CreateDijobRequest.ts

@@ -9,131 +9,50 @@ import { CreateDIJobRequestTransformationRules } from "./CreateDijobRequestTrans
 
 
 export class CreateDIJobRequest extends $dara.Model {
-  /**
-   * @remarks
-   * The description of the synchronization task.
-   * 
-   * @example
-   * The description of the synchronization task.
-   */
   description?: string;
   /**
    * @remarks
-   * The settings of the destination. Only a single destination is supported.
-   * 
    * This parameter is required.
    */
   destinationDataSourceSettings?: CreateDIJobRequestDestinationDataSourceSettings[];
   /**
    * @remarks
-   * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB for MySQL, Kafka, and Hive.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * Hologres
    */
   destinationDataSourceType?: string;
   /**
-   * @remarks
-   * This parameter is deprecated and is replaced by the Name parameter.
-   * 
-   * @example
-   * mysql_to_holo_sync_8772
-   * 
    * @deprecated
    */
   jobName?: string;
-  /**
-   * @remarks
-   * The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.
-   */
   jobSettings?: CreateDIJobRequestJobSettings;
-  /**
-   * @remarks
-   * The type of the task. This parameter is optional. Valid values:
-   * 
-   * *   DatabaseRealtimeMigration: A real-time synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases at the source.
-   * *   DatabaseOfflineMigration: A batch synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases at the source.
-   * *   SingleTableRealtimeMigration: A real-time synchronization task used to synchronize only data in single table at the source.
-   * 
-   * @example
-   * DatabaseRealtimeMigration
-   */
   jobType?: string;
   /**
    * @remarks
-   * The synchronization type. Valid values:
-   * 
-   * *   FullAndRealtimeIncremental: full synchronization and real-time incremental synchronization of data in an entire database
-   * *   RealtimeIncremental: real-time incremental synchronization of data in a single table
-   * *   Full: full batch synchronization of data in an entire database
-   * *   OfflineIncremental: batch incremental synchronization of data in an entire database
-   * *   FullAndOfflineIncremental: full synchronization and batch incremental synchronization of data in an entire database
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * FullAndRealtimeIncremental
    */
   migrationType?: string;
-  /**
-   * @remarks
-   * The name of the synchronization task.
-   * 
-   * @example
-   * mysql_to_holo_sync_8772
-   */
   name?: 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 query the ID.
-   * 
-   * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
-   * 
-   * @example
-   * 10000
-   */
   projectId?: number;
   /**
    * @remarks
-   * The resource settings.
-   * 
    * This parameter is required.
    */
   resourceSettings?: CreateDIJobRequestResourceSettings;
   /**
    * @remarks
-   * The settings of the source. Only a single source is supported.
-   * 
    * This parameter is required.
    */
   sourceDataSourceSettings?: CreateDIJobRequestSourceDataSourceSettings[];
   /**
    * @remarks
-   * The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, Redshift, Hive, SQL Server, Doris, and ClickHouse.
-   * 
    * This parameter is required.
-   * 
-   * @example
-   * MySQL
    */
   sourceDataSourceType?: string;
   /**
    * @remarks
-   * The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.
-   * 
-   * >  [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
-   * 
    * This parameter is required.
    */
   tableMappings?: CreateDIJobRequestTableMappings[];
-  /**
-   * @remarks
-   * The list of transformation rules for objects involved in the synchronization task.
-   * 
-   * >  [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
-   */
   transformationRules?: CreateDIJobRequestTransformationRules[];
   static names(): { [key: string]: string } {
     return {

dataworks-public-20240518/src/models/CreateDijobRequestDestinationDataSourceSettings.ts

@@ -3,13 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDIJobRequestDestinationDataSourceSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The name of the data source.
-   * 
-   * @example
-   * holo_datasource_1
-   */
   dataSourceName?: string;
   static names(): { [key: string]: string } {
     return {

dataworks-public-20240518/src/models/CreateDijobRequestJobSettings.ts

@@ -7,51 +7,10 @@ import { CreateDIJobRequestJobSettingsRuntimeSettings } from "./CreateDijobReque
 
 
 export class CreateDIJobRequestJobSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The channel control settings for the synchronization task. You can configure special channel control settings for the following synchronization links: data synchronization between Hologres data sources and data synchronization from Hologres to Kafka.
-   * 
-   * 1.  Holo2Kafka
-   * 
-   * *   Example: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}
-   * *   kafkaClientProperties: the parameters related to a Kafka producer, which are used when you write data to a Kafka data source.
-   * *   keyColumns: the names of Kafka columns to which you want to write data.
-   * *   writeMode: the writing format of the Kafka data source. Valid values: json and canal.
-   * 
-   * 2.  Holo2Holo
-   * 
-   * *   Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}
-   * *   conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.
-   * *   writeMode: the mode in which you want to write data to Hologres. Valid values: replay and insert.
-   * *   dynamicColumnAction: the mode in which you want to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
-   * 
-   * @example
-   * {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
-   */
   channelSettings?: string;
-  /**
-   * @remarks
-   * The data type mappings between source fields and destination fields.
-   * 
-   * >  "ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]
-   */
   columnDataTypeSettings?: CreateDIJobRequestJobSettingsColumnDataTypeSettings[];
-  /**
-   * @remarks
-   * The settings for periodic scheduling.
-   */
   cycleScheduleSettings?: CreateDIJobRequestJobSettingsCycleScheduleSettings;
-  /**
-   * @remarks
-   * The processing settings for DDL messages.
-   * 
-   * >  "DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
-   */
   ddlHandlingSettings?: CreateDIJobRequestJobSettingsDdlHandlingSettings[];
-  /**
-   * @remarks
-   * The runtime settings.
-   */
   runtimeSettings?: CreateDIJobRequestJobSettingsRuntimeSettings[];
   static names(): { [key: string]: string } {
     return {

dataworks-public-20240518/src/models/CreateDijobRequestJobSettingsColumnDataTypeSettings.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDIJobRequestJobSettingsColumnDataTypeSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The data type of the destination field. Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.
-   * 
-   * @example
-   * text
-   */
   destinationDataType?: string;
-  /**
-   * @remarks
-   * The data type of the source field. Valid values: Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.
-   * 
-   * @example
-   * bigint
-   */
   sourceDataType?: string;
   static names(): { [key: string]: string } {
     return {

dataworks-public-20240518/src/models/CreateDijobRequestJobSettingsCycleScheduleSettings.ts

@@ -3,24 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDIJobRequestJobSettingsCycleScheduleSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The synchronization type that requires periodic scheduling. Valid values:
-   * 
-   * *   Full: full synchronization
-   * *   OfflineIncremental: batch incremental synchronization
-   * 
-   * @example
-   * Full
-   */
   cycleMigrationType?: string;
-  /**
-   * @remarks
-   * The scheduling parameters.
-   * 
-   * @example
-   * bizdate=$bizdate
-   */
   scheduleParameters?: string;
   static names(): { [key: string]: string } {
     return {