@google-cloud/vectorsearch 0.1.0

package/build/src/v1beta/data_object_search_service_client.js

@@ -0,0 +1,849 @@
+"use strict";
+// Copyright 2025 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// ** This file is automatically generated by gapic-generator-typescript. **
+// ** https://github.com/googleapis/gapic-generator-typescript **
+// ** All changes to this file may be overwritten. **
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataObjectSearchServiceClient = void 0;
+const jsonProtos = require("../../protos/protos.json");
+const google_gax_1 = require("google-gax");
+/**
+ * Client JSON configuration object, loaded from
+ * `src/v1beta/data_object_search_service_client_config.json`.
+ * This file defines retry strategy and timeouts for all API methods in this library.
+ */
+const gapicConfig = require("./data_object_search_service_client_config.json");
+const version = require('../../../package.json').version;
+/**
+ *  Service for searching data objects.
+ * @class
+ * @memberof v1beta
+ */
+class DataObjectSearchServiceClient {
+    _terminated = false;
+    _opts;
+    _providedCustomServicePath;
+    _gaxModule;
+    _gaxGrpc;
+    _protos;
+    _defaults;
+    _universeDomain;
+    _servicePath;
+    _log = google_gax_1.loggingUtils.log('vectorsearch');
+    auth;
+    descriptors = {
+        page: {},
+        stream: {},
+        longrunning: {},
+        batching: {},
+    };
+    warn;
+    innerApiCalls;
+    locationsClient;
+    pathTemplates;
+    dataObjectSearchServiceStub;
+    /**
+     * Construct an instance of DataObjectSearchServiceClient.
+     *
+     * @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 DataObjectSearchServiceClient({fallback: true}, gax);
+     *     ```
+     */
+    constructor(opts, gaxInstance) {
+        // Ensure that options include all the required fields.
+        const staticMembers = this.constructor;
+        if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
+            throw new Error('Please set either universe_domain or universeDomain, but not both.');
+        }
+        const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
+        this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
+        this._servicePath = 'vectorsearch.' + this._universeDomain;
+        const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
+        this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
+        const port = opts?.port || staticMembers.port;
+        const clientConfig = opts?.clientConfig ?? {};
+        const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
+        opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
+        // Request numeric enum values if REST transport is used.
+        opts.numericEnums = true;
+        // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
+        if (servicePath !== this._servicePath && !('scopes' in opts)) {
+            opts['scopes'] = staticMembers.scopes;
+        }
+        // Load google-gax module synchronously if needed
+        if (!gaxInstance) {
+            gaxInstance = require('google-gax');
+        }
+        // Choose either gRPC or proto-over-HTTP implementation of google-gax.
+        this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
+        // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
+        this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
+        // Save options to use in initialize() method.
+        this._opts = opts;
+        // Save the auth object to the client, for use by other methods.
+        this.auth = this._gaxGrpc.auth;
+        // Set useJWTAccessWithScope on the auth object.
+        this.auth.useJWTAccessWithScope = true;
+        // Set defaultServicePath on the auth object.
+        this.auth.defaultServicePath = this._servicePath;
+        // Set the default scopes in auth client if needed.
+        if (servicePath === this._servicePath) {
+            this.auth.defaultScopes = staticMembers.scopes;
+        }
+        this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
+        // Determine the client header string.
+        const clientHeader = [
+            `gax/${this._gaxModule.version}`,
+            `gapic/${version}`,
+        ];
+        if (typeof process === 'object' && 'versions' in process) {
+            clientHeader.push(`gl-node/${process.versions.node}`);
+        }
+        else {
+            clientHeader.push(`gl-web/${this._gaxModule.version}`);
+        }
+        if (!opts.fallback) {
+            clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
+        }
+        else {
+            clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
+        }
+        if (opts.libName && opts.libVersion) {
+            clientHeader.push(`${opts.libName}/${opts.libVersion}`);
+        }
+        // Load the applicable protos.
+        this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
+        // This API contains "path templates"; forward-slash-separated
+        // identifiers to uniquely identify resources within the API.
+        // Create useful helper objects for these.
+        this.pathTemplates = {
+            collectionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}'),
+            dataObjectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataObjects/{dataObject}'),
+            indexPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/indexes/{index}'),
+        };
+        // Some of the methods on this service return "paged" results,
+        // (e.g. 50 results at a time, with tokens to get subsequent
+        // pages). Denote the keys used for pagination and results.
+        this.descriptors.page = {
+            searchDataObjects: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
+            queryDataObjects: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'dataObjects')
+        };
+        // Put together the default options sent with requests.
+        this._defaults = this._gaxGrpc.constructSettings('google.cloud.vectorsearch.v1beta.DataObjectSearchService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
+        // Set up a dictionary of "inner API calls"; the core implementation
+        // of calling the API is handled in `google-gax`, with this code
+        // merely providing the destination and request information.
+        this.innerApiCalls = {};
+        // Add a warn function to the client constructor so it can be easily tested.
+        this.warn = this._gaxModule.warn;
+    }
+    /**
+     * 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() {
+        // If the client stub promise is already initialized, return immediately.
+        if (this.dataObjectSearchServiceStub) {
+            return this.dataObjectSearchServiceStub;
+        }
+        // Put together the "service stub" for
+        // google.cloud.vectorsearch.v1beta.DataObjectSearchService.
+        this.dataObjectSearchServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.cloud.vectorsearch.v1beta.DataObjectSearchService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.cloud.vectorsearch.v1beta.DataObjectSearchService, this._opts, this._providedCustomServicePath);
+        // Iterate over each of the methods that the service provides
+        // and create an API call method for each.
+        const dataObjectSearchServiceStubMethods = ['searchDataObjects', 'queryDataObjects', 'aggregateDataObjects', 'batchSearchDataObjects'];
+        for (const methodName of dataObjectSearchServiceStubMethods) {
+            const callPromise = this.dataObjectSearchServiceStub.then(stub => (...args) => {
+                if (this._terminated) {
+                    return Promise.reject('The client has already been closed.');
+                }
+                const func = stub[methodName];
+                return func.apply(stub, args);
+            }, (err) => () => {
+                throw err;
+            });
+            const descriptor = this.descriptors.page[methodName] ||
+                undefined;
+            const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
+            this.innerApiCalls[methodName] = apiCall;
+        }
+        return this.dataObjectSearchServiceStub;
+    }
+    /**
+     * 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() {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
+            process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
+        return 'vectorsearch.googleapis.com';
+    }
+    /**
+     * 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() {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
+            process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
+        return 'vectorsearch.googleapis.com';
+    }
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint() {
+        return this._servicePath;
+    }
+    get universeDomain() {
+        return this._universeDomain;
+    }
+    /**
+     * The port for this API service.
+     * @returns {number} The default port for this service.
+     */
+    static get port() {
+        return 443;
+    }
+    /**
+     * The scopes needed to make gRPC calls for every method defined
+     * in this service.
+     * @returns {string[]} List of default scopes.
+     */
+    static get scopes() {
+        return [
+            'https://www.googleapis.com/auth/cloud-platform'
+        ];
+    }
+    /**
+     * Return the project ID used by this class.
+     * @returns {Promise} A promise that resolves to string containing the project ID.
+     */
+    getProjectId(callback) {
+        if (callback) {
+            this.auth.getProjectId(callback);
+            return;
+        }
+        return this.auth.getProjectId();
+    }
+    aggregateDataObjects(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        this._log.info('aggregateDataObjects request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('aggregateDataObjects response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls.aggregateDataObjects(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('aggregateDataObjects response %j', response);
+            return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    batchSearchDataObjects(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        this._log.info('batchSearchDataObjects request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('batchSearchDataObjects response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls.batchSearchDataObjects(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('batchSearchDataObjects response %j', response);
+            return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
+    searchDataObjects(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        const wrappedCallback = callback
+            ? (error, values, nextPageRequest, rawResponse) => {
+                this._log.info('searchDataObjects values %j', values);
+                callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('searchDataObjects request %j', request);
+        return this.innerApiCalls
+            .searchDataObjects(request, options, wrappedCallback)
+            ?.then(([response, input, output]) => {
+            this._log.info('searchDataObjects values %j', response);
+            return [response, input, output];
+        });
+    }
+    /**
+     * Equivalent to `searchDataObjects`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.cloud.vectorsearch.v1beta.VectorSearch} request.vectorSearch
+     *   A vector search operation.
+     * @param {google.cloud.vectorsearch.v1beta.SemanticSearch} request.semanticSearch
+     *   A semantic search operation.
+     * @param {google.cloud.vectorsearch.v1beta.TextSearch} [request.textSearch]
+     *   Optional. A text search operation.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to search.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse.next_page_token|SearchDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1beta.DataObjectSearchService.SearchDataObjects|DataObjectSearchService.SearchDataObjects}
+     *   call.
+     * @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.v1beta.SearchResult|SearchResult} 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 `searchDataObjectsAsync()`
+     *   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.
+     */
+    searchDataObjectsStream(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        const defaultCallSettings = this._defaults['searchDataObjects'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => { throw err; });
+        this._log.info('searchDataObjects stream %j', request);
+        return this.descriptors.page.searchDataObjects.createStream(this.innerApiCalls.searchDataObjects, request, callSettings);
+    }
+    /**
+     * Equivalent to `searchDataObjects`, 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 {google.cloud.vectorsearch.v1beta.VectorSearch} request.vectorSearch
+     *   A vector search operation.
+     * @param {google.cloud.vectorsearch.v1beta.SemanticSearch} request.semanticSearch
+     *   A semantic search operation.
+     * @param {google.cloud.vectorsearch.v1beta.TextSearch} [request.textSearch]
+     *   Optional. A text search operation.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to search.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse.next_page_token|SearchDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1beta.DataObjectSearchService.SearchDataObjects|DataObjectSearchService.SearchDataObjects}
+     *   call.
+     * @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.v1beta.SearchResult|SearchResult}. 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/v1beta/data_object_search_service.search_data_objects.js</caption>
+     * region_tag:vectorsearch_v1beta_generated_DataObjectSearchService_SearchDataObjects_async
+     */
+    searchDataObjectsAsync(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        const defaultCallSettings = this._defaults['searchDataObjects'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => { throw err; });
+        this._log.info('searchDataObjects iterate %j', request);
+        return this.descriptors.page.searchDataObjects.asyncIterate(this.innerApiCalls['searchDataObjects'], request, callSettings);
+    }
+    queryDataObjects(request, optionsOrCallback, callback) {
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        this.initialize().catch(err => { throw err; });
+        const wrappedCallback = callback
+            ? (error, values, nextPageRequest, rawResponse) => {
+                this._log.info('queryDataObjects values %j', values);
+                callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('queryDataObjects request %j', request);
+        return this.innerApiCalls
+            .queryDataObjects(request, options, wrappedCallback)
+            ?.then(([response, input, output]) => {
+            this._log.info('queryDataObjects values %j', response);
+            return [response, input, output];
+        });
+    }
+    /**
+     * Equivalent to `queryDataObjects`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the Collection for which to query.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {google.protobuf.Struct} [request.filter]
+     *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+     *   represented as a google.protobuf.Struct.
+     * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
+     *   Optional. Mask specifying which fields to return.
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1beta.QueryDataObjectsResponse.next_page_token|QueryDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1beta.DataObjectSearchService.QueryDataObjects|DataObjectSearchService.QueryDataObjects}
+     *   call.
+     * @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.v1beta.DataObject|DataObject} 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 `queryDataObjectsAsync()`
+     *   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.
+     */
+    queryDataObjectsStream(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        const defaultCallSettings = this._defaults['queryDataObjects'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => { throw err; });
+        this._log.info('queryDataObjects stream %j', request);
+        return this.descriptors.page.queryDataObjects.createStream(this.innerApiCalls.queryDataObjects, request, callSettings);
+    }
+    /**
+     * Equivalent to `queryDataObjects`, 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. The resource name of the Collection for which to query.
+     *   Format: `projects/{project}/locations/{location}/collections/{collection}`
+     * @param {google.protobuf.Struct} [request.filter]
+     *   Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
+     *   represented as a google.protobuf.Struct.
+     * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
+     *   Optional. Mask specifying which fields to return.
+     * @param {number} [request.pageSize]
+     *   Optional. The standard list page size.
+     * @param {string} [request.pageToken]
+     *   Optional. The standard list page token.
+     *   Typically obtained via
+     *   {@link protos.google.cloud.vectorsearch.v1beta.QueryDataObjectsResponse.next_page_token|QueryDataObjectsResponse.next_page_token}
+     *   of the previous
+     *   {@link protos.google.cloud.vectorsearch.v1beta.DataObjectSearchService.QueryDataObjects|DataObjectSearchService.QueryDataObjects}
+     *   call.
+     * @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.v1beta.DataObject|DataObject}. 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/v1beta/data_object_search_service.query_data_objects.js</caption>
+     * region_tag:vectorsearch_v1beta_generated_DataObjectSearchService_QueryDataObjects_async
+     */
+    queryDataObjectsAsync(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'parent': request.parent ?? '',
+        });
+        const defaultCallSettings = this._defaults['queryDataObjects'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => { throw err; });
+        this._log.info('queryDataObjects iterate %j', request);
+        return this.descriptors.page.queryDataObjects.asyncIterate(this.innerApiCalls['queryDataObjects'], request, callSettings);
+    }
+    /**
+       * 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, options, callback) {
+        return this.locationsClient.getLocation(request, options, callback);
+    }
+    /**
+       * 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, options) {
+        return this.locationsClient.listLocationsAsync(request, options);
+    }
+    // --------------------
+    // -- Path templates --
+    // --------------------
+    /**
+     * Return a fully-qualified collection resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @returns {string} Resource name string.
+     */
+    collectionPath(project, location, collection) {
+        return this.pathTemplates.collectionPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.collectionPathTemplate.match(collectionName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.collectionPathTemplate.match(collectionName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.collectionPathTemplate.match(collectionName).collection;
+    }
+    /**
+     * 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, location, collection, dataObject) {
+        return this.pathTemplates.dataObjectPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            dataObject: dataObject,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.dataObjectPathTemplate.match(dataObjectName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.dataObjectPathTemplate.match(dataObjectName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.dataObjectPathTemplate.match(dataObjectName).collection;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.dataObjectPathTemplate.match(dataObjectName).dataObject;
+    }
+    /**
+     * 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, location, collection, index) {
+        return this.pathTemplates.indexPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            index: index,
+        });
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.indexPathTemplate.match(indexName).project;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.indexPathTemplate.match(indexName).location;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.indexPathTemplate.match(indexName).collection;
+    }
+    /**
+     * 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) {
+        return this.pathTemplates.indexPathTemplate.match(indexName).index;
+    }
+    /**
+     * 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() {
+        if (this.dataObjectSearchServiceStub && !this._terminated) {
+            return this.dataObjectSearchServiceStub.then(stub => {
+                this._log.info('ending gRPC channel');
+                this._terminated = true;
+                stub.close();
+                this.locationsClient.close().catch(err => { throw err; });
+            });
+        }
+        return Promise.resolve();
+    }
+}
+exports.DataObjectSearchServiceClient = DataObjectSearchServiceClient;
+//# sourceMappingURL=data_object_search_service_client.js.map