@alicloud/adb20211201 5.5.0 → 5.5.1

package/src/models/CreateApsKafkaHudiJobRequest.ts

@@ -65,8 +65,8 @@ export class CreateApsKafkaHudiJobRequestColumns extends $dara.Model {
 export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The RAM role of a trusted entity that is an Alibaba Cloud account. For more information about how to create a RAM role, see Create a RAM role for a trusted Alibaba Cloud account.
-   * The Alibaba Cloud account that owns the AnalyticDB for MySQL cluster must be added as a trusted account to the RAM role.
+   * The RAM role whose trusted entity is an Alibaba Cloud account. For more information about how to create a RAM role, see Create a RAM role for a trusted Alibaba Cloud account.
+   * In the RAM role, the Alibaba Cloud account to which AnalyticDB for MySQL belongs must be configured as a trusted account for the Alibaba Cloud account to which the Kafka instance belongs.
    * 
    * @example
    * aps
@@ -82,7 +82,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   acrossUid?: string;
   /**
    * @remarks
-   * The advanced configuration.
+   * The advanced configurations.
    * 
    * @example
    * -
@@ -98,8 +98,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to view the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in the destination region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (3.0) clusters in the specified region.
    * 
    * This parameter is required.
    * 
@@ -117,9 +116,9 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   dataFormatType?: string;
   /**
    * @remarks
-   * The valid values and their descriptions are as follows:
-   * Single: The source is a single-line JSON record.
-   * Multi: The source is a JSON array. A single JSON record is returned as the output.
+   * The data output format. Valid values:
+   * - Single: The source is a single-line JSON record.
+   * - Multi: The source is a JSON array. A single JSON record must be output.
    * 
    * @example
    * Single
@@ -135,7 +134,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   datasourceId?: number;
   /**
    * @remarks
-   * The user-defined name of the database.
+   * The custom database name.
    * 
    * This parameter is required.
    * 
@@ -145,7 +144,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
-   * The configuration for full synchronization.
+   * The full synchronization configurations.
    * 
    * @example
    * 2ACU
@@ -153,7 +152,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   fullComputeUnit?: string;
   /**
    * @remarks
-   * The Hudi configuration for the destination.
+   * The destination Hudi configurations.
    * 
    * @example
    * hoodie.keep.min.commits=20
@@ -161,7 +160,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   hudiAdvancedConfig?: string;
   /**
    * @remarks
-   * The configuration for incremental synchronization.
+   * The incremental synchronization configurations.
    * 
    * This parameter is required.
    * 
@@ -171,13 +170,13 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   incrementalComputeUnit?: string;
   /**
    * @remarks
-   * The number of nested JSON layers to parse. Valid values:
-   * 0: No parsing is performed.
-   * 1: One layer is parsed.
-   * 2: Two layers are parsed.
-   * 3: Three layers are parsed.
-   * 4: Four layers are parsed.
-   * By default, one layer is parsed. For more information about the JSON parsing policy for nested data, see JSON parsing levels and schema field inference examples.
+   * The nesting parse level for JSON. Valid values:
+   * - 0: No parsing.
+   * - 1: Parse one level.
+   * - 2: Parse two levels.
+   * - 3: Parse three levels.
+   * - 4: Parse four levels.
+   * Default value: 1. For more information about the JSON nesting parse strategy, see JSON parse levels and schema field inference examples.
    * 
    * @example
    * 0
@@ -185,7 +184,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   jsonParseLevel?: number;
   /**
    * @remarks
-   * The ID of the Kafka instance. Obtain the ID from the Kafka console.
+   * Instance ID of the Kafka instance. You can obtain instance ID in the Kafka console.
    * 
    * @example
    * xxx
@@ -193,7 +192,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   kafkaClusterId?: string;
   /**
    * @remarks
-   * The ID of the Kafka topic. Obtain the ID from the Kafka console.
+   * The ID of the Kafka topic. You can obtain the ID in the Kafka console.
    * 
    * @example
    * test
@@ -209,7 +208,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   lakehouseId?: number;
   /**
    * @remarks
-   * The number of entries to consume in a single batch.
+   * The maximum number of messages to consume per trigger.
    * 
    * @example
    * 50000
@@ -217,7 +216,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   maxOffsetsPerTrigger?: number;
   /**
    * @remarks
-   * The destination lakehouse address. This must be a complete OSS path.
+   * The destination lakehouse address, which is a complete OSS path.
    * 
    * @example
    * oss://test-xx-zzz/yyy/
@@ -241,16 +240,16 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   partitionSpecs?: { [key: string]: any }[];
   /**
    * @remarks
-   * The primary key settings. This parameter supports the UUID policy and the mapping policy. The policies are described as follows.
-   * UUID policy: "Strategy": "uuid".
-   * Mapping policy:
+   * The primary key settings, including the UUID strategy and the mapping strategy. Details:
+   * UUID strategy: "Strategy": "uuid".
+   * Mapping strategy:
    * "Strategy": "mapping",
    * "Values":[
-   * "f1",
-   * "f2"
+   *  "f1",
+   *  "f2"
    * ],
    * "RecordVersionField","xxx"
-   * \\`RecordVersionField\\` specifies the Hudi record version.
+   * RecordVersionField specifies the Hudi record version.
    * 
    * @example
    * "Strategy": "mapping"
@@ -286,10 +285,10 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   sourceRegionId?: string;
   /**
    * @remarks
-   * The initial consumer offset for Kafka.
-   * Valid values:
-   * begin_cursor, end_cursor, and timestamp.
-   * These values correspond to the earliest offset, the latest offset, and a specified time.
+   * The starting consumption offset for Kafka. Valid values:
+   * - begin_cursor: The earliest offset.
+   * - end_cursor: The latest offset.
+   * - timestamp: A specified time.
    * 
    * This parameter is required.
    * 
@@ -299,7 +298,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   startingOffsets?: string;
   /**
    * @remarks
-   * The user-defined name of the table.
+   * The custom table name.
    * 
    * This parameter is required.
    * 
@@ -309,7 +308,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The generation rule for the destination.
+   * The destination generation rule.
    * 
    * @example
    * xxx
@@ -317,7 +316,7 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   targetGenerateRule?: string;
   /**
    * @remarks
-   * The type of the destination.
+   * The destination type.
    * 
    * @example
    * OSS

package/src/models/CreateApsKafkaHudiJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApsKafkaHudiJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The same as the HTTP status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -45,8 +45,9 @@ export class CreateApsKafkaHudiJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
-   * True: The request was successful. False: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - true: The request is successful.
+   * - false: The request fails.
    * 
    * @example
    * true

package/src/models/CreateApsKafkaHudiJobShrinkRequest.ts

@@ -5,8 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The RAM role of a trusted entity that is an Alibaba Cloud account. For more information about how to create a RAM role, see Create a RAM role for a trusted Alibaba Cloud account.
-   * The Alibaba Cloud account that owns the AnalyticDB for MySQL cluster must be added as a trusted account to the RAM role.
+   * The RAM role whose trusted entity is an Alibaba Cloud account. For more information about how to create a RAM role, see Create a RAM role for a trusted Alibaba Cloud account.
+   * In the RAM role, the Alibaba Cloud account to which AnalyticDB for MySQL belongs must be configured as a trusted account for the Alibaba Cloud account to which the Kafka instance belongs.
    * 
    * @example
    * aps
@@ -22,7 +22,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   acrossUid?: string;
   /**
    * @remarks
-   * The advanced configuration.
+   * The advanced configurations.
    * 
    * @example
    * -
@@ -38,8 +38,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to view the cluster IDs of all AnalyticDB for MySQL Data Lakehouse Edition (V3.0) clusters in the destination region.
+   * > You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL Data Lakehouse Edition (3.0) clusters in the specified region.
    * 
    * This parameter is required.
    * 
@@ -57,9 +56,9 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   dataFormatType?: string;
   /**
    * @remarks
-   * The valid values and their descriptions are as follows:
-   * Single: The source is a single-line JSON record.
-   * Multi: The source is a JSON array. A single JSON record is returned as the output.
+   * The data output format. Valid values:
+   * - Single: The source is a single-line JSON record.
+   * - Multi: The source is a JSON array. A single JSON record must be output.
    * 
    * @example
    * Single
@@ -75,7 +74,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   datasourceId?: number;
   /**
    * @remarks
-   * The user-defined name of the database.
+   * The custom database name.
    * 
    * This parameter is required.
    * 
@@ -85,7 +84,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
-   * The configuration for full synchronization.
+   * The full synchronization configurations.
    * 
    * @example
    * 2ACU
@@ -93,7 +92,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   fullComputeUnit?: string;
   /**
    * @remarks
-   * The Hudi configuration for the destination.
+   * The destination Hudi configurations.
    * 
    * @example
    * hoodie.keep.min.commits=20
@@ -101,7 +100,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   hudiAdvancedConfig?: string;
   /**
    * @remarks
-   * The configuration for incremental synchronization.
+   * The incremental synchronization configurations.
    * 
    * This parameter is required.
    * 
@@ -111,13 +110,13 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   incrementalComputeUnit?: string;
   /**
    * @remarks
-   * The number of nested JSON layers to parse. Valid values:
-   * 0: No parsing is performed.
-   * 1: One layer is parsed.
-   * 2: Two layers are parsed.
-   * 3: Three layers are parsed.
-   * 4: Four layers are parsed.
-   * By default, one layer is parsed. For more information about the JSON parsing policy for nested data, see JSON parsing levels and schema field inference examples.
+   * The nesting parse level for JSON. Valid values:
+   * - 0: No parsing.
+   * - 1: Parse one level.
+   * - 2: Parse two levels.
+   * - 3: Parse three levels.
+   * - 4: Parse four levels.
+   * Default value: 1. For more information about the JSON nesting parse strategy, see JSON parse levels and schema field inference examples.
    * 
    * @example
    * 0
@@ -125,7 +124,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   jsonParseLevel?: number;
   /**
    * @remarks
-   * The ID of the Kafka instance. Obtain the ID from the Kafka console.
+   * Instance ID of the Kafka instance. You can obtain instance ID in the Kafka console.
    * 
    * @example
    * xxx
@@ -133,7 +132,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   kafkaClusterId?: string;
   /**
    * @remarks
-   * The ID of the Kafka topic. Obtain the ID from the Kafka console.
+   * The ID of the Kafka topic. You can obtain the ID in the Kafka console.
    * 
    * @example
    * test
@@ -149,7 +148,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   lakehouseId?: number;
   /**
    * @remarks
-   * The number of entries to consume in a single batch.
+   * The maximum number of messages to consume per trigger.
    * 
    * @example
    * 50000
@@ -157,7 +156,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   maxOffsetsPerTrigger?: number;
   /**
    * @remarks
-   * The destination lakehouse address. This must be a complete OSS path.
+   * The destination lakehouse address, which is a complete OSS path.
    * 
    * @example
    * oss://test-xx-zzz/yyy/
@@ -181,16 +180,16 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   partitionSpecsShrink?: string;
   /**
    * @remarks
-   * The primary key settings. This parameter supports the UUID policy and the mapping policy. The policies are described as follows.
-   * UUID policy: "Strategy": "uuid".
-   * Mapping policy:
+   * The primary key settings, including the UUID strategy and the mapping strategy. Details:
+   * UUID strategy: "Strategy": "uuid".
+   * Mapping strategy:
    * "Strategy": "mapping",
    * "Values":[
-   * "f1",
-   * "f2"
+   *  "f1",
+   *  "f2"
    * ],
    * "RecordVersionField","xxx"
-   * \\`RecordVersionField\\` specifies the Hudi record version.
+   * RecordVersionField specifies the Hudi record version.
    * 
    * @example
    * "Strategy": "mapping"
@@ -226,10 +225,10 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   sourceRegionId?: string;
   /**
    * @remarks
-   * The initial consumer offset for Kafka.
-   * Valid values:
-   * begin_cursor, end_cursor, and timestamp.
-   * These values correspond to the earliest offset, the latest offset, and a specified time.
+   * The starting consumption offset for Kafka. Valid values:
+   * - begin_cursor: The earliest offset.
+   * - end_cursor: The latest offset.
+   * - timestamp: A specified time.
    * 
    * This parameter is required.
    * 
@@ -239,7 +238,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   startingOffsets?: string;
   /**
    * @remarks
-   * The user-defined name of the table.
+   * The custom table name.
    * 
    * This parameter is required.
    * 
@@ -249,7 +248,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * The generation rule for the destination.
+   * The destination generation rule.
    * 
    * @example
    * xxx
@@ -257,7 +256,7 @@ export class CreateApsKafkaHudiJobShrinkRequest extends $dara.Model {
   targetGenerateRule?: string;
   /**
    * @remarks
-   * The type of the destination.
+   * The destination type.
    * 
    * @example
    * OSS

package/src/models/CreateApsjobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAPSJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the synchronization job.
+   * The name of the task.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   apsJobName?: string;
   /**
    * @remarks
-   * The objects to be synchronized.
+   * The list of synchronization objects.
    * 
    * This parameter is required.
    * 
@@ -25,7 +25,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   dbList?: string;
   /**
    * @remarks
-   * The name of the database account of the destination cluster.
+   * The instance ID of the destination database.
    * 
    * This parameter is required.
    * 
@@ -35,7 +35,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   destinationEndpointInstanceID?: string;
   /**
    * @remarks
-   * The password of the database account of the destination cluster.
+   * The password of the destination instance.
    * 
    * @example
    * ******
@@ -43,7 +43,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   destinationEndpointPassword?: string;
   /**
    * @remarks
-   * The name of the database account of the destination cluster.
+   * The username of the destination instance.
    * 
    * @example
    * ******
@@ -51,7 +51,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   destinationEndpointUserName?: string;
   /**
    * @remarks
-   * The partitions.
+   * The list of partitions.
    * 
    * @example
    * {}
@@ -60,8 +60,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the region ID.
    * 
    * This parameter is required.
    * 
@@ -71,7 +70,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the source instance or cluster.
+   * The instance ID of the source database.
    * 
    * This parameter is required.
    * 
@@ -81,7 +80,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   sourceEndpointInstanceID?: string;
   /**
    * @remarks
-   * The password of the database account of the source instance.
+   * The password of the source endpoint.
    * 
    * @example
    * ******
@@ -89,7 +88,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   sourceEndpointPassword?: string;
   /**
    * @remarks
-   * The region ID of the source instance.
+   * The region of the source database.
    * 
    * @example
    * cn-beijing
@@ -97,7 +96,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   sourceEndpointRegion?: string;
   /**
    * @remarks
-   * The name of the database account of the source instance.
+   * The username of the source endpoint.
    * 
    * @example
    * xxxx
@@ -105,7 +104,7 @@ export class CreateAPSJobRequest extends $dara.Model {
   sourceEndpointUserName?: string;
   /**
    * @remarks
-   * The mode of the destination table.
+   * The destination table mode.
    * 
    * @example
    * 1

package/src/models/CreateApsjobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAPSJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The job ID.
+   * The ID of the task.
    * 
    * @example
    * aps-bj1xxxxxx
@@ -13,7 +13,7 @@ export class CreateAPSJobResponseBody extends $dara.Model {
   apsJobId?: string;
   /**
    * @remarks
-   * The HTTP status code or the error code.
+   * The operation status code or POP error code.
    * 
    * @example
    * InvalidInput
@@ -21,7 +21,7 @@ export class CreateAPSJobResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response code. The status code 200 indicates that the request was successful.
+   * The HTTP status code returned. A value of 200 indicates that the request was sent successfully.
    * 
    * @example
    * 200
@@ -29,10 +29,9 @@ export class CreateAPSJobResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The returned message. Valid values:
-   * 
-   * *   If the request was successful, a success message is returned.****
-   * *   If the request failed, an error message is returned.
+   * The additional information about the call result. Valid values:
+   * - If the request is normal, **OK** is returned.                                
+   * - If the request is abnormal, a specific error code is returned.
    * 
    * @example
    * OK
@@ -40,7 +39,7 @@ export class CreateAPSJobResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * D1B8ED33-5E9B-512D-B188-1579ED6xxx
@@ -48,10 +47,9 @@ export class CreateAPSJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
+   * Indicates whether the call was successful. Valid values:
+   * - **true**: The call was successful.
+   * - **false**: The call failed.
    * 
    * @example
    * True