@alicloud/adb20211201 4.7.0 → 5.0.0

package/src/models/Detail.ts

@@ -4,61 +4,97 @@ import * as $dara from '@darabonba/typescript';
 
 export class Detail extends $dara.Model {
   /**
+   * @remarks
+   * The type of the Spark application.
+   * 
    * @example
    * BATCH
    */
   appType?: string;
   /**
+   * @remarks
+   * The ID of the cluster that runs the Spark application.
+   * 
    * @example
-   * amv-bp11q28kv****
+   * amv-bp11q28kvl688****
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * The configuration content of the Spark application.
+   * 
    * @example
    * {     "name": "SparkPi",     "file": "local:///tmp/spark-examples.jar",     "className": "org.apache.spark.examples.SparkPi",     "args": [         "1000000"     ],     "conf": {         "spark.driver.resourceSpec": "small",         "spark.executor.instances": 1,         "spark.executor.resourceSpec": "small"     } }
    */
   data?: string;
   /**
+   * @remarks
+   * The execution duration of the Spark application, in milliseconds (ms).
+   * 
    * @example
    * 100
    */
   durationInMillis?: number;
   /**
+   * @remarks
+   * The CPU time consumed by the Spark application, in milliseconds (ms).
+   * 
    * @example
    * 100
    */
   estimateExecutionCpuTimeInSeconds?: number;
   /**
+   * @remarks
+   * The execution duration.
+   * 
    * @example
    * 36000
    */
   executionDurationInMillis?: number;
   /**
+   * @remarks
+   * The ID of the last retry of the Spark application.
+   * 
    * @example
-   * s202204291426hzpre60cfa*****-0003
+   * s202204291426hzpre60****-0003
    */
   lastAttemptId?: string;
   /**
+   * @remarks
+   * The time when the Spark application was last updated. This value is a UNIX timestamp, in milliseconds (ms).
+   * 
    * @example
    * 1651213645200
    */
   lastUpdatedTimeInMillis?: number;
   /**
+   * @remarks
+   * The storage path of the log file.
+   * 
    * @example
    * oss://<bucket-name>/logs/driver
    */
   logRootPath?: string;
   /**
+   * @remarks
+   * The name of the job resource group.
+   * 
    * @example
    * spark-rg
    */
   resourceGroupName?: string;
   /**
+   * @remarks
+   * The duration of resource provisioning for the application.
+   * 
    * @example
    * 36000
    */
   resourceProvisioningDurationInMillis?: number;
   /**
+   * @remarks
+   * The timestamp when the job started running.
+   * 
    * @example
    * 36000
    * 
@@ -67,23 +103,35 @@ export class Detail extends $dara.Model {
    */
   runningStartTimeInMillis?: number;
   /**
+   * @remarks
+   * The time when the Spark application was created. This value is a UNIX timestamp, in milliseconds (ms).
+   * 
    * @example
    * 1651213645010
    */
   startedTimeInMillis?: number;
   /**
+   * @remarks
+   * The time when the Spark application was submitted. This value is a UNIX timestamp, in milliseconds (ms).
+   * 
    * @example
    * 1651213645000
    */
   submittedTimeInMillis?: number;
   /**
+   * @remarks
+   * The time when the Spark application was terminated. This value is a UNIX timestamp, in milliseconds (ms).
+   * 
    * @example
    * 1651213645300
    */
   terminatedTimeInMillis?: number;
   /**
+   * @remarks
+   * The Web UI address.
+   * 
    * @example
-   * https://sparkui.aliyuncs.com/token=xxx
+   * https://adbsparkui-cn-hangzhou.aliyuncs.com/?token=****
    */
   webUiAddress?: string;
   static names(): { [key: string]: string } {

package/src/models/DownloadInstanceCacertificateRequest.ts

@@ -15,10 +15,10 @@ export class DownloadInstanceCACertificateRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The database engine of the cluster. Valid values:
+   * The database engine. Valid values:
    * 
-   * *   **AnalyticDB** (default): the AnalyticDB for MySQL engine.
-   * *   **Clickhouse**: the wide table engine.
+   * - **AnalyticDB** (default): AnalyticDB for MySQL engine.
+   * - **Clickhouse**: wide table engine.
    * 
    * @example
    * Clickhouse
@@ -28,8 +28,7 @@ export class DownloadInstanceCACertificateRequest extends $dara.Model {
   /**
    * @remarks
    * The region ID.
-   * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the most recent region list.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/143074.html) operation to query the supported regions and zones, including region IDs.
    * 
    * @example
    * cn-hangzhou

package/src/models/DownloadInstanceCacertificateResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DownloadInstanceCACertificateResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The OSS URL of the downloaded certificate.
+   * The certificate download path.
    */
   downloadUrl?: string;
   /**

package/src/models/ExecuteSparkWarehouseBatchSqlrequest.ts

@@ -8,7 +8,7 @@ export class ExecuteSparkWarehouseBatchSQLRequest extends $dara.Model {
    * The name of the client.
    * 
    * @example
-   * DataWorks
+   * Dataworks。
    */
   agency?: string;
   /**

package/src/models/FieldSchemaModel.ts

@@ -3,32 +3,221 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class FieldSchemaModel extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the column is auto-incremented.
+   * 
+   * @example
+   * true
+   */
   autoIncrement?: boolean;
+  /**
+   * @remarks
+   * The original name of the column.
+   * 
+   * @example
+   * ColumnRawName
+   */
   columnRawName?: string;
+  /**
+   * @remarks
+   * The description of the column.
+   * 
+   * @example
+   * comment
+   */
   comment?: string;
+  /**
+   * @remarks
+   * Indicates whether FLOAT data is compressed to SHORT data.
+   * 
+   * @example
+   * false
+   */
   compressFloatUseShort?: boolean;
+  /**
+   * @remarks
+   * The compression method of the column.
+   * 
+   * @example
+   * compression
+   */
   compression?: string;
+  /**
+   * @remarks
+   * The time when the column was created.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   createTime?: string;
+  /**
+   * @remarks
+   * The data type of the column.
+   * 
+   * @example
+   * long
+   */
   dataType?: string;
+  /**
+   * @remarks
+   * The logical name of the database.
+   * 
+   * @example
+   * databaseName
+   */
   databaseName?: string;
+  /**
+   * @remarks
+   * The default value of the column.
+   * 
+   * @example
+   * default
+   */
   defaultValue?: string;
+  /**
+   * @remarks
+   * The delimiter of the column.
+   * 
+   * @example
+   * delimiter
+   */
   delimiter?: string;
+  /**
+   * @remarks
+   * The encryption method of the column.
+   * 
+   * @example
+   * encode
+   */
   encode?: string;
+  /**
+   * @remarks
+   * Indicates whether the column is the partition key.
+   * 
+   * @example
+   * false
+   */
   isPartitionKey?: boolean;
+  /**
+   * @remarks
+   * The mapping name.
+   * 
+   * @example
+   * mappedName
+   */
   mappedName?: string;
+  /**
+   * @remarks
+   * The name of the column.
+   * 
+   * @example
+   * name
+   */
   name?: string;
+  /**
+   * @remarks
+   * Indicates whether the column can be empty.
+   * 
+   * @example
+   * true
+   */
   nullable?: boolean;
+  /**
+   * @remarks
+   * The update condition of the column.
+   * 
+   * @example
+   * onUpdate
+   */
   onUpdate?: string;
+  /**
+   * @remarks
+   * The location of the column.
+   * 
+   * @example
+   * -1
+   */
   ordinalPosition?: number;
+  /**
+   * @remarks
+   * The physical name of the column.
+   * 
+   * @example
+   * PhysicalColumnName
+   */
   physicalColumnName?: string;
+  /**
+   * @remarks
+   * The location of the primary key.
+   * 
+   * @example
+   * -1
+   */
   pkPosition?: number;
+  /**
+   * @remarks
+   * The precision of the column.
+   * 
+   * @example
+   * 1
+   */
   precision?: number;
+  /**
+   * @remarks
+   * Indicates whether the column is the primary key.
+   * 
+   * @example
+   * true
+   */
   primarykey?: boolean;
+  /**
+   * @remarks
+   * The scale of the column.
+   * 
+   * @example
+   * 1
+   */
   scale?: number;
+  /**
+   * @remarks
+   * The logical name of the table.
+   * 
+   * @example
+   * tableName
+   */
   tableName?: string;
+  /**
+   * @remarks
+   * The token of the column.
+   * 
+   * @example
+   * tokenizer
+   */
   tokenizer?: string;
+  /**
+   * @remarks
+   * The type of the column.
+   * 
+   * @example
+   * long
+   */
   type?: string;
+  /**
+   * @remarks
+   * The time when the index was updated.
+   * 
+   * @example
+   * 2023-01-05 13:17:55
+   */
   updateTime?: string;
+  /**
+   * @remarks
+   * The value type of the column.
+   * 
+   * @example
+   * valueType
+   */
   valueType?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/GenerateSqlBySemanticSqlRequest.ts

@@ -0,0 +1,58 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GenerateSqlBySemanticSqlRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the ADB cluster.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * am-uf6wjk5xxxxxxxxxx
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The schema name.
+   * 
+   * @example
+   * adb_demo
+   */
+  schemaName?: string;
+  /**
+   * @remarks
+   * The SQL statement that queries the semantic view.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * select sum(amount) from sv_sales
+   */
+  sql?: string;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      schemaName: 'SchemaName',
+      sql: 'Sql',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      schemaName: 'string',
+      sql: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/{ListApsOptimizationTasksResponse.ts → GenerateSqlBySemanticSqlResponse.ts}

@@ -1,12 +1,12 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { ListApsOptimizationTasksResponseBody } from "./ListApsOptimizationTasksResponseBody";
+import { GenerateSqlBySemanticSqlResponseBody } from "./GenerateSqlBySemanticSqlResponseBody";
 
 
-export class ListApsOptimizationTasksResponse extends $dara.Model {
+export class GenerateSqlBySemanticSqlResponse extends $dara.Model {
   headers?: { [key: string]: string };
   statusCode?: number;
-  body?: ListApsOptimizationTasksResponseBody;
+  body?: GenerateSqlBySemanticSqlResponseBody;
   static names(): { [key: string]: string } {
     return {
       headers: 'headers',
@@ -19,7 +19,7 @@ export class ListApsOptimizationTasksResponse extends $dara.Model {
     return {
       headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
       statusCode: 'number',
-      body: ListApsOptimizationTasksResponseBody,
+      body: GenerateSqlBySemanticSqlResponseBody,
     };
   }
 

package/src/models/GenerateSqlBySemanticSqlResponseBody.ts

@@ -0,0 +1,96 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GenerateSqlBySemanticSqlResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The error message returned when the task fails to be created.
+   * 
+   * @example
+   * Failed to rewrite semantic SQL: Ambiguous path from \\"lineitem\\" to \\"nation\\". Multiple paths found
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The generated executable SQL statement.
+   * 
+   * @example
+   * select sum(amount) from orders
+   */
+  generatedSql?: string;
+  /**
+   * @remarks
+   * Indicates whether the generation request was successful. Valid values:
+   * - **true**: Successful.
+   * - **false**: Failed.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      errorMessage: 'ErrorMessage',
+      generatedSql: 'GeneratedSql',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      errorMessage: 'string',
+      generatedSql: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GenerateSqlBySemanticSqlResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
+  data?: GenerateSqlBySemanticSqlResponseBodyData;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 1AD222E9-E606-4A42-BF6D-8A4442913CEF
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      data: 'Data',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      data: GenerateSqlBySemanticSqlResponseBodyData,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetAdbsparkNecessaryRampermissionsRequest.ts

@@ -6,8 +6,7 @@ export class GetADBSparkNecessaryRAMPermissionsRequest extends $dara.Model {
   /**
    * @remarks
    * The cluster ID.
-   * 
-   * >  You can call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
+   * > Call the [DescribeDBClusters](https://help.aliyun.com/document_detail/129857.html) operation to query the IDs of all clusters in a specific region.
    * 
    * This parameter is required.
    * 

package/src/models/GetAdbsparkNecessaryRampermissionsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail extends $dara.Model {
   /**
    * @remarks
-   * The name of the RAM action that failed the authentication.
+   * The name of the RAM action for which authentication failed.
    * 
    * @example
    * ListSparkApps
@@ -13,10 +13,9 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   action?: string;
   /**
    * @remarks
-   * The type of the policy denial. Valid values:
-   * 
-   * *   ImplicitDeny: Resource owner has not configured relevant permission policies for the current user, default denial of unauthorized operations.
-   * *   ExplicitDeny: RAM policies configured by the resource owner explicitly deny the current user access to corresponding resources
+   * The type of access policy denial. Valid values:
+   * - ImplicitDeny: The resource owner has not configured a relevant access policy for the current user. Unauthorized operations are denied by default.
+   * - ExplicitDeny: The RAM policy configured by the resource owner explicitly denies the current user authorization to access the corresponding resource.
    * 
    * @example
    * ImplicitDeny
@@ -24,13 +23,12 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   noPermissionType?: string;
   /**
    * @remarks
-   * The type of the policy that causes the access denied error.
-   * 
-   * *   ControlPolicy: control policy
-   * *   SessionPolicy: Temporary Token additional permission policy
-   * *   AssumeRolePolicy: RAM role trust policy
-   * *   AccountLevelIdentityBasedPolicy: Principal policy within account authorization scope, including custom policies and system policies
-   * *   ResourceGroupLevelIdentityBasedPolicy: Principal policy within resource group authorization scope, including custom policies and system policies.
+   * The type of the policy that caused the permission denial. Valid values:
+   * - ControlPolicy: control policy.
+   * - SessionPolicy: an additional permission policy attached to a temporary token.
+   * - AssumeRolePolicy: the trust policy of a RAM role.
+   * - AccountLevelIdentityBasedPolicy: an identity-access policy at the account authorization scope, including custom policies and system policies.
+   * - ResourceGroupLevelIdentityBasedPolicy: an identity-access policy at the resource group authorization scope, including custom policies and system policies.
    * 
    * @example
    * ControlPolicy
@@ -39,9 +37,8 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   /**
    * @remarks
    * The identity type of the current user. Valid values:
-   * 
-   * *   SubUser: a RAM user
-   * *   AssumedRoleUser: a RAM role
+   * - SubUser: Resource Access Management (RAM) user.
+   * - AssumedRoleUser: RAM role.
    * 
    * @example
    * SubUser
@@ -49,7 +46,7 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
   principalType?: string;
   /**
    * @remarks
-   * Authentication object information, can be the current user\\"s RAM account ID, or the role information corresponding to the current visitor.
+   * The information about the authentication target, which can be the Resource Access Management (RAM) users ID of the current user or the role information of the current accessor.
    * 
    * @example
    * 223345695632****
@@ -97,15 +94,15 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail exte
 export class GetADBSparkNecessaryRAMPermissionsResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * When permission check fails, returns diagnostic information related to permission check failure.
+   * The diagnostic information returned when the permission check fails.
    */
   deniedDetail?: GetADBSparkNecessaryRAMPermissionsResponseBodyDataDeniedDetail;
   /**
    * @remarks
-   * Check whether the use has the basic permissions to use Analytic DB for Spark.
+   * Indicates whether the current user has the basic permissions to use ADB Spark. Valid values:
    * 
-   * *   true: The check is passed and the basic permissions are granted.
-   * *   false: The check fails and some permissions are missing.
+   * - true: The check is passed. The user has the basic permissions.
+   * - false: The check failed. The user is missing some permissions.
    * 
    * @example
    * true
@@ -113,7 +110,7 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyData extends $dara.Mo
   passed?: boolean;
   /**
    * @remarks
-   * Based on diagnostic information, recommends configurations for customers to perform in the RAM system.
+   * The recommended RAM configuration based on the diagnostic information.
    * 
    * @example
    * Grant the system RAM policy \\"AliyunADBDeveloperAccess\\" to current RAM user can quickly solve this issue.
@@ -150,12 +147,12 @@ export class GetADBSparkNecessaryRAMPermissionsResponseBodyData extends $dara.Mo
 export class GetADBSparkNecessaryRAMPermissionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The returned result.
+   * The returned data.
    */
   data?: GetADBSparkNecessaryRAMPermissionsResponseBodyData;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 642F3512-C628-5D0C-8815-F6670C****