@alicloud/dms20250414 1.14.0 → 1.14.2

package/src/models/UpdateDataAgentWorkspaceMemberRoleResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDataAgentWorkspaceMemberRoleResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The time when the user joined the workspace. This is a UNIX timestamp in seconds.
+   * 
    * @example
    * 1765961516
    */
   joinTime?: number;
   /**
+   * @remarks
+   * The UID of the member whose role was changed.
+   * 
    * @example
    * 20282*****7591
    */
   memberId?: string;
   /**
+   * @remarks
+   * The new role of the user.
+   * 
    * @example
    * admin
    */
   roleName?: string;
   /**
+   * @remarks
+   * The number of running tasks for the user in the workspace.
+   * 
    * @example
    * 10
    */
   runningTaskNumber?: number;
   /**
+   * @remarks
+   * The total number of tasks for the user in the workspace.
+   * 
    * @example
    * 20
    */
   totalTaskNumber?: number;
   /**
+   * @remarks
+   * The RAM username.
+   * 
    * @example
    * yunqitest
    */
@@ -65,23 +83,39 @@ export class UpdateDataAgentWorkspaceMemberRoleResponseBodyData extends $dara.Mo
 }
 
 export class UpdateDataAgentWorkspaceMemberRoleResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: UpdateDataAgentWorkspaceMemberRoleResponseBodyData;
   /**
+   * @remarks
+   * The error code returned if the request fails.
+   * 
    * @example
    * DMS-DA-40114
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message returned if the request fails.
+   * 
    * @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/UpdateDataLakeDatabaseRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDataLakeDatabaseRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDataLakeDatabaseRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,25 +24,42 @@ export class UpdateDataLakeDatabaseRequest extends $dara.Model {
    */
   dbName?: string;
   /**
+   * @remarks
+   * The description of the database.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The storage path of the database. Supported protocols include oss, s3, and s3a.
+   * 
    * This parameter is required.
    * 
    * @example
    * oss://path/to/database
    */
   location?: string;
+  /**
+   * @remarks
+   * The key-value pairs of the database properties.
+   */
   parameters?: { [key: string]: 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/UpdateDataLakeDatabaseResponseBody.ts

@@ -4,23 +4,43 @@ import { DLDatabase } from "./Dldatabase";
 
 
 export class UpdateDataLakeDatabaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the database.
+   */
   database?: DLDatabase;
   /**
+   * @remarks
+   * The error code that is returned if the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorCode?: string;
   /**
+   * @remarks
+   * The error message that is returned if the request fails.
+   * 
    * @example
    * UnknownError
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The ID of the request, used for log tracing and troubleshooting.
+   * 
    * @example
    * 4E1D2B4D-3E53-4ABC-999D-1D2520B3****
    */
   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/UpdateDataLakeDatabaseShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDataLakeDatabaseShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDataLakeDatabaseShrinkRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,25 +24,42 @@ export class UpdateDataLakeDatabaseShrinkRequest extends $dara.Model {
    */
   dbName?: string;
   /**
+   * @remarks
+   * The description of the database.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The storage path of the database. Supported protocols include oss, s3, and s3a.
+   * 
    * This parameter is required.
    * 
    * @example
    * oss://path/to/database
    */
   location?: string;
+  /**
+   * @remarks
+   * The key-value pairs of the database properties.
+   */
   parametersShrink?: 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/UpdateDataLakeFunctionRequest.ts

@@ -6,6 +6,8 @@ import { DLFunctionInput } from "./DlfunctionInput";
 export class UpdateDataLakeFunctionRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +16,8 @@ export class UpdateDataLakeFunctionRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,11 +26,15 @@ export class UpdateDataLakeFunctionRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The details of the function.
+   * 
    * This parameter is required.
    */
   functionInput?: DLFunctionInput;
   /**
    * @remarks
+   * The name of the function.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,11 +42,19 @@ export class UpdateDataLakeFunctionRequest extends $dara.Model {
    */
   functionName?: 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/UpdateDataLakeFunctionResponseBody.ts

@@ -5,22 +5,42 @@ import { DLFunction } from "./Dlfunction";
 
 export class UpdateDataLakeFunctionResponseBody 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 details of the function.
+   */
   function?: DLFunction;
   /**
+   * @remarks
+   * The ID of the request, used for log tracing and troubleshooting.
+   * 
    * @example
    * C1D39814-9808-47F8-AFE0-AF167239****
    */
   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/UpdateDataLakeFunctionShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDataLakeFunctionShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDataLakeFunctionShrinkRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,11 +25,15 @@ export class UpdateDataLakeFunctionShrinkRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The details of the function.
+   * 
    * This parameter is required.
    */
   functionInputShrink?: string;
   /**
    * @remarks
+   * The name of the function.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,11 +41,19 @@ export class UpdateDataLakeFunctionShrinkRequest extends $dara.Model {
    */
   functionName?: 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/UpdateDataLakePartitionRequest.ts

@@ -6,6 +6,8 @@ import { DLPartitionInput } from "./DlpartitionInput";
 export class UpdateDataLakePartitionRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +16,8 @@ export class UpdateDataLakePartitionRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,11 +26,15 @@ export class UpdateDataLakePartitionRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The information about the partition to be updated.
+   * 
    * This parameter is required.
    */
   partitionInput?: DLPartitionInput;
   /**
    * @remarks
+   * The name of the table.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -34,11 +42,19 @@ export class UpdateDataLakePartitionRequest 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/UpdateDataLakePartitionResponseBody.ts

@@ -4,21 +4,37 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDataLakePartitionResponseBody 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
    * 427688B8-ADFB-4C4E-9D45-EF5C1FD6****
    */
   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/UpdateDataLakePartitionShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDataLakePartitionShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDataLakePartitionShrinkRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,11 +25,15 @@ export class UpdateDataLakePartitionShrinkRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The information about the partition to be updated.
+   * 
    * This parameter is required.
    */
   partitionInputShrink?: string;
   /**
    * @remarks
+   * The name of the table.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,11 +41,19 @@ export class UpdateDataLakePartitionShrinkRequest 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/UpdateDataLakeTableRequest.ts

@@ -6,6 +6,8 @@ import { DLTableInput } from "./DltableInput";
 export class UpdateDataLakeTableRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -14,6 +16,8 @@ export class UpdateDataLakeTableRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,20 +26,33 @@ export class UpdateDataLakeTableRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The information about the table.
+   * 
    * This parameter is required.
    */
   tableInput?: DLTableInput;
   /**
+   * @remarks
+   * The name of the table to update. If you do not want to change the table name, set this parameter to the same value as the Name parameter in TableInput.
+   * 
    * @example
    * 100g_customer
    */
   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/UpdateDataLakeTableResponseBody.ts

@@ -5,25 +5,45 @@ import { DLTable } from "./Dltable";
 
 export class UpdateDataLakeTableResponseBody 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
    * C5B8E84B-42B6-4374-AD5A-6264E175****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. Valid values:
+   * 
+   * - **true**: The request was successful.
+   * 
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */
   success?: boolean;
+  /**
+   * @remarks
+   * The details of the table.
+   */
   table?: DLTable;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateDataLakeTableShrinkRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDataLakeTableShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the data catalog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class UpdateDataLakeTableShrinkRequest extends $dara.Model {
   catalogName?: string;
   /**
    * @remarks
+   * The name of the database.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,20 +25,33 @@ export class UpdateDataLakeTableShrinkRequest extends $dara.Model {
   dbName?: string;
   /**
    * @remarks
+   * The information about the table.
+   * 
    * This parameter is required.
    */
   tableInputShrink?: string;
   /**
+   * @remarks
+   * The name of the table to update. If you do not want to change the table name, set this parameter to the same value as the Name parameter in TableInput.
+   * 
    * @example
    * 100g_customer
    */
   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****
    */