@google-cloud/vectorsearch 0.2.0 → 0.4.0

package/build/src/v1/vector_search_service_client.d.ts

@@ -0,0 +1,1021 @@
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
+import { Transform } from 'stream';
+import * as protos from '../../protos/protos';
+/**
+ *  VectorSearchService provides methods for managing Collection resources, and
+ *  Collection Index resources. The primary resources offered by this service are
+ *  Collections which are a container for a set of related JSON data objects, and
+ *  Collection Indexes which enable efficient ANN search across data objects
+ *  within a Collection.
+ * @class
+ * @memberof v1
+ */
+export declare class VectorSearchServiceClient {
+    private _terminated;
+    private _opts;
+    private _providedCustomServicePath;
+    private _gaxModule;
+    private _gaxGrpc;
+    private _protos;
+    private _defaults;
+    private _universeDomain;
+    private _servicePath;
+    private _log;
+    auth: gax.GoogleAuth;
+    descriptors: Descriptors;
+    warn: (code: string, message: string, warnType?: string) => void;
+    innerApiCalls: {
+        [name: string]: Function;
+    };
+    locationsClient: LocationsClient;
+    pathTemplates: {
+        [name: string]: gax.PathTemplate;
+    };
+    operationsClient: gax.OperationsClient;
+    vectorSearchServiceStub?: Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * Construct an instance of VectorSearchServiceClient.
+     *
+     * @param {object} [options] - The configuration object.
+     * The options accepted by the constructor are described in detail
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+     * The common options are:
+     * @param {object} [options.credentials] - Credentials object.
+     * @param {string} [options.credentials.client_email]
+     * @param {string} [options.credentials.private_key]
+     * @param {string} [options.email] - Account email address. Required when
+     *     using a .pem or .p12 keyFilename.
+     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+     *     .p12 key downloaded from the Google Developers Console. If you provide
+     *     a path to a JSON file, the projectId option below is not necessary.
+     *     NOTE: .pem and .p12 require you to specify options.email as well.
+     * @param {number} [options.port] - The port on which to connect to
+     *     the remote host.
+     * @param {string} [options.projectId] - The project ID from the Google
+     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+     *     the environment variable GCLOUD_PROJECT for your project ID. If your
+     *     app is running in an environment which supports
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+     *     your project ID will be detected automatically.
+     * @param {string} [options.apiEndpoint] - The domain name of the
+     *     API remote host.
+     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+     *     Follows the structure of {@link gapicConfig}.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
+     *     For more information, please check the
+     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
+     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     HTTP implementation. Load only fallback version and pass it to the constructor:
+     *     ```
+     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
+     *     const client = new VectorSearchServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
+    /**
+     * Initialize the client.
+     * Performs asynchronous operations (such as authentication) and prepares the client.
+     * This function will be called automatically when any class method is called for the
+     * first time, but if you need to initialize it before calling an actual method,
+     * feel free to call initialize() directly.
+     *
+     * You can await on this method if you want to make sure the client is initialized.
+     *
+     * @returns {Promise} A promise that resolves to an authenticated service stub.
+     */
+    initialize(): Promise<{
+        [name: string]: Function;
+    }>;
+    /**
+     * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get servicePath(): string;
+    /**
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
+     * @returns {string} The DNS address for this service.
+     */
+    static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port(): number;
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes(): string[];
+    getProjectId(): Promise<string>;
+    getProjectId(callback: Callback<string, undefined, undefined>): void;
+    /**
+     * Gets details of a single Collection.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. Name of the resource
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.cloud.vectorsearch.v1.Collection|Collection}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.get_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_GetCollection_async
+     */
+    getCollection(request?: protos.google.cloud.vectorsearch.v1.IGetCollectionRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.ICollection,
+        protos.google.cloud.vectorsearch.v1.IGetCollectionRequest | undefined,
+        {} | undefined
+    ]>;
+    getCollection(request: protos.google.cloud.vectorsearch.v1.IGetCollectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IGetCollectionRequest | null | undefined, {} | null | undefined>): void;
+    getCollection(request: protos.google.cloud.vectorsearch.v1.IGetCollectionRequest, callback: Callback<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IGetCollectionRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets details of a single Index.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. Name of the resource
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.cloud.vectorsearch.v1.Index|Index}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.get_index.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_GetIndex_async
+     */
+    getIndex(request?: protos.google.cloud.vectorsearch.v1.IGetIndexRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.IIndex,
+        protos.google.cloud.vectorsearch.v1.IGetIndexRequest | undefined,
+        {} | undefined
+    ]>;
+    getIndex(request: protos.google.cloud.vectorsearch.v1.IGetIndexRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1.IIndex, protos.google.cloud.vectorsearch.v1.IGetIndexRequest | null | undefined, {} | null | undefined>): void;
+    getIndex(request: protos.google.cloud.vectorsearch.v1.IGetIndexRequest, callback: Callback<protos.google.cloud.vectorsearch.v1.IIndex, protos.google.cloud.vectorsearch.v1.IGetIndexRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates a new Collection in a given project and location.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Value for parent.
+     * @param {string} request.collectionId
+     *   Required. ID of the Collection to create.
+     *   The id must be 1-63 characters long, and comply with
+     *   [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+     *   Specifically, it must be 1-63 characters long and match the regular
+     *   expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
+     * @param {google.cloud.vectorsearch.v1.Collection} request.collection
+     *   Required. The resource being created
+     * @param {string} [request.requestId]
+     *   Optional. An optional request ID to identify requests. Specify a unique
+     *   request ID so that if you must retry your request, the server will know to
+     *   ignore the request if it has already been completed. The server will
+     *   guarantee that for at least 60 minutes since the first request.
+     *
+     *   For example, consider a situation where you make an initial request and the
+     *   request times out. If you make the request again with the same request
+     *   ID, the server can check if original operation with the same request ID
+     *   was received, and if so, will ignore the second request. This prevents
+     *   clients from accidentally creating duplicate commitments.
+     *
+     *   The request ID must be a valid UUID with the exception that zero UUID is
+     *   not supported (00000000-0000-0000-0000-000000000000).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.create_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_CreateCollection_async
+     */
+    createCollection(request?: protos.google.cloud.vectorsearch.v1.ICreateCollectionRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    createCollection(request: protos.google.cloud.vectorsearch.v1.ICreateCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    createCollection(request: protos.google.cloud.vectorsearch.v1.ICreateCollectionRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `createCollection()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.create_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_CreateCollection_async
+     */
+    checkCreateCollectionProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1.Collection, protos.google.cloud.vectorsearch.v1.OperationMetadata>>;
+    /**
+     * Updates the parameters of a single Collection.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.protobuf.FieldMask} [request.updateMask]
+     *   Optional. Field mask is used to specify the fields to be overwritten in the
+     *   Collection resource by the update.
+     *   The fields specified in the update_mask are relative to the resource, not
+     *   the full request. A field will be overwritten if it is in the mask. If the
+     *   user does not provide a mask then all fields present in the request will be
+     *   overwritten.
+     *
+     *   The following fields support update: `display_name`, `description`,
+     *   `labels`, `data_schema`, `vector_schema`.
+     *   For `data_schema` and `vector_schema`, fields can only be added, not
+     *   deleted, but `vertex_embedding_config` in `vector_schema` can be added or
+     *   removed.
+     *   Partial updates for `data_schema` and `vector_schema` are also supported
+     *   by using sub-field paths in `update_mask`, e.g.
+     *   `data_schema.properties.foo` or `vector_schema.my_vector_field`.
+     *
+     *   If `*` is provided in the update_mask, full replacement will be performed.
+     * @param {google.cloud.vectorsearch.v1.Collection} request.collection
+     *   Required. The resource being updated
+     * @param {string} [request.requestId]
+     *   Optional. An optional request ID to identify requests. Specify a unique
+     *   request ID so that if you must retry your request, the server will know to
+     *   ignore the request if it has already been completed. The server will
+     *   guarantee that for at least 60 minutes since the first request.
+     *
+     *   For example, consider a situation where you make an initial request and the
+     *   request times out. If you make the request again with the same request
+     *   ID, the server can check if original operation with the same request ID
+     *   was received, and if so, will ignore the second request. This prevents
+     *   clients from accidentally creating duplicate commitments.
+     *
+     *   The request ID must be a valid UUID with the exception that zero UUID is
+     *   not supported (00000000-0000-0000-0000-000000000000).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.update_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_UpdateCollection_async
+     */
+    updateCollection(request?: protos.google.cloud.vectorsearch.v1.IUpdateCollectionRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    updateCollection(request: protos.google.cloud.vectorsearch.v1.IUpdateCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    updateCollection(request: protos.google.cloud.vectorsearch.v1.IUpdateCollectionRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.ICollection, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `updateCollection()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.update_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_UpdateCollection_async
+     */
+    checkUpdateCollectionProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1.Collection, protos.google.cloud.vectorsearch.v1.OperationMetadata>>;
+    /**
+     * Deletes a single Collection.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. Name of the resource
+     * @param {string} [request.requestId]
+     *   Optional. An optional request ID to identify requests. Specify a unique
+     *   request ID so that if you must retry your request, the server will know to
+     *   ignore the request if it has already been completed. The server will
+     *   guarantee that for at least 60 minutes after the first request.
+     *
+     *   For example, consider a situation where you make an initial request and the
+     *   request times out. If you make the request again with the same request
+     *   ID, the server can check if original operation with the same request ID
+     *   was received, and if so, will ignore the second request. This prevents
+     *   clients from accidentally creating duplicate commitments.
+     *
+     *   The request ID must be a valid UUID with the exception that zero UUID is
+     *   not supported (00000000-0000-0000-0000-000000000000).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.delete_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_DeleteCollection_async
+     */
+    deleteCollection(request?: protos.google.cloud.vectorsearch.v1.IDeleteCollectionRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    deleteCollection(request: protos.google.cloud.vectorsearch.v1.IDeleteCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    deleteCollection(request: protos.google.cloud.vectorsearch.v1.IDeleteCollectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `deleteCollection()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.delete_collection.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_DeleteCollection_async
+     */
+    checkDeleteCollectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vectorsearch.v1.OperationMetadata>>;
+    /**
+     * Creates a new Index in a given project and location.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to create the
+     *   Index. Format:
+     *   `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {string} request.indexId
+     *   Required. ID of the Index to create.
+     *   The id must be 1-63 characters long, and comply with
+     *   [RFC1035](https://www.ietf.org/rfc/rfc1035.txt).
+     *   Specifically, it must be 1-63 characters long and match the regular
+     *   expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
+     * @param {google.cloud.vectorsearch.v1.Index} request.index
+     *   Required. The resource being created
+     * @param {string} [request.requestId]
+     *   Optional. An optional request ID to identify requests. Specify a unique
+     *   request ID so that if you must retry your request, the server will know to
+     *   ignore the request if it has already been completed. The server will
+     *   guarantee that for at least 60 minutes since the first request.
+     *
+     *   For example, consider a situation where you make an initial request and the
+     *   request times out. If you make the request again with the same request
+     *   ID, the server can check if original operation with the same request ID
+     *   was received, and if so, will ignore the second request. This prevents
+     *   clients from accidentally creating duplicate commitments.
+     *
+     *   The request ID must be a valid UUID with the exception that zero UUID is
+     *   not supported (00000000-0000-0000-0000-000000000000).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.create_index.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_CreateIndex_async
+     */
+    createIndex(request?: protos.google.cloud.vectorsearch.v1.ICreateIndexRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.vectorsearch.v1.IIndex, protos.google.cloud.vectorsearch.v1.IOperationMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    createIndex(request: protos.google.cloud.vectorsearch.v1.ICreateIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.IIndex, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    createIndex(request: protos.google.cloud.vectorsearch.v1.ICreateIndexRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.IIndex, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `createIndex()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.create_index.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_CreateIndex_async
+     */
+    checkCreateIndexProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1.Index, protos.google.cloud.vectorsearch.v1.OperationMetadata>>;
+    /**
+     * Deletes a single Index.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The resource name of the Index to delete.
+     *   Format:
+     *   `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`
+     * @param {string} [request.requestId]
+     *   Optional. An optional request ID to identify requests. Specify a unique
+     *   request ID so that if you must retry your request, the server will know to
+     *   ignore the request if it has already been completed. The server will
+     *   guarantee that for at least 60 minutes since the first request.
+     *
+     *   For example, consider a situation where you make an initial request and the
+     *   request times out. If you make the request again with the same request
+     *   ID, the server can check if original operation with the same request ID
+     *   was received, and if so, will ignore the second request. This prevents
+     *   clients from accidentally creating duplicate commitments.
+     *
+     *   The request ID must be a valid UUID with the exception that zero UUID is
+     *   not supported (00000000-0000-0000-0000-000000000000).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.delete_index.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_DeleteIndex_async
+     */
+    deleteIndex(request?: protos.google.cloud.vectorsearch.v1.IDeleteIndexRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    deleteIndex(request: protos.google.cloud.vectorsearch.v1.IDeleteIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    deleteIndex(request: protos.google.cloud.vectorsearch.v1.IDeleteIndexRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `deleteIndex()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.delete_index.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_DeleteIndex_async
+     */
+    checkDeleteIndexProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vectorsearch.v1.OperationMetadata>>;
+    /**
+     * Initiates a Long-Running Operation to import DataObjects into a Collection.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.vectorsearch.v1.ImportDataObjectsRequest.GcsImportConfig} request.gcsImport
+     *   The Cloud Storage location of the input content.
+     * @param {string} request.name
+     *   Required. The resource name of the Collection to import DataObjects into.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.import_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_ImportDataObjects_async
+     */
+    importDataObjects(request?: protos.google.cloud.vectorsearch.v1.IImportDataObjectsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.vectorsearch.v1.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IImportDataObjectsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    importDataObjects(request: protos.google.cloud.vectorsearch.v1.IImportDataObjectsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IImportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    importDataObjects(request: protos.google.cloud.vectorsearch.v1.IImportDataObjectsRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1.IImportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `importDataObjects()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.import_data_objects.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_ImportDataObjects_async
+     */
+    checkImportDataObjectsProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1.ImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1.ImportDataObjectsMetadata>>;
+    /**
+    * Lists Collections in a given project and location.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. Parent value for ListCollectionsRequest
+    * @param {number} [request.pageSize]
+    *   Optional. Requested page size. Server may return fewer items than
+    *   requested. If unspecified, server will pick an appropriate default.
+    * @param {string} [request.pageToken]
+    *   Optional. A token identifying a page of results the server should return.
+    * @param {string} [request.filter]
+    *   Optional. Filtering results
+    * @param {string} [request.orderBy]
+    *   Optional. Hint for how to order the results
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.cloud.vectorsearch.v1.Collection|Collection}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `listCollectionsAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
+    listCollections(request?: protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.ICollection[],
+        protos.google.cloud.vectorsearch.v1.IListCollectionsRequest | null,
+        protos.google.cloud.vectorsearch.v1.IListCollectionsResponse
+    ]>;
+    listCollections(request: protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, protos.google.cloud.vectorsearch.v1.IListCollectionsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.ICollection>): void;
+    listCollections(request: protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, protos.google.cloud.vectorsearch.v1.IListCollectionsResponse | null | undefined, protos.google.cloud.vectorsearch.v1.ICollection>): void;
+    /**
+     * Equivalent to `listCollections`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Parent value for ListCollectionsRequest
+     * @param {number} [request.pageSize]
+     *   Optional. Requested page size. Server may return fewer items than
+     *   requested. If unspecified, server will pick an appropriate default.
+     * @param {string} [request.pageToken]
+     *   Optional. A token identifying a page of results the server should return.
+     * @param {string} [request.filter]
+     *   Optional. Filtering results
+     * @param {string} [request.orderBy]
+     *   Optional. Hint for how to order the results
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1.Collection|Collection} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listCollectionsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listCollectionsStream(request?: protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listCollections`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Parent value for ListCollectionsRequest
+     * @param {number} [request.pageSize]
+     *   Optional. Requested page size. Server may return fewer items than
+     *   requested. If unspecified, server will pick an appropriate default.
+     * @param {string} [request.pageToken]
+     *   Optional. A token identifying a page of results the server should return.
+     * @param {string} [request.filter]
+     *   Optional. Filtering results
+     * @param {string} [request.orderBy]
+     *   Optional. Hint for how to order the results
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.cloud.vectorsearch.v1.Collection|Collection}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.list_collections.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_ListCollections_async
+     */
+    listCollectionsAsync(request?: protos.google.cloud.vectorsearch.v1.IListCollectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1.ICollection>;
+    /**
+    * Lists Indexes in a given project and location.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. Parent value for ListIndexesRequest
+    * @param {number} [request.pageSize]
+    *   Optional. Requested page size. Server may return fewer items than
+    *   requested. If unspecified, server will pick an appropriate default.
+    * @param {string} [request.pageToken]
+    *   Optional. A token identifying a page of results the server should return.
+    * @param {string} [request.filter]
+    *   Optional. Filtering results
+    * @param {string} [request.orderBy]
+    *   Optional. Hint for how to order the results
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.cloud.vectorsearch.v1.Index|Index}.
+    *   The client library will perform auto-pagination by default: it will call the API as many
+    *   times as needed and will merge results from all the pages into this array.
+    *   Note that it can affect your quota.
+    *   We recommend using `listIndexesAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
+    listIndexes(request?: protos.google.cloud.vectorsearch.v1.IListIndexesRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.vectorsearch.v1.IIndex[],
+        protos.google.cloud.vectorsearch.v1.IListIndexesRequest | null,
+        protos.google.cloud.vectorsearch.v1.IListIndexesResponse
+    ]>;
+    listIndexes(request: protos.google.cloud.vectorsearch.v1.IListIndexesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IListIndexesRequest, protos.google.cloud.vectorsearch.v1.IListIndexesResponse | null | undefined, protos.google.cloud.vectorsearch.v1.IIndex>): void;
+    listIndexes(request: protos.google.cloud.vectorsearch.v1.IListIndexesRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1.IListIndexesRequest, protos.google.cloud.vectorsearch.v1.IListIndexesResponse | null | undefined, protos.google.cloud.vectorsearch.v1.IIndex>): void;
+    /**
+     * Equivalent to `listIndexes`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Parent value for ListIndexesRequest
+     * @param {number} [request.pageSize]
+     *   Optional. Requested page size. Server may return fewer items than
+     *   requested. If unspecified, server will pick an appropriate default.
+     * @param {string} [request.pageToken]
+     *   Optional. A token identifying a page of results the server should return.
+     * @param {string} [request.filter]
+     *   Optional. Filtering results
+     * @param {string} [request.orderBy]
+     *   Optional. Hint for how to order the results
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1.Index|Index} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listIndexesAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listIndexesStream(request?: protos.google.cloud.vectorsearch.v1.IListIndexesRequest, options?: CallOptions): Transform;
+    /**
+     * Equivalent to `listIndexes`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. Parent value for ListIndexesRequest
+     * @param {number} [request.pageSize]
+     *   Optional. Requested page size. Server may return fewer items than
+     *   requested. If unspecified, server will pick an appropriate default.
+     * @param {string} [request.pageToken]
+     *   Optional. A token identifying a page of results the server should return.
+     * @param {string} [request.filter]
+     *   Optional. Filtering results
+     * @param {string} [request.orderBy]
+     *   Optional. Hint for how to order the results
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.cloud.vectorsearch.v1.Index|Index}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/vector_search_service.list_indexes.js</caption>
+     * region_tag:vectorsearch_v1_generated_VectorSearchService_ListIndexes_async
+     */
+    listIndexesAsync(request?: protos.google.cloud.vectorsearch.v1.IListIndexesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1.IIndex>;
+    /**
+       * Gets information about a location.
+       *
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   Resource name for the location.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
+       * @returns {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const [response] = await client.getLocation(request);
+       * ```
+       */
+    getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
+    /**
+       * Lists information about the supported locations for this service. Returns an iterable object.
+       *
+       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   The resource that owns the locations collection, if applicable.
+       * @param {string} request.filter
+       *   The standard list filter.
+       * @param {number} request.pageSize
+       *   The standard list page size.
+       * @param {string} request.pageToken
+       *   The standard list page token.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+       * @returns {Object}
+       *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+       *   When you iterate the returned iterable, each element will be an object representing
+       *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
+       *   so you can stop the iteration when you don't need more results.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const iterable = client.listLocationsAsync(request);
+       * for await (const response of iterable) {
+       *   // process response
+       * }
+       * ```
+       */
+    listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
+    /**
+       * Gets the latest state of a long-running operation.  Clients can use this
+       * method to poll the operation result at intervals as recommended by the API
+       * service.
+       *
+       * @param {Object} request - The request object that will be sent.
+       * @param {string} request.name - The name of the operation resource.
+       * @param {Object=} options
+       *   Optional parameters. You can override the default settings for this call,
+       *   e.g, timeout, retries, paginations, etc. See {@link
+       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+       *   for the details.
+       * @param {function(?Error, ?Object)=} callback
+       *   The function which will be called with the result of the API call.
+       *
+       *   The second parameter to the callback is an object representing
+       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * @return {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing
+       * {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * The promise has a method named "cancel" which cancels the ongoing API call.
+       *
+       * @example
+       * ```
+       * const client = longrunning.operationsClient();
+       * const name = '';
+       * const [response] = await client.getOperation({name});
+       * // doThingsWith(response)
+       * ```
+       */
+    getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
+    /**
+     * Lists operations that match the specified filter in the request. If the
+     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
+     *
+     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation collection.
+     * @param {string} request.filter - The standard list filter.
+     * @param {number=} request.pageSize -
+     *   The maximum number of resources contained in the underlying API
+     *   response. If page streaming is performed per-resource, this
+     *   parameter does not affect the return value. If page streaming is
+     *   performed per-page, this determines the maximum number of
+     *   resources in a page.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     *   details.
+     * @returns {Object}
+     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * for await (const response of client.listOperationsAsync(request));
+     * // doThingsWith(response)
+     * ```
+     */
+    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
+    /**
+     * Starts asynchronous cancellation on a long-running operation.  The server
+     * makes a best effort to cancel the operation, but success is not
+     * guaranteed.  If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
+     * {@link Operations.GetOperation} or
+     * other methods to check whether the cancellation succeeded or whether the
+     * operation completed despite cancellation. On successful cancellation,
+     * the operation is not deleted; instead, it becomes an operation with
+     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
+     * 1, corresponding to `Code.CANCELLED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be cancelled.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     * details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.cancelOperation({name: ''});
+     * ```
+     */
+    cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * Deletes a long-running operation. This method indicates that the client is
+     * no longer interested in the operation result. It does not cancel the
+     * operation. If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be deleted.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     * for the details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.deleteOperation({name: ''});
+     * ```
+     */
+    deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * Return a fully-qualified collection resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @returns {string} Resource name string.
+     */
+    collectionPath(project: string, location: string, collection: string): string;
+    /**
+     * Parse the project from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromCollectionName(collectionName: string): string | number;
+    /**
+     * Parse the location from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromCollectionName(collectionName: string): string | number;
+    /**
+     * Parse the collection from Collection resource.
+     *
+     * @param {string} collectionName
+     *   A fully-qualified path representing Collection resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromCollectionName(collectionName: string): string | number;
+    /**
+     * Return a fully-qualified dataObject resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} dataObject
+     * @returns {string} Resource name string.
+     */
+    dataObjectPath(project: string, location: string, collection: string, dataObject: string): string;
+    /**
+     * Parse the project from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the location from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the collection from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Parse the dataObject from DataObject resource.
+     *
+     * @param {string} dataObjectName
+     *   A fully-qualified path representing DataObject resource.
+     * @returns {string} A string representing the dataObject.
+     */
+    matchDataObjectFromDataObjectName(dataObjectName: string): string | number;
+    /**
+     * Return a fully-qualified index resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} index
+     * @returns {string} Resource name string.
+     */
+    indexPath(project: string, location: string, collection: string, index: string): string;
+    /**
+     * Parse the project from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the location from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the collection from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromIndexName(indexName: string): string | number;
+    /**
+     * Parse the index from Index resource.
+     *
+     * @param {string} indexName
+     *   A fully-qualified path representing Index resource.
+     * @returns {string} A string representing the index.
+     */
+    matchIndexFromIndexName(indexName: string): string | number;
+    /**
+     * Return a fully-qualified location resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @returns {string} Resource name string.
+     */
+    locationPath(project: string, location: string): string;
+    /**
+     * Parse the project from Location resource.
+     *
+     * @param {string} locationName
+     *   A fully-qualified path representing Location resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromLocationName(locationName: string): string | number;
+    /**
+     * Parse the location from Location resource.
+     *
+     * @param {string} locationName
+     *   A fully-qualified path representing Location resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromLocationName(locationName: string): string | number;
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project: string): string;
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName: string): string | number;
+    /**
+     * Terminate the gRPC channel and close the client.
+     *
+     * The client will no longer be usable and all future behavior is undefined.
+     * @returns {Promise} A promise that resolves when the client is closed.
+     */
+    close(): Promise<void>;
+}