@alicloud/adb20211201 5.5.0 → 5.6.0

package/src/models/ModifyDbresourceGroupShrinkRequest.ts

@@ -10,7 +10,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   atmConfigShrink?: string;
   /**
    * @remarks
-   * The auto-stop interval.
+   * The auto-stop time.
    * 
    * @example
    * 5m
@@ -18,7 +18,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   autoStopInterval?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
    * None
@@ -26,7 +26,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   clusterMode?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
    * None
@@ -34,8 +34,8 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   clusterSizeResource?: string;
   /**
    * @remarks
-   * <props="china">The cluster ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
-   * <props="intl">The cluster ID of the Data Lakehouse Edition cluster.
+   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
+   * <props="intl">The ID of the Data Lakehouse Edition cluster.
    * 
    * This parameter is required.
    * 
@@ -45,7 +45,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to enable the spot instance feature for the resource group. After spot instances are enabled, the unit price of resources is reduced, but the resources may be released. Only Job resource groups support this feature. Valid values:
+   * Specifies whether to enable the spot instance feature for the resource group. After you enable this feature, the unit price of resources decreases, but the resources may be released. This feature can be enabled only for Job resource groups. Valid values:
    * - **True**: Enables the spot instance feature.
    * - **False**: Disables the spot instance feature.
    * 
@@ -55,7 +55,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   enableSpot?: boolean;
   /**
    * @remarks
-   * The engine configuration.
+   * The engine configurations.
    * 
    * @example
    * {\\"spark.adb.version\\":\\"3.5\\"}
@@ -63,13 +63,13 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   engineParamsShrink?: string;
   /**
    * @remarks
-   * The GPU time-sharing elastic plan.
+   * The GPU time-based elastic plan.
    */
   gpuElasticPlanShrink?: string;
   /**
    * @remarks
-   * The resource group name.
-   * > You can call the [DescribeDBResourceGroup](https://help.aliyun.com/document_detail/459446.html) operation to query the resource group names of a specified cluster.
+   * The name of the resource group.
+   * > You can call the [DescribeDBResourceGroup](https://help.aliyun.com/document_detail/459446.html) operation to query the name of the resource group for a specified cluster.
    * 
    * This parameter is required.
    * 
@@ -79,10 +79,10 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * The resource group type. Valid values:
+   * The type of the resource group. Valid values:
    * - **Interactive**
    * - **Job**
-   * > For more information about Data Lakehouse Edition resource groups, refer to [Resource group introduction](https://help.aliyun.com/document_detail/428610.html).
+   * > For more information about Data Lakehouse Edition resource groups, see [Resource groups](https://help.aliyun.com/document_detail/428610.html).
    * 
    * This parameter is required.
    * 
@@ -92,7 +92,7 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   groupType?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
    * None
@@ -101,8 +101,8 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The maximum reserved computing resources.
-   * - If the resource group type is Interactive, the maximum reserved computing resources are the current unallocated resources of the cluster, in increments of 16 ACUs.
-   * - If the resource group type is Job, the maximum reserved computing resources are the current unallocated resources of the cluster, in increments of 8 ACUs.
+   * - If the resource group type is Interactive, the maximum reserved computing resources is the currently unallocated resources of the cluster, and the step size is 16 ACUs.
+   * - If the resource group type is Job, the maximum reserved computing resources is the currently unallocated resources of the cluster, and the step size is 8 ACUs.
    * 
    * @example
    * 48ACU
@@ -110,15 +110,15 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   maxComputeResource?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
-   * Reserved parameter. Not applicable.
+   * Reserved parameter
    */
   maxGpuQuantity?: number;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
    * None
@@ -127,8 +127,8 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   /**
    * @remarks
    * The minimum reserved computing resources.
-   * - If the resource group type is Interactive, the minimum reserved computing resources are 16 ACUs.
-   * - If the resource group type is Job, the minimum reserved computing resources are 0 ACUs.
+   * - If the resource group type is Interactive, the minimum reserved computing resources is 16 ACUs.
+   * - If the resource group type is Job, the minimum reserved computing resources is 0 ACUs.
    * 
    * @example
    * 0ACU
@@ -136,15 +136,15 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   minComputeResource?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
-   * Reserved parameter. Not applicable.
+   * Reserved parameter
    */
   minGpuQuantity?: number;
   /**
    * @remarks
-   * The Ray configuration. This parameter is required when the resource group is an AI resource group and the corresponding engine is RayCluster.
+   * The Ray configuration information. This parameter is required when the resource group is an AI resource group and the corresponding engine is RayCluster.
    */
   rayConfigShrink?: string;
   /**
@@ -158,20 +158,20 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The job routing rules.
+   * The job delivery rules.
    */
   rulesShrink?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
-   * Reserved parameter. Not applicable.
+   * Reserved parameter
    */
   specName?: string;
   /**
    * @remarks
-   * The resource group status. **starting** indicates that the resource group is being started. **stopping** indicates that the resource group is being stopped.
+   * The status of the resource group. **starting** indicates that the resource group is being started. **stopping** indicates that the resource group is being stopped.
    * 
    * @example
    * starting
@@ -179,10 +179,10 @@ export class ModifyDBResourceGroupShrinkRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Reserved parameter (not applicable).
+   * Reserved parameter.
    * 
    * @example
-   * Reserved parameter. Not applicable.
+   * Reserved parameter
    */
   targetResourceGroupName?: string;
   static names(): { [key: string]: string } {

package/src/models/ModifyMaterializedViewRequest.ts

@@ -25,10 +25,9 @@ export class ModifyMaterializedViewRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
-   * Enable the refresh delay alert. Valid values:
-   * 
-   * *   true: Enables alert.
-   * *   false: Disables alert.
+   * Specifies whether to enable alerting for refresh latency. Valid values:
+   * - true: Yes.
+   * - false: No.
    * 
    * @example
    * false
@@ -36,10 +35,9 @@ export class ModifyMaterializedViewRequest extends $dara.Model {
   enableDelayAlert?: boolean;
   /**
    * @remarks
-   * Specifies whether to send alerts when the refresh task fails. Valid values:
-   * 
-   * *   true: Send alerts.
-   * *   false: Alerts disabled.
+   * Specifies whether to enable alerting for refresh task failures. Valid values:
+   * - true: Yes.
+   * - false: No.
    * 
    * @example
    * false
@@ -47,7 +45,7 @@ export class ModifyMaterializedViewRequest extends $dara.Model {
   enableFailureAlert?: boolean;
   /**
    * @remarks
-   * The name of the resource group to which the materialized view is bound.
+   * The name of the resource group bound to the materialized view.
    * 
    * @example
    * res_1
@@ -55,7 +53,7 @@ export class ModifyMaterializedViewRequest extends $dara.Model {
   groupName?: string;
   /**
    * @remarks
-   * Refresh delay tolerance (in minutes).
+   * The refresh latency tolerance in minutes.
    * 
    * @example
    * 2
@@ -65,10 +63,9 @@ export class ModifyMaterializedViewRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * Specifies whether to enable query rewrite. Valid values:
-   * 
-   * *   true: Enables query rewrite.
-   * *   false: Disables query rewrite.
+   * Specifies whether to enable the rewrite feature. Valid values:
+   * - true: Yes.
+   * - false: No.
    * 
    * @example
    * true

package/src/models/ModifyUserEniVswitchOptionsResponseBody.ts

@@ -27,7 +27,7 @@ export class ModifyUserEniVswitchOptionsResponseBody extends $dara.Model {
    * *   If the request failed, an error message is returned.
    * 
    * @example
-   * Success
+   * SUCCESS
    */
   message?: string;
   /**

package/src/models/OperatorNode.ts

@@ -3,10 +3,42 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class OperatorNodeStats extends $dara.Model {
+  /**
+   * @remarks
+   * The data volume.
+   * 
+   * @example
+   * 0
+   */
   bytes?: number;
+  /**
+   * @remarks
+   * The number of output rows.
+   * 
+   * @example
+   * 0
+   */
   outputRows?: number;
+  /**
+   * @remarks
+   * The operator parameters.
+   */
   parameters?: string;
+  /**
+   * @remarks
+   * The maximum memory size consumed.
+   * 
+   * @example
+   * 0
+   */
   peakMemory?: number;
+  /**
+   * @remarks
+   * The execution time.
+   * 
+   * @example
+   * 0
+   */
   timeCost?: number;
   static names(): { [key: string]: string } {
     return {
@@ -38,13 +70,63 @@ export class OperatorNodeStats extends $dara.Model {
 }
 
 export class OperatorNode extends $dara.Model {
+  /**
+   * @remarks
+   * The child operator queue.
+   */
   children?: OperatorNode[];
+  /**
+   * @remarks
+   * The operator ID.
+   * 
+   * @example
+   * 0
+   */
   id?: number;
+  /**
+   * @remarks
+   * The total number of nodes at the tree level of the operator.
+   * 
+   * @example
+   * 0
+   */
   levelWidth?: number;
+  /**
+   * @remarks
+   * The level of the operator in the tree.
+   * 
+   * @example
+   * 0
+   */
   nodeDepth?: number;
+  /**
+   * @remarks
+   * The operator name.
+   * 
+   * @example
+   * TableScan
+   */
   nodeName?: string;
+  /**
+   * @remarks
+   * The left-to-right position of the node at the corresponding level.
+   * 
+   * @example
+   * 0
+   */
   nodeWidth?: number;
+  /**
+   * @remarks
+   * The parent operator ID.
+   * 
+   * @example
+   * 0
+   */
   parentId?: number;
+  /**
+   * @remarks
+   * The operator statistics information.
+   */
   stats?: OperatorNodeStats;
   static names(): { [key: string]: string } {
     return {

package/src/models/QueryFormationInstsByTaskIdrequest.ts

@@ -15,7 +15,7 @@ export class QueryFormationInstsByTaskIDRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) to query available region IDs.
+   * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query available region IDs.
    * 
    * This parameter is required.
    * 

package/src/models/QueryFormationInstsByTaskIdresponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class QueryFormationInstsByTaskIDResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The time when the task was created.
+   * The creation time of the task.
    * 
    * @example
    * 2023-05-15T07:24:58Z
@@ -62,8 +62,8 @@ export class QueryFormationInstsByTaskIDResponseBodyData extends $dara.Model {
   /**
    * @remarks
    * The task source. Valid values:
-   * - **system**: system.
-   * - **custom**: custom.
+   * - **system**: System.
+   * - **custom**: Custom.
    * 
    * @example
    * shareScreen
@@ -173,7 +173,7 @@ export class QueryFormationInstsByTaskIDResponseBody extends $dara.Model {
   items?: { [key: string]: any }[];
   /**
    * @remarks
-   * The response message. OK is returned if the request was successful.
+   * The message. The value is OK when the request is successful.
    * 
    * @example
    * OK
@@ -205,7 +205,7 @@ export class QueryFormationInstsByTaskIDResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/QueryFormationTaskByIdresponseBody.ts

@@ -52,9 +52,9 @@ export class QueryFormationTaskByIDResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * - true: The request was successful.
-   * - false: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - true: Successful.
+   * - false: Failed.
    * 
    * @example
    * true

package/src/models/ReleaseClusterPublicConnectionRequest.ts

@@ -5,8 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ReleaseClusterPublicConnectionRequest extends $dara.Model {
   /**
    * @remarks
-   * <props="china">The ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition cluster.
-   * <props="intl">The ID of the Data Lakehouse Edition cluster.
+   * <props="china">The cluster ID of the Enterprise Edition, Basic Edition, or Data Lakehouse Edition.
+   * <props="intl">The cluster ID of the Data Lakehouse Edition.
    * 
    * This parameter is required.
    * 
@@ -18,14 +18,20 @@ export class ReleaseClusterPublicConnectionRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (Default): AnalyticDB for MySQL.
-   * 
-   * - **ClickHouse**: a wide table engine.
+   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
+   * - **Clickhouse**: the wide-table engine.
    * 
    * @example
    * Clickhouse
    */
   engine?: string;
+  /**
+   * @remarks
+   * The name of the resource group.
+   * 
+   * @example
+   * test_group
+   */
   resourceGroupName?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RemoveKnowledgeTagsRequest.ts

@@ -15,9 +15,15 @@ export class RemoveKnowledgeTagsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The location of the knowledge base document.
+   * The file ID.
    * 
-   * This parameter is required.
+   * @example
+   * 2131234
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The knowledge base document location.
    * 
    * @example
    * oss://bucket/doc.pdf
@@ -25,7 +31,7 @@ export class RemoveKnowledgeTagsRequest extends $dara.Model {
   fileLocation?: string;
   /**
    * @remarks
-   * The JSON string of the tag array to delete.
+   * The JSON string of the tag array to be deleted.
    * 
    * @example
    * [{"tag_key":"biz.scene","tag_value":"test"}]
@@ -34,6 +40,7 @@ export class RemoveKnowledgeTagsRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
+      fileId: 'FileId',
       fileLocation: 'FileLocation',
       tags: 'Tags',
     };
@@ -42,6 +49,7 @@ export class RemoveKnowledgeTagsRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       DBClusterId: 'string',
+      fileId: 'string',
       fileLocation: 'string',
       tags: 'string',
     };

package/src/models/RemoveKnowledgeTagsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RemoveKnowledgeTagsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The location of the knowledge base file.
+   * The knowledge base file location.
    * 
    * @example
    * oss://bucket/doc.pdf
@@ -13,7 +13,7 @@ export class RemoveKnowledgeTagsResponseBodyData extends $dara.Model {
   fileLocation?: string;
   /**
    * @remarks
-   * The message returned by the operation.
+   * The API message.
    * 
    * @example
    * Successful
@@ -21,7 +21,7 @@ export class RemoveKnowledgeTagsResponseBodyData extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The number of tags that were successfully deleted.
+   * The number of tags successfully deleted.
    * 
    * @example
    * 1
@@ -29,10 +29,9 @@ export class RemoveKnowledgeTagsResponseBodyData extends $dara.Model {
   removed?: number;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * 
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - **true**: Successful.
+   * - **false**: Failed.
    * 
    * @example
    * true

package/src/models/RemoveKnowledgeUploadUserRequest.ts

@@ -15,9 +15,15 @@ export class RemoveKnowledgeUploadUserRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The location of the knowledge base document.
+   * The file ID.
    * 
-   * This parameter is required.
+   * @example
+   * 2134143
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The address of the knowledge base document.
    * 
    * @example
    * oss://bucket/doc.pdf
@@ -36,6 +42,7 @@ export class RemoveKnowledgeUploadUserRequest extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       DBClusterId: 'DBClusterId',
+      fileId: 'FileId',
       fileLocation: 'FileLocation',
       users: 'Users',
     };
@@ -44,6 +51,7 @@ export class RemoveKnowledgeUploadUserRequest extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       DBClusterId: 'string',
+      fileId: 'string',
       fileLocation: 'string',
       users: 'string',
     };

package/src/models/RemoveKnowledgeUploadUserResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RemoveKnowledgeUploadUserResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The location of the knowledge base file.
+   * The address of the knowledge base file.
    * 
    * @example
    * oss://bucketName/path/to/file.pdf
@@ -13,7 +13,7 @@ export class RemoveKnowledgeUploadUserResponseBodyData extends $dara.Model {
   fileLocation?: string;
   /**
    * @remarks
-   * The prompt message.
+   * The message.
    * 
    * @example
    * Successful
@@ -21,7 +21,7 @@ export class RemoveKnowledgeUploadUserResponseBodyData extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The number of users that were successfully deleted.
+   * The number of successfully deleted users.
    * 
    * @example
    * 1
@@ -29,9 +29,9 @@ export class RemoveKnowledgeUploadUserResponseBodyData extends $dara.Model {
   removed?: number;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * Indicates whether the request is successful. Valid values:
+   * - **true**: Successful.
+   * - **false**: Failed.
    * 
    * @example
    * true

package/src/models/RenameSemanticViewRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RenameSemanticViewRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL cluster.
+   * The ID of the ADB cluster.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class RenameSemanticViewRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The new schema name in which the semantic view resides.
+   * The new schema name of the semantic view.
    * 
    * This parameter is required.
    * 
@@ -35,7 +35,7 @@ export class RenameSemanticViewRequest extends $dara.Model {
   newViewName?: string;
   /**
    * @remarks
-   * The original schema name in which the semantic view resides.
+   * The original schema name of the semantic view.
    * 
    * This parameter is required.
    *