@alicloud/adb20211201 4.5.0 → 4.6.0

package/src/models/DescribeResultExportConfigResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeResultExportConfigResponseBodyDataOssInfo extends $dara.Model {
   /**
+   * @remarks
+   * The path of the OSS bucket to which the result sets are exported.
+   * 
    * @example
    * oss://testBucketName/data_result
    */
   exportBasePath?: string;
   /**
+   * @remarks
+   * The name of the resource group that runs the export SQL.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The expiration period (in days) for the OSS file. The returned value is between 1 and 30 days (inclusive).
+   * 
    * @example
    * 10
    */
@@ -45,16 +54,25 @@ export class DescribeResultExportConfigResponseBodyDataOssInfo extends $dara.Mod
 
 export class DescribeResultExportConfigResponseBodyDataSlsInfo extends $dara.Model {
   /**
+   * @remarks
+   * The expiration period (in days) for the temporary Logstore automatically created during result set export. The Logstore is automatically deleted after expiration. The returned value is between 1 and 30 days (inclusive).
+   * 
    * @example
    * 10
    */
   logstoreTtl?: number;
   /**
+   * @remarks
+   * The name of the resource group that runs the export SQL.
+   * 
    * @example
    * aps
    */
   resourceGroup?: string;
   /**
+   * @remarks
+   * The name of the SLS project.
+   * 
    * @example
    * test-project
    */
@@ -86,11 +104,25 @@ export class DescribeResultExportConfigResponseBodyDataSlsInfo extends $dara.Mod
 
 export class DescribeResultExportConfigResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The export type. Valid values:
+   * 
+   * *   SLS: Indicates that the export destination is SLS.
+   * *   OSS: Indicates that the export destination is OSS.
+   * 
    * @example
    * OSS
    */
   exportType?: string;
+  /**
+   * @remarks
+   * The configured OSS export settings, returned when the export destination is OSS.
+   */
   ossInfo?: DescribeResultExportConfigResponseBodyDataOssInfo;
+  /**
+   * @remarks
+   * The configured SLS export settings, returned when the export destination is SLS.
+   */
   slsInfo?: DescribeResultExportConfigResponseBodyDataSlsInfo;
   static names(): { [key: string]: string } {
     return {
@@ -125,27 +157,52 @@ export class DescribeResultExportConfigResponseBodyData extends $dara.Model {
 
 export class DescribeResultExportConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * API status or POP error code.
+   * 
    * @example
    * InvalidInput
    */
   code?: string;
+  /**
+   * @remarks
+   * The data returned.
+   */
   data?: DescribeResultExportConfigResponseBodyData;
   /**
+   * @remarks
+   * The HTTP response status code. A value of 200 indicates that the request was successful.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The returned message. Valid values:
+   * 
+   * *   The request succeeded, and the server returns **OK**.
+   * *   The request failed, and the server returns an error message.
+   * 
    * @example
    * OK
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the call was successful. Valid values: Valid values:
+   * 
+   * *   **True: Succeeded.**
+   * *   **False: Failed.
+   * 
    * @example
    * true
    */

package/src/models/DescribeSparkAuditLogRecordsRequest.ts

@@ -4,12 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSparkAuditLogRecordsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The source IP address.
+   * 
    * @example
    * 192.168.XX.XX
    */
   clientIp?: string;
   /**
    * @remarks
+   * The cluster ID.
+   * 
+   * > 
+   * 
+   * *   You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/454250.html) operation to query cluster IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,11 +26,33 @@ export class DescribeSparkAuditLogRecordsRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * Query end time. The end time must be later than the start time, and the interval between them must be less than 1 day. Format: yyyy-MM-ddTHH:mmZ (UTC time).
+   * 
    * @example
    * 2025-09-25T01:00Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * Sort the SQL statements based on specified fields. The format is a JSON array that preserves order, and composite sorting is performed according to the sequence of objects in the array. Each object contains two fields: `Field` and `Type`. For example:`[{"Field":"CreateTime", "Type": "desc" }]`. Where:
+   * 
+   * *   `Field` specifies the field that is used to sort the SQL statements. Valid values:
+   * 
+   *     *   `ResourceGroupName`: The name of the resource group.
+   *     *   `Status` :SQL execution status.
+   *     *   `User`: The username that is used to execute the SQL statement.
+   *     *   `ExecuteTime`: The start time of SQL execution.
+   *     *   `TotalTime`: The amount of time consumed to execute the SQL statement.
+   *     *   `ProcessId`: Query ID.
+   *     *   `ClientIp`: The source IP address.
+   *     *   `StatementSource`: The source from which the query was initiated.
+   * 
+   * *   `Type` specifies the sorting order. Valid values (case-insensitive):
+   * 
+   *     *   `Desc`: Descending order.
+   *     *   `Asc`: Ascending order.
+   * 
    * @example
    * [{\\"Field\\":\\"ExecuteTime\\",\\"Type\\":\\"Desc\\"}]
    */
@@ -29,27 +60,43 @@ export class DescribeSparkAuditLogRecordsRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The query ID.
+   * 
    * @example
    * 999f2439-6b10-xxxx-a5d3-daf3b35c****
    */
   processId?: string;
   /**
+   * @remarks
+   * This parameter is deprecated.
+   * 
    * @example
    * user
    */
   proxyUser?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
+   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/612293.html) operation to query the available regions and zones, including region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -57,6 +104,11 @@ export class DescribeSparkAuditLogRecordsRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource group name.
+   * 
+   * >  You can call the [DescribeDBResourceGroup](https://help.aliyun.com/document_detail/612410.html) operation to query the resource group ID within a cluster.
+   * 
    * @example
    * test_job
    */
@@ -64,39 +116,71 @@ export class DescribeSparkAuditLogRecordsRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * The keyword in the SQL statement.
+   * 
    * @example
    * test_table_name
    */
   SQLText?: string;
   /**
+   * @remarks
+   * Query start time. Format: *yyyy-MM-ddTHH:mmZ* (UTC time).
+   * 
+   * >  We recommend that you set the query start time to any point in time within 30 days.
+   * 
    * @example
    * 2025-09-25T00:00Z
    */
   startTime?: string;
   /**
    * @remarks
-   * Statement ID。
+   * The ID of the statement.
    * 
    * @example
    * fbd22066-1c03-xxxx-aa16-6ae28288****
    */
   statementId?: string;
   /**
+   * @remarks
+   * The source from which the query was initiated.
+   * 
+   * Valid values:
+   * 
+   * *   SQL_EDITOR: SQL_EDITOR.
+   * *   JDBC: JDBC.
+   * 
    * @example
    * SQL_EDITOR
    */
   statementSource?: string;
   /**
+   * @remarks
+   * The execution status of the SQL statement.
+   * 
+   * Valid values:
+   * 
+   * *   cancel: The task is canceled .
+   * *   finished: The execution succeeds .
+   * *   error:The execution fails .
+   * *   timeout: The execution timed out .
+   * 
    * @example
    * finish
    */
   status?: string;
   /**
+   * @remarks
+   * The duration of the SQL statement. Unit: milliseconds.
+   * 
    * @example
    * 3000
    */
   totalTime?: string;
   /**
+   * @remarks
+   * The username that is used to execute SQL statements.
+   * 
    * @example
    * test_user
    */

package/src/models/DescribeSparkAuditLogRecordsResponseBody.ts

@@ -4,79 +4,133 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeSparkAuditLogRecordsResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * The Spark application ID.
+   * 
    * @example
    * s202411061011hzc5d6476000****
    */
   appId?: string;
   /**
+   * @remarks
+   * The source IP address.
+   * 
    * @example
    * 192.168.XX.XX
    */
   clientIp?: string;
   /**
+   * @remarks
+   * The SQL execution error message.
+   * 
    * @example
    * notFoundIp
    */
   errorMsg?: string;
   /**
+   * @remarks
+   * The SQL execution error stack trace.
+   * 
    * @example
    * notFoundIpException
    */
   errorTrace?: string;
   /**
+   * @remarks
+   * The start time of the SQL statement. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.
+   * 
    * @example
    * 2022-01-23T16:05:08Z
    */
   executeTime?: string;
   /**
+   * @remarks
+   * The ID of the query executed within the Spark application.
+   * 
    * @example
    * 1
    */
   innerQueryId?: string;
   /**
+   * @remarks
+   * Whether it can be diagnosed.
+   * 
    * @example
    * true
    */
   isDiagnosable?: boolean;
   /**
+   * @remarks
+   * The query ID.
+   * 
    * @example
    * 999f2439-6b10-xxxx-a5d3-daf3b35c****
    */
   processId?: string;
   /**
+   * @remarks
+   * The resource group name.
+   * 
    * @example
    * test_job
    */
   resourceGroupName?: string;
   /**
+   * @remarks
+   * The SQL statement.
+   * 
    * @example
    * SELECT * FROM adb_hdfs_import_source
    */
   SQLText?: string;
   /**
    * @remarks
-   * Statement ID。
+   * The ID of the statement.
    * 
    * @example
    * fbd22066-1c03-xxxx-aa16-6ae28288****
    */
   statementId?: string;
   /**
+   * @remarks
+   * The source from which the query was initiated.
+   * 
+   * Valid values:
+   * 
+   * *   SQL_EDITOR: SQL_EDITOR.
+   * *   JDBC: JDBC.
+   * 
    * @example
    * SQL_EDITOR
    */
   statementSource?: string;
   /**
+   * @remarks
+   * The execution status of the SQL statement.
+   * 
+   * Valid values:
+   * 
+   * *   cancel: The task is canceled .
+   * *   finished: The execution succeeds .
+   * *   error: The execution fails .
+   * *   timeout: The execution of the command timed out.
+   * 
    * @example
    * finish
    */
   status?: string;
   /**
+   * @remarks
+   * The duration of the SQL statement. Unit: milliseconds.
+   * 
    * @example
    * 40000
    */
   totalTime?: number;
   /**
+   * @remarks
+   * The username that is used to execute SQL statements.
+   * 
    * @example
    * test_user
    */
@@ -132,6 +186,9 @@ export class DescribeSparkAuditLogRecordsResponseBodyItems extends $dara.Model {
 
 export class DescribeSparkAuditLogRecordsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The details about the access denial. This parameter is returned only if Resource Access Management (RAM) permission verification failed.
+   * 
    * @example
    * {
    *     "PolicyType": "AccountLevelIdentityBasedPolicy",
@@ -145,27 +202,46 @@ export class DescribeSparkAuditLogRecordsResponseBody extends $dara.Model {
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * The cluster ID.
+   * 
    * @example
    * amv-bp1j7******78j8i
    */
   DBClusterId?: string;
+  /**
+   * @remarks
+   * The list of SQL audit logs.
+   */
   items?: DescribeSparkAuditLogRecordsResponseBodyItems[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: string;
   /**
+   * @remarks
+   * The number of entries to return per page.
+   * 
    * @example
    * 30
    */
   pageSize?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 2D5867CF-423F-559F-BBB1-199A289E****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 100
    */

package/src/models/DescribeViewJobsRequest.ts

@@ -0,0 +1,131 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeViewJobsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The cluster ID.
+   * 
+   * @example
+   * am-bp1ub9grke1****
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The owner of the view.
+   * 
+   * @example
+   * admin
+   */
+  filterOwner?: string;
+  /**
+   * @remarks
+   * The name of the view.
+   * 
+   * @example
+   * test_mv
+   */
+  filterViewName?: string;
+  /**
+   * @remarks
+   * The type of the view.
+   * 
+   * Valid values:
+   * 
+   * \\-VIRTUAL_VIEW
+   * 
+   * \\-MATERIALIZED_VIEW
+   * 
+   * This parameter is empty by default.
+   * 
+   * @example
+   * MATERIALIZED_VIEW
+   */
+  filterViewType?: string;
+  /**
+   * @remarks
+   * The field used for sorting. Valid values for Type:
+   * 
+   * *   Asc.
+   * *   Desc.
+   * 
+   * Valid values for Field:
+   * 
+   * *   StartTime.
+   * *   EndTime;
+   * *   ScheduledStartTime;
+   * 
+   * @example
+   * {\\"Field\\":\\"StartTime\\",\\"Type\\":\\"Desc\\"}
+   */
+  orderBy?: string;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The database name.
+   * 
+   * @example
+   * demo_db
+   */
+  schemaName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      filterOwner: 'FilterOwner',
+      filterViewName: 'FilterViewName',
+      filterViewType: 'FilterViewType',
+      orderBy: 'OrderBy',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+      schemaName: 'SchemaName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      filterOwner: 'string',
+      filterViewName: 'string',
+      filterViewType: 'string',
+      orderBy: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+      schemaName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeViewJobsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeViewJobsResponseBody } from "./DescribeViewJobsResponseBody";
+
+
+export class DescribeViewJobsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeViewJobsResponseBody;
+  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: DescribeViewJobsResponseBody,
+    };
+  }
+
+  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);
+  }
+}
+