@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/CreateDataLakeTableShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataLakeTableShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class CreateDataLakeTableShrinkRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,15 +25,25 @@ export class CreateDataLakeTableShrinkRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The information about the table.
+   * 
    * This parameter is required.
    */
   tableInputShrink?: string;
   /**
+   * @remarks
+   * The ID of the tenant.
+   * 
+   * > Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](https://help.aliyun.com/document_detail/181330.html).
+   * 
    * @example
    * 3****
    */
   tid?: number;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 12****
    */

package/src/models/DataMountInfo.ts

@@ -4,21 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class DataMountInfo extends $dara.Model {
   /**
+   * @remarks
+   * The name of the mount directory. The actual mount path is prefixed with /Workspace/data/.
+   * 
    * @example
    * image
    */
   mountFolderName?: string;
   /**
+   * @remarks
+   * The name of the OSS bucket.
+   * 
    * @example
    * test-bucket
    */
   ossBucket?: string;
   /**
+   * @remarks
+   * The prefix. If this parameter is not specified, the root directory is used.
+   * 
    * @example
    * /prod
    */
   prefix?: string;
   /**
+   * @remarks
+   * Whether to mount the data volume as read-only.
+   * 
+   * Default value: false.
+   * 
    * @example
    * false
    */

package/src/models/DeleteAirflowRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteAirflowRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Airflow instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class DeleteAirflowRequest extends $dara.Model {
    */
   airflowId?: string;
   /**
+   * @remarks
+   * The client token that is used to ensure the idempotence of the request.
+   * 
    * @example
    * token-****
    */
   clientToken?: string;
   /**
    * @remarks
+   * The ID of the workspace.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteAirflowResponseBody.ts

@@ -4,11 +4,23 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteAirflowResponseBodyRootResponses extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the request was successful. The following values are returned:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * The UUID of the asset instance.
+   * 
+   * > This result is not returned if no process exists under the asset.
+   * 
    * @example
    * af-test****
    */
@@ -37,6 +49,10 @@ export class DeleteAirflowResponseBodyRootResponses extends $dara.Model {
 }
 
 export class DeleteAirflowResponseBodyRoot extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the return value.
+   */
   responses?: DeleteAirflowResponseBodyRootResponses[];
   static names(): { [key: string]: string } {
     return {
@@ -64,32 +80,58 @@ export class DeleteAirflowResponseBodyRoot extends $dara.Model {
 
 export class DeleteAirflowResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details of the access denied error.
+   * 
    * @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
    * Instance not found.
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D21075-CD3E-4D98-8264-****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The details of the deleted instance.
+   */
   root?: DeleteAirflowResponseBodyRoot;
   /**
+   * @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/DeleteCustomAgentRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteCustomAgentRequest extends $dara.Model {
   /**
    * @remarks
+   * Custom Agent ID
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,9 @@ export class DeleteCustomAgentRequest extends $dara.Model {
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * Workspace ID
+   * 
    * @example
    * 56kv1pvl9uvt9**********bb
    */

package/src/models/DeleteCustomAgentResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Custom Agent ID
+   * 
    * @example
    * ca-4y3ca4khkcu**********ysf
    */
   customAgentId?: string;
   /**
+   * @remarks
+   * Deletion operation message
+   * 
    * @example
    * Custom agent successfully deleted
    */
   message?: string;
   /**
+   * @remarks
+   * Is deletion successful?
+   * 
    * @example
    * true
    */
@@ -44,13 +53,23 @@ export class DeleteCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class DeleteCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Return struct
+   */
   data?: DeleteCustomAgentResponseBodyData;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Returns an error message if the call fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
@@ -64,6 +83,13 @@ export class DeleteCustomAgentResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Return value description.
+   * 
+   * - **true**: Deletion successful.
+   * 
+   * - **false**: Deletion failed.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataAgentKnowledgeBaseRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataAgentKnowledgeBaseRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
    * @remarks
+   * The ID of the knowledge base.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class DeleteDataAgentKnowledgeBaseRequest extends $dara.Model {
   kbUuid?: string;
   /**
    * @remarks
+   * The ID of the workspace.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DeleteDataAgentKnowledgeBaseResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataAgentKnowledgeBaseResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the deleted knowledge base.
+   * 
    * @example
    * kb-HZ-rtl5lwx********q32d3ux
    */
@@ -30,26 +33,43 @@ export class DeleteDataAgentKnowledgeBaseResponseBodyData extends $dara.Model {
 }
 
 export class DeleteDataAgentKnowledgeBaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data returned by the operation.
+   */
   data?: DeleteDataAgentKnowledgeBaseResponseBodyData;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * InvalidTid
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * Specified parameter Tid is not valid.
    */
   errorMessage?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 67E910F2-4B62-5B0C-ACA3-7547695C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. Valid values:
+   * 
+   * - **true**: The request succeeded.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataAgentWorkspaceRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataAgentWorkspaceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The current DMS unit.
+   * 
    * @example
    * cn-hangzhou
    */
   DMSUnit?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 20923*****7291
    */

package/src/models/DeleteDataAgentWorkspaceResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataAgentWorkspaceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * DMS-DA-40114
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * Specified parameter is not valid.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E0D2-*****-A63B6
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataLakeDatabaseRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataLakeDatabaseRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteDataLakeDatabaseRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,11 +24,19 @@ export class DeleteDataLakeDatabaseRequest extends $dara.Model {
    */
   dbName?: string;
   /**
+   * @remarks
+   * The tenant ID.
+   * 
+   * > Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](https://help.aliyun.com/document_detail/181330.html).
+   * 
    * @example
    * 3****
    */
   tid?: number;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 12****
    */

package/src/models/DeleteDataLakeDatabaseResponseBody.ts

@@ -4,21 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataLakeDatabaseResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code returned when the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID, used for log tracing and troubleshooting.
+   * 
    * @example
    * C51420E3-144A-4A94-B473-8662FCF4****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataLakeFunctionRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataLakeFunctionRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteDataLakeFunctionRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DeleteDataLakeFunctionRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The name of the function.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,11 +34,19 @@ export class DeleteDataLakeFunctionRequest extends $dara.Model {
    */
   functionName?: string;
   /**
+   * @remarks
+   * The ID of the tenant.
+   * 
+   * > Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](https://help.aliyun.com/document_detail/181330.html).
+   * 
    * @example
    * 3****
    */
   tid?: number;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * 12****
    */

package/src/models/DeleteDataLakeFunctionResponseBody.ts

@@ -4,21 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataLakeFunctionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID, used for log tracing and troubleshooting.
+   * 
    * @example
    * B4B07137-F6AE-4756-8474-7F92BB6C****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/DeleteDataLakePartitionRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DeleteDataLakePartitionRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DeleteDataLakePartitionRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,17 +24,24 @@ export class DeleteDataLakePartitionRequest extends $dara.Model {
    */
   dbName?: string;
   /**
+   * @remarks
+   * Specifies whether to ignore the error if the partition to delete does not exist.
+   * 
    * @example
    * true
    */
   ifExists?: boolean;
   /**
    * @remarks
+   * The list of partition values.
+   * 
    * This parameter is required.
    */
   partitionValues?: string[];
   /**
    * @remarks
+   * The name of the table.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,11 +49,19 @@ export class DeleteDataLakePartitionRequest extends $dara.Model {
    */
   tableName?: string;
   /**
+   * @remarks
+   * The tenant ID.
+   * 
+   * > Hover over your profile picture in the upper-right corner of the DMS console to obtain the tenant ID. For details, see [View tenant information](https://help.aliyun.com/document_detail/181330.html).
+   * 
    * @example
    * 3****
    */
   tid?: number;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * 12****
    */

package/src/models/DeleteDataLakePartitionResponseBody.ts

@@ -4,21 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteDataLakePartitionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code returned when the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned when the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The request ID, used for log tracing and troubleshooting.
+   * 
    * @example
    * 0C1CB646-1DE4-4AD0-B4A4-7D47DD52****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the deletion succeeded.
+   * 
+   * - **true**: The deletion succeeded.
+   * 
+   * - **false**: The deletion failed.
+   * 
    * @example
    * true
    */