@alicloud/dataworks-public20240518 7.2.3 → 7.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/dist/client.d.ts +5 -0
  2. package/dist/client.js +264 -197
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CreateDijobRequest.d.ts +54 -0
  5. package/dist/models/CreateDijobRequest.js.map +1 -1
  6. package/dist/models/CreateDijobShrinkRequest.d.ts +54 -0
  7. package/dist/models/CreateDijobShrinkRequest.js.map +1 -1
  8. package/dist/models/UpdateDijobRequest.d.ts +15 -0
  9. package/dist/models/UpdateDijobRequest.js.map +1 -1
  10. package/dist/models/UpdateDijobShrinkRequest.d.ts +15 -0
  11. package/dist/models/UpdateDijobShrinkRequest.js.map +1 -1
  12. package/package.json +2 -5
  13. package/src/client.ts +277 -199
  14. package/src/models/CreateDijobRequest.ts +54 -0
  15. package/src/models/CreateDijobShrinkRequest.ts +54 -0
  16. package/src/models/UpdateDijobRequest.ts +15 -0
  17. package/src/models/UpdateDijobShrinkRequest.ts +15 -0
package/src/models/CreateDijobRequest.ts CHANGED
@@ -17,21 +17,70 @@ export class CreateDIJobRequest extends $dara.Model {
17
17
  destinationDataSourceSettings?: CreateDIJobRequestDestinationDataSourceSettings[];
18
18
  /**
19
19
  * @remarks
20
+ * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB for MySQL, Kafka, and Hive.
21
+ *
20
22
  * This parameter is required.
23
+ *
24
+ * @example
25
+ * Hologres
21
26
  */
22
27
  destinationDataSourceType?: string;
23
28
  /**
29
+ * @remarks
30
+ * This parameter is deprecated and is replaced by the Name parameter.
31
+ *
32
+ * @example
33
+ * mysql_to_holo_sync_8772
34
+ *
24
35
  * @deprecated
25
36
  */
26
37
  jobName?: string;
27
38
  jobSettings?: CreateDIJobRequestJobSettings;
39
+ /**
40
+ * @remarks
41
+ * The type of the task. This parameter is optional. Valid values:
42
+ *
43
+ * * 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.
44
+ * * 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.
45
+ * * SingleTableRealtimeMigration: A real-time synchronization task used to synchronize only data in single table at the source.
46
+ *
47
+ * @example
48
+ * DatabaseRealtimeMigration
49
+ */
28
50
  jobType?: string;
29
51
  /**
30
52
  * @remarks
53
+ * The synchronization type. Valid values:
54
+ *
55
+ * * FullAndRealtimeIncremental: full synchronization and real-time incremental synchronization of data in an entire database
56
+ * * RealtimeIncremental: real-time incremental synchronization of data in a single table
57
+ * * Full: full batch synchronization of data in an entire database
58
+ * * OfflineIncremental: batch incremental synchronization of data in an entire database
59
+ * * FullAndOfflineIncremental: full synchronization and batch incremental synchronization of data in an entire database
60
+ *
31
61
  * This parameter is required.
62
+ *
63
+ * @example
64
+ * FullAndRealtimeIncremental
32
65
  */
33
66
  migrationType?: string;
67
+ /**
68
+ * @remarks
69
+ * The name of the synchronization task.
70
+ *
71
+ * @example
72
+ * mysql_to_holo_sync_8772
73
+ */
34
74
  name?: string;
75
+ /**
76
+ * @remarks
77
+ * 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.
78
+ *
79
+ * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
80
+ *
81
+ * @example
82
+ * 10000
83
+ */
35
84
  projectId?: number;
36
85
  /**
37
86
  * @remarks
@@ -45,7 +94,12 @@ export class CreateDIJobRequest extends $dara.Model {
45
94
  sourceDataSourceSettings?: CreateDIJobRequestSourceDataSourceSettings[];
46
95
  /**
47
96
  * @remarks
97
+ * The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, Redshift, Hive, SQL Server, Doris, and ClickHouse.
98
+ *
48
99
  * This parameter is required.
100
+ *
101
+ * @example
102
+ * MySQL
49
103
  */
50
104
  sourceDataSourceType?: string;
51
105
  /**
package/src/models/CreateDijobShrinkRequest.ts CHANGED
@@ -11,21 +11,70 @@ export class CreateDIJobShrinkRequest extends $dara.Model {
11
11
  destinationDataSourceSettingsShrink?: string;
12
12
  /**
13
13
  * @remarks
14
+ * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB for MySQL, Kafka, and Hive.
15
+ *
14
16
  * This parameter is required.
17
+ *
18
+ * @example
19
+ * Hologres
15
20
  */
16
21
  destinationDataSourceType?: string;
17
22
  /**
23
+ * @remarks
24
+ * This parameter is deprecated and is replaced by the Name parameter.
25
+ *
26
+ * @example
27
+ * mysql_to_holo_sync_8772
28
+ *
18
29
  * @deprecated
19
30
  */
20
31
  jobName?: string;
21
32
  jobSettingsShrink?: string;
33
+ /**
34
+ * @remarks
35
+ * The type of the task. This parameter is optional. Valid values:
36
+ *
37
+ * * 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.
38
+ * * 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.
39
+ * * SingleTableRealtimeMigration: A real-time synchronization task used to synchronize only data in single table at the source.
40
+ *
41
+ * @example
42
+ * DatabaseRealtimeMigration
43
+ */
22
44
  jobType?: string;
23
45
  /**
24
46
  * @remarks
47
+ * The synchronization type. Valid values:
48
+ *
49
+ * * FullAndRealtimeIncremental: full synchronization and real-time incremental synchronization of data in an entire database
50
+ * * RealtimeIncremental: real-time incremental synchronization of data in a single table
51
+ * * Full: full batch synchronization of data in an entire database
52
+ * * OfflineIncremental: batch incremental synchronization of data in an entire database
53
+ * * FullAndOfflineIncremental: full synchronization and batch incremental synchronization of data in an entire database
54
+ *
25
55
  * This parameter is required.
56
+ *
57
+ * @example
58
+ * FullAndRealtimeIncremental
26
59
  */
27
60
  migrationType?: string;
61
+ /**
62
+ * @remarks
63
+ * The name of the synchronization task.
64
+ *
65
+ * @example
66
+ * mysql_to_holo_sync_8772
67
+ */
28
68
  name?: string;
69
+ /**
70
+ * @remarks
71
+ * 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.
72
+ *
73
+ * You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.
74
+ *
75
+ * @example
76
+ * 10000
77
+ */
29
78
  projectId?: number;
30
79
  /**
31
80
  * @remarks
@@ -39,7 +88,12 @@ export class CreateDIJobShrinkRequest extends $dara.Model {
39
88
  sourceDataSourceSettingsShrink?: string;
40
89
  /**
41
90
  * @remarks
91
+ * The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, Redshift, Hive, SQL Server, Doris, and ClickHouse.
92
+ *
42
93
  * This parameter is required.
94
+ *
95
+ * @example
96
+ * MySQL
43
97
  */
44
98
  sourceDataSourceType?: string;
45
99
  /**
package/src/models/UpdateDijobRequest.ts CHANGED
@@ -8,6 +8,12 @@ import { UpdateDIJobRequestTransformationRules } from "./UpdateDijobRequestTrans
8
8
 
9
9
  export class UpdateDIJobRequest extends $dara.Model {
10
10
  /**
11
+ * @remarks
12
+ * This parameter is deprecated. Use the Id parameter instead.
13
+ *
14
+ * @example
15
+ * 11588
16
+ *
11
17
  * @deprecated
12
18
  */
13
19
  DIJobId?: number;
@@ -21,6 +27,15 @@ export class UpdateDIJobRequest extends $dara.Model {
21
27
  */
22
28
  id?: number;
23
29
  jobSettings?: UpdateDIJobRequestJobSettings;
30
+ /**
31
+ * @remarks
32
+ * 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.
33
+ *
34
+ * You must configure this parameter to specify the DataWorks workspace to which the operation is applied.
35
+ *
36
+ * @example
37
+ * 10000
38
+ */
24
39
  projectId?: number;
25
40
  resourceSettings?: UpdateDIJobRequestResourceSettings;
26
41
  tableMappings?: UpdateDIJobRequestTableMappings[];
package/src/models/UpdateDijobShrinkRequest.ts CHANGED
@@ -4,6 +4,12 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class UpdateDIJobShrinkRequest extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * This parameter is deprecated. Use the Id parameter instead.
9
+ *
10
+ * @example
11
+ * 11588
12
+ *
7
13
  * @deprecated
8
14
  */
9
15
  DIJobId?: number;
@@ -17,6 +23,15 @@ export class UpdateDIJobShrinkRequest extends $dara.Model {
17
23
  */
18
24
  id?: number;
19
25
  jobSettingsShrink?: string;
26
+ /**
27
+ * @remarks
28
+ * 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.
29
+ *
30
+ * You must configure this parameter to specify the DataWorks workspace to which the operation is applied.
31
+ *
32
+ * @example
33
+ * 10000
34
+ */
20
35
  projectId?: number;
21
36
  resourceSettingsShrink?: string;
22
37
  tableMappingsShrink?: string;