@alicloud/gpdb20160503 3.4.1 → 3.6.0

package/src/models/ListChunksRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ListChunksRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the document collection.
+   * 
+   * > A document collection is created by calling the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation. You can call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to query the created document collections.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,10 @@ export class ListChunksRequest extends $dara.Model {
   collection?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including the instance IDs.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,27 +28,53 @@ export class ListChunksRequest extends $dara.Model {
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * The name of the file.
+   * 
+   * > The name of an uploaded file. You can call the [ListDocuments](https://help.aliyun.com/document_detail/2618453.html) operation to query the file list.
+   * 
    * @example
    * mydoc.txt
    */
   fileName?: string;
   /**
+   * @remarks
+   * The filter conditions for the data to be queried. The format is the same as the WHERE clause in SQL. It is an expression that returns a Boolean value. The conditions can be simple comparison operators, such as equal to (=), not equal to (<> or !=), greater than (>), less than (<), greater than or equal to (>=), and less than or equal to (<=). They can also be more complex expressions that are combined with logical operators (AND, OR, and NOT), and conditions that use keywords such as IN, BETWEEN, and LIKE.
+   * 
+   * > - For more information about the syntax, see [PostgreSQL WHERE](https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/).
+   * 
    * @example
    * title = \\"test\\" AND name like \\"test%\\"
    */
   filter?: string;
   /**
+   * @remarks
+   * Specifies whether to return vectors. Default value: false.
+   * 
+   * > - **false**: Vectors are not returned.
+   * >
+   * > - **true**: Vectors are returned.
+   * 
    * @example
    * true
    */
   includeVector?: boolean;
   /**
+   * @remarks
+   * The name of the namespace. Default value: public.
+   * 
+   * > You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace or call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to query a list of namespaces.
+   * 
    * @example
    * mynamespace
    */
   namespace?: string;
   /**
    * @remarks
+   * The password of the namespace.
+   * 
+   * > This parameter is specified when you call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -48,17 +82,33 @@ export class ListChunksRequest extends $dara.Model {
    */
   namespacePassword?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page. Valid values:
+   * 
+   * - **20**
+   * 
+   * - **50**
+   * 
+   * - **100**
+   * 
+   * Default value: **20**.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ListChunksResponseBody.ts

@@ -104,21 +104,33 @@ export class ListChunksResponseBodyChunks extends $dara.Model {
 export class ListChunksResponseBody extends $dara.Model {
   chunks?: ListChunksResponseBodyChunks;
   /**
+   * @remarks
+   * The current page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of records on the current page.
+   * 
    * @example
    * 20
    */
   pageRecordCount?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of records.
+   * 
    * @example
    * 30
    */

package/src/models/ListDocumentCollectionsRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ListDocumentCollectionsRequest extends $dara.Model {
   /**
    * @remarks
-   * The instance ID.
+   * The ID of the instance.
    * 
-   * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > To view details of all AnalyticDB for PostgreSQL instances in a region, including their IDs, call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation.
    * 
    * This parameter is required.
    * 
@@ -17,9 +17,9 @@ export class ListDocumentCollectionsRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The name of the namespace. Default value: public.
+   * The namespace. Default value: public.
    * 
-   * >  You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
+   * > To create a namespace, call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation. To list namespaces, call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation.
    * 
    * @example
    * mynamespace
@@ -27,9 +27,9 @@ export class ListDocumentCollectionsRequest extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * The password of the namespace.
+   * The password for the namespace.
    * 
-   * >  This value is specified when you call the CreateNamespace operation.
+   * > You set this password when you call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation.
    * 
    * This parameter is required.
    * 
@@ -40,7 +40,7 @@ export class ListDocumentCollectionsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The ID of the region where the instance resides.
    * 
    * This parameter is required.
    * 

package/src/models/ListDocumentCollectionsResponseBody.ts

@@ -78,7 +78,7 @@ export class ListDocumentCollectionsResponseBodyItems extends $dara.Model {
 export class ListDocumentCollectionsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of items.
    * 
    * @example
    * 10
@@ -87,7 +87,7 @@ export class ListDocumentCollectionsResponseBody extends $dara.Model {
   items?: ListDocumentCollectionsResponseBodyItems;
   /**
    * @remarks
-   * The returned message.
+   * The response message.
    * 
    * @example
    * success
@@ -95,7 +95,7 @@ export class ListDocumentCollectionsResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -103,10 +103,11 @@ export class ListDocumentCollectionsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * The creation status. Valid values:
    * 
-   * *   **success**
-   * *   **fail**
+   * - **success**: The operation succeeded.
+   * 
+   * - **fail**: The operation failed.
    * 
    * @example
    * success

package/src/models/ListExternalDataServicesResponseBody.ts

@@ -24,7 +24,7 @@ export class ListExternalDataServicesResponseBodyServiceItems extends $dara.Mode
    * The description of the service.
    * 
    * @example
-   * test-adbpgss
+   * test-pxf
    */
   serviceDescription?: string;
   /**
@@ -40,7 +40,7 @@ export class ListExternalDataServicesResponseBodyServiceItems extends $dara.Mode
    * The name of the service.
    * 
    * @example
-   * test-adbpgss
+   * test-pxf
    */
   serviceName?: string;
   /**
@@ -48,7 +48,7 @@ export class ListExternalDataServicesResponseBodyServiceItems extends $dara.Mode
    * The specifications of the service. Unit: compute units (CUs).
    * 
    * @example
-   * 2
+   * 8
    */
   serviceSpec?: string;
   /**

package/src/models/ListExternalDataSourcesResponseBody.ts

@@ -60,7 +60,7 @@ export class ListExternalDataSourcesResponseBodyItems extends $dara.Model {
    * The type of the data source.
    * 
    * @example
-   * HDFS
+   * hdfs
    */
   dataSourceType?: string;
   /**

package/src/models/ListModelServicesResponseBody.ts

@@ -43,6 +43,9 @@ export class ListModelServicesResponseBodyModelServices extends $dara.Model {
   /**
    * @remarks
    * Model service parameters (not available).
+   * 
+   * @example
+   * Not yet available.
    */
   modelParams?: { [key: string]: string };
   /**

package/src/models/ListNamespacesRequest.ts

@@ -10,7 +10,7 @@ export class ListNamespacesRequest extends $dara.Model {
    * >  You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
    * 
    * @example
-   * gp-xxxxxxxxx
+   * gp-bp152460513z****
    */
   DBInstanceId?: string;
   /**

package/src/models/ListNamespacesResponseBody.ts

@@ -42,7 +42,7 @@ export class ListNamespacesResponseBody extends $dara.Model {
    * The instance ID.
    * 
    * @example
-   * gp-xxxxxxxxx
+   * gp-bp152460513z****
    */
   DBInstanceId?: string;
   /**

package/src/models/ListSaasServiceRequest.ts

@@ -0,0 +1,81 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListSaasServiceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The maximum number of entries to return in this request. Default value: 10.
+   * 
+   * @example
+   * 50
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The token for the next query to begin with during a paginated query.
+   * 
+   * @example
+   * caeba0bbb2be03f84eb48b699f0a4883
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The region ID of the workspace.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * Service type, with the following value:
+   * 
+   * - **memroy**
+   * - **drama**
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * drama
+   */
+  serviceType?: string;
+  /**
+   * @remarks
+   * The workspace ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * ws-*****
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      maxResults: 'MaxResults',
+      nextToken: 'NextToken',
+      regionId: 'RegionId',
+      serviceType: 'ServiceType',
+      workspaceId: 'WorkspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      maxResults: 'number',
+      nextToken: 'string',
+      regionId: 'string',
+      serviceType: 'string',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListSaasServiceResponse.ts

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