@alicloud/gpdb20160503 3.5.0 → 3.7.0

package/src/models/ListSaasServiceResponseBody.ts

@@ -0,0 +1,193 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListSaasServiceResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2021-10-09T04:54:08Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The computing resources.
+   * 
+   * @example
+   * 1
+   */
+  cu?: number;
+  /**
+   * @remarks
+   * The expiration time.
+   * 
+   * @example
+   * 2021-10-15T16:00:00Z
+   */
+  expireTime?: string;
+  /**
+   * @remarks
+   * The billing type. Valid values:
+   * 
+   * - **POSTPAY**: pay-as-you-go.
+   * - **PREPAY**: subscription.
+   * 
+   * @example
+   * POSTPAY
+   */
+  payType?: string;
+  /**
+   * @remarks
+   * [Deprecated]
+   * 
+   * @example
+   * deprecated
+   */
+  plan?: string;
+  /**
+   * @remarks
+   * The service ID.
+   * 
+   * @example
+   * agdb-xxxx
+   */
+  serviceId?: string;
+  /**
+   * @remarks
+   * The service name.
+   * 
+   * @example
+   * agdb-xxxx
+   */
+  serviceName?: string;
+  /**
+   * @remarks
+   * The service type:
+   * 
+   * - **memory**
+   * - **drama**
+   * 
+   * @example
+   * memory
+   */
+  serviceType?: string;
+  /**
+   * @remarks
+   * The service status:
+   * 
+   * - active: Running
+   * - creating: Being created
+   * 
+   * @example
+   * active
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      cu: 'Cu',
+      expireTime: 'ExpireTime',
+      payType: 'PayType',
+      plan: 'Plan',
+      serviceId: 'ServiceId',
+      serviceName: 'ServiceName',
+      serviceType: 'ServiceType',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      cu: 'number',
+      expireTime: 'string',
+      payType: 'string',
+      plan: 'string',
+      serviceId: 'string',
+      serviceName: 'string',
+      serviceType: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListSaasServiceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of service details.
+   */
+  items?: ListSaasServiceResponseBodyItems[];
+  /**
+   * @remarks
+   * The maximum number of entries returned in this request. Default value: 10.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query to begin with.
+   * 
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a4883
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of records.
+   * 
+   * @example
+   * 2
+   */
+  totalRecordCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      requestId: 'RequestId',
+      totalRecordCount: 'TotalRecordCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': ListSaasServiceResponseBodyItems },
+      maxResults: 'number',
+      nextToken: 'string',
+      requestId: 'string',
+      totalRecordCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListSecretsRequest.ts

@@ -24,6 +24,13 @@ export class ListSecretsRequest extends $dara.Model {
    * cn-beijing
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The ID of the workspace composed of multiple database instances. This parameter and the DBInstanceId parameter cannot both be empty. If both are specified, this parameter takes precedence.
+   * 
+   * @example
+   * gp-ws-*****
+   */
   workspaceId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListStreamingJobsResponseBody.ts

@@ -129,7 +129,7 @@ export class ListStreamingJobsResponseBodyJobItems extends $dara.Model {
    * 2.  professional: In professional mode, you can submit a YAML configuration file.
    * 
    * @example
-   * Basic / Professional
+   * basic / professional
    */
   mode?: string;
   /**

package/src/models/ListSupabaseProjectTagsRequest.ts

@@ -4,11 +4,27 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSupabaseProjectTagsRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key. The key can be 1 to 64 characters in length.
+   * 
+   * The `Tag.N` parameter specifies a key-value pair to filter Supabase instances.
+   * 
+   * N is an integer from 1 to 20.
+   * 
+   * - If you specify only `Tag.N.Key`, the operation returns all instances that have the specified tag key.
+   * 
+   * - If you specify only `Tag.N.Value`, an `InvalidParameter.TagValue` error is returned.
+   * 
+   * - If you specify multiple tag key-value pairs, the operation returns only Supabase instances that match all the specified pairs.
+   * 
    * @example
    * test-key
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value. The value can be 1 to 128 characters in length.
+   * 
    * @example
    * TestValue
    */
@@ -38,24 +54,42 @@ export class ListSupabaseProjectTagsRequestTag extends $dara.Model {
 
 export class ListSupabaseProjectTagsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The token for the next page of results. This token is returned in the `NextToken` parameter of a previous request.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
    */
   nextToken?: string;
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * > You must specify at least one of the `ResourceId` and `Tag` parameters.
+   */
   resourceId?: string[];
   /**
+   * @remarks
+   * The resource type. Set the value to `instance`.
+   * 
    * @example
    * instance
    */
   resourceType?: string;
+  /**
+   * @remarks
+   * A list of tags.
+   * 
+   * > You must specify at least one of the `ResourceId` and `Tag` parameters.
+   */
   tag?: ListSupabaseProjectTagsRequestTag[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListSupabaseProjectTagsResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSupabaseProjectTagsResponseBodyTagResources extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * spb-xxxxxxxxxx
    */
   resourceId?: string;
   /**
+   * @remarks
+   * The resource type.
+   * 
    * @example
    * instance
    */
   resourceType?: string;
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * TestKey
    */
   tagKey?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * TestValue
    */
@@ -52,18 +64,25 @@ export class ListSupabaseProjectTagsResponseBodyTagResources extends $dara.Model
 
 export class ListSupabaseProjectTagsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The pagination token for the next page of results. This parameter is not returned if no more results are available.
+   * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a4883
    */
   nextToken?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
    */
   requestId?: string;
+  /**
+   * @remarks
+   * A list of tagged resources.
+   */
   tagResources?: ListSupabaseProjectTagsResponseBodyTagResources[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListSupabaseProjectsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListSupabaseProjectsRequest extends $dara.Model {
   /**
    * @remarks
-   * The maximum number of instances to return per page. Default value: 10.
+   * The maximum number of entries to return. The default value is 10.
    * 
    * @example
    * 20
@@ -13,27 +13,33 @@ export class ListSupabaseProjectsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * A pagination token returned from a previous call. Use it to retrieve the next page of results.
+   * The pagination token to retrieve the next page of results.
    * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
-   * 20
+   * 30
    */
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The ID of the region.
    * 
-   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation get a list of available region IDs.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/86912.html) operation to query the available regions.
    * 
    * @example
    * cn-hangzhou

package/src/models/ListSupabaseProjectsResponseBody.ts

@@ -4,13 +4,21 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   /**
+   * @remarks
+   * Indicates if the **auto start and stop** feature is enabled.
+   * Valid values:
+   * 
+   * - `true`: The feature is enabled. The Supabase instance automatically pauses and resumes based on traffic.
+   * 
+   * - `false`: The auto start and stop feature is disabled.
+   * 
    * @example
    * false
    */
   autoScale?: string;
   /**
    * @remarks
-   * The creation time.
+   * The time when the resource was created.
    * 
    * @example
    * 2021-10-09T04:54:08Z
@@ -18,7 +26,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * Supabase Dashboard password (not used).
+   * The password for the Supabase dashboard. This parameter is reserved.
    * 
    * @example
    * xxpassword
@@ -26,7 +34,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   dashboardPassword?: string;
   /**
    * @remarks
-   * Supabase Dashboard user name (not used).
+   * The username for the Supabase dashboard. This parameter is reserved.
    * 
    * @example
    * null
@@ -34,7 +42,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   dashboardUserName?: string;
   /**
    * @remarks
-   * The ESSD performance level.
+   * The disk performance level.
    * 
    * @example
    * PL0
@@ -42,7 +50,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   diskPerformanceLevel?: string;
   /**
    * @remarks
-   * The database engine type.
+   * The database engine.
    * 
    * @example
    * gpdb
@@ -50,24 +58,29 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   engine?: string;
   /**
    * @remarks
-   * The database engine version.
+   * The engine version.
    * 
    * @example
    * 6.0
    */
   engineVersion?: string;
   /**
+   * @remarks
+   * The expiration time.
+   * 
    * @example
    * 2026-04-27T16:00:00Z
    */
   expireTime?: string;
   /**
    * @remarks
-   * The billing method of the instance. Valid values:
+   * The billing method. Valid values:
+   * 
+   * - **Postpaid**: pay-as-you-go.
+   * 
+   * - **Prepaid**: subscription.
    * 
-   * *   **Postpaid**: pay-as-you-go
-   * *   **Prepaid**: subscription.
-   * *   **Free**: Free.
+   * - **Free**: The instance is free of charge.
    * 
    * @example
    * Postpaid
@@ -75,16 +88,23 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * The private (VPC) connection URL for the Supabase Dashboard.
+   * The private endpoint for the Supabase dashboard.
    * 
    * @example
    * 192.168.0.1
    */
   privateConnectUrl?: string;
+  /**
+   * @remarks
+   * The detailed description of the Supabase project.
+   * 
+   * @example
+   * for-test-project
+   */
   projectDescription?: string;
   /**
    * @remarks
-   * The Supabase project ID.
+   * The ID of the Supabase instance.
    * 
    * @example
    * sbp-12***
@@ -100,7 +120,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   projectName?: string;
   /**
    * @remarks
-   * The type of the Supabase instance.
+   * The Supabase instance specification.
    * 
    * @example
    * 1C1G
@@ -108,7 +128,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   projectSpec?: string;
   /**
    * @remarks
-   * The public connection URL for the Supabase Dashboard.
+   * The public endpoint for the Supabase dashboard.
    * 
    * @example
    * 10.154.11.10
@@ -124,11 +144,13 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * A comma-separated list of IP addresses and CIDR blocks allowed to connect. Valid values:
+   * The IP whitelist. IP addresses are separated by commas. The following formats are supported:
+   * 
+   * - 0.0.0.0/0
+   * 
+   * - 10.23.12.24 (IP)
    * 
-   * *   0.0.0.0/0
-   * *   10.23.12.24(IP)
-   * *   10.23.12.24/24. This is a CIDR block. The value`/24`indicates that the prefix of the CIDR block is 24-bit long. You can replace 24 with a value in the range of`[1,32]`.
+   * - 10.23.12.24/24 (a Classless Inter-Domain Routing (CIDR) block; the prefix length, which is the number after the `/`, must be an integer from 1 to 32.)
    * 
    * @example
    * 127.0.0.1
@@ -136,7 +158,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   securityIPList?: string;
   /**
    * @remarks
-   * The status of the Supabase instance.
+   * The status of the instance.
    * 
    * @example
    * running
@@ -144,7 +166,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The storage capacity of the instance. Unit: GB.
+   * The storage size in GB.
    * 
    * @example
    * 2
@@ -152,7 +174,7 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
   storageSize?: number;
   /**
    * @remarks
-   * The vSwitch ID of the instance.
+   * The vSwitch ID.
    * 
    * @example
    * vsw-bp1cpq8mr64paltkb****
@@ -240,12 +262,12 @@ export class ListSupabaseProjectsResponseBodyItems extends $dara.Model {
 export class ListSupabaseProjectsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * A list of objects, where each object represents a Supabase instance.
+   * A list of instance details.
    */
   items?: ListSupabaseProjectsResponseBodyItems[];
   /**
    * @remarks
-   * The maximum amount of data to read this time. Default value: 10.
+   * The maximum number of entries returned per page.
    * 
    * @example
    * 50
@@ -253,7 +275,7 @@ export class ListSupabaseProjectsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token to use in the next request to get the next page. If this field is empty, there are no more results.
+   * A pagination token for retrieving the next page of results. If this parameter is not returned, it indicates that all results have been displayed.
    * 
    * @example
    * caeba0bbb2be03f84eb48b699f0a****
@@ -261,7 +283,7 @@ export class ListSupabaseProjectsResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The page number of the returned page.
+   * The page number.
    * 
    * @example
    * 1
@@ -269,7 +291,7 @@ export class ListSupabaseProjectsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page.
+   * The number of entries on the current page.
    * 
    * @example
    * 20
@@ -277,7 +299,7 @@ export class ListSupabaseProjectsResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D****
@@ -285,7 +307,7 @@ export class ListSupabaseProjectsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of log entries returned.
+   * The total number of entries.
    * 
    * @example
    * 2