@alicloud/dataworks-public20240518 7.2.2 → 7.2.4

package/src/models/CreateDijobRequest.ts

@@ -17,21 +17,70 @@ export class CreateDIJobRequest extends $dara.Model {
   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;
   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
@@ -45,7 +94,12 @@ export class CreateDIJobRequest extends $dara.Model {
   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;
   /**

package/src/models/CreateDijobShrinkRequest.ts

@@ -11,21 +11,70 @@ export class CreateDIJobShrinkRequest extends $dara.Model {
   destinationDataSourceSettingsShrink?: string;
   /**
    * @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;
   jobSettingsShrink?: string;
+  /**
+   * @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
@@ -39,7 +88,12 @@ export class CreateDIJobShrinkRequest extends $dara.Model {
   sourceDataSourceSettingsShrink?: string;
   /**
    * @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;
   /**

package/src/models/GetWorkflowInstanceResponseBodyWorkflowInstance.ts

@@ -133,6 +133,7 @@ export class GetWorkflowInstanceResponseBodyWorkflowInstance extends $dara.Model
    * 1234
    */
   workflowId?: number;
+  workflowParameters?: string;
   static names(): { [key: string]: string } {
     return {
       bizDate: 'BizDate',
@@ -149,6 +150,7 @@ export class GetWorkflowInstanceResponseBodyWorkflowInstance extends $dara.Model
       status: 'Status',
       type: 'Type',
       workflowId: 'WorkflowId',
+      workflowParameters: 'WorkflowParameters',
     };
   }
 
@@ -168,6 +170,7 @@ export class GetWorkflowInstanceResponseBodyWorkflowInstance extends $dara.Model
       status: 'string',
       type: 'string',
       workflowId: 'number',
+      workflowParameters: 'string',
     };
   }
 

package/src/models/ListWorkflowInstancesResponseBodyPagingInfoWorkflowInstances.ts

@@ -121,6 +121,7 @@ export class ListWorkflowInstancesResponseBodyPagingInfoWorkflowInstances extend
    * 1234
    */
   workflowId?: number;
+  workflowParameters?: string;
   static names(): { [key: string]: string } {
     return {
       bizDate: 'BizDate',
@@ -137,6 +138,7 @@ export class ListWorkflowInstancesResponseBodyPagingInfoWorkflowInstances extend
       status: 'Status',
       type: 'Type',
       workflowId: 'WorkflowId',
+      workflowParameters: 'WorkflowParameters',
     };
   }
 
@@ -156,6 +158,7 @@ export class ListWorkflowInstancesResponseBodyPagingInfoWorkflowInstances extend
       status: 'string',
       type: 'string',
       workflowId: 'number',
+      workflowParameters: 'string',
     };
   }
 

package/src/models/UpdateDijobRequest.ts

@@ -8,6 +8,12 @@ import { UpdateDIJobRequestTransformationRules } from "./UpdateDijobRequestTrans
 
 export class UpdateDIJobRequest extends $dara.Model {
   /**
+   * @remarks
+   * This parameter is deprecated. Use the Id parameter instead.
+   * 
+   * @example
+   * 11588
+   * 
    * @deprecated
    */
   DIJobId?: number;
@@ -21,6 +27,15 @@ export class UpdateDIJobRequest extends $dara.Model {
    */
   id?: number;
   jobSettings?: UpdateDIJobRequestJobSettings;
+  /**
+   * @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;
   resourceSettings?: UpdateDIJobRequestResourceSettings;
   tableMappings?: UpdateDIJobRequestTableMappings[];

package/src/models/UpdateDijobShrinkRequest.ts

@@ -4,6 +4,12 @@ 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;
@@ -17,6 +23,15 @@ export class UpdateDIJobShrinkRequest extends $dara.Model {
    */
   id?: number;
   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;
   resourceSettingsShrink?: string;
   tableMappingsShrink?: string;