@google-cloud/discoveryengine 2.0.1 → 2.2.0

package/build/src/v1/search_service_client.js

@@ -97,26 +97,17 @@ class SearchServiceClient {
     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) {
+        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';
+        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 = 'discoveryengine.' + 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');
+        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;
@@ -146,7 +137,10 @@ class SearchServiceClient {
         }
         this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
         // Determine the client header string.
-        const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
+        const clientHeader = [
+            `gax/${this._gaxModule.version}`,
+            `gapic/${version}`,
+        ];
         if (typeof process === 'object' && 'versions' in process) {
             clientHeader.push(`gl-node/${process.versions.node}`);
         }
@@ -183,6 +177,7 @@ class SearchServiceClient {
             projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
             projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
             projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
             projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
             projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
             projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
@@ -202,6 +197,7 @@ class SearchServiceClient {
             projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
             projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
             projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
             projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
         };
         // Some of the methods on this service return "paged" results,
@@ -209,7 +205,7 @@ class SearchServiceClient {
         // pages). Denote the keys used for pagination and results.
         this.descriptors.page = {
             search: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
-            searchLite: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
+            searchLite: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results')
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1.SearchService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -238,10 +234,10 @@ class SearchServiceClient {
         }
         // Put together the "service stub" for
         // google.cloud.discoveryengine.v1.SearchService.
-        this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback
-            ? this._protos.lookupService('google.cloud.discoveryengine.v1.SearchService')
-            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._protos.google.cloud.discoveryengine.v1.SearchService, this._opts, this._providedCustomServicePath);
+        this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.cloud.discoveryengine.v1.SearchService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.cloud.discoveryengine.v1.SearchService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
         const searchServiceStubMethods = ['search', 'searchLite'];
@@ -255,7 +251,8 @@ class SearchServiceClient {
             }, (err) => () => {
                 throw err;
             });
-            const descriptor = this.descriptors.page[methodName] || undefined;
+            const descriptor = this.descriptors.page[methodName] ||
+                undefined;
             const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
             this.innerApiCalls[methodName] = apiCall;
         }
@@ -267,8 +264,7 @@ class SearchServiceClient {
      * @returns {string} The DNS address for this service.
      */
     static get servicePath() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'discoveryengine.googleapis.com';
@@ -279,8 +275,7 @@ class SearchServiceClient {
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'discoveryengine.googleapis.com';
@@ -308,7 +303,9 @@ class SearchServiceClient {
      * @returns {string[]} List of default scopes.
      */
     static get scopes() {
-        return ['https://www.googleapis.com/auth/cloud-platform'];
+        return [
+            'https://www.googleapis.com/auth/cloud-platform'
+        ];
     }
     /**
      * Return the project ID used by this class.
@@ -334,13 +331,10 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         const wrappedCallback = callback
             ? (error, values, nextPageRequest, rawResponse) => {
                 this._log.info('search values %j', values);
@@ -409,10 +403,13 @@ class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -457,7 +454,7 @@ class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -539,6 +536,9 @@ class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -570,6 +570,16 @@ class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -586,15 +596,12 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('search stream %j', request);
         return this.descriptors.page.search.createStream(this.innerApiCalls.search, request, callSettings);
     }
@@ -654,10 +661,13 @@ class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -702,7 +712,7 @@ class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -784,6 +794,9 @@ class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -815,6 +828,16 @@ class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -832,15 +855,12 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('search iterate %j', request);
         return this.descriptors.page.search.asyncIterate(this.innerApiCalls['search'], request, callSettings);
     }
@@ -857,13 +877,10 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         const wrappedCallback = callback
             ? (error, values, nextPageRequest, rawResponse) => {
                 this._log.info('searchLite values %j', values);
@@ -932,10 +949,13 @@ class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -980,7 +1000,7 @@ class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -1062,6 +1082,9 @@ class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -1093,6 +1116,16 @@ class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
@@ -1109,15 +1142,12 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['searchLite'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('searchLite stream %j', request);
         return this.descriptors.page.searchLite.createStream(this.innerApiCalls.searchLite, request, callSettings);
     }
@@ -1177,10 +1207,13 @@ class SearchServiceClient {
      *   This applies to each OneBox type individually.
      *   Default number is 10.
      * @param {number[]} request.dataStoreSpecs
-     *   Specs defining dataStores to filter on in a search call and configurations
-     *   for those dataStores. This is only considered for engines with multiple
-     *   dataStores use case. For single dataStore within an engine, they should
-     *   use the specs at the top level.
+     *   Specifications that define the specific
+     *   {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
+     *   along with configurations for those data stores. This is only considered
+     *   for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
+     *   stores. For engines with a single data store, the specs directly under
+     *   {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
+     *   used.
      * @param {string} request.filter
      *   The filter syntax consists of an expression language for constructing a
      *   predicate from one or more fields of the documents being filtered. Filter
@@ -1225,7 +1258,7 @@ class SearchServiceClient {
      *   If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
      * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
      *   Information about the end user.
-     *   Highly recommended for analytics.
+     *   Highly recommended for analytics and personalization.
      *   {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
      *   is used to deduce `device_type` for analytics.
      * @param {string} request.languageCode
@@ -1307,6 +1340,9 @@ class SearchServiceClient {
      *   Search as you type configuration. Only supported for the
      *   {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
      *   vertical.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
+     *   Optional. Config for display feature, like match highlighting on search
+     *   results.
      * @param {string} request.session
      *   The session resource name. Optional.
      *
@@ -1338,6 +1374,16 @@ class SearchServiceClient {
      *   Session specification.
      *
      *   Can be used only when `session` is set.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
+     *   The relevance threshold of the search results.
+     *
+     *   Default to Google defined threshold, leveraging a balance of
+     *   precision and recall to deliver both highly accurate results and
+     *   comprehensive coverage of relevant information.
+     *
+     *   This feature is not supported for healthcare search.
+     * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
+     *   Optional. The specification for returning the relevance score.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
@@ -1355,70 +1401,67 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['searchLite'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('searchLite iterate %j', request);
         return this.descriptors.page.searchLite.asyncIterate(this.innerApiCalls['searchLite'], 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);
-     * ```
-     */
+       * 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
-     * }
-     * ```
-     */
+       * 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);
     }
@@ -2412,6 +2455,75 @@ class SearchServiceClient {
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
         return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project, location, collection, dataStore, sitemap) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            sitemap: sitemap,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).data_store;
+    }
+    /**
+     * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).sitemap;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
      *
@@ -3591,6 +3703,63 @@ class SearchServiceClient {
     matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
         return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} sitemap
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineSitemapPath(project, location, dataStore, sitemap) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            sitemap: sitemap,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).data_store;
+    }
+    /**
+     * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
+     * @returns {string} A string representing the sitemap.
+     */
+    matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).sitemap;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
      *
@@ -3660,7 +3829,7 @@ class SearchServiceClient {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close();
+                this.locationsClient.close().catch(err => { throw err; });
             });
         }
         return Promise.resolve();