@alicloud/gpdb20160503 2.3.0 → 2.4.0

package/dist/client.d.ts

@@ -519,6 +519,56 @@ export declare class DescribeAvailableResourcesResponseBodyResources extends $da
         [key: string]: any;
     });
 }
+export declare class DescribeCreateIndexJobResponseBodyJob extends $dara.Model {
+    /**
+     * @example
+     * false
+     */
+    completed?: boolean;
+    /**
+     * @example
+     * 2024-01-08 16:52:04.864664
+     */
+    createTime?: string;
+    /**
+     * @example
+     * Failed to connect database.
+     */
+    error?: string;
+    /**
+     * @remarks
+     * Job ID。
+     *
+     * @example
+     * 231460f8-75dc-405e-a669-0c5204887e91
+     */
+    id?: string;
+    /**
+     * @example
+     * 20
+     */
+    progress?: number;
+    /**
+     * @example
+     * Running
+     */
+    status?: string;
+    /**
+     * @example
+     * 2024-01-08 16:53:04.864664
+     */
+    updateTime?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeDBClusterNodeResponseBodyNodes extends $dara.Model {
     /**
      * @remarks
@@ -5863,6 +5913,51 @@ export declare class ListExternalDataSourcesResponseBodyItems extends $dara.Mode
         [key: string]: any;
     });
 }
+export declare class ListIndicesResponseBodyIndicesIndices extends $dara.Model {
+    /**
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * CREATE INDEX testindex ON mynamespace. testcollection
+     */
+    indexDef?: string;
+    /**
+     * @example
+     * testindex
+     */
+    indexName?: string;
+    /**
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesResponseBodyIndices extends $dara.Model {
+    indices?: ListIndicesResponseBodyIndicesIndices[];
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ListInstanceExtensionsResponseBodyItems extends $dara.Model {
     /**
      * @remarks
@@ -7640,6 +7735,113 @@ export declare class BindDBResourceGroupWithRoleResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class CancelCreateIndexJobRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 231460f8-75dc-405e-a669-0c5204887e91
+     */
+    jobId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CancelCreateIndexJobResponseBody extends $dara.Model {
+    /**
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CancelCreateIndexJobResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: CancelCreateIndexJobResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CancelUploadDocumentJobRequest extends $dara.Model {
     /**
      * @remarks
@@ -10335,6 +10537,121 @@ export declare class CreateHadoopDataSourceResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class CreateIndexRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    indexConfig?: string;
+    /**
+     * @example
+     * title
+     */
+    indexField?: string;
+    /**
+     * @example
+     * testindex
+     */
+    indexName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexResponseBody extends $dara.Model {
+    /**
+     * @example
+     * 231460f8-75dc-405e-a669-0c5204887e91
+     */
+    jobId?: string;
+    /**
+     * @example
+     * Successfully create job
+     */
+    message?: string;
+    /**
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateIndexResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: CreateIndexResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateJDBCDataSourceRequest extends $dara.Model {
     /**
      * @remarks
@@ -13314,6 +13631,113 @@ export declare class DeleteHadoopDataSourceResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class DeleteIndexRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testindex
+     */
+    indexName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexResponseBody extends $dara.Model {
+    /**
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DeleteIndexResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DeleteIndexResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DeleteJDBCDataSourceRequest extends $dara.Model {
     /**
      * @remarks
@@ -14823,6 +15247,114 @@ export declare class DescribeCollectionResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class DescribeCreateIndexJobRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * 231460f8-75dc-405e-a669-0c5204887e91
+     */
+    jobId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeCreateIndexJobResponseBody extends $dara.Model {
+    job?: DescribeCreateIndexJobResponseBodyJob;
+    /**
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeCreateIndexJobResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DescribeCreateIndexJobResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeDBClusterNodeRequest extends $dara.Model {
     /**
      * @remarks
@@ -19188,6 +19720,133 @@ export declare class DescribeIMVInfosResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class DescribeIndexRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testindex
+     */
+    indexName?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeIndexResponseBody extends $dara.Model {
+    /**
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * CREATE INDEX testindex ON mynamespace. testcollection
+     */
+    indexDef?: string;
+    /**
+     * @example
+     * testindex
+     */
+    indexName?: string;
+    /**
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class DescribeIndexResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: DescribeIndexResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class DescribeJDBCDataSourceRequest extends $dara.Model {
     /**
      * @remarks
@@ -24889,6 +25548,109 @@ export declare class ListExternalDataSourcesResponse extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class ListIndicesRequest extends $dara.Model {
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testcollection
+     */
+    collection?: string;
+    /**
+     * @example
+     * gp-xxxxxxxxx
+     */
+    DBInstanceId?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * mynamespace
+     */
+    namespace?: string;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * testpassword
+     */
+    namespacePassword?: string;
+    ownerId?: number;
+    /**
+     * @remarks
+     * This parameter is required.
+     *
+     * @example
+     * cn-hangzhou
+     */
+    regionId?: string;
+    /**
+     * @example
+     * gp-ws-*****
+     */
+    workspaceId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesResponseBody extends $dara.Model {
+    indices?: ListIndicesResponseBodyIndices;
+    /**
+     * @example
+     * success
+     */
+    message?: string;
+    /**
+     * @remarks
+     * Request ID.
+     *
+     * @example
+     * ABB39CC3-4488-4857-905D-2E4A051D0521
+     */
+    requestId?: string;
+    /**
+     * @example
+     * success
+     */
+    status?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class ListIndicesResponse extends $dara.Model {
+    headers?: {
+        [key: string]: string;
+    };
+    statusCode?: number;
+    body?: ListIndicesResponseBody;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class ListInstanceExtensionsRequest extends $dara.Model {
     /**
      * @remarks
@@ -34298,6 +35060,21 @@ export default class Client extends OpenApi {
      * @returns BindDBResourceGroupWithRoleResponse
      */
     bindDBResourceGroupWithRole(request: BindDBResourceGroupWithRoleRequest): Promise<BindDBResourceGroupWithRoleResponse>;
+    /**
+     * 取消创建索引任务
+     *
+     * @param request - CancelCreateIndexJobRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CancelCreateIndexJobResponse
+     */
+    cancelCreateIndexJobWithOptions(request: CancelCreateIndexJobRequest, runtime: $dara.RuntimeOptions): Promise<CancelCreateIndexJobResponse>;
+    /**
+     * 取消创建索引任务
+     *
+     * @param request - CancelCreateIndexJobRequest
+     * @returns CancelCreateIndexJobResponse
+     */
+    cancelCreateIndexJob(request: CancelCreateIndexJobRequest): Promise<CancelCreateIndexJobResponse>;
     /**
      * Cancels an asynchronous document upload job based on the job ID.
      *
@@ -34597,6 +35374,21 @@ export default class Client extends OpenApi {
      * @returns CreateHadoopDataSourceResponse
      */
     createHadoopDataSource(request: CreateHadoopDataSourceRequest): Promise<CreateHadoopDataSourceResponse>;
+    /**
+     * 创建索引
+     *
+     * @param request - CreateIndexRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns CreateIndexResponse
+     */
+    createIndexWithOptions(request: CreateIndexRequest, runtime: $dara.RuntimeOptions): Promise<CreateIndexResponse>;
+    /**
+     * 创建索引
+     *
+     * @param request - CreateIndexRequest
+     * @returns CreateIndexResponse
+     */
+    createIndex(request: CreateIndexRequest): Promise<CreateIndexResponse>;
     /**
      * Creates a JDBC data source.
      *
@@ -34957,6 +35749,21 @@ export default class Client extends OpenApi {
      * @returns DeleteHadoopDataSourceResponse
      */
     deleteHadoopDataSource(request: DeleteHadoopDataSourceRequest): Promise<DeleteHadoopDataSourceResponse>;
+    /**
+     * 删除索引
+     *
+     * @param request - DeleteIndexRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DeleteIndexResponse
+     */
+    deleteIndexWithOptions(request: DeleteIndexRequest, runtime: $dara.RuntimeOptions): Promise<DeleteIndexResponse>;
+    /**
+     * 删除索引
+     *
+     * @param request - DeleteIndexRequest
+     * @returns DeleteIndexResponse
+     */
+    deleteIndex(request: DeleteIndexRequest): Promise<DeleteIndexResponse>;
     /**
      * Delete JDBC data source
      *
@@ -35193,6 +36000,21 @@ export default class Client extends OpenApi {
      * @returns DescribeCollectionResponse
      */
     describeCollection(request: DescribeCollectionRequest): Promise<DescribeCollectionResponse>;
+    /**
+     * 获取创建索引任务
+     *
+     * @param request - DescribeCreateIndexJobRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeCreateIndexJobResponse
+     */
+    describeCreateIndexJobWithOptions(request: DescribeCreateIndexJobRequest, runtime: $dara.RuntimeOptions): Promise<DescribeCreateIndexJobResponse>;
+    /**
+     * 获取创建索引任务
+     *
+     * @param request - DescribeCreateIndexJobRequest
+     * @returns DescribeCreateIndexJobResponse
+     */
+    describeCreateIndexJob(request: DescribeCreateIndexJobRequest): Promise<DescribeCreateIndexJobResponse>;
     /**
      * Queries a list of nodes in an AnalyticDB for PostgreSQL instance.
      *
@@ -35904,6 +36726,21 @@ export default class Client extends OpenApi {
      * @returns DescribeIMVInfosResponse
      */
     describeIMVInfos(request: DescribeIMVInfosRequest): Promise<DescribeIMVInfosResponse>;
+    /**
+     * 获取索引详情
+     *
+     * @param request - DescribeIndexRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns DescribeIndexResponse
+     */
+    describeIndexWithOptions(request: DescribeIndexRequest, runtime: $dara.RuntimeOptions): Promise<DescribeIndexResponse>;
+    /**
+     * 获取索引详情
+     *
+     * @param request - DescribeIndexRequest
+     * @returns DescribeIndexResponse
+     */
+    describeIndex(request: DescribeIndexRequest): Promise<DescribeIndexResponse>;
     /**
      * Queries the configurations of a Java Database Connectivity (JDBC) data source.
      *
@@ -36657,6 +37494,21 @@ export default class Client extends OpenApi {
      * @returns ListExternalDataSourcesResponse
      */
     listExternalDataSources(request: ListExternalDataSourcesRequest): Promise<ListExternalDataSourcesResponse>;
+    /**
+     * 获取索引列表
+     *
+     * @param request - ListIndicesRequest
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListIndicesResponse
+     */
+    listIndicesWithOptions(request: ListIndicesRequest, runtime: $dara.RuntimeOptions): Promise<ListIndicesResponse>;
+    /**
+     * 获取索引列表
+     *
+     * @param request - ListIndicesRequest
+     * @returns ListIndicesResponse
+     */
+    listIndices(request: ListIndicesRequest): Promise<ListIndicesResponse>;
     /**
      * Queries a list of extensions.
      *