@alicloud/gpdb20160503 3.5.0 → 3.6.0

package/src/models/CreateSaasServiceRequest.ts

@@ -0,0 +1,125 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSaasServiceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The compute resources of the SaaS service.
+   * 
+   * @example
+   * 1
+   */
+  cu?: number;
+  /**
+   * @remarks
+   * The billing method. Valid values:
+   * 
+   * - **Postpaid**: pay-as-you-go.
+   * - **Prepaid**: subscription.
+   * 
+   * > - If you leave this parameter empty, a Free service is created by default.
+   * > - The subscription billing method offers discounts for purchases of one year or longer. Select a billing method as needed.
+   * 
+   * @example
+   * Postpaid
+   */
+  payType?: string;
+  /**
+   * @remarks
+   * The unit of the duration for which you want to purchase the resource. Valid values:
+   * - **Month**: month.
+   * - **Year**: year.
+   * 
+   * > This parameter is required when you create a subscription instance.
+   * 
+   * @example
+   * Month
+   */
+  period?: string;
+  /**
+   * @remarks
+   * Deprecated.
+   * 
+   * @example
+   * deprecated
+   */
+  plan?: string;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The service type. Valid values:
+   * 
+   * - **memroy**
+   * - **drama**.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * drama
+   */
+  serviceType?: string;
+  /**
+   * @remarks
+   * The duration for which you want to purchase the resource. Valid values:
+   * - If **Period** is set to **Month**, the valid values are 1 to 11.
+   * - If **Period** is set to **Year**, the valid values are 1 to 3.
+   * 
+   * > This parameter is required when you create a subscription instance.
+   * 
+   * @example
+   * 1
+   */
+  usedTime?: string;
+  /**
+   * @remarks
+   * The workspace of the SaaS service.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ws-*****
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      cu: 'Cu',
+      payType: 'PayType',
+      period: 'Period',
+      plan: 'Plan',
+      regionId: 'RegionId',
+      serviceType: 'ServiceType',
+      usedTime: 'UsedTime',
+      workspaceId: 'WorkspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      cu: 'number',
+      payType: 'string',
+      period: 'string',
+      plan: 'string',
+      regionId: 'string',
+      serviceType: 'string',
+      usedTime: 'string',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateSaasServiceResponse.ts

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

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateSaasServiceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The order ID.
+   * 
+   * @example
+   * *********
+   */
+  orderId?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 7565770E-7C45-462D-BA4A-8A5396F2CAD1
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The service ID.
+   * 
+   * @example
+   * agdb-eqxwj5tj5ojx
+   */
+  serviceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      orderId: 'OrderId',
+      requestId: 'RequestId',
+      serviceId: 'ServiceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      orderId: 'string',
+      requestId: 'string',
+      serviceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateStreamingJobRequest.ts

@@ -91,7 +91,7 @@ export class CreateStreamingJobRequest extends $dara.Model {
    * Kafka group name
    * 
    * @example
-   * group_name.
+   * group_name。
    */
   groupName?: string;
   /**

package/src/models/CreateStreamingJobShrinkRequest.ts

@@ -91,7 +91,7 @@ export class CreateStreamingJobShrinkRequest extends $dara.Model {
    * Kafka group name
    * 
    * @example
-   * group_name.
+   * group_name。
    */
   groupName?: string;
   /**

package/src/models/CreateSupabaseProjectRequest.ts

@@ -7,9 +7,9 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
    * @remarks
    * The password of the initial account.
    * 
-   * *   The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
-   * *   Special characters include `! @ # $ % ^ & * ( ) _ + - =`
-   * *   The password must be 8 to 32 characters in length.
+   * - The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.
+   * - The following special characters are supported: `!@#$%^&*()_+-=`
+   * - The password must be 8 to 32 characters in length.
    * 
    * This parameter is required.
    * 
@@ -28,24 +28,50 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The performance level of Enterprise SSDs (ESSDs). Default value: PL0. Valid values:
-   * 
-   * *   PL0
-   * *   PL1
+   * The performance level (PL) of the cloud disk. Default value: PL0. Valid values:
+   * - PL0
+   * - PL1
    * 
    * @example
    * PL0
    */
   diskPerformanceLevel?: string;
+  engineVersion?: string;
+  /**
+   * @remarks
+   * The billing method. Valid values:
+   * 
+   * - **Postpaid**: pay-as-you-go.
+   * - **Prepaid**: subscription.
+   * 
+   * > - If you do not specify this parameter, an instance of the Free type is created by default.
+   * > - If you select the subscription billing method, you can receive discounts when you purchase a one-year or longer subscription. We recommend that you select a billing method based on your business requirements.
+   * 
+   * @example
+   * Postpaid
+   */
   payType?: string;
+  /**
+   * @remarks
+   * The unit of the subscription duration. Valid values:
+   * - **Month**: month.
+   * - **Year**: year.
+   * 
+   * > This parameter is required when you create a subscription instance.
+   * 
+   * @example
+   * Month
+   */
   period?: string;
   /**
    * @remarks
-   * The name of the Supabase project. The name must meet the following requirements:
+   * The project name. The naming rules are as follows:
    * 
-   * *   The name must be 1 to 128 characters in length.
-   * *   The name can contain only letters, digits, hyphens (-), and underscores (_).
-   * *   The name must start with a letter or an underscore (_).
+   * - The name must be 1 to 128 characters in length.
+   * 
+   * - The name can contain only letters, digits, hyphens (-), and underscores (_).
+   * 
+   * - The name must start with a letter or an underscore (_).
    * 
    * This parameter is required.
    * 
@@ -55,7 +81,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The specifications of the Supabase project. Default value: 1C1G.
+   * The Supabase instance specification. The default specification for the Free type is 1C1G. The specifications for paid types are consistent with those available on the console.
    * 
    * This parameter is required.
    * 
@@ -65,7 +91,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
   projectSpec?: string;
   /**
    * @remarks
-   * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the most recent region list.
+   * The region ID. You can call [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) to view the available region IDs.
    * 
    * @example
    * cn-hangzhou
@@ -75,7 +101,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
    * @remarks
    * The IP address whitelist.
    * 
-   * A value of 127.0.0.1 denies access from any external IP address. You can call the [ModifySecurityIps](https://help.aliyun.com/document_detail/86928.html) operation to modify the IP address whitelist after you create a project.
+   * The value 127.0.0.1 indicates that no external IP addresses are allowed to access the instance. After the instance is created, you can call [ModifySecurityIps](https://help.aliyun.com/document_detail/86928.html) to modify the IP address whitelist.
    * 
    * This parameter is required.
    * 
@@ -91,16 +117,24 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
    * 2
    */
   storageSize?: number;
-  usedTime?: string;
   /**
    * @remarks
-   * The vSwitch ID.
+   * The subscription duration. Valid values:
+   * - If **Period** is set to **Month**, the valid values are 1 to 11.
+   * - If **Period** is set to **Year**, the valid values are 1 to 3.
    * 
-   * > 
+   * > This parameter is required when you create a subscription instance.
    * 
-   * *   **This parameter** must be specified.
+   * @example
+   * 1
+   */
+  usedTime?: string;
+  /**
+   * @remarks
+   * The vSwitch ID.
    * 
-   * *   The zone where the **vSwitch** resides must be the same as the zone that is specified by **ZoneId**.
+   * > - The **vSwitchId** parameter is required.
+   * > - The zone of the **vSwitch** must be the same as the value of **ZoneId**.
    * 
    * This parameter is required.
    * 
@@ -110,13 +144,9 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The virtual private cloud (VPC) ID.
-   * 
-   * > 
-   * 
-   * *   You can call the [DescribeRdsVpcs](https://help.aliyun.com/document_detail/208327.html) operation to query the available VPC IDs.
-   * 
-   * *   This parameter must be specified.
+   * The VPC ID.
+   * >  - You can call [DescribeRdsVpcs](https://help.aliyun.com/document_detail/208327.html) to view the available VPC IDs.
+   * > - This parameter is required.
    * 
    * This parameter is required.
    * 
@@ -128,7 +158,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
    * @remarks
    * The zone ID.
    * 
-   * >  You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the most recent zone list.
+   * > You can call [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) to view the available zone IDs.
    * 
    * This parameter is required.
    * 
@@ -142,6 +172,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
       autoScale: 'AutoScale',
       clientToken: 'ClientToken',
       diskPerformanceLevel: 'DiskPerformanceLevel',
+      engineVersion: 'EngineVersion',
       payType: 'PayType',
       period: 'Period',
       projectName: 'ProjectName',
@@ -162,6 +193,7 @@ export class CreateSupabaseProjectRequest extends $dara.Model {
       autoScale: 'boolean',
       clientToken: 'string',
       diskPerformanceLevel: 'string',
+      engineVersion: 'string',
       payType: 'string',
       period: 'string',
       projectName: 'string',

package/src/models/CreateSupabaseProjectResponseBody.ts

@@ -3,10 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateSupabaseProjectResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The order ID.
+   * 
+   * @example
+   * 278880417310796
+   */
   orderId?: string;
   /**
    * @remarks
-   * The Supabase project ID.
+   * The Supabase instance ID.
    * 
    * @example
    * sbp-180****

package/src/models/CreateVectorIndexRequest.ts

@@ -3,11 +3,27 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateVectorIndexRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The vector indexing algorithm.
+   * 
+   * Valid values:
+   * 
+   * - `hnswflat`: (Default) An HNSW index that does not use quantization compression.
+   * 
+   * - `novam`: A graph-based index that does not use quantization compression. This algorithm is suitable for high-performance scenarios, such as real-time recommendations.
+   * 
+   * - `novad`: A partitioned index that uses rabitq quantization. This algorithm is suitable for large-scale, cost-effective retrieval scenarios.
+   * 
+   * @example
+   * hnswflat
+   */
   algorithm?: string;
   /**
    * @remarks
-   * Collection name.
-   * > You can use the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) API to view the list.
+   * The collection name.
+   * 
+   * > You can call the [ListCollections](https://help.aliyun.com/document_detail/2401503.html) operation to list all collections.
    * 
    * This parameter is required.
    * 
@@ -17,9 +33,9 @@ export class CreateVectorIndexRequest extends $dara.Model {
   collection?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
-   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) API to view details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to view the details of all AnalyticDB for PostgreSQL instances in a specific region, including the instance ID.
    * 
    * This parameter is required.
    * 
@@ -29,8 +45,11 @@ export class CreateVectorIndexRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Vector dimension.
-   * > This value must be consistent with the length of the vector data (Rows. Vector) uploaded via the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) API.
+   * The vector dimension.
+   * 
+   * > - This parameter is required for dense vectors.
+   * >
+   * > - This value must match the length of the `Rows.Vector` data provided when calling the [UpsertCollectionData](https://help.aliyun.com/document_detail/2401493.html) operation.
    * 
    * @example
    * 1024
@@ -38,26 +57,51 @@ export class CreateVectorIndexRequest extends $dara.Model {
   dimension?: number;
   /**
    * @remarks
-   * Whether to use mmap to build the HNSW index, default is 0. If the data does not need to be deleted and there are performance requirements for uploading data, it is recommended to set this to 1.
+   * Specifies whether to use `mmap` to build the HNSW index. The default value is 0. Set this to 1 for high-performance data uploads in scenarios where data deletion is not required.
+   * 
+   * Valid values:
    * 
-   * > 
-   * > - When set to 0, the segment-page storage mode is used to build the index, which can use the shared_buffer in PostgreSQL for caching and supports deletion and update operations.
-   * > - When set to 1, the index is built using mmap, which does not support deletion and update operations.
+   * - `0`: (Default) Builds the index by using segmented page storage. This mode uses the `shared_buffer` in PostgreSQL for caching and supports delete and update operations.
+   * 
+   * - `1`: Builds the index by using `mmap`. This mode does not support delete and update operations.
+   * 
+   * >Notice: 
+   * 
+   * The `ExternalStorage` parameter is supported only by AnalyticDB for PostgreSQL V6.0.
    * 
    * @example
    * 0
    */
   externalStorage?: number;
+  /**
+   * @remarks
+   * The size of the candidate set for the HNSW algorithm during index construction. The value must be in the range of 4 to 1,000. The default value is 64.
+   * 
+   * > This parameter applies only to AnalyticDB for PostgreSQL V7.0 instances, and its value must be greater than or equal to `2 * HnswM`.
+   * 
+   * @example
+   * 128
+   */
   hnswEfConstruction?: number;
   /**
    * @remarks
-   * The maximum number of neighbors in the HNSW algorithm, ranging from 1 to 1000. The API will automatically set this value based on the vector dimension, and it generally does not need to be manually set.
+   * The maximum number of neighbors for the Hierarchical Navigable Small World (HNSW) algorithm. The system automatically sets this value based on the vector dimension. You do not typically need to configure this parameter manually.
    * 
-   * > It is suggested to set this based on the vector dimension as follows:
-   * > - Less than or equal to 384: 16
-   * > - Greater than 384 and less than or equal to 768: 32
-   * > - Greater than 768 and less than or equal to 1024: 64
-   * > - Greater than 1024: 128
+   * > Valid values:
+   * >
+   * > - For AnalyticDB for PostgreSQL V6.0 instances: 1 to 1,000.
+   * >
+   * > - For AnalyticDB for PostgreSQL V7.0 instances: 2 to 100. The default value is 16.
+   * 
+   * > We recommend the following values based on the vector dimension:
+   * >
+   * > - For dimensions of 384 or less: 16
+   * >
+   * > - For dimensions from 385 to 768: 32
+   * >
+   * > - For dimensions from 769 to 1,024: 64
+   * >
+   * > - For dimensions greater than 1,024: 128
    * 
    * @example
    * 64
@@ -65,9 +109,9 @@ export class CreateVectorIndexRequest extends $dara.Model {
   hnswM?: number;
   /**
    * @remarks
-   * Name of the management account with rds_superuser permissions.
+   * The name of the management account that has `rds_superuser` permissions.
    * 
-   * > You can create an account through the console -> Account Management, or by using the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) API.
+   * > You can create an account on the \\*\\*account management\\*\\* page in the console or by calling the [CreateAccount](https://help.aliyun.com/document_detail/2361789.html) operation.
    * 
    * This parameter is required.
    * 
@@ -77,7 +121,7 @@ export class CreateVectorIndexRequest extends $dara.Model {
   managerAccount?: string;
   /**
    * @remarks
-   * Management account password.
+   * The password of the management account.
    * 
    * This parameter is required.
    * 
@@ -87,10 +131,15 @@ export class CreateVectorIndexRequest extends $dara.Model {
   managerAccountPassword?: string;
   /**
    * @remarks
-   * Method used for building the vector index. Value description:
-   * - l2: Euclidean distance.
-   * - ip: Inner product (dot product) distance.
-   * - cosine: Cosine similarity.
+   * The distance metric used to build the vector index. Valid values:
+   * 
+   * - `l2`: euclidean distance
+   * 
+   * - `ip`: dot product (inner product)
+   * 
+   * - `cosine`: cosine similarity
+   * 
+   * > Sparse vectors support only `ip`.
    * 
    * @example
    * cosine
@@ -98,30 +147,46 @@ export class CreateVectorIndexRequest extends $dara.Model {
   metrics?: string;
   /**
    * @remarks
-   * Namespace, default is public.
+   * The namespace. The default value is `public`.
    * 
-   * > You can use the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) API to view the list.
+   * > You can call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to list all namespaces.
    * 
    * @example
    * mynamespace
    */
   namespace?: string;
+  /**
+   * @remarks
+   * The number of lists (partitions) for the Novad algorithm. The value must be in the range of 2 to 1,073,741,824. The default value is 256.
+   * 
+   * @example
+   * 256
+   */
   nlist?: number;
   ownerId?: number;
   /**
    * @remarks
-   * Whether to enable PQ (Product Quantization) algorithm acceleration for the index. It is recommended to enable this when the data volume exceeds 500,000. Value description:
-   * - 0: Disabled.
-   * - 1: Enabled (default).
+   * Specifies whether to enable Product Quantization (PQ) to accelerate indexing. Recommended for collections with over 500,000 vectors. Valid values:
+   * 
+   * - `0`: Disabled.
+   * 
+   * - `1`: Enabled. (Default)
    * 
    * @example
    * 1
    */
   pqEnable?: number;
+  /**
+   * @remarks
+   * The number of bits for rabitq compression. The valid range is 1 to 8. The default value is 3.
+   * 
+   * @example
+   * 3
+   */
   rabitqBits?: number;
   /**
    * @remarks
-   * Region ID where the instance is located.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 
@@ -129,6 +194,17 @@ export class CreateVectorIndexRequest extends $dara.Model {
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The vector type. Valid values:
+   * 
+   * - `Dense`: (Default) a dense vector
+   * 
+   * - `Sparse`: a sparse vector
+   * 
+   * @example
+   * Dense
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {