@alicloud/adb20211201 5.5.0 → 5.5.1

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.
    * 

package/src/models/ResetAccountPasswordRequest.ts

@@ -16,7 +16,7 @@ export class ResetAccountPasswordRequest extends $dara.Model {
   /**
    * @remarks
    * The database account.
-   * > You can call the [DescribeAccounts](https://help.aliyun.com/document_detail/612430.html) operation to query the database account information of a specified cluster, including the database account.
+   * > You can call the [DescribeAccounts](https://help.aliyun.com/document_detail/612430.html) operation to query the database account information of a specified cluster, including the database accounts.
    * 
    * This parameter is required.
    * 
@@ -28,7 +28,7 @@ export class ResetAccountPasswordRequest extends $dara.Model {
    * @remarks
    * The password of the database account.
    * - The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
-   * - The following special characters are supported: `!@#$%^&*()_+-=`
+   * - Special characters include: `!@#$%^&*()_+-=`
    * - The password must be 8 to 32 characters in length.
    * 
    * This parameter is required.
@@ -39,7 +39,7 @@ export class ResetAccountPasswordRequest extends $dara.Model {
   accountPassword?: string;
   /**
    * @remarks
-   * <props="china">The ID of the cluster. The cluster can be an Enterprise Edition, Basic Edition, or 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.
@@ -52,13 +52,20 @@ export class ResetAccountPasswordRequest extends $dara.Model {
    * @remarks
    * The database engine. Valid values:
    * 
-   * - **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * - **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL engine.
+   * - **Clickhouse**: 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/ResetAccountPasswordResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResetAccountPasswordResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF

package/src/models/SearchSemanticViewsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SearchSemanticViewsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the AnalyticDB for MySQL cluster.
+   * The ADB cluster ID.
    * 
    * This parameter is required.
    * 
@@ -15,15 +15,15 @@ export class SearchSemanticViewsRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The search query.
+   * The text content to search.
    * 
    * @example
-   * 销售额
+   * Sales revenue
    */
   queryText?: string;
   /**
    * @remarks
-   * The number of the most relevant semantic views to return.
+   * The number of most relevant documents to return.
    * 
    * @example
    * 3

package/src/models/SearchSemanticViewsResponseBody.ts

@@ -6,12 +6,12 @@ import { SemanticViewModel } from "./SemanticViewModel";
 export class SearchSemanticViewsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of semantic view objects.
+   * The response data body.
    */
   data?: SemanticViewModel[];
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF

package/src/models/SetSparkAppLogRootPathRequest.ts

@@ -15,7 +15,7 @@ export class SetSparkAppLogRootPathRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The path of Object Storage Service (OSS) logs.
+   * The OSS log path.
    * 
    * @example
    * oss://testBucketname/to/log
@@ -23,7 +23,7 @@ export class SetSparkAppLogRootPathRequest extends $dara.Model {
   ossLogPath?: string;
   /**
    * @remarks
-   * Specifies whether to use the default OSS log path.
+   * Specifies whether to use the default OSS path.
    * 
    * @example
    * true

package/src/models/SetSparkAppLogRootPathResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class SetSparkAppLogRootPathResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The default log path.
+   * The recommended default path.
    * 
    * @example
    * oss://testBucketname/to/log
@@ -13,7 +13,7 @@ export class SetSparkAppLogRootPathResponseBodyData extends $dara.Model {
   defaultLogPath?: string;
   /**
    * @remarks
-   * Indicates whether a log path exists.
+   * Indicates whether the log path exists.
    * 
    * @example
    * true
@@ -29,7 +29,7 @@ export class SetSparkAppLogRootPathResponseBodyData extends $dara.Model {
   modifiedTimestamp?: string;
   /**
    * @remarks
-   * The modifier ID.
+   * The ID of the modifier.
    * 
    * @example
    * 11111111
@@ -75,12 +75,12 @@ export class SetSparkAppLogRootPathResponseBodyData extends $dara.Model {
 export class SetSparkAppLogRootPathResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned data.
+   * The response data.
    */
   data?: SetSparkAppLogRootPathResponseBodyData;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * D65A809F-34CE-4550-9BC1-0ED21ETG380

package/src/models/SparkOperatorInfo.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SparkOperatorInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The metric value.
+   * 
+   * @example
+   * 0
+   */
   metricValue?: number;
+  /**
+   * @remarks
+   * The operator name.
+   * 
+   * @example
+   * TableScan
+   */
   operatorName?: Buffer;
   static names(): { [key: string]: string } {
     return {

package/src/models/SubmitSparkLogAnalyzeTaskResponseBody.ts

@@ -6,12 +6,12 @@ import { SparkAnalyzeLogTask } from "./SparkAnalyzeLogTask";
 export class SubmitSparkLogAnalyzeTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the Spark log analysis task.
+   * The details of the Spark log analysis task.
    */
   data?: SparkAnalyzeLogTask;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 1DF5AF5B-C803-1861-A0FF-63666A557709

package/src/models/TableDetailModel.ts

@@ -6,7 +6,7 @@ import { ColDetailModel } from "./ColDetailModel";
 export class TableDetailModel extends $dara.Model {
   /**
    * @remarks
-   * External data source.
+   * The external data source.
    * 
    * @example
    * oss
@@ -14,40 +14,59 @@ export class TableDetailModel extends $dara.Model {
   catalog?: string;
   /**
    * @remarks
-   * Column information.
+   * The column information.
    */
   columns?: ColDetailModel[];
   /**
    * @remarks
-   * Creation time.
+   * The creation time.
    * 
    * @example
    * 2023-01-05 13:17:55
    */
   createTime?: string;
+  /**
+   * @remarks
+   * The creation source of the table.
+   */
   createdBySource?: string;
+  /**
+   * @remarks
+   * The user who created the table.
+   */
   createdByUser?: string;
   /**
    * @remarks
-   * Description.
+   * The description.
    * 
    * @example
    * Description
    */
   description?: string;
+  /**
+   * @remarks
+   * The storage location of the table data.
+   * 
+   * @example
+   * oss://**************
+   */
   location?: string;
   /**
    * @remarks
-   * Owner.
+   * The owner.
    * 
    * @example
    * abc
    */
   owner?: string;
+  /**
+   * @remarks
+   * The table property parameters.
+   */
   parameters?: { [key: string]: string };
   /**
    * @remarks
-   * Logical database name.
+   * The logical database name.
    * 
    * @example
    * schemaName
@@ -55,7 +74,7 @@ export class TableDetailModel extends $dara.Model {
   schemaName?: string;
   /**
    * @remarks
-   * Logical table name.
+   * The logical table name.
    * 
    * @example
    * tableName
@@ -63,7 +82,7 @@ export class TableDetailModel extends $dara.Model {
   tableName?: string;
   /**
    * @remarks
-   * Table type.
+   * The table type.
    * 
    * @example
    * PHYSICAL_SCHEMA_NAME
@@ -71,7 +90,7 @@ export class TableDetailModel extends $dara.Model {
   tableType?: string;
   /**
    * @remarks
-   * Update time.
+   * The update time.
    * 
    * @example
    * 2023-01-05 13:17:55