@alicloud/dataworks-public20240518 7.2.1 → 7.2.2

package/src/models/UpdateDijobRequestJobSettings.ts

@@ -7,51 +7,10 @@ import { UpdateDIJobRequestJobSettingsRuntimeSettings } from "./UpdateDijobReque
 
 
 export class UpdateDIJobRequestJobSettings 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 read data from a Kafka data source.
-   * *   keyColumns: the names of Kafka columns to which you want to write data.
-   * *   writeMode: the writing format. 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?: UpdateDIJobRequestJobSettingsColumnDataTypeSettings[];
-  /**
-   * @remarks
-   * The settings for periodic scheduling.
-   */
   cycleScheduleSettings?: UpdateDIJobRequestJobSettingsCycleScheduleSettings;
-  /**
-   * @remarks
-   * The processing settings for DDL messages.
-   * 
-   * >  "DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
-   */
   ddlHandlingSettings?: UpdateDIJobRequestJobSettingsDdlHandlingSettings[];
-  /**
-   * @remarks
-   * The runtime settings.
-   */
   runtimeSettings?: UpdateDIJobRequestJobSettingsRuntimeSettings[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestJobSettingsColumnDataTypeSettings.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestJobSettingsColumnDataTypeSettings 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 {

package/src/models/UpdateDijobRequestJobSettingsCycleScheduleSettings.ts

@@ -3,13 +3,6 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestJobSettingsCycleScheduleSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The scheduling parameters.
-   * 
-   * @example
-   * bizdate=$bizdate
-   */
   scheduleParameters?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestJobSettingsDdlHandlingSettings.ts

@@ -3,33 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestJobSettingsDdlHandlingSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The processing policy. Valid values:
-   * 
-   * *   Ignore: ignores a DDL message.
-   * *   Critical: reports an error for a DDL message.
-   * *   Normal: normally processes a DDL message.
-   * 
-   * @example
-   * Critical
-   */
   action?: string;
-  /**
-   * @remarks
-   * The type of the DDL operation. Valid values:
-   * 
-   * *   RenameColumn
-   * *   ModifyColumn
-   * *   CreateTable
-   * *   TruncateTable
-   * *   DropTable
-   * *   DropColumn
-   * *   AddColumn
-   * 
-   * @example
-   * AddColumn
-   */
   type?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestJobSettingsRuntimeSettings.ts

@@ -3,30 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The name of the configuration item. Valid values:
-   * 
-   * *   src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.
-   * *   dst.offline.truncate: specifies whether to clear the destination table before data writing.
-   * *   runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.
-   * *   runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
-   * *   runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
-   * *   runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
-   * *   runtime.realtime.failover.minute.dataxcdc: specifies the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.
-   * *   runtime.realtime.failover.times.dataxcdc: specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
-   * 
-   * @example
-   * runtime.offline.concurrent
-   */
   name?: string;
-  /**
-   * @remarks
-   * The value of the configuration item.
-   * 
-   * @example
-   * 1
-   */
   value?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestResourceSettings.ts

@@ -6,20 +6,8 @@ import { UpdateDIJobRequestResourceSettingsScheduleResourceSettings } from "./Up
 
 
 export class UpdateDIJobRequestResourceSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The resource used for batch synchronization.
-   */
   offlineResourceSettings?: UpdateDIJobRequestResourceSettingsOfflineResourceSettings;
-  /**
-   * @remarks
-   * The resource used for real-time synchronization.
-   */
   realtimeResourceSettings?: UpdateDIJobRequestResourceSettingsRealtimeResourceSettings;
-  /**
-   * @remarks
-   * The resource used for scheduling.
-   */
   scheduleResourceSettings?: UpdateDIJobRequestResourceSettingsScheduleResourceSettings;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestResourceSettingsOfflineResourceSettings.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestResourceSettingsOfflineResourceSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The number of compute units (CUs) in the resource group for Data Integration that are used for batch synchronization.
-   * 
-   * @example
-   * 2.0
-   */
   requestedCu?: number;
-  /**
-   * @remarks
-   * The name of the resource group for Data Integration used for batch synchronization.
-   * 
-   * @example
-   * S_res_group_111_222
-   */
   resourceGroupIdentifier?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestResourceSettingsRealtimeResourceSettings.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestResourceSettingsRealtimeResourceSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The number of CUs in the resource group for Data Integration that are used for real-time synchronization.
-   * 
-   * @example
-   * 2.0
-   */
   requestedCu?: number;
-  /**
-   * @remarks
-   * The name of the resource group for Data Integration used for real-time synchronization.
-   * 
-   * @example
-   * S_res_group_111_222
-   */
   resourceGroupIdentifier?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestResourceSettingsScheduleResourceSettings.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestResourceSettingsScheduleResourceSettings extends $dara.Model {
-  /**
-   * @remarks
-   * The number of CUs in the resource group for scheduling that are used for batch synchronization.
-   * 
-   * @example
-   * 2.0
-   */
   requestedCu?: number;
-  /**
-   * @remarks
-   * The name of the resource group for scheduling used for batch synchronization.
-   * 
-   * @example
-   * S_res_group_235454102432001_1721021993437
-   */
   resourceGroupIdentifier?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestTableMappings.ts

@@ -5,15 +5,7 @@ import { UpdateDIJobRequestTableMappingsTransformationRules } from "./UpdateDijo
 
 
 export class UpdateDIJobRequestTableMappings extends $dara.Model {
-  /**
-   * @remarks
-   * The list of rules that you want to use to select synchronization objects in the source.
-   */
   sourceObjectSelectionRules?: UpdateDIJobRequestTableMappingsSourceObjectSelectionRules[];
-  /**
-   * @remarks
-   * The transformation rules that you want to apply to the synchronization objects selected from the source.
-   */
   transformationRules?: UpdateDIJobRequestTableMappingsTransformationRules[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestTableMappingsSourceObjectSelectionRules.ts

@@ -3,41 +3,9 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestTableMappingsSourceObjectSelectionRules extends $dara.Model {
-  /**
-   * @remarks
-   * The operation that is performed to select objects. Valid values: Include and Exclude.
-   * 
-   * @example
-   * Include
-   */
   action?: string;
-  /**
-   * @remarks
-   * The expression.
-   * 
-   * @example
-   * mysql_table_1
-   */
   expression?: string;
-  /**
-   * @remarks
-   * The expression type. Valid values: Exact and Regex.
-   * 
-   * @example
-   * Exact
-   */
   expressionType?: string;
-  /**
-   * @remarks
-   * The object type. Valid values:
-   * 
-   * *   Table
-   * *   Schema
-   * *   Database
-   * 
-   * @example
-   * Table
-   */
   objectType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestTableMappingsTransformationRules.ts

@@ -3,38 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestTableMappingsTransformationRules extends $dara.Model {
-  /**
-   * @remarks
-   * The action type. Valid values:
-   * 
-   * *   DefinePrimaryKey
-   * *   Rename
-   * *   AddColumn
-   * *   HandleDml
-   * 
-   * @example
-   * Rename
-   */
   ruleActionType?: string;
-  /**
-   * @remarks
-   * The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.
-   * 
-   * @example
-   * rename_rule_1
-   */
   ruleName?: string;
-  /**
-   * @remarks
-   * The type of the object on which you want to perform the action. Valid values:
-   * 
-   * *   Table
-   * *   Schema
-   * *   Database
-   * 
-   * @example
-   * Table
-   */
   ruleTargetType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobRequestTransformationRules.ts

@@ -3,92 +3,9 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDIJobRequestTransformationRules extends $dara.Model {
-  /**
-   * @remarks
-   * The action type. Valid values:
-   * 
-   * *   DefinePrimaryKey
-   * *   Rename
-   * *   AddColumn
-   * *   HandleDml
-   * *   DefineIncrementalCondition
-   * *   DefineCycleScheduleSettings
-   * *   DefinePartitionKey
-   * 
-   * @example
-   * Rename
-   */
   ruleActionType?: string;
-  /**
-   * @remarks
-   * The expression of the rule. The expression must be a JSON string.
-   * 
-   * 1.  Example of a renaming rule
-   * 
-   * *   Example: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }
-   * *   expression: the expression of the renaming rule. You can use the following variables in an expression: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} specifies the name of the source. ${srcDatabaseName} specifies the name of a source database. ${srcTableName} specifies the name of a source table.
-   * 
-   * 2.  Example of a column addition rule
-   * 
-   * *   Example: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}
-   * *   If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.
-   * *   columnName: the name of the field that is added.
-   * *   columnValueType: the value type of the field. Valid values: Constant and Variable.
-   * *   columnValue: the value of the field. If the columnValueType parameter is set to Constant, set the columnValue parameter to a constant of the STRING data type. If the columnValueType parameter is set to Variable, set the columnValue parameter to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC specifies the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation.
-   * 
-   * 3.  Example of a rule used to specify primary key fields for a destination table
-   * 
-   * *   Example: {"columns":["ukcolumn1","ukcolumn2"]}
-   * *   If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default.
-   * *   If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.
-   * *   If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.
-   * 
-   * 4.  Example of a rule used to process DML messages
-   * 
-   * *   Example: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}
-   * *   If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.
-   * *   dmlType: the DML operation. Valid values: Insert, Update, and Delete.
-   * *   dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete.
-   * *   filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.
-   * 
-   * 5.  Example of a rule used to perform incremental synchronization
-   * 
-   * *   Example: {"where":"id > 0"}
-   * *   You can configure such a rule to perform incremental synchronization.
-   * 
-   * 6.  Example of a rule used to configure scheduling parameters for an auto triggered task
-   * 
-   * *   Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}
-   * *   You can configure such a rule to configure scheduling parameters for an auto triggered task.
-   * 
-   * 7.  Example of a rule used to specify a partition key
-   * 
-   * *   Example: {"columns":["id"]}
-   * *   You can configure such a rule to specify a partition key.
-   * 
-   * @example
-   * {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
-   */
   ruleExpression?: string;
-  /**
-   * @remarks
-   * The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.
-   * 
-   * @example
-   * rename_rule_1
-   */
   ruleName?: string;
-  /**
-   * @remarks
-   * The type of the object on which you want to perform the action. Valid values:
-   * 
-   * *   Table
-   * *   Schema
-   * *   Database
-   * 
-   * @example
-   * Table
-   */
   ruleTargetType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDijobShrinkRequest.ts

@@ -4,22 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDIJobShrinkRequest extends $dara.Model {
   /**
-   * @remarks
-   * This parameter is deprecated. Use the Id parameter instead.
-   * 
-   * @example
-   * 11588
-   * 
    * @deprecated
    */
   DIJobId?: number;
-  /**
-   * @remarks
-   * The description of the synchronization task.
-   * 
-   * @example
-   * The description of the synchronization task.
-   */
   description?: string;
   /**
    * @remarks
@@ -29,39 +16,10 @@ export class UpdateDIJobShrinkRequest extends $dara.Model {
    * 11588
    */
   id?: number;
-  /**
-   * @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.
-   */
   jobSettingsShrink?: 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.
-   * 
-   * You must configure this parameter to specify the DataWorks workspace to which the operation is applied.
-   * 
-   * @example
-   * 10000
-   */
   projectId?: number;
-  /**
-   * @remarks
-   * The resource settings.
-   */
   resourceSettingsShrink?: 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" } ] } ]
-   */
   tableMappingsShrink?: string;
-  /**
-   * @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}"}" } ]
-   */
   transformationRulesShrink?: string;
   static names(): { [key: string]: string } {
     return {