@alicloud/dataworks-public20240518 6.1.0 → 6.1.2

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.
package/dist/client.d.ts CHANGED
@@ -1516,7 +1516,7 @@ export declare class CreateAlertRuleRequestTriggerCondition extends $dara.Model
1516
1516
  export declare class CreateDIAlarmRuleRequestNotificationSettingsNotificationChannels extends $dara.Model {
1517
1517
  /**
1518
1518
  * @remarks
1519
- * The alert notification methods. Valid values:
1519
+ * The alert notification method. Valid values:
1520
1520
  *
1521
1521
  * * Mail
1522
1522
  * * Phone
@@ -1577,7 +1577,7 @@ export declare class CreateDIAlarmRuleRequestNotificationSettingsNotificationRec
1577
1577
  export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
1578
1578
  /**
1579
1579
  * @remarks
1580
- * The duration of the alert suppression interval. Default value: 5. Unit: minutes.
1580
+ * This parameter is deprecated and replaced by the MuteInterval parameter.
1581
1581
  *
1582
1582
  * @example
1583
1583
  * 5
@@ -1587,7 +1587,7 @@ export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.
1587
1587
  inhibitionInterval?: number;
1588
1588
  /**
1589
1589
  * @remarks
1590
- * 告警抑制间隔时长,单位分钟,默认5分钟。
1590
+ * The duration of the alert suppression interval. Default value: 5. Unit: minutes.
1591
1591
  *
1592
1592
  * @example
1593
1593
  * 5
@@ -1617,14 +1617,14 @@ export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.
1617
1617
  export declare class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
1618
1618
  /**
1619
1619
  * @remarks
1620
- * The types of DDL operations for which the alert rule takes effect.
1620
+ * This parameter is deprecated and replaced by the DdlTypes parameter.
1621
1621
  *
1622
1622
  * @deprecated
1623
1623
  */
1624
1624
  ddlReportTags?: string[];
1625
1625
  /**
1626
1626
  * @remarks
1627
- * DDL通知的时候才生效,需要生效的DDL列表。
1627
+ * The types of DDL operations for which the alert rule takes effect.
1628
1628
  */
1629
1629
  ddlTypes?: string[];
1630
1630
  /**
@@ -1799,8 +1799,8 @@ export declare class CreateDIJobRequestJobSettingsRuntimeSettings extends $dara.
1799
1799
  * * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
1800
1800
  * * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
1801
1801
  * * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
1802
- * * runtime.realtime.failover.minute.dataxcdc: The maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.
1803
- * * runtime.realtime.failover.times.dataxcdc: The maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
1802
+ * * 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.
1803
+ * * runtime.realtime.failover.times.dataxcdc: specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
1804
1804
  *
1805
1805
  * @example
1806
1806
  * runtime.offline.concurrent
@@ -1830,19 +1830,19 @@ export declare class CreateDIJobRequestJobSettings extends $dara.Model {
1830
1830
  * @remarks
1831
1831
  * 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.
1832
1832
  *
1833
- * 1. Data synchronization from Hologres to Kafka
1833
+ * 1. Holo2Kafka
1834
1834
  *
1835
1835
  * * Example: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}
1836
1836
  * * kafkaClientProperties: the parameters related to a Kafka producer, which are used when you write data to a Kafka data source.
1837
1837
  * * keyColumns: the names of Kafka columns to which you want to write data.
1838
- * * writeMode: the writing format. Valid values: json and canal.
1838
+ * * writeMode: the writing format of the Kafka data source. Valid values: json and canal.
1839
1839
  *
1840
- * 2. Data synchronization between Hologres data sources
1840
+ * 2. Holo2Holo
1841
1841
  *
1842
1842
  * * Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}
1843
1843
  * * conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.
1844
1844
  * * writeMode: the mode in which you want to write data to Hologres. Valid values: replay and insert.
1845
- * * dynamicColumnAction: the method used to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
1845
+ * * dynamicColumnAction: the mode in which you want to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
1846
1846
  *
1847
1847
  * @example
1848
1848
  * {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
@@ -2805,6 +2805,8 @@ export declare class CreateDataQualityEvaluationTaskRequestTarget extends $dara.
2805
2805
  * * emr
2806
2806
  * * analyticdb_for_postgresql
2807
2807
  *
2808
+ * This parameter is required.
2809
+ *
2808
2810
  * @example
2809
2811
  * maxcompute
2810
2812
  */
@@ -2821,6 +2823,8 @@ export declare class CreateDataQualityEvaluationTaskRequestTarget extends $dara.
2821
2823
  * @remarks
2822
2824
  * The ID of the table in Data Map.
2823
2825
  *
2826
+ * This parameter is required.
2827
+ *
2824
2828
  * @example
2825
2829
  * odps.api_test.ods_openapi_log_d
2826
2830
  */
@@ -3442,10 +3446,11 @@ export declare class CreateResourceGroupResponseBodyResourceGroupOrder extends $
3442
3446
  export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert extends $dara.Model {
3443
3447
  /**
3444
3448
  * @remarks
3445
- * The notification method.
3446
- * - Sms: Sms only
3447
- * - Mail: Mail only
3448
- * - SmsMail: SMS and email.
3449
+ * The alert notification method. Valid values:
3450
+ *
3451
+ * * Sms
3452
+ * * Mail
3453
+ * * SmsMail
3449
3454
  *
3450
3455
  * @example
3451
3456
  * Sms
@@ -3453,10 +3458,11 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert ext
3453
3458
  noticeType?: string;
3454
3459
  /**
3455
3460
  * @remarks
3456
- * The alert policy.
3457
- * - Success: successful alert
3458
- * - Failure: failed alarm
3459
- * - SuccessFailure: alerts for both success and failure
3461
+ * The alerting policy. Valid values:
3462
+ *
3463
+ * * SUCCESS: An alert is reported when data backfill succeeds.
3464
+ * * FAILURE: An alert is reported when data backfill fails.
3465
+ * * SuccessFailure: An alert is reported regardless of whether data backfill succeeds or fails.
3460
3466
  *
3461
3467
  * @example
3462
3468
  * Succes
@@ -3476,7 +3482,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert ext
3476
3482
  export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis extends $dara.Model {
3477
3483
  /**
3478
3484
  * @remarks
3479
- * Whether to block the operation if the analysis fails.
3485
+ * Specifies whether to block the running of the instance if the analysis fails.
3480
3486
  *
3481
3487
  * @example
3482
3488
  * true
@@ -3484,7 +3490,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis
3484
3490
  blocked?: boolean;
3485
3491
  /**
3486
3492
  * @remarks
3487
- * Whether to enable analysis.
3493
+ * Specifies whether to enable the analysis feature.
3488
3494
  *
3489
3495
  * @example
3490
3496
  * true
@@ -3504,7 +3510,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis
3504
3510
  export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy extends $dara.Model {
3505
3511
  /**
3506
3512
  * @remarks
3507
- * The end runtime. This field is required if the policy is set.
3513
+ * The time when the instance finishes running. This parameter is required if you specify the RunPolicy parameter.
3508
3514
  *
3509
3515
  * @example
3510
3516
  * 23:59:59
@@ -3512,7 +3518,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
3512
3518
  endTime?: string;
3513
3519
  /**
3514
3520
  * @remarks
3515
- * The default value is false.
3521
+ * Specifies whether the instance can be run immediately during the time period in the future. Default value: false.
3516
3522
  *
3517
3523
  * @example
3518
3524
  * false
@@ -3520,7 +3526,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
3520
3526
  immediately?: boolean;
3521
3527
  /**
3522
3528
  * @remarks
3523
- * The start time. This field is required if the policy is set.
3529
+ * The time when the instance starts to run. This parameter is required if you specify the RunPolicy parameter.
3524
3530
  *
3525
3531
  * @example
3526
3532
  * 00:00:00
@@ -3528,9 +3534,10 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
3528
3534
  startTime?: string;
3529
3535
  /**
3530
3536
  * @remarks
3531
- * The type of the time period. This field is required if the policy is set.
3532
- * - Daily: every day
3533
- * - Weekend: Weekends only
3537
+ * The type of the time period during which the data is backfilled. This parameter is required if you specify the RunPolicy parameter. Valid values:
3538
+ *
3539
+ * * Daily
3540
+ * * Weekend
3534
3541
  *
3535
3542
  * @example
3536
3543
  * Daily
@@ -3550,41 +3557,42 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
3550
3557
  export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends $dara.Model {
3551
3558
  /**
3552
3559
  * @remarks
3553
- * Alarm configuration.
3560
+ * The alert settings.
3554
3561
  */
3555
3562
  alert?: CreateWorkflowInstancesRequestDefaultRunPropertiesAlert;
3556
3563
  /**
3557
3564
  * @remarks
3558
- * Analyze the configuration.
3565
+ * The analysis of the configurations.
3559
3566
  */
3560
3567
  analysis?: CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis;
3561
3568
  /**
3562
3569
  * @remarks
3563
- * The list of project IDs that do not need to be run.
3570
+ * The IDs of the projects that do not need to be run.
3564
3571
  */
3565
3572
  excludeProjectIds?: number[];
3566
3573
  /**
3567
3574
  * @remarks
3568
- * The list of task IDs that you do not want to run.
3575
+ * The IDs of the tasks that do not need to be run.
3569
3576
  */
3570
3577
  excludeTaskIds?: number[];
3571
3578
  /**
3572
3579
  * @remarks
3573
- * The list of project IDs to be run.
3580
+ * The IDs of the projects that need to be run.
3574
3581
  */
3575
3582
  includeProjectIds?: number[];
3576
3583
  /**
3577
3584
  * @remarks
3578
- * The list of task IDs to be run.
3585
+ * The IDs of the tasks that need to be run.
3579
3586
  */
3580
3587
  includeTaskIds?: number[];
3581
3588
  /**
3582
3589
  * @remarks
3583
- * The data replenishment mode. The default value is ManualSelection.
3584
- * - General: In normal mode, only one \\"roottaskkids\\" can be filled in, and \\"IncludeTaskIds\\" is optional. If not, the content in \\"roottaskkids\\" will be included by default.
3585
- * - ManualSelection: manually select, \\"roottaskkids\\" can be filled in multiple, \\"IncludeTaskIds\\" optional, if not, the content in \\"roottaskkids\\" will be included by default.
3586
- * - Chain: the link, \\"roottaskkids\\" is empty, and \\"IncludeTaskIds\\" is filled with two IDs, which are the start and end tasks respectively.
3587
- * - AllDownstream: all downstream, \\"roottaskkids\\" can only be filled in one
3590
+ * The data backfill mode. Default value: ManualSelection. Valid values:
3591
+ *
3592
+ * * General: You can specify only one root task ID. The `IncludeTaskIds` parameter is optional. If you do not specify the IncludeTaskIds parameter, the tasks that are specified by the `RootTaskIds` parameter are included by default.``
3593
+ * * ManualSelection: You can specify multiple root tasks IDs. The `IncludeTaskIds` parameter is optional. If you do not specify the IncludeTaskIds parameter, the tasks that are specified by the `RootTaskIds` parameter are included by default.``
3594
+ * * Chain: The value of the `RootTaskIds` parameter is left empty. You must set the `IncludeTaskIds` parameter to the start task ID and the end task ID.
3595
+ * * AllDownstream: You can specify only one root task ID.``
3588
3596
  *
3589
3597
  * @example
3590
3598
  * ManualSelection
@@ -3592,9 +3600,10 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
3592
3600
  mode?: string;
3593
3601
  /**
3594
3602
  * @remarks
3595
- * The running sequence. Default value: Asc.
3596
- * - Asc: ascending order by business date.
3597
- * - Desc: descending order by business date.
3603
+ * The running order. Default value: Asc. Valid values:
3604
+ *
3605
+ * * Asc: The tasks are sorted by data timestamp in ascending order.
3606
+ * * Desc: The tasks are sorted by data timestamp in descending order.
3598
3607
  *
3599
3608
  * @example
3600
3609
  * Asc
@@ -3602,7 +3611,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
3602
3611
  order?: string;
3603
3612
  /**
3604
3613
  * @remarks
3605
- * The number of rows that the task has. Values from 2 to 10 are parallelism and 1 is serial.
3614
+ * The number of tasks that can be run in parallel. If you specify the value to 2 to 10, the value indicates the number of tasks that can be run in parallel. If you specify the value to 1, the tasks are run one by one.
3606
3615
  *
3607
3616
  * @example
3608
3617
  * 2
@@ -3610,17 +3619,17 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
3610
3619
  parallelism?: number;
3611
3620
  /**
3612
3621
  * @remarks
3613
- * The ID list of the root task.
3622
+ * The root task IDs.
3614
3623
  */
3615
3624
  rootTaskIds?: number[];
3616
3625
  /**
3617
3626
  * @remarks
3618
- * Run the policy. If this field is empty, the task configuration is followed.
3627
+ * The data backfill policy. If you leave this parameter empty, the runtime configuration is used.
3619
3628
  */
3620
3629
  runPolicy?: CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy;
3621
3630
  /**
3622
3631
  * @remarks
3623
- * The identifier of the custom scheduling Resource Group. If this field is empty, the task configuration is followed.
3632
+ * The identifier of the custom resource group for scheduling. If you leave this parameter empty, the runtime configuration is used.
3624
3633
  *
3625
3634
  * @example
3626
3635
  * S_res_group_524258031846018_1684XXXXXXXXX
@@ -5196,7 +5205,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
5196
5205
  destinationDataSourceSettings?: GetDIJobResponseBodyPagingInfoDestinationDataSourceSettings[];
5197
5206
  /**
5198
5207
  * @remarks
5199
- * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, Datahub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive.
5208
+ * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB_For_MySQL, Kafka, Hive.
5200
5209
  *
5201
5210
  * @example
5202
5211
  * Hologres
@@ -5231,6 +5240,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
5231
5240
  * Running
5232
5241
  */
5233
5242
  jobStatus?: string;
5243
+ jobType?: string;
5234
5244
  /**
5235
5245
  * @remarks
5236
5246
  * The synchronization type. Valid values:
@@ -5267,7 +5277,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
5267
5277
  sourceDataSourceSettings?: GetDIJobResponseBodyPagingInfoSourceDataSourceSettings[];
5268
5278
  /**
5269
5279
  * @remarks
5270
- * The source type. Valid values: PolarDB, MySQL, Kafka, Loghub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SqlServer, Doris, and ClickHouse.
5280
+ * The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SQLServer, Doris, ClickHouse.
5271
5281
  *
5272
5282
  * @example
5273
5283
  * Mysql
@@ -5611,13 +5621,190 @@ export declare class GetDataQualityEvaluationTaskResponseBodyDataQualityEvaluati
5611
5621
  [key: string]: any;
5612
5622
  });
5613
5623
  }
5624
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsDetails extends $dara.Model {
5625
+ checkedValue?: string;
5626
+ referencedValue?: string;
5627
+ status?: string;
5628
+ static names(): {
5629
+ [key: string]: string;
5630
+ };
5631
+ static types(): {
5632
+ [key: string]: any;
5633
+ };
5634
+ validate(): void;
5635
+ constructor(map?: {
5636
+ [key: string]: any;
5637
+ });
5638
+ }
5639
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsCritical extends $dara.Model {
5640
+ expression?: string;
5641
+ operator?: string;
5642
+ value?: string;
5643
+ static names(): {
5644
+ [key: string]: string;
5645
+ };
5646
+ static types(): {
5647
+ [key: string]: any;
5648
+ };
5649
+ validate(): void;
5650
+ constructor(map?: {
5651
+ [key: string]: any;
5652
+ });
5653
+ }
5654
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsExpected extends $dara.Model {
5655
+ expression?: string;
5656
+ operator?: string;
5657
+ value?: string;
5658
+ static names(): {
5659
+ [key: string]: string;
5660
+ };
5661
+ static types(): {
5662
+ [key: string]: any;
5663
+ };
5664
+ validate(): void;
5665
+ constructor(map?: {
5666
+ [key: string]: any;
5667
+ });
5668
+ }
5669
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsWarned extends $dara.Model {
5670
+ expression?: string;
5671
+ operator?: string;
5672
+ value?: string;
5673
+ static names(): {
5674
+ [key: string]: string;
5675
+ };
5676
+ static types(): {
5677
+ [key: string]: any;
5678
+ };
5679
+ validate(): void;
5680
+ constructor(map?: {
5681
+ [key: string]: any;
5682
+ });
5683
+ }
5684
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholds extends $dara.Model {
5685
+ critical?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsCritical;
5686
+ expected?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsExpected;
5687
+ warned?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholdsWarned;
5688
+ static names(): {
5689
+ [key: string]: string;
5690
+ };
5691
+ static types(): {
5692
+ [key: string]: any;
5693
+ };
5694
+ validate(): void;
5695
+ constructor(map?: {
5696
+ [key: string]: any;
5697
+ });
5698
+ }
5699
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfig extends $dara.Model {
5700
+ referencedSamplesFilter?: string;
5701
+ thresholds?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfigThresholds;
5702
+ type?: string;
5703
+ static names(): {
5704
+ [key: string]: string;
5705
+ };
5706
+ static types(): {
5707
+ [key: string]: any;
5708
+ };
5709
+ validate(): void;
5710
+ constructor(map?: {
5711
+ [key: string]: any;
5712
+ });
5713
+ }
5714
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleErrorHandlers extends $dara.Model {
5715
+ errorDataFilter?: string;
5716
+ type?: string;
5717
+ static names(): {
5718
+ [key: string]: string;
5719
+ };
5720
+ static types(): {
5721
+ [key: string]: any;
5722
+ };
5723
+ validate(): void;
5724
+ constructor(map?: {
5725
+ [key: string]: any;
5726
+ });
5727
+ }
5728
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleSamplingConfig extends $dara.Model {
5729
+ metric?: string;
5730
+ metricParameters?: string;
5731
+ samplingFilter?: string;
5732
+ settingConfig?: string;
5733
+ static names(): {
5734
+ [key: string]: string;
5735
+ };
5736
+ static types(): {
5737
+ [key: string]: any;
5738
+ };
5739
+ validate(): void;
5740
+ constructor(map?: {
5741
+ [key: string]: any;
5742
+ });
5743
+ }
5744
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleTarget extends $dara.Model {
5745
+ databaseType?: string;
5746
+ tableGuid?: string;
5747
+ type?: string;
5748
+ static names(): {
5749
+ [key: string]: string;
5750
+ };
5751
+ static types(): {
5752
+ [key: string]: any;
5753
+ };
5754
+ validate(): void;
5755
+ constructor(map?: {
5756
+ [key: string]: any;
5757
+ });
5758
+ }
5759
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRule extends $dara.Model {
5760
+ checkingConfig?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleCheckingConfig;
5761
+ description?: string;
5762
+ enabled?: boolean;
5763
+ errorHandlers?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleErrorHandlers[];
5764
+ id?: number;
5765
+ name?: string;
5766
+ projectId?: number;
5767
+ samplingConfig?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleSamplingConfig;
5768
+ severity?: string;
5769
+ target?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRuleTarget;
5770
+ templateCode?: string;
5771
+ static names(): {
5772
+ [key: string]: string;
5773
+ };
5774
+ static types(): {
5775
+ [key: string]: any;
5776
+ };
5777
+ validate(): void;
5778
+ constructor(map?: {
5779
+ [key: string]: any;
5780
+ });
5781
+ }
5782
+ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResults extends $dara.Model {
5783
+ createTime?: number;
5784
+ details?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsDetails[];
5785
+ id?: number;
5786
+ rule?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResultsRule;
5787
+ sample?: string;
5788
+ status?: string;
5789
+ taskInstanceId?: number;
5790
+ static names(): {
5791
+ [key: string]: string;
5792
+ };
5793
+ static types(): {
5794
+ [key: string]: any;
5795
+ };
5796
+ validate(): void;
5797
+ constructor(map?: {
5798
+ [key: string]: any;
5799
+ });
5800
+ }
5614
5801
  export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskHooks extends $dara.Model {
5615
5802
  /**
5616
5803
  * @remarks
5617
- * Hook trigger condition. When this condition is met, hook action is triggered. Currently, only two conditional expressions are supported:
5804
+ * The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:
5618
5805
  *
5619
- * - Specify only one set of rule severity types AND rule verification status, such as `${severity} = = "High" AND ${status} = = "Critical"`, which indicates that in the executed rule, if the rule verification result of severity High is Critical, the condition is met.
5620
- * - Specify multiple sets of rule severity types AND rule verification status, such as `(${severity} = = "High" AND ${status} = "Critical") OR (${severity} = "Normal" AND ${status} = "Critical") OR (${severity} = "Normal" AND ${status} = "Error")`, if the rule verification result of severity High is Critical, the rule verification result of severity Normal is Critical, or the rule verification result of severity Normal is Error, the enumeration that satisfies the condition expression severity is consistent with the enumeration DataQualityRule in severity, and the enumeration of status is consistent with the status in DataQualityResult.
5806
+ * * Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.
5807
+ * * Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.
5621
5808
  *
5622
5809
  * @example
5623
5810
  * (${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
@@ -5721,10 +5908,10 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
5721
5908
  export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskNotifications extends $dara.Model {
5722
5909
  /**
5723
5910
  * @remarks
5724
- * The notification trigger condition. When this condition is met, a message notification is triggered. Currently, only two conditional expressions are supported:
5911
+ * The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:
5725
5912
  *
5726
- * - Specify only one set of rule severity types AND rule verification status, such as `${severity} = = "High" AND ${status} = = "Critical"`, which indicates that in the executed rule, if the rule verification result of severity High is Critical, the condition is met.
5727
- * - Specify multiple sets of rule severity types AND rule verification status, such as `(${severity} = = "High" AND ${status} = "Critical") OR (${severity} = "Normal" AND ${status} = "Critical") OR (${severity} = "Normal" AND ${status} = "Error")`, if the rule verification result of severity High is Critical, the rule verification result of severity Normal is Critical, or the rule verification result of severity Normal is Error, the enumeration that satisfies the condition expression severity is consistent with the enumeration DataQualityRule in severity, and the enumeration of status is consistent with the status in DataQualityResult.
5913
+ * * Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.
5914
+ * * Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.
5728
5915
  *
5729
5916
  * @example
5730
5917
  * ${severity} == "High" AND ${status} == "Critical"
@@ -5799,10 +5986,10 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
5799
5986
  taskIds?: number[];
5800
5987
  /**
5801
5988
  * @remarks
5802
- * Quality Monitoring trigger type:
5989
+ * The trigger type of the monitor. Valid values:
5803
5990
  *
5804
- * - ByManual: manually triggered. Default value
5805
- * - ByScheduledTaskInstance: triggered by associated scheduling tasks
5991
+ * * ByManual (default): The monitor is manually triggered.
5992
+ * * ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.
5806
5993
  *
5807
5994
  * @example
5808
5995
  * ByScheduledTaskInstance
@@ -5830,7 +6017,7 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
5830
6017
  description?: string;
5831
6018
  /**
5832
6019
  * @remarks
5833
- * Callback settings.
6020
+ * The hook.
5834
6021
  */
5835
6022
  hooks?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskHooks[];
5836
6023
  /**
@@ -5877,12 +6064,12 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
5877
6064
  runtimeConf?: string;
5878
6065
  /**
5879
6066
  * @remarks
5880
- * For more information, see DataQualityTarget monitoring objects for the sample data quality verification task. For more information, see DataQualityTarget.
6067
+ * The monitored object of the monitor.
5881
6068
  */
5882
6069
  target?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskTarget;
5883
6070
  /**
5884
6071
  * @remarks
5885
- * The trigger configuration of the data quality verification task.
6072
+ * The trigger configuration of the monitor.
5886
6073
  */
5887
6074
  trigger?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskTrigger;
5888
6075
  static names(): {
@@ -5938,6 +6125,7 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
5938
6125
  * 98330
5939
6126
  */
5940
6127
  projectId?: number;
6128
+ results?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceResults[];
5941
6129
  /**
5942
6130
  * @remarks
5943
6131
  * The status of the data quality monitoring instance.
@@ -10142,8 +10330,8 @@ export declare class GetWorkflowInstanceResponseBodyWorkflowInstance extends $da
10142
10330
  * @remarks
10143
10331
  * The environment of the workspace. Valid values:
10144
10332
  *
10145
- * * Prod: production environment
10146
- * * Dev: development environment
10333
+ * * Prod
10334
+ * * Dev
10147
10335
  *
10148
10336
  * @example
10149
10337
  * Prod
@@ -11528,7 +11716,7 @@ export declare class ListDIJobsResponseBodyPagingInfoDIJobs extends $dara.Model
11528
11716
  DIJobId?: number;
11529
11717
  /**
11530
11718
  * @remarks
11531
- * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, Datahub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive. If you do not configure this parameter, the API operation returns synchronization tasks that use all type of destinations.
11719
+ * The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, DataHub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive.
11532
11720
  *
11533
11721
  * @example
11534
11722
  * Hologres
@@ -12607,6 +12795,7 @@ export declare class ListDataQualityEvaluationTasksResponseBodyPagingInfoDataQua
12607
12795
  });
12608
12796
  }
12609
12797
  export declare class ListDataQualityEvaluationTasksResponseBodyPagingInfoDataQualityEvaluationTasks extends $dara.Model {
12798
+ dataSourceId?: number;
12610
12799
  /**
12611
12800
  * @remarks
12612
12801
  * The description of the data quality monitoring task. The description can be up to 65,535 characters in length.
@@ -14114,7 +14303,10 @@ export declare class ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource
14114
14303
  connectionProperties?: any;
14115
14304
  /**
14116
14305
  * @remarks
14117
- * The mode in which the data source is added. The mode varies based on the data source type. Valid values: InstanceMode, UrlMode, and CdhMode. The value InstanceMode indicates the instance mode. The value UrlMode indicates the connection string mode. The value CdhMode indicates the CDH cluster mode.
14306
+ * The mode in which the data source is added. The mode varies based on the data source type. Valid values:
14307
+ *
14308
+ * * InstanceMode: instance mode
14309
+ * * UrlMode: connection string mode
14118
14310
  *
14119
14311
  * @example
14120
14312
  * UrlMode
@@ -15076,9 +15268,6 @@ export declare class ListDownstreamTaskInstancesResponseBodyPagingInfoTaskInstan
15076
15268
  * @remarks
15077
15269
  * The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:
15078
15270
  *
15079
- * * Prod: production environment
15080
- * * Dev: development environment
15081
- *
15082
15271
  * @example
15083
15272
  * Prod
15084
15273
  *
@@ -18044,8 +18233,8 @@ export declare class ListProjectMembersResponseBodyPagingInfoProjectMembersRoles
18044
18233
  * @remarks
18045
18234
  * The type of the role. Valid values:
18046
18235
  *
18047
- * * UserCustom: custom role
18048
- * * System: built-in role
18236
+ * * UserCustom: user-defined role
18237
+ * * System: system role
18049
18238
  *
18050
18239
  * @example
18051
18240
  * System
@@ -20166,8 +20355,8 @@ export declare class ListUpstreamTaskInstancesResponseBodyPagingInfoTaskInstance
20166
20355
  * @remarks
20167
20356
  * The environment of the workspace. Valid values:
20168
20357
  *
20169
- * * Prod: production environment
20170
- * * Dev: development environment
20358
+ * * Prod
20359
+ * * Dev
20171
20360
  *
20172
20361
  * @example
20173
20362
  * Prod
@@ -21074,9 +21263,8 @@ export declare class ListUpstreamTasksResponseBodyPagingInfoTasks extends $dara.
21074
21263
  * @remarks
21075
21264
  * The instance generation mode. Valid values:
21076
21265
  *
21077
- * T+1
21078
- *
21079
- * Immediately
21266
+ * * T+1
21267
+ * * Immediately
21080
21268
  *
21081
21269
  * @example
21082
21270
  * T+1
@@ -21184,9 +21372,8 @@ export declare class ListUpstreamTasksResponseBodyPagingInfoTasks extends $dara.
21184
21372
  * @remarks
21185
21373
  * The scheduling dependency type. Valid values:
21186
21374
  *
21187
- * Normal: same-cycle scheduling dependency
21188
- *
21189
- * CrossCycle: cross-cycle scheduling dependency
21375
+ * * Normal: same-cycle scheduling dependency
21376
+ * * CrossCycle: cross-cycle scheduling dependency
21190
21377
  *
21191
21378
  * @example
21192
21379
  * Normal
@@ -22289,17 +22476,30 @@ export declare class TagDataAssetsRequestTags extends $dara.Model {
22289
22476
  }
22290
22477
  export declare class TestDataSourceConnectivityResponseBodyConnectivityDetailLogs extends $dara.Model {
22291
22478
  /**
22479
+ * @remarks
22480
+ * The code of the test item.
22481
+ *
22292
22482
  * @example
22293
22483
  * validate_input_parameters
22294
22484
  */
22295
22485
  code?: string;
22296
22486
  /**
22487
+ * @remarks
22488
+ * The end time of a step.
22489
+ *
22297
22490
  * @example
22298
22491
  * 1730217604002
22299
22492
  */
22300
22493
  endTime?: number;
22494
+ /**
22495
+ * @remarks
22496
+ * The name of the step.
22497
+ */
22301
22498
  message?: string;
22302
22499
  /**
22500
+ * @remarks
22501
+ * The start time of a step.
22502
+ *
22303
22503
  * @example
22304
22504
  * 1730217600001
22305
22505
  */
@@ -22316,12 +22516,23 @@ export declare class TestDataSourceConnectivityResponseBodyConnectivityDetailLog
22316
22516
  });
22317
22517
  }
22318
22518
  export declare class TestDataSourceConnectivityResponseBodyConnectivity extends $dara.Model {
22519
+ /**
22520
+ * @remarks
22521
+ * The error message returned if the connectivity test fails. No such a message is returned if the connectivity test is successful.
22522
+ */
22319
22523
  connectMessage?: string;
22320
22524
  /**
22525
+ * @remarks
22526
+ * The result of the connectivity test. Valid values: Connectable: The network can be connected. ConfigError: The network can be connected, but the configurations are incorrect. Unreachable: The network cannot be connected. Unsupport: An error is reported due to other causes. For example, the desired resource group is being initialized.
22527
+ *
22321
22528
  * @example
22322
22529
  * Connectable
22323
22530
  */
22324
22531
  connectState?: string;
22532
+ /**
22533
+ * @remarks
22534
+ * The detailed logs of each step in the connectivity test.
22535
+ */
22325
22536
  detailLogs?: TestDataSourceConnectivityResponseBodyConnectivityDetailLogs[];
22326
22537
  static names(): {
22327
22538
  [key: string]: string;
@@ -22832,7 +23043,7 @@ export declare class UpdateDIAlarmRuleRequestNotificationSettingsNotificationRec
22832
23043
  export declare class UpdateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
22833
23044
  /**
22834
23045
  * @remarks
22835
- * The duration of the alert suppression interval. Default value: 5. Unit: minutes.
23046
+ * This parameter is deprecated and replaced by the MuteInterval parameter.
22836
23047
  *
22837
23048
  * @example
22838
23049
  * 5
@@ -22872,7 +23083,7 @@ export declare class UpdateDIAlarmRuleRequestNotificationSettings extends $dara.
22872
23083
  export declare class UpdateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
22873
23084
  /**
22874
23085
  * @remarks
22875
- * The types of DDL operations for which the alert rule takes effect.
23086
+ * This parameter is deprecated and replaced by the DdlTypes parameter.
22876
23087
  *
22877
23088
  * @deprecated
22878
23089
  */
@@ -22927,7 +23138,7 @@ export declare class UpdateDIAlarmRuleRequestTriggerConditions extends $dara.Mod
22927
23138
  export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends $dara.Model {
22928
23139
  /**
22929
23140
  * @remarks
22930
- * The data type of the destination field.
23141
+ * 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.
22931
23142
  *
22932
23143
  * @example
22933
23144
  * text
@@ -22935,7 +23146,7 @@ export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends
22935
23146
  destinationDataType?: string;
22936
23147
  /**
22937
23148
  * @remarks
22938
- * The data type of the source field.
23149
+ * 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.
22939
23150
  *
22940
23151
  * @example
22941
23152
  * bigint
@@ -23017,14 +23228,14 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
23017
23228
  * @remarks
23018
23229
  * The name of the configuration item. Valid values:
23019
23230
  *
23020
- * * runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.
23021
- * * runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.
23022
- * * dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.
23023
- * * runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.
23024
- * * dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.
23025
- * * runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.
23026
- * * src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.
23027
- * * runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.
23231
+ * * 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.
23232
+ * * dst.offline.truncate: specifies whether to clear the destination table before data writing.
23233
+ * * runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.
23234
+ * * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
23235
+ * * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
23236
+ * * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
23237
+ * * 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.
23238
+ * * runtime.realtime.failover.times.dataxcdc: specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
23028
23239
  *
23029
23240
  * @example
23030
23241
  * runtime.offline.concurrent
@@ -23052,7 +23263,21 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
23052
23263
  export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
23053
23264
  /**
23054
23265
  * @remarks
23055
- * The channel control settings for the synchronization task. The value of this parameter must be a JSON string.
23266
+ * 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.
23267
+ *
23268
+ * 1. Holo2Kafka
23269
+ *
23270
+ * * Example: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}
23271
+ * * kafkaClientProperties: the parameters related to a Kafka producer, which are used when you read data from a Kafka data source.
23272
+ * * keyColumns: the names of Kafka columns to which you want to write data.
23273
+ * * writeMode: the writing format. Valid values: json and canal.
23274
+ *
23275
+ * 2. Holo2Holo
23276
+ *
23277
+ * * Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}
23278
+ * * conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.
23279
+ * * writeMode: the mode in which you want to write data to Hologres. Valid values: replay and insert.
23280
+ * * dynamicColumnAction: the mode in which you want to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
23056
23281
  *
23057
23282
  * @example
23058
23283
  * {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
@@ -23061,6 +23286,8 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
23061
23286
  /**
23062
23287
  * @remarks
23063
23288
  * The data type mappings between source fields and destination fields.
23289
+ *
23290
+ * > "ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]
23064
23291
  */
23065
23292
  columnDataTypeSettings?: UpdateDIJobRequestJobSettingsColumnDataTypeSettings[];
23066
23293
  /**
@@ -23071,6 +23298,8 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
23071
23298
  /**
23072
23299
  * @remarks
23073
23300
  * The processing settings for DDL messages.
23301
+ *
23302
+ * > "DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
23074
23303
  */
23075
23304
  ddlHandlingSettings?: UpdateDIJobRequestJobSettingsDdlHandlingSettings[];
23076
23305
  /**
@@ -23230,6 +23459,7 @@ export declare class UpdateDIJobRequestTableMappingsSourceObjectSelectionRules e
23230
23459
  * The object type. Valid values:
23231
23460
  *
23232
23461
  * * Table
23462
+ * * Schema
23233
23463
  * * Database
23234
23464
  *
23235
23465
  * @example
@@ -23275,6 +23505,7 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
23275
23505
  *
23276
23506
  * * Table
23277
23507
  * * Schema
23508
+ * * Database
23278
23509
  *
23279
23510
  * @example
23280
23511
  * Table
@@ -23294,12 +23525,12 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
23294
23525
  export declare class UpdateDIJobRequestTableMappings extends $dara.Model {
23295
23526
  /**
23296
23527
  * @remarks
23297
- * The list of rules used to select synchronization objects in the source. The objects can be databases or tables.
23528
+ * The list of rules that you want to use to select synchronization objects in the source.
23298
23529
  */
23299
23530
  sourceObjectSelectionRules?: UpdateDIJobRequestTableMappingsSourceObjectSelectionRules[];
23300
23531
  /**
23301
23532
  * @remarks
23302
- * The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.
23533
+ * The transformation rules that you want to apply to the synchronization objects selected from the source.
23303
23534
  */
23304
23535
  transformationRules?: UpdateDIJobRequestTableMappingsTransformationRules[];
23305
23536
  static names(): {
@@ -23322,6 +23553,9 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
23322
23553
  * * Rename
23323
23554
  * * AddColumn
23324
23555
  * * HandleDml
23556
+ * * DefineIncrementalCondition
23557
+ * * DefineCycleScheduleSettings
23558
+ * * DefinePartitionKey
23325
23559
  *
23326
23560
  * @example
23327
23561
  * Rename
@@ -23331,15 +23565,48 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
23331
23565
  * @remarks
23332
23566
  * The expression of the rule. The expression must be a JSON string.
23333
23567
  *
23334
- * Example of a renaming rule: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]}.
23568
+ * 1. Example of a renaming rule
23335
23569
  *
23336
- * expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. The variable name cannot be enclosed in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.
23570
+ * * Example: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }
23571
+ * * 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.
23337
23572
  *
23338
- * 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 you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue 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 indicates 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. Example of a rule used to specify primary key fields for a destination table: {"columns":["ukcolumn1","ukcolumn2"]}.
23573
+ * 2. Example of a column addition rule
23339
23574
  *
23340
- * 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. Example of a rule used to process DML messages: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.
23575
+ * * Example: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}
23576
+ * * If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.
23577
+ * * columnName: the name of the field that is added.
23578
+ * * columnValueType: the value type of the field. Valid values: Constant and Variable.
23579
+ * * 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.
23341
23580
  *
23342
- * 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.
23581
+ * 3. Example of a rule used to specify primary key fields for a destination table
23582
+ *
23583
+ * * Example: {"columns":["ukcolumn1","ukcolumn2"]}
23584
+ * * 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.
23585
+ * * 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.
23586
+ * * 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.
23587
+ *
23588
+ * 4. Example of a rule used to process DML messages
23589
+ *
23590
+ * * Example: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}
23591
+ * * If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.
23592
+ * * dmlType: the DML operation. Valid values: Insert, Update, and Delete.
23593
+ * * 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.
23594
+ * * filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.
23595
+ *
23596
+ * 5. Example of a rule used to perform incremental synchronization
23597
+ *
23598
+ * * Example: {"where":"id > 0"}
23599
+ * * You can configure such a rule to perform incremental synchronization.
23600
+ *
23601
+ * 6. Example of a rule used to configure scheduling parameters for an auto triggered task
23602
+ *
23603
+ * * Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}
23604
+ * * You can configure such a rule to configure scheduling parameters for an auto triggered task.
23605
+ *
23606
+ * 7. Example of a rule used to specify a partition key
23607
+ *
23608
+ * * Example: {"columns":["id"]}
23609
+ * * You can configure such a rule to specify a partition key.
23343
23610
  *
23344
23611
  * @example
23345
23612
  * {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
@@ -23359,6 +23626,7 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
23359
23626
  *
23360
23627
  * * Table
23361
23628
  * * Schema
23629
+ * * Database
23362
23630
  *
23363
23631
  * @example
23364
23632
  * Table
@@ -25234,8 +25502,8 @@ export declare class UpdateWorkflowRequestTasksTrigger extends $dara.Model {
25234
25502
  * @remarks
25235
25503
  * The trigger type. Valid values:
25236
25504
  *
25237
- * * Scheduler: periodic scheduling
25238
- * * Manual: manual scheduling
25505
+ * * Scheduler: scheduling cycle-based trigger
25506
+ * * Manual: manual trigger
25239
25507
  *
25240
25508
  * @example
25241
25509
  * Scheduler
@@ -25302,8 +25570,6 @@ export declare class UpdateWorkflowRequestTasks extends $dara.Model {
25302
25570
  * @remarks
25303
25571
  * The task ID. If you configure this parameter, full update is performed on the task. If you do not configure this parameter, another task is created.
25304
25572
  *
25305
- * This parameter is required.
25306
- *
25307
25573
  * @example
25308
25574
  * 1234
25309
25575
  */
@@ -26576,6 +26842,7 @@ export declare class CreateDIJobRequest extends $dara.Model {
26576
26842
  * 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.
26577
26843
  */
26578
26844
  jobSettings?: CreateDIJobRequestJobSettings;
26845
+ jobType?: string;
26579
26846
  /**
26580
26847
  * @remarks
26581
26848
  * The synchronization type. Valid values:
@@ -26702,6 +26969,7 @@ export declare class CreateDIJobShrinkRequest extends $dara.Model {
26702
26969
  * 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.
26703
26970
  */
26704
26971
  jobSettingsShrink?: string;
26972
+ jobType?: string;
26705
26973
  /**
26706
26974
  * @remarks
26707
26975
  * The synchronization type. Valid values:
@@ -27003,6 +27271,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
27003
27271
  * @remarks
27004
27272
  * The data source ID. You can call the [ListDataSources](https://help.aliyun.com/document_detail/211431.html) operation to query the ID.
27005
27273
  *
27274
+ * This parameter is required.
27275
+ *
27006
27276
  * @example
27007
27277
  * 1
27008
27278
  */
@@ -27041,6 +27311,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
27041
27311
  *
27042
27312
  * You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.
27043
27313
  *
27314
+ * This parameter is required.
27315
+ *
27044
27316
  * @example
27045
27317
  * 10000
27046
27318
  */
@@ -27063,6 +27335,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
27063
27335
  /**
27064
27336
  * @remarks
27065
27337
  * The monitored object of the monitor.
27338
+ *
27339
+ * This parameter is required.
27066
27340
  */
27067
27341
  target?: CreateDataQualityEvaluationTaskRequestTarget;
27068
27342
  /**
@@ -27091,6 +27365,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
27091
27365
  * @remarks
27092
27366
  * The data source ID. You can call the [ListDataSources](https://help.aliyun.com/document_detail/211431.html) operation to query the ID.
27093
27367
  *
27368
+ * This parameter is required.
27369
+ *
27094
27370
  * @example
27095
27371
  * 1
27096
27372
  */
@@ -27129,6 +27405,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
27129
27405
  *
27130
27406
  * You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.
27131
27407
  *
27408
+ * This parameter is required.
27409
+ *
27132
27410
  * @example
27133
27411
  * 10000
27134
27412
  */
@@ -27151,6 +27429,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
27151
27429
  /**
27152
27430
  * @remarks
27153
27431
  * The monitored object of the monitor.
27432
+ *
27433
+ * This parameter is required.
27154
27434
  */
27155
27435
  targetShrink?: string;
27156
27436
  /**
@@ -29483,14 +29763,15 @@ export declare class CreateWorkflowInstancesRequest extends $dara.Model {
29483
29763
  comment?: string;
29484
29764
  /**
29485
29765
  * @remarks
29486
- * Runtime configuration.
29766
+ * The runtime configuration.
29487
29767
  */
29488
29768
  defaultRunProperties?: CreateWorkflowInstancesRequestDefaultRunProperties;
29489
29769
  /**
29490
29770
  * @remarks
29491
- * The project environment.
29492
- * - Prod (production)
29493
- * - Dev
29771
+ * The environment of the workspace. Valid values:
29772
+ *
29773
+ * * Prod: production environment
29774
+ * * Dev: development environment
29494
29775
  *
29495
29776
  * @example
29496
29777
  * Prod
@@ -29534,10 +29815,10 @@ export declare class CreateWorkflowInstancesRequest extends $dara.Model {
29534
29815
  taskParameters?: string;
29535
29816
  /**
29536
29817
  * @remarks
29537
- * The type of the workflow instance.
29818
+ * The type of the workflow instance. Valid values:
29538
29819
  *
29539
- * - SupplementData: Retroactive data
29540
- * - ManualWorkflow: manual workflow
29820
+ * * SupplementData
29821
+ * * ManualWorkflow
29541
29822
  *
29542
29823
  * This parameter is required.
29543
29824
  *
@@ -29596,14 +29877,15 @@ export declare class CreateWorkflowInstancesShrinkRequest extends $dara.Model {
29596
29877
  comment?: string;
29597
29878
  /**
29598
29879
  * @remarks
29599
- * Runtime configuration.
29880
+ * The runtime configuration.
29600
29881
  */
29601
29882
  defaultRunPropertiesShrink?: string;
29602
29883
  /**
29603
29884
  * @remarks
29604
- * The project environment.
29605
- * - Prod (production)
29606
- * - Dev
29885
+ * The environment of the workspace. Valid values:
29886
+ *
29887
+ * * Prod: production environment
29888
+ * * Dev: development environment
29607
29889
  *
29608
29890
  * @example
29609
29891
  * Prod
@@ -29647,10 +29929,10 @@ export declare class CreateWorkflowInstancesShrinkRequest extends $dara.Model {
29647
29929
  taskParameters?: string;
29648
29930
  /**
29649
29931
  * @remarks
29650
- * The type of the workflow instance.
29932
+ * The type of the workflow instance. Valid values:
29651
29933
  *
29652
- * - SupplementData: Retroactive data
29653
- * - ManualWorkflow: manual workflow
29934
+ * * SupplementData
29935
+ * * ManualWorkflow
29654
29936
  *
29655
29937
  * This parameter is required.
29656
29938
  *
@@ -29803,6 +30085,8 @@ export declare class DeleteAlertRuleResponse extends $dara.Model {
29803
30085
  export declare class DeleteCertificateRequest extends $dara.Model {
29804
30086
  /**
29805
30087
  * @remarks
30088
+ * The ID of the certificate file.
30089
+ *
29806
30090
  * This parameter is required.
29807
30091
  *
29808
30092
  * @example
@@ -29810,6 +30094,9 @@ export declare class DeleteCertificateRequest extends $dara.Model {
29810
30094
  */
29811
30095
  id?: number;
29812
30096
  /**
30097
+ * @remarks
30098
+ * The ID of the workspace to which the certificate file belongs.
30099
+ *
29813
30100
  * @example
29814
30101
  * 106560
29815
30102
  */
@@ -29827,11 +30114,17 @@ export declare class DeleteCertificateRequest extends $dara.Model {
29827
30114
  }
29828
30115
  export declare class DeleteCertificateResponseBody extends $dara.Model {
29829
30116
  /**
30117
+ * @remarks
30118
+ * The request ID.
30119
+ *
29830
30120
  * @example
29831
30121
  * D9A61DC0-B922-421B-B706
29832
30122
  */
29833
30123
  requestId?: string;
29834
30124
  /**
30125
+ * @remarks
30126
+ * Indicates whether the request was successful.
30127
+ *
29835
30128
  * @example
29836
30129
  * true
29837
30130
  */
@@ -30800,7 +31093,7 @@ export declare class DeleteProjectMemberRequest extends $dara.Model {
30800
31093
  projectId?: number;
30801
31094
  /**
30802
31095
  * @remarks
30803
- * The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.
31096
+ * The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the **Tenant Members and Roles** page, view the ID of the account used by the member in the workspace.
30804
31097
  *
30805
31098
  * This parameter is required.
30806
31099
  *
@@ -32109,10 +32402,10 @@ export declare class GetDIJobLogRequest extends $dara.Model {
32109
32402
  instanceId?: number;
32110
32403
  /**
32111
32404
  * @remarks
32112
- * Node type. Currently, it is only applicable in the view resource group 2.0 task:
32405
+ * The type of the node. This parameter is applicable only to the tasks that are run on serverless resource groups. Valid values:
32113
32406
  *
32114
- * - MASTER: obtains logs of JobManager.
32115
- * - WORKER: obtains logs of TaskManager.
32407
+ * * **MASTER**: the master node, which is used to query the logs of JobManagers.
32408
+ * * **WORKER**: the worker node, which is used to query the logs of TaskManagers.
32116
32409
  *
32117
32410
  * @example
32118
32411
  * MASTER
@@ -32941,7 +33234,7 @@ export declare class GetProjectMemberRequest extends $dara.Model {
32941
33234
  projectId?: number;
32942
33235
  /**
32943
33236
  * @remarks
32944
- * The ID of the account used by the member. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the IDs of the accounts used by the members in the workspace.
33237
+ * The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.
32945
33238
  *
32946
33239
  * This parameter is required.
32947
33240
  *
@@ -35981,7 +36274,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
35981
36274
  * * Desc: descending order
35982
36275
  * * Asc: ascending order
35983
36276
  *
35984
- * Default value: Asc
36277
+ * Default value: Desc
35985
36278
  *
35986
36279
  * @example
35987
36280
  * Asc
@@ -36023,7 +36316,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
36023
36316
  * * Id
36024
36317
  * * Name
36025
36318
  *
36026
- * Default value: Id
36319
+ * Default value: CreateTime
36027
36320
  *
36028
36321
  * @example
36029
36322
  * Id
@@ -36034,7 +36327,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
36034
36327
  * The tag of the data source. This parameter specifies a filter condition.
36035
36328
  *
36036
36329
  * * You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.
36037
- * * If you do not configure this parameter, tag-based filtering is not performed.
36330
+ * * If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.
36038
36331
  *
36039
36332
  * @example
36040
36333
  * ["tag1", "tag2", "tag3"]
@@ -36083,7 +36376,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
36083
36376
  * * Desc: descending order
36084
36377
  * * Asc: ascending order
36085
36378
  *
36086
- * Default value: Asc
36379
+ * Default value: Desc
36087
36380
  *
36088
36381
  * @example
36089
36382
  * Asc
@@ -36125,7 +36418,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
36125
36418
  * * Id
36126
36419
  * * Name
36127
36420
  *
36128
- * Default value: Id
36421
+ * Default value: CreateTime
36129
36422
  *
36130
36423
  * @example
36131
36424
  * Id
@@ -36136,7 +36429,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
36136
36429
  * The tag of the data source. This parameter specifies a filter condition.
36137
36430
  *
36138
36431
  * * You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.
36139
- * * If you do not configure this parameter, tag-based filtering is not performed.
36432
+ * * If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.
36140
36433
  *
36141
36434
  * @example
36142
36435
  * ["tag1", "tag2", "tag3"]
@@ -37305,18 +37598,6 @@ export declare class ListProjectsRequest extends $dara.Model {
37305
37598
  * * Updating
37306
37599
  * * UpdateFailed
37307
37600
  *
37308
- * <!---->
37309
- *
37310
- * *
37311
- * *
37312
- * *
37313
- * *
37314
- * *
37315
- * *
37316
- * *
37317
- * *
37318
- * *
37319
- *
37320
37601
  * @example
37321
37602
  * Available
37322
37603
  */
@@ -37421,18 +37702,6 @@ export declare class ListProjectsShrinkRequest extends $dara.Model {
37421
37702
  * * Updating
37422
37703
  * * UpdateFailed
37423
37704
  *
37424
- * <!---->
37425
- *
37426
- * *
37427
- * *
37428
- * *
37429
- * *
37430
- * *
37431
- * *
37432
- * *
37433
- * *
37434
- * *
37435
- *
37436
37705
  * @example
37437
37706
  * Available
37438
37707
  */
@@ -38645,7 +38914,28 @@ export declare class ListTasksRequest extends $dara.Model {
38645
38914
  sortBy?: string;
38646
38915
  /**
38647
38916
  * @remarks
38648
- * The type of the task.
38917
+ * The type of the task. Valid values:
38918
+ *
38919
+ * * ODPS_SQL
38920
+ * * SPARK
38921
+ * * PY_ODPS
38922
+ * * PY_ODPS3
38923
+ * * ODPS_SCRIPT
38924
+ * * ODPS_MR
38925
+ * * COMPONENT_SQL
38926
+ * * EMR_HIVE
38927
+ * * EMR_MR
38928
+ * * EMR_SPARK_SQL
38929
+ * * EMR_SPARK
38930
+ * * EMR_SHELL
38931
+ * * EMR_PRESTO
38932
+ * * EMR_IMPALA
38933
+ * * SPARK_STREAMING
38934
+ * * EMR_KYUUBI
38935
+ * * EMR_TRINO
38936
+ * * HOLOGRES_SQL
38937
+ * * HOLOGRES_SYNC_DDL
38938
+ * * HOLOGRES_SYNC_DATA
38649
38939
  *
38650
38940
  * @example
38651
38941
  * ODPS_SQL
@@ -38784,7 +39074,28 @@ export declare class ListTasksShrinkRequest extends $dara.Model {
38784
39074
  sortBy?: string;
38785
39075
  /**
38786
39076
  * @remarks
38787
- * The type of the task.
39077
+ * The type of the task. Valid values:
39078
+ *
39079
+ * * ODPS_SQL
39080
+ * * SPARK
39081
+ * * PY_ODPS
39082
+ * * PY_ODPS3
39083
+ * * ODPS_SCRIPT
39084
+ * * ODPS_MR
39085
+ * * COMPONENT_SQL
39086
+ * * EMR_HIVE
39087
+ * * EMR_MR
39088
+ * * EMR_SPARK_SQL
39089
+ * * EMR_SPARK
39090
+ * * EMR_SHELL
39091
+ * * EMR_PRESTO
39092
+ * * EMR_IMPALA
39093
+ * * SPARK_STREAMING
39094
+ * * EMR_KYUUBI
39095
+ * * EMR_TRINO
39096
+ * * HOLOGRES_SQL
39097
+ * * HOLOGRES_SYNC_DDL
39098
+ * * HOLOGRES_SYNC_DATA
38788
39099
  *
38789
39100
  * @example
38790
39101
  * ODPS_SQL
@@ -38987,9 +39298,7 @@ export declare class ListUpstreamTasksRequest extends $dara.Model {
38987
39298
  pageSize?: number;
38988
39299
  /**
38989
39300
  * @remarks
38990
- * The environment of the workspace.
38991
- *
38992
- * Valid values:
39301
+ * The environment of the workspace. Valid values:
38993
39302
  *
38994
39303
  * * Prod: production environment
38995
39304
  * * Dev: development environment
@@ -41679,6 +41988,8 @@ export declare class TagDataAssetsResponse extends $dara.Model {
41679
41988
  export declare class TestDataSourceConnectivityRequest extends $dara.Model {
41680
41989
  /**
41681
41990
  * @remarks
41991
+ * The ID of the data source for which you want to test the network connectivity.
41992
+ *
41682
41993
  * This parameter is required.
41683
41994
  *
41684
41995
  * @example
@@ -41687,6 +41998,8 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
41687
41998
  dataSourceId?: number;
41688
41999
  /**
41689
42000
  * @remarks
42001
+ * The DataWorks workspace ID.
42002
+ *
41690
42003
  * This parameter is required.
41691
42004
  *
41692
42005
  * @example
@@ -41695,6 +42008,8 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
41695
42008
  projectId?: number;
41696
42009
  /**
41697
42010
  * @remarks
42011
+ * The resource group ID.
42012
+ *
41698
42013
  * This parameter is required.
41699
42014
  *
41700
42015
  * @example
@@ -41713,8 +42028,15 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
41713
42028
  });
41714
42029
  }
41715
42030
  export declare class TestDataSourceConnectivityResponseBody extends $dara.Model {
42031
+ /**
42032
+ * @remarks
42033
+ * The details of the connectivity test.
42034
+ */
41716
42035
  connectivity?: TestDataSourceConnectivityResponseBodyConnectivity;
41717
42036
  /**
42037
+ * @remarks
42038
+ * The request ID.
42039
+ *
41718
42040
  * @example
41719
42041
  * 4CDF7B72-020B-542A-8465-21CFFA81****
41720
42042
  */
@@ -42422,11 +42744,15 @@ export declare class UpdateDIJobRequest extends $dara.Model {
42422
42744
  /**
42423
42745
  * @remarks
42424
42746
  * 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.
42747
+ *
42748
+ * > [ { "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" } ] } ]
42425
42749
  */
42426
42750
  tableMappings?: UpdateDIJobRequestTableMappings[];
42427
42751
  /**
42428
42752
  * @remarks
42429
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
42753
+ * The list of transformation rules for objects involved in the synchronization task.
42754
+ *
42755
+ * > [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
42430
42756
  */
42431
42757
  transformationRules?: UpdateDIJobRequestTransformationRules[];
42432
42758
  static names(): {
@@ -42490,11 +42816,15 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
42490
42816
  /**
42491
42817
  * @remarks
42492
42818
  * 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.
42819
+ *
42820
+ * > [ { "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" } ] } ]
42493
42821
  */
42494
42822
  tableMappingsShrink?: string;
42495
42823
  /**
42496
42824
  * @remarks
42497
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
42825
+ * The list of transformation rules for objects involved in the synchronization task.
42826
+ *
42827
+ * > [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
42498
42828
  */
42499
42829
  transformationRulesShrink?: string;
42500
42830
  static names(): {
@@ -42975,7 +43305,7 @@ export declare class UpdateDataQualityRuleRequest extends $dara.Model {
42975
43305
  samplingConfig?: UpdateDataQualityRuleRequestSamplingConfig;
42976
43306
  /**
42977
43307
  * @remarks
42978
- * The strength of the rule.
43308
+ * The strength of the rule. Valid values:
42979
43309
  *
42980
43310
  * * Normal
42981
43311
  * * High
@@ -43060,7 +43390,7 @@ export declare class UpdateDataQualityRuleShrinkRequest extends $dara.Model {
43060
43390
  samplingConfigShrink?: string;
43061
43391
  /**
43062
43392
  * @remarks
43063
- * The strength of the rule.
43393
+ * The strength of the rule. Valid values:
43064
43394
  *
43065
43395
  * * Normal
43066
43396
  * * High
@@ -45141,7 +45471,7 @@ export default class Client extends OpenApi {
45141
45471
  */
45142
45472
  createDataQualityEvaluationTask(request: CreateDataQualityEvaluationTaskRequest): Promise<CreateDataQualityEvaluationTaskResponse>;
45143
45473
  /**
45144
- * Creates a monitor instance
45474
+ * Creates a monitor instance.
45145
45475
  *
45146
45476
  * @param tmpReq - CreateDataQualityEvaluationTaskInstanceRequest
45147
45477
  * @param runtime - runtime options for this request RuntimeOptions
@@ -45149,7 +45479,7 @@ export default class Client extends OpenApi {
45149
45479
  */
45150
45480
  createDataQualityEvaluationTaskInstanceWithOptions(tmpReq: CreateDataQualityEvaluationTaskInstanceRequest, runtime: $dara.RuntimeOptions): Promise<CreateDataQualityEvaluationTaskInstanceResponse>;
45151
45481
  /**
45152
- * Creates a monitor instance
45482
+ * Creates a monitor instance.
45153
45483
  *
45154
45484
  * @param request - CreateDataQualityEvaluationTaskInstanceRequest
45155
45485
  * @returns CreateDataQualityEvaluationTaskInstanceResponse
@@ -45453,7 +45783,7 @@ export default class Client extends OpenApi {
45453
45783
  */
45454
45784
  createWorkflowInstances(request: CreateWorkflowInstancesRequest): Promise<CreateWorkflowInstancesResponse>;
45455
45785
  /**
45456
- * Deletes a custom alert monitoring rule.
45786
+ * Deletes a custom monitoring alert rule.
45457
45787
  *
45458
45788
  * @param request - DeleteAlertRuleRequest
45459
45789
  * @param runtime - runtime options for this request RuntimeOptions
@@ -45461,14 +45791,18 @@ export default class Client extends OpenApi {
45461
45791
  */
45462
45792
  deleteAlertRuleWithOptions(request: DeleteAlertRuleRequest, runtime: $dara.RuntimeOptions): Promise<DeleteAlertRuleResponse>;
45463
45793
  /**
45464
- * Deletes a custom alert monitoring rule.
45794
+ * Deletes a custom monitoring alert rule.
45465
45795
  *
45466
45796
  * @param request - DeleteAlertRuleRequest
45467
45797
  * @returns DeleteAlertRuleResponse
45468
45798
  */
45469
45799
  deleteAlertRule(request: DeleteAlertRuleRequest): Promise<DeleteAlertRuleResponse>;
45470
45800
  /**
45471
- * 删除认证文件
45801
+ * Deletes a certificate file.
45802
+ *
45803
+ * @remarks
45804
+ * 1. This API operation is available for all DataWorks editions.
45805
+ * 2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.
45472
45806
  *
45473
45807
  * @param request - DeleteCertificateRequest
45474
45808
  * @param runtime - runtime options for this request RuntimeOptions
@@ -45476,7 +45810,11 @@ export default class Client extends OpenApi {
45476
45810
  */
45477
45811
  deleteCertificateWithOptions(request: DeleteCertificateRequest, runtime: $dara.RuntimeOptions): Promise<DeleteCertificateResponse>;
45478
45812
  /**
45479
- * 删除认证文件
45813
+ * Deletes a certificate file.
45814
+ *
45815
+ * @remarks
45816
+ * 1. This API operation is available for all DataWorks editions.
45817
+ * 2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.
45480
45818
  *
45481
45819
  * @param request - DeleteCertificateRequest
45482
45820
  * @returns DeleteCertificateResponse
@@ -46478,7 +46816,7 @@ export default class Client extends OpenApi {
46478
46816
  */
46479
46817
  grantMemberProjectRoles(request: GrantMemberProjectRolesRequest): Promise<GrantMemberProjectRolesResponse>;
46480
46818
  /**
46481
- * 验证用
46819
+ * Imports a certificate file.
46482
46820
  *
46483
46821
  * @param request - ImportCertificateRequest
46484
46822
  * @param runtime - runtime options for this request RuntimeOptions
@@ -46486,7 +46824,7 @@ export default class Client extends OpenApi {
46486
46824
  */
46487
46825
  importCertificateWithOptions(request: ImportCertificateRequest, runtime: $dara.RuntimeOptions): Promise<ImportCertificateResponse>;
46488
46826
  /**
46489
- * 验证用
46827
+ * Imports a certificate file.
46490
46828
  *
46491
46829
  * @param request - ImportCertificateRequest
46492
46830
  * @returns ImportCertificateResponse
@@ -47607,7 +47945,11 @@ export default class Client extends OpenApi {
47607
47945
  */
47608
47946
  tagDataAssets(request: TagDataAssetsRequest): Promise<TagDataAssetsResponse>;
47609
47947
  /**
47610
- * 测试数据源在资源组上的连通性
47948
+ * Tests the network connectivity between a resource group and a data source.
47949
+ *
47950
+ * @remarks
47951
+ * 1. This API operation is available for all DataWorks editions.
47952
+ * 2. Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M
47611
47953
  *
47612
47954
  * @param request - TestDataSourceConnectivityRequest
47613
47955
  * @param runtime - runtime options for this request RuntimeOptions
@@ -47615,7 +47957,11 @@ export default class Client extends OpenApi {
47615
47957
  */
47616
47958
  testDataSourceConnectivityWithOptions(request: TestDataSourceConnectivityRequest, runtime: $dara.RuntimeOptions): Promise<TestDataSourceConnectivityResponse>;
47617
47959
  /**
47618
- * 测试数据源在资源组上的连通性
47960
+ * Tests the network connectivity between a resource group and a data source.
47961
+ *
47962
+ * @remarks
47963
+ * 1. This API operation is available for all DataWorks editions.
47964
+ * 2. Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M
47619
47965
  *
47620
47966
  * @param request - TestDataSourceConnectivityRequest
47621
47967
  * @returns TestDataSourceConnectivityResponse