@alicloud/adb20211201 4.5.0 → 4.6.0

package/src/models/ConfigureResultExportRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigureResultExportRequestOssInfo extends $dara.Model {
   /**
+   * @remarks
+   * The OSS path where the result sets are stored.
+   * 
    * @example
    * oss://testBucketName/data_result
    */
   exportBasePath?: string;
   /**
+   * @remarks
+   * The name of the resource group that runs the job.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days. Values outside this range will result in an error.
+   * 
    * @example
    * 10
    */
@@ -45,16 +54,25 @@ export class ConfigureResultExportRequestOssInfo extends $dara.Model {
 
 export class ConfigureResultExportRequestSlsInfo extends $dara.Model {
   /**
+   * @remarks
+   * The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day, maximum: 30 days. Values outside this range will result in an error.
+   * 
    * @example
    * 10
    */
   logstoreTtl?: number;
   /**
+   * @remarks
+   * The name of the resource group that runs the job.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The name of the SLS project.
+   * 
    * @example
    * test-project
    */
@@ -87,6 +105,10 @@ export class ConfigureResultExportRequestSlsInfo extends $dara.Model {
 export class ConfigureResultExportRequest extends $dara.Model {
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -94,19 +116,35 @@ export class ConfigureResultExportRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The export type. Valid values:
+   * 
+   * *   SLS: Specifies that the export destination is SLS.
+   * *   OSS: Specifies that the export destination is OSS.
+   * 
    * @example
    * SLS
    */
   exportType?: string;
+  /**
+   * @remarks
+   * The OSS configuration details if the destination is of the OSS type.
+   */
   ossInfo?: ConfigureResultExportRequestOssInfo;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-shenzhen
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The SLS configuration details if the destination is of the SLS type.
+   */
   slsInfo?: ConfigureResultExportRequestSlsInfo;
   static names(): { [key: string]: string } {
     return {

package/src/models/ConfigureResultExportResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
   /**
+   * @remarks
+   * The OSS path where the result sets are stored.
+   * 
    * @example
    * oss://testBucketName/data_result
    */
   exportBasePath?: string;
   /**
+   * @remarks
+   * The name of the resource group that runs the job.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The expiration time of the OSS file. Unit: days. Minimum: 1 day, maximum: 30 days.
+   * 
    * @example
    * 10
    */
@@ -45,16 +54,25 @@ export class ConfigureResultExportResponseBodyDataOssInfo extends $dara.Model {
 
 export class ConfigureResultExportResponseBodyDataSlsInfo extends $dara.Model {
   /**
+   * @remarks
+   * The expiration time of the Logstore temporarily generated during the result set export. Unit: days. The Logstore is automatically deleted after it expires. Minimum value: 1 day. Maximum value: 30 days.
+   * 
    * @example
    * 10
    */
   logstoreTtl?: number;
   /**
+   * @remarks
+   * The name of the resource group that runs the job.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The name of the SLS project.
+   * 
    * @example
    * test-project
    */
@@ -86,11 +104,25 @@ export class ConfigureResultExportResponseBodyDataSlsInfo extends $dara.Model {
 
 export class ConfigureResultExportResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The export type. Valid values:
+   * 
+   * *   SLS: Indicates that the export destination is SLS.
+   * *   OSS: Indicates that the export destination is OSS.
+   * 
    * @example
    * SLS
    */
   exportType?: string;
+  /**
+   * @remarks
+   * The OSS configuration if the destination is of the OSS type.
+   */
   ossInfo?: ConfigureResultExportResponseBodyDataOssInfo;
+  /**
+   * @remarks
+   * The SLS configuration if the destination is of the SLS type.
+   */
   slsInfo?: ConfigureResultExportResponseBodyDataSlsInfo;
   static names(): { [key: string]: string } {
     return {
@@ -125,27 +157,52 @@ export class ConfigureResultExportResponseBodyData extends $dara.Model {
 
 export class ConfigureResultExportResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The backend error code.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The path where the result sets are stored.
+   */
   data?: ConfigureResultExportResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code. A value of 200 indicates that the request is successful.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   OK is returned if the request is normal.
+   * *   The specific error code is returned if the request is abnormal,
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * *   **true**: Succeeded.
+   * *   **false**: Failed.
+   * 
    * @example
    * true
    */

package/src/models/ConfigureResultExportShrinkRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureResultExportShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,19 +16,35 @@ export class ConfigureResultExportShrinkRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The export type. Valid values:
+   * 
+   * *   SLS: Specifies that the export destination is SLS.
+   * *   OSS: Specifies that the export destination is OSS.
+   * 
    * @example
    * SLS
    */
   exportType?: string;
+  /**
+   * @remarks
+   * The OSS configuration details if the destination is of the OSS type.
+   */
   ossInfoShrink?: string;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-shenzhen
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The SLS configuration details if the destination is of the SLS type.
+   */
   slsInfoShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateApsKafkaHudiJobRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateApsKafkaHudiJobRequestColumns extends $dara.Model {
   /**
+   * @remarks
+   * The name of the partition column in the destination table.
+   * 
    * @example
    * b
    */
   mapName?: string;
   /**
+   * @remarks
+   * The desired format for the destination partition column.
+   * 
    * @example
    * string
    */
   mapType?: string;
   /**
+   * @remarks
+   * The name of the source column to use for partitioning.
+   * 
    * @example
    * a
    */
   name?: string;
   /**
+   * @remarks
+   * The format of the source field. See the table below for valid values.
+   * 
    * @example
    * string
    */
@@ -52,27 +64,42 @@ export class CreateApsKafkaHudiJobRequestColumns extends $dara.Model {
 
 export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   /**
+   * @remarks
+   * The Resource Access Management (RAM) role that is created for the trusted Alibaba Cloud account. For more information, see Create a RAM role for a trusted Alibaba Cloud account. The ARN of the RAM role that grants AnalyticDB for MySQL permission to access resources in the source account. Required for cross-account data ingestion.
+   * 
    * @example
    * aps
    */
   acrossRole?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the source Kafka belongs.
+   * 
    * @example
    * 123************
    */
   acrossUid?: string;
   /**
+   * @remarks
+   * The advanced configurations.
+   * 
    * @example
    * -
    */
   advancedConfig?: string;
   /**
    * @remarks
+   * The column information.
+   * 
    * This parameter is required.
    */
   columns?: CreateApsKafkaHudiJobRequestColumns[];
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all clusters in a region.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -80,17 +107,25 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * Enumeration value and description. Single: The source is a single-row JSON record. Multi: source is a JSON array. Output a single JSON record.
+   * 
    * @example
    * Single
    */
   dataOutputFormat?: string;
   /**
+   * @remarks
+   * The data source ID.
+   * 
    * @example
    * 1
    */
   datasourceId?: number;
   /**
    * @remarks
+   * The name of the user-defined database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -98,17 +133,25 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
    */
   dbName?: string;
   /**
+   * @remarks
+   * The full synchronization configuration.
+   * 
    * @example
    * 2ACU
    */
   fullComputeUnit?: string;
   /**
+   * @remarks
+   * The HUDI configuration of the destination.
+   * 
    * @example
    * hoodie.keep.min.commits=20
    */
   hudiAdvancedConfig?: string;
   /**
    * @remarks
+   * The incremental synchronization configuration.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -116,52 +159,81 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
    */
   incrementalComputeUnit?: string;
   /**
+   * @remarks
+   * The number of layers that are parsed for nested JSON fields. Valid values: 0: Nested JSON fields are not parsed. 1: parses one layer. 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 how nested JSON fields are parsed, see the Examples of schema fields parsed with different numbers of layers section of this topic.
+   * 
    * @example
    * 0
    */
   jsonParseLevel?: number;
   /**
+   * @remarks
+   * The ID of the Apache Kafka instance. You can get it in the Kafka console.
+   * 
    * @example
    * xxx
    */
   kafkaClusterId?: string;
   /**
+   * @remarks
+   * Kafka Topic ID. You can get it in the Kafka console.
+   * 
    * @example
    * test
    */
   kafkaTopic?: string;
   /**
+   * @remarks
+   * The ID of the lakehouse.
+   * 
    * @example
    * 123
    */
   lakehouseId?: number;
   /**
+   * @remarks
+   * The maximum number of records to fetch in a single batch.
+   * 
    * @example
    * 50000
    */
   maxOffsetsPerTrigger?: number;
   /**
+   * @remarks
+   * The path of the destination data lakehouse in an Object Storage Service (OSS) bucket.
+   * 
    * @example
    * oss://test-xx-zzz/yyy/
    */
   ossLocation?: string;
   /**
+   * @remarks
+   * The format of the output data.
+   * 
    * @example
    * HUDI
    */
   outputFormat?: string;
   /**
+   * @remarks
+   * The partition information.
+   * 
    * **if can be null:**
    * true
    */
   partitionSpecs?: { [key: string]: any }[];
   /**
+   * @remarks
+   * The primary key settings. Contains the uuid policy and mapping policy. The explanation is as follows. Uuid policy: "Strategy": "uuid". Mapping policy: "Strategy": "mapping", "Values":[ "f1", "f2" ], "RecordVersionField","xxx" The meaning of the RecordVersionField is the HUDI record version.
+   * 
    * @example
    * "Strategy": "mapping"
    */
   primaryKeyDefinition?: string;
   /**
    * @remarks
+   * The region ID of the cluster.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -170,6 +242,8 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The resource group name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -177,12 +251,17 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * 地域ID。
+   * 
    * @example
    * cn-hangzhou
    */
   sourceRegionId?: string;
   /**
    * @remarks
+   * Specifies the position from which to start consuming messages. Valid values: begin_cursor/end_cursor/timestamp Each corresponds to the earliest /latest /specified time respectively.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -191,6 +270,8 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
   startingOffsets?: string;
   /**
    * @remarks
+   * The name of the user-defined table.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -198,17 +279,25 @@ export class CreateApsKafkaHudiJobRequest extends $dara.Model {
    */
   tableName?: string;
   /**
+   * @remarks
+   * The rules for generating the destination database.
+   * 
    * @example
    * xxx
    */
   targetGenerateRule?: string;
   /**
+   * @remarks
+   * The destination type.
+   * 
    * @example
    * OSS
    */
   targetType?: string;
   /**
    * @remarks
+   * The name of the workload.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateApsKafkaHudiJobResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateApsKafkaHudiJobResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Same as HTTP status code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Returns the ID of the created task.
+   * 
    * @example
    * xxx
    */
   data?: string;
   /**
+   * @remarks
+   * The HTTP status code returned.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The returned message.
+   * 
    * @example
    * ok
    */
   message?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 1A943417-5B0E-1DB9-A8**-A566****C3
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. true: The request is successful. false: The message group failed to be unmuted.
+   * 
    * @example
    * true
    */