@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/DltablebaseInfo.ts

@@ -5,83 +5,142 @@ import { DLColumn } from "./Dlcolumn";
 
 export class DLTablebaseInfo extends $dara.Model {
   /**
+   * @remarks
+   * The data catalog to which the table belongs.
+   * 
    * @example
    * hive
    */
   catalogName?: string;
   /**
+   * @remarks
+   * The time when the table was created.
+   * 
    * @example
    * 1608707407
    */
   createTime?: number;
   /**
+   * @remarks
+   * The ID of the user who created the table.
+   * 
    * @example
    * 141****
    */
   creatorId?: number;
   /**
+   * @remarks
+   * The ID of the database to which the table belongs.
+   * 
    * @example
    * 19
    */
   dbId?: number;
   /**
+   * @remarks
+   * The name of the database to which the table belongs.
+   * 
    * @example
    * default
    */
   dbName?: string;
   /**
+   * @remarks
+   * The description of the table.
+   * 
    * @example
    * "table"
    */
   description?: string;
   /**
+   * @remarks
+   * The time when the table was last accessed.
+   * 
    * @example
    * 1731586286
    */
   lastAccessTime?: number;
   /**
+   * @remarks
+   * The storage path of the table.
+   * 
    * @example
    * oss://xxx
    */
   location?: string;
   /**
+   * @remarks
+   * The time when the table was modified.
+   * 
    * @example
    * 1731585286
    */
   modifierId?: number;
   /**
+   * @remarks
+   * The name of the table.
+   * 
    * @example
    * 100g_customer
    */
   name?: string;
   /**
+   * @remarks
+   * The owner of the table.
+   * 
    * @example
    * test
    */
   owner?: string;
+  /**
+   * @remarks
+   * The type of the owner. Valid values: USER, ROLE, or GROUP.
+   * 
+   * @example
+   * USER
+   */
   ownerType?: string;
   /**
+   * @remarks
+   * The additional parameters of the table.
+   * 
    * @example
    * "EXTERNAL": "TRUE"
    */
   parameters?: { [key: string]: any };
+  /**
+   * @remarks
+   * The list of column attributes.
+   */
   partitionKeys?: DLColumn[];
   /**
+   * @remarks
+   * The retention period of the table, in days.
+   * 
    * @example
    * 30000
    */
   retention?: number;
   /**
+   * @remarks
+   * The type of the table. Examples include MANAGED_TABLE, EXTERNAL_TABLE, VIRTUAL_VIEW, INDEX_TABLE, and MATERIALIZED_VIEW.
+   * 
    * @example
    * EXTERNAL_TABLE
    */
   tableType?: string;
   /**
+   * @remarks
+   * The expanded text of the view if the table is a view.
+   * 
    * @example
    * ""
    */
   viewExpandedText?: string;
   /**
+   * @remarks
+   * The original text of the view if the table is a view.
+   * 
    * @example
    * ""
    */

package/src/models/DmsKnowledgeSearchOrderInfoDo.ts

@@ -3,12 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DmsKnowledgeSearchOrderInfoDO extends $dara.Model {
+  /**
+   * @remarks
+   * The UID of the Alibaba Cloud account.
+   */
   aliyunAccountUid?: string;
+  /**
+   * @remarks
+   * The API key used for authentication.
+   */
   apiKey?: string;
+  /**
+   * @remarks
+   * The time when the entry was created.
+   */
   gmtCreate?: string;
+  /**
+   * @remarks
+   * The time when the entry was last modified.
+   */
   gmtModified?: string;
+  /**
+   * @remarks
+   * The unique ID of the entry.
+   */
   id?: number;
+  /**
+   * @remarks
+   * The unique ID of the order.
+   */
   orderId?: string;
+  /**
+   * @remarks
+   * The endpoint URL for the web search API.
+   */
   webSearchApiUrl?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/FileUploadCallbackRequest.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class FileUploadCallbackRequest extends $dara.Model {
   /**
+   * @remarks
+   * For frontend use only.
+   * 
    * @example
    * TrailCenter
    */
   callFrom?: string;
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
   /**
+   * @remarks
+   * The file size in bytes.
+   * 
    * @example
    * 8110
    */
   fileSize?: number;
   /**
    * @remarks
+   * The file name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +40,12 @@ export class FileUploadCallbackRequest extends $dara.Model {
   ossBucket?: string;
   /**
    * @remarks
+   * The full path for the file upload.
+   * 
+   * - Format: This path is formed by appending the file name to the UploadDir value returned by the DescribeFileUploadSignature operation.
+   * 
+   * - Example: ${UploadDir}/${Filename}
+   * 
    * This parameter is required.
    */
   uploadLocation?: string;

package/src/models/FileUploadCallbackResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class FileUploadCallbackResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The file ID.
+   * 
    * @example
    * f-8*******01m
    */
@@ -30,26 +33,43 @@ export class FileUploadCallbackResponseBodyData extends $dara.Model {
 }
 
 export class FileUploadCallbackResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned struct.
+   */
   data?: FileUploadCallbackResponseBodyData;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 841BC14F-8E21-56B0-A7D6-593C5841AC84
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. The following values are returned:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/GetAirflowRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class GetAirflowRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class GetAirflowRequest extends $dara.Model {
   airflowId?: string;
   /**
    * @remarks
+   * The ID of the workspace.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetAirflowResponseBody.ts

@@ -4,110 +4,174 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAirflowResponseBodyRoot extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the Airflow instance.
+   * 
    * @example
    * af-7a6ygsh80dx1jn****
    */
   airflowId?: string;
   /**
+   * @remarks
+   * The name of the Airflow instance.
+   * 
    * @example
    * testairflow
    */
   airflowName?: string;
   /**
+   * @remarks
+   * The specifications of the Airflow instance.
+   * 
    * @example
    * SMALL
    */
   appSpec?: string;
   /**
+   * @remarks
+   * The application type.
+   * 
    * @example
    * AIRFLOW
    */
   appType?: string;
+  /**
+   * @remarks
+   * The custom configurations.
+   */
   customAirflowCfg?: string[];
   /**
+   * @remarks
+   * The DAG directory that Airflow scans.
+   * 
    * @example
    * default/dags
    */
   dagsDir?: string;
   /**
+   * @remarks
+   * The deployment error message.
+   * 
    * @example
    * Deployed
    */
   deployErrorMsg?: string;
   /**
+   * @remarks
+   * The description of the Airflow instance.
+   * 
    * @example
    * test airflow
    */
   description?: string;
   /**
+   * @remarks
+   * The time when the instance was created.
+   * 
    * @example
    * 2025-08-12T05:46:01.000+0000
    */
   gmtCreated?: string;
   /**
+   * @remarks
+   * The name of the OSS bucket.
+   * 
    * @example
    * osstest
    */
   ossBucketName?: string;
   /**
+   * @remarks
+   * The OSS path.
+   * 
    * @example
    * /airflow
    */
   ossPath?: string;
   /**
+   * @remarks
+   * The plugin directory that Airflow scans.
+   * 
    * @example
    * default/plugins
    */
   pluginsDir?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The path to the Python dependencies file (requirements.txt).
+   * 
    * @example
    * default/requirements.txt
    */
   requirementFile?: string;
   /**
+   * @remarks
+   * The ID of the security group.
+   * 
    * @example
    * sg-2ze9gj646bkv****
    */
   securityGroupId?: string;
   /**
+   * @remarks
+   * The startup script that runs before Airflow starts.
+   * 
    * @example
    * default/startup.sh
    */
   startupFile?: string;
   /**
+   * @remarks
+   * The status of the Airflow instance.
+   * 
    * @example
    * DEPLOYED
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the vSwitch.
+   * 
    * @example
    * vsw-bp1931trfxkvf74v****
    */
   vSwitchId?: string;
   /**
    * @remarks
-   * VPC ID。
+   * The ID of the VPC.
    * 
    * @example
    * vpc-2zevqv4obraqd5p****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The number of worker nodes.
+   * 
    * @example
    * 0
    */
   workerServerlessReplicas?: number;
   /**
+   * @remarks
+   * The ID of the DMS workspace.
+   * 
    * @example
    * 8630242382****
    */
   workspaceId?: string;
   /**
+   * @remarks
+   * The zone ID.
+   * 
    * @example
    * cn-hangzhou-h
    */
@@ -180,35 +244,58 @@ export class GetAirflowResponseBodyRoot extends $dara.Model {
 
 export class GetAirflowResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about the access denial.
+   * 
    * @example
    * NOT_FOUND
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Unknown error
    */
   message?: string;
   /**
    * @remarks
-   * Reuqest ID。
+   * The request ID.
    * 
    * @example
    * E0D21075-CD3E-4D98-8264-****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The returned data.
+   */
   root?: GetAirflowResponseBodyRoot;
   /**
+   * @remarks
+   * Indicates whether the request was successful. The following values are returned:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/GetChatContentRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetChatContentRequest extends $dara.Model {
   /**
+   * @remarks
+   * The agent ID. This parameter is required.
+   * 
    * @example
    * xxxx-xxxx-xxxx
    */
   agentId?: string;
   /**
+   * @remarks
+   * The service returns output starting from this checkpoint.
+   * 
    * @example
    * 0
    */
   checkpoint?: string;
   /**
+   * @remarks
+   * The DMS unit. For users on the Alibaba Cloud China site, the default value is cn-hangzhou.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * The session ID. This parameter is required.
+   * 
    * @example
    * sess_12345
    */

package/src/models/GetChatContentResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetChatContentResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The category of the message, which helps parse the `content` field when it is a JSON object. For example,`PLAN` indicates that the message is an execution plan and conforms to the execution plan schema.
+   * 
    * @example
    * PLAN
    */
   category?: string;
   /**
+   * @remarks
+   * The checkpoint value.
+   * 
    * @example
    * 0
    */
   checkpoint?: number;
   /**
+   * @remarks
+   * The message content.
+   * 
    * @example
    * Data understanding completed.
    */
   content?: string;
   /**
+   * @remarks
+   * The type of the content field. Valid values: `[str, json]`. If the value is `json`, the content field can be parsed as a JSON object.
+   * 
    * @example
    * str
    */
   contentType?: string;
   /**
+   * @remarks
+   * The message type, which distinguishes control signals from message data. For example,`CHAT_START` indicates the start of an agent\\"s reply,`CHAT_FINISH` indicates the end of the reply,`DATA` indicates a message that contains content, and`DELTA` indicates a part of an incremental output.
+   * 
    * @example
    * DATA
    */
   eventType?: string;
   /**
+   * @remarks
+   * The output level of the message. A higher value indicates greater importance.
+   * 
    * @example
    * 20
    */

package/src/models/GetDataAgentSubAccountInfoRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetDataAgentSubAccountInfoRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   dmsUnit?: string;
   /**
+   * @remarks
+   * The UID of the RAM user.
+   * 
    * @example
    * 20282*****7591
    */