@alicloud/dms20250414 4.0.0 → 4.2.0

package/src/models/GetAgenticTableColumnResponseBody.ts

@@ -0,0 +1,78 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { AgenticTableColumn } from "./AgenticTableColumn";
+
+
+export class GetAgenticTableColumnResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of fields.
+   */
+  data?: AgenticTableColumn[];
+  /**
+   * @remarks
+   * The error code returned when a request exception occurs.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: { 'type': 'array', 'itemType': AgenticTableColumn },
+      errorCode: 'string',
+      errorMessage: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.data)) {
+      $dara.Model.validateArray(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetAgenticTableIndexRequest.ts

@@ -0,0 +1,48 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetAgenticTableIndexRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The UUID of the database to which the table belongs. You can obtain this value by calling ListAgenticDatabase or SearchAgenticDatabase.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * md-HZ-fp9K7r***
+   */
+  databaseUuid?: string;
+  /**
+   * @remarks
+   * The fully qualified name of the table. You can obtain this value from the QualifiedName parameter returned by ListAgenticTableBaseInfo. You must specify the full name.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * orders
+   */
+  tableQualifiedName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      databaseUuid: 'DatabaseUuid',
+      tableQualifiedName: 'TableQualifiedName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      databaseUuid: 'string',
+      tableQualifiedName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetAgenticTableIndexResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { GetAgenticTableIndexResponseBody } from "./GetAgenticTableIndexResponseBody";
+
+
+export class GetAgenticTableIndexResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: GetAgenticTableIndexResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: GetAgenticTableIndexResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetAgenticTableIndexResponseBody.ts

@@ -0,0 +1,78 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { AgenticTableIndex } from "./AgenticTableIndex";
+
+
+export class GetAgenticTableIndexResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of indexes.
+   */
+  data?: AgenticTableIndex[];
+  /**
+   * @remarks
+   * The error code returned when a request exception occurs.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
+   * @example
+   * UnknownError
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 67E910F2-4B62-5B0C-ACA3-7547695C****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful. Valid values:
+   * 
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: { 'type': 'array', 'itemType': AgenticTableIndex },
+      errorCode: 'string',
+      errorMessage: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.data)) {
+      $dara.Model.validateArray(this.data);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetDataAgentTaskModelUsageMetricsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentTaskModelUsageMetricsRequest extends $dara.Model {
   /**
    * @remarks
-   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month.
    * 
    * @example
    * 1735660800
@@ -21,13 +21,24 @@ export class GetDataAgentTaskModelUsageMetricsRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month.
    * 
    * @example
    * 1735747200
    */
   endTime?: string;
+  /**
+   * @remarks
+   * The list of billing instance IDs to query.
+   */
   instanceIds?: string[];
+  /**
+   * @remarks
+   * The billing level.
+   * 
+   * @example
+   * ENTERPRISE
+   */
   payLevel?: string;
   /**
    * @remarks

package/src/models/GetDataAgentTaskModelUsageMetricsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentTaskModelUsageMetricsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The start time of the statistical interval for this time series data point. The value is a UNIX timestamp in seconds.
+   * The start time of the statistical interval for the time-series point. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1735660800
@@ -13,7 +13,7 @@ export class GetDataAgentTaskModelUsageMetricsResponseBodyData extends $dara.Mod
   beginTime?: number;
   /**
    * @remarks
-   * The end time of the statistical interval for this time series data point. The value is a UNIX timestamp in seconds.
+   * The end time of the statistical interval for the time-series point. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1735660860
@@ -21,7 +21,7 @@ export class GetDataAgentTaskModelUsageMetricsResponseBodyData extends $dara.Mod
   endTime?: number;
   /**
    * @remarks
-   * The TPM for this time series data point, which is the number of tokens consumed within the statistical interval.
+   * The TPM at the time-series point, which represents the number of tokens consumed in the statistical interval.
    * 
    * @example
    * 1200
@@ -55,12 +55,12 @@ export class GetDataAgentTaskModelUsageMetricsResponseBodyData extends $dara.Mod
 export class GetDataAgentTaskModelUsageMetricsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The list of TPM time series metrics for model usage, returned in chronological order.
+   * The list of time-series TPM metrics for model usage. The usage at each time point is returned in chronological order.
    */
   data?: GetDataAgentTaskModelUsageMetricsResponseBodyData[];
   /**
    * @remarks
-   * The error code returned when the request is abnormal.
+   * The error code, which is returned when a request exception occurs.
    * 
    * @example
    * DMS-DA-40411
@@ -68,7 +68,7 @@ export class GetDataAgentTaskModelUsageMetricsResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message, which is returned when the call fails.
    * 
    * @example
    * UnknownError
@@ -84,10 +84,13 @@ export class GetDataAgentTaskModelUsageMetricsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request is successful. Valid values:
    * 
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
+   * 
+   * @example
+   * true
    */
   success?: boolean;
   static names(): { [key: string]: string } {

package/src/models/GetDataAgentTaskModelUsageMetricsShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentTaskModelUsageMetricsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month.
    * 
    * @example
    * 1735660800
@@ -21,13 +21,24 @@ export class GetDataAgentTaskModelUsageMetricsShrinkRequest extends $dara.Model
   DMSUnit?: string;
   /**
    * @remarks
-   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended time range is up to one month.
    * 
    * @example
    * 1735747200
    */
   endTime?: string;
+  /**
+   * @remarks
+   * The list of billing instance IDs to query.
+   */
   instanceIdsShrink?: string;
+  /**
+   * @remarks
+   * The billing level.
+   * 
+   * @example
+   * ENTERPRISE
+   */
   payLevel?: string;
   /**
    * @remarks

package/src/models/GetDataAgentTaskModelUsageRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentTaskModelUsageRequest extends $dara.Model {
   /**
    * @remarks
-   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month.
    * 
    * @example
    * 1735660800
@@ -13,7 +13,7 @@ export class GetDataAgentTaskModelUsageRequest extends $dara.Model {
   beginTime?: number;
   /**
    * @remarks
-   * The current Data Management unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou
@@ -21,13 +21,24 @@ export class GetDataAgentTaskModelUsageRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month.
    * 
    * @example
    * 1735747200
    */
   endTime?: number;
+  /**
+   * @remarks
+   * The list of billing instance IDs to be queried.
+   */
   instanceIds?: string[];
+  /**
+   * @remarks
+   * The billing level.
+   * 
+   * @example
+   * ENTERPRISE
+   */
   payLevel?: string;
   /**
    * @remarks

package/src/models/GetDataAgentTaskModelUsageResponseBody.ts

@@ -3,13 +3,41 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetDataAgentTaskModelUsageResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The acceleration ratio, which indicates the speed improvement brought by subtask parallelism.
+   * 
+   * @example
+   * 3.8
+   */
   accelerationRatio?: number;
+  /**
+   * @remarks
+   * The number of throttled sessions.
+   * 
+   * @example
+   * 8
+   */
   rateLimitedSessionCount?: number;
+  /**
+   * @remarks
+   * The total throttling duration of all sessions.
+   * 
+   * @example
+   * 89
+   */
   totalLlmWaitDuration?: number;
+  /**
+   * @remarks
+   * The total number of sessions.
+   * 
+   * @example
+   * 39
+   */
   totalSessionCount?: number;
   /**
    * @remarks
-   * The peak TPM (tokens per minute) within the query time range, which is the maximum number of tokens consumed per minute.
+   * The peak TPM within the query time range, which is the maximum number of tokens consumed per minute.
    * 
    * @example
    * 42000
@@ -82,7 +110,7 @@ export class GetDataAgentTaskModelUsageResponseBody extends $dara.Model {
   data?: GetDataAgentTaskModelUsageResponseBodyData;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when a request exception occurs.
    * 
    * @example
    * DMS-DA-40411
@@ -90,7 +118,7 @@ export class GetDataAgentTaskModelUsageResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * UnknownError
@@ -98,7 +126,7 @@ export class GetDataAgentTaskModelUsageResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The request ID, which is used to locate logs and troubleshoot issues.
+   * The request ID. You can use this ID to locate logs and troubleshoot issues.
    * 
    * @example
    * 67E910F2-***695C
@@ -106,10 +134,10 @@ export class GetDataAgentTaskModelUsageResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request is successful. Valid values:
    * 
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
    * 
    * @example
    * true

package/src/models/GetDataAgentTaskModelUsageShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentTaskModelUsageShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The start time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month.
    * 
    * @example
    * 1735660800
@@ -13,7 +13,7 @@ export class GetDataAgentTaskModelUsageShrinkRequest extends $dara.Model {
   beginTime?: number;
   /**
    * @remarks
-   * The current Data Management unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou
@@ -21,13 +21,24 @@ export class GetDataAgentTaskModelUsageShrinkRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no longer than one month.
+   * The end time of the query time range. The value is a UNIX timestamp in seconds. The recommended interval length is no more than one month.
    * 
    * @example
    * 1735747200
    */
   endTime?: number;
+  /**
+   * @remarks
+   * The list of billing instance IDs to be queried.
+   */
   instanceIdsShrink?: string;
+  /**
+   * @remarks
+   * The billing level.
+   * 
+   * @example
+   * ENTERPRISE
+   */
   payLevel?: string;
   /**
    * @remarks

package/src/models/GetDataAgentWorkspaceInfoRequest.ts

@@ -13,7 +13,7 @@ export class GetDataAgentWorkspaceInfoRequest extends $dara.Model {
   DMSUnit?: string;
   /**
    * @remarks
-   * The ID of the collaborative workspace.
+   * The ID of the workspace.
    * 
    * @example
    * 20923*****7291

package/src/models/GetDataAgentWorkspaceInfoResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentWorkspaceInfoResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The creation time of the session. Unit: seconds. The value is a UNIX timestamp.
+   * The creation time of the workspace. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1765960516
@@ -19,10 +19,17 @@ export class GetDataAgentWorkspaceInfoResponseBodyData extends $dara.Model {
    * 20282*****7591
    */
   creator?: string;
+  /**
+   * @remarks
+   * Indicates whether sessions are shared within the workspace.
+   * 
+   * @example
+   * true
+   */
   isSessionShareEnabled?: boolean;
   /**
    * @remarks
-   * The most recent modification time of the workspace. Unit: seconds. The value is a UNIX timestamp.
+   * The last modification time of the workspace. The value is a UNIX timestamp in seconds.
    * 
    * @example
    * 1765961516
@@ -44,10 +51,17 @@ export class GetDataAgentWorkspaceInfoResponseBodyData extends $dara.Model {
    * 11
    */
   totalMember?: string;
+  /**
+   * @remarks
+   * The type of the workspace.
+   * 
+   * @example
+   * personal
+   */
   type?: string;
   /**
    * @remarks
-   * The description of the collaborative workspace.
+   * The description of the workspace.
    * 
    * @example
    * space for test
@@ -55,7 +69,7 @@ export class GetDataAgentWorkspaceInfoResponseBodyData extends $dara.Model {
   workspaceDesc?: string;
   /**
    * @remarks
-   * The ID of the collaborative workspace.
+   * The ID of the workspace.
    * 
    * @example
    * 20923*****7291
@@ -142,7 +156,7 @@ export class GetDataAgentWorkspaceInfoResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * E0D2-*****-A63B6

package/src/models/ListAgenticCatalogRequest.ts

@@ -0,0 +1,68 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListAgenticCatalogRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The catalog type. This parameter is used to filter catalogs by exact type. Valid values:
+   * 
+   * - **JDBC**: relational database catalog
+   * - **DataLake**: data lake catalog
+   * - **Dataset**: knowledge base catalog
+   * 
+   * @example
+   * JDBC
+   */
+  catalogType?: string;
+  /**
+   * @remarks
+   * The maximum number of entries to return per page.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query. You do not need to specify this parameter for the first query. To query the next page, set this parameter to the NextToken value returned from the previous query.
+   * 
+   * @example
+   * f056501ada12****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The search keyword for the catalog name. Matches catalogs by name prefix.
+   * 
+   * @example
+   * prod_
+   */
+  searchKey?: string;
+  static names(): { [key: string]: string } {
+    return {
+      catalogType: 'CatalogType',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      searchKey: 'SearchKey',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      catalogType: 'string',
+      maxResults: 'number',
+      nextToken: 'string',
+      searchKey: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+