@google-cloud/discoveryengine 2.0.1 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +7 -2
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +54 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +2 -1
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +35 -6
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +113 -2
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +168 -2
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +23 -4
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +7 -2
  10. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +16 -3
  12. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +70 -9
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +20 -1
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +9 -5
  15. package/build/protos/google/cloud/discoveryengine/v1/rank_service.proto +3 -1
  16. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +2 -2
  17. package/build/protos/google/cloud/discoveryengine/v1/safety.proto +107 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +96 -8
  19. package/build/protos/google/cloud/discoveryengine/v1/serving_config.proto +271 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/serving_config_service.proto +75 -0
  21. package/build/protos/google/cloud/discoveryengine/v1/session.proto +19 -0
  22. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +27 -3
  23. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +184 -5
  24. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +34 -0
  25. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +16 -4
  26. package/build/protos/protos.d.ts +4390 -300
  27. package/build/protos/protos.js +13785 -2922
  28. package/build/protos/protos.json +1355 -14
  29. package/build/src/index.d.ts +4 -1
  30. package/build/src/index.js +4 -21
  31. package/build/src/v1/completion_service_client.d.ts +313 -76
  32. package/build/src/v1/completion_service_client.js +451 -262
  33. package/build/src/v1/completion_service_proto_list.json +3 -0
  34. package/build/src/v1/control_service_client.d.ts +318 -81
  35. package/build/src/v1/control_service_client.js +422 -132
  36. package/build/src/v1/control_service_proto_list.json +3 -0
  37. package/build/src/v1/conversational_search_service_client.d.ts +341 -134
  38. package/build/src/v1/conversational_search_service_client.js +395 -223
  39. package/build/src/v1/conversational_search_service_client_config.json +5 -0
  40. package/build/src/v1/conversational_search_service_proto_list.json +3 -0
  41. package/build/src/v1/data_store_service_client.d.ts +359 -122
  42. package/build/src/v1/data_store_service_client.js +460 -280
  43. package/build/src/v1/data_store_service_proto_list.json +3 -0
  44. package/build/src/v1/document_service_client.d.ts +364 -121
  45. package/build/src/v1/document_service_client.js +469 -300
  46. package/build/src/v1/document_service_proto_list.json +3 -0
  47. package/build/src/v1/engine_service_client.d.ts +340 -103
  48. package/build/src/v1/engine_service_client.js +460 -279
  49. package/build/src/v1/engine_service_proto_list.json +3 -0
  50. package/build/src/v1/gapic_metadata.json +59 -0
  51. package/build/src/v1/grounded_generation_service_client.d.ts +286 -51
  52. package/build/src/v1/grounded_generation_service_client.js +405 -100
  53. package/build/src/v1/grounded_generation_service_proto_list.json +3 -0
  54. package/build/src/v1/index.d.ts +1 -0
  55. package/build/src/v1/index.js +3 -1
  56. package/build/src/v1/project_service_client.d.ts +313 -76
  57. package/build/src/v1/project_service_client.js +434 -222
  58. package/build/src/v1/project_service_proto_list.json +3 -0
  59. package/build/src/v1/rank_service_client.d.ts +285 -48
  60. package/build/src/v1/rank_service_client.js +398 -85
  61. package/build/src/v1/rank_service_proto_list.json +3 -0
  62. package/build/src/v1/recommendation_service_client.d.ts +142 -49
  63. package/build/src/v1/recommendation_service_client.js +198 -82
  64. package/build/src/v1/recommendation_service_proto_list.json +3 -0
  65. package/build/src/v1/schema_service_client.d.ts +348 -111
  66. package/build/src/v1/schema_service_client.js +457 -273
  67. package/build/src/v1/schema_service_proto_list.json +3 -0
  68. package/build/src/v1/search_service_client.d.ts +748 -559
  69. package/build/src/v1/search_service_client.js +302 -133
  70. package/build/src/v1/search_service_proto_list.json +3 -0
  71. package/build/src/v1/search_tuning_service_client.d.ts +314 -77
  72. package/build/src/v1/search_tuning_service_client.js +439 -235
  73. package/build/src/v1/search_tuning_service_proto_list.json +3 -0
  74. package/build/src/v1/serving_config_service_client.d.ts +1851 -0
  75. package/build/src/v1/serving_config_service_client.js +2642 -0
  76. package/build/src/v1/serving_config_service_client_config.json +30 -0
  77. package/build/src/v1/serving_config_service_proto_list.json +39 -0
  78. package/build/src/v1/site_search_engine_service_client.d.ts +504 -151
  79. package/build/src/v1/site_search_engine_service_client.js +625 -351
  80. package/build/src/v1/site_search_engine_service_client_config.json +12 -0
  81. package/build/src/v1/site_search_engine_service_proto_list.json +3 -0
  82. package/build/src/v1/user_event_service_client.d.ts +335 -86
  83. package/build/src/v1/user_event_service_client.js +447 -253
  84. package/build/src/v1/user_event_service_proto_list.json +3 -0
  85. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  86. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  87. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  88. package/build/src/v1alpha/chunk_service_client.js +92 -120
  89. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  90. package/build/src/v1alpha/completion_service_client.js +134 -280
  91. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  92. package/build/src/v1alpha/control_service_client.js +105 -151
  93. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  94. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  95. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  96. package/build/src/v1alpha/data_store_service_client.js +151 -316
  97. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  98. package/build/src/v1alpha/document_service_client.js +156 -328
  99. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  100. package/build/src/v1alpha/engine_service_client.js +155 -325
  101. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  102. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  103. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  104. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  105. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  106. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  107. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  108. package/build/src/v1alpha/project_service_client.js +126 -262
  109. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  110. package/build/src/v1alpha/rank_service_client.js +81 -104
  111. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  112. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  113. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  114. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  115. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  116. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  117. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  118. package/build/src/v1alpha/schema_service_client.js +140 -292
  119. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  120. package/build/src/v1alpha/search_service_client.js +88 -112
  121. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  122. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  123. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  124. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  125. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  126. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  127. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  128. package/build/src/v1alpha/user_event_service_client.js +130 -271
  129. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  130. package/build/src/v1beta/completion_service_client.js +136 -279
  131. package/build/src/v1beta/control_service_client.d.ts +84 -84
  132. package/build/src/v1beta/control_service_client.js +103 -147
  133. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  134. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  135. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  136. package/build/src/v1beta/data_store_service_client.js +141 -288
  137. package/build/src/v1beta/document_service_client.d.ts +124 -124
  138. package/build/src/v1beta/document_service_client.js +150 -309
  139. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  140. package/build/src/v1beta/engine_service_client.js +153 -315
  141. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  142. package/build/src/v1beta/evaluation_service_client.js +141 -285
  143. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  144. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  145. package/build/src/v1beta/project_service_client.d.ts +76 -76
  146. package/build/src/v1beta/project_service_client.js +115 -231
  147. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  148. package/build/src/v1beta/rank_service_client.js +79 -99
  149. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  150. package/build/src/v1beta/recommendation_service_client.js +77 -96
  151. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  152. package/build/src/v1beta/sample_query_service_client.js +142 -291
  153. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  154. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  155. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  156. package/build/src/v1beta/schema_service_client.js +138 -282
  157. package/build/src/v1beta/search_service_client.d.ts +665 -665
  158. package/build/src/v1beta/search_service_client.js +97 -128
  159. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  160. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  161. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  162. package/build/src/v1beta/serving_config_service_client.js +95 -129
  163. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  164. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  165. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  166. package/build/src/v1beta/user_event_service_client.js +128 -261
  167. package/package.json +4 -4
@@ -97,26 +97,17 @@ class SearchServiceClient {
97
97
  constructor(opts, gaxInstance) {
98
98
  // Ensure that options include all the required fields.
99
99
  const staticMembers = this.constructor;
100
- if (opts?.universe_domain &&
101
- opts?.universeDomain &&
102
- opts?.universe_domain !== opts?.universeDomain) {
100
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
103
101
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
104
102
  }
105
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
106
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
107
- : undefined;
108
- this._universeDomain =
109
- opts?.universeDomain ??
110
- opts?.universe_domain ??
111
- universeDomainEnvVar ??
112
- 'googleapis.com';
103
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
104
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
113
105
  this._servicePath = 'discoveryengine.' + this._universeDomain;
114
106
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
115
107
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
116
108
  const port = opts?.port || staticMembers.port;
117
109
  const clientConfig = opts?.clientConfig ?? {};
118
- const fallback = opts?.fallback ??
119
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
110
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
120
111
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
121
112
  // Request numeric enum values if REST transport is used.
122
113
  opts.numericEnums = true;
@@ -146,7 +137,10 @@ class SearchServiceClient {
146
137
  }
147
138
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
148
139
  // Determine the client header string.
149
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
140
+ const clientHeader = [
141
+ `gax/${this._gaxModule.version}`,
142
+ `gapic/${version}`,
143
+ ];
150
144
  if (typeof process === 'object' && 'versions' in process) {
151
145
  clientHeader.push(`gl-node/${process.versions.node}`);
152
146
  }
@@ -183,6 +177,7 @@ class SearchServiceClient {
183
177
  projectLocationCollectionDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}'),
184
178
  projectLocationCollectionDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
185
179
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
180
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
186
181
  projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
187
182
  projectLocationCollectionEngineControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/controls/{control}'),
188
183
  projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
@@ -202,6 +197,7 @@ class SearchServiceClient {
202
197
  projectLocationDataStoreSessionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}'),
203
198
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
204
199
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
200
+ projectLocationDataStoreSiteSearchEngineSitemapPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}'),
205
201
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
206
202
  };
207
203
  // Some of the methods on this service return "paged" results,
@@ -209,7 +205,7 @@ class SearchServiceClient {
209
205
  // pages). Denote the keys used for pagination and results.
210
206
  this.descriptors.page = {
211
207
  search: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
212
- searchLite: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
208
+ searchLite: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results')
213
209
  };
214
210
  // Put together the default options sent with requests.
215
211
  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 {
238
234
  }
239
235
  // Put together the "service stub" for
240
236
  // google.cloud.discoveryengine.v1.SearchService.
241
- this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback
242
- ? this._protos.lookupService('google.cloud.discoveryengine.v1.SearchService')
243
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
244
- this._protos.google.cloud.discoveryengine.v1.SearchService, this._opts, this._providedCustomServicePath);
237
+ this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
238
+ this._protos.lookupService('google.cloud.discoveryengine.v1.SearchService') :
239
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
240
+ this._protos.google.cloud.discoveryengine.v1.SearchService, this._opts, this._providedCustomServicePath);
245
241
  // Iterate over each of the methods that the service provides
246
242
  // and create an API call method for each.
247
243
  const searchServiceStubMethods = ['search', 'searchLite'];
@@ -255,7 +251,8 @@ class SearchServiceClient {
255
251
  }, (err) => () => {
256
252
  throw err;
257
253
  });
258
- const descriptor = this.descriptors.page[methodName] || undefined;
254
+ const descriptor = this.descriptors.page[methodName] ||
255
+ undefined;
259
256
  const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
260
257
  this.innerApiCalls[methodName] = apiCall;
261
258
  }
@@ -267,8 +264,7 @@ class SearchServiceClient {
267
264
  * @returns {string} The DNS address for this service.
268
265
  */
269
266
  static get servicePath() {
270
- if (typeof process === 'object' &&
271
- typeof process.emitWarning === 'function') {
267
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
272
268
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
273
269
  }
274
270
  return 'discoveryengine.googleapis.com';
@@ -279,8 +275,7 @@ class SearchServiceClient {
279
275
  * @returns {string} The DNS address for this service.
280
276
  */
281
277
  static get apiEndpoint() {
282
- if (typeof process === 'object' &&
283
- typeof process.emitWarning === 'function') {
278
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
284
279
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
285
280
  }
286
281
  return 'discoveryengine.googleapis.com';
@@ -308,7 +303,9 @@ class SearchServiceClient {
308
303
  * @returns {string[]} List of default scopes.
309
304
  */
310
305
  static get scopes() {
311
- return ['https://www.googleapis.com/auth/cloud-platform'];
306
+ return [
307
+ 'https://www.googleapis.com/auth/cloud-platform'
308
+ ];
312
309
  }
313
310
  /**
314
311
  * Return the project ID used by this class.
@@ -334,13 +331,10 @@ class SearchServiceClient {
334
331
  options = options || {};
335
332
  options.otherArgs = options.otherArgs || {};
336
333
  options.otherArgs.headers = options.otherArgs.headers || {};
337
- options.otherArgs.headers['x-goog-request-params'] =
338
- this._gaxModule.routingHeader.fromParams({
339
- serving_config: request.servingConfig ?? '',
340
- });
341
- this.initialize().catch(err => {
342
- throw err;
334
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
335
+ 'serving_config': request.servingConfig ?? '',
343
336
  });
337
+ this.initialize().catch(err => { throw err; });
344
338
  const wrappedCallback = callback
345
339
  ? (error, values, nextPageRequest, rawResponse) => {
346
340
  this._log.info('search values %j', values);
@@ -409,10 +403,13 @@ class SearchServiceClient {
409
403
  * This applies to each OneBox type individually.
410
404
  * Default number is 10.
411
405
  * @param {number[]} request.dataStoreSpecs
412
- * Specs defining dataStores to filter on in a search call and configurations
413
- * for those dataStores. This is only considered for engines with multiple
414
- * dataStores use case. For single dataStore within an engine, they should
415
- * use the specs at the top level.
406
+ * Specifications that define the specific
407
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
408
+ * along with configurations for those data stores. This is only considered
409
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
410
+ * stores. For engines with a single data store, the specs directly under
411
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
412
+ * used.
416
413
  * @param {string} request.filter
417
414
  * The filter syntax consists of an expression language for constructing a
418
415
  * predicate from one or more fields of the documents being filtered. Filter
@@ -457,7 +454,7 @@ class SearchServiceClient {
457
454
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
458
455
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
459
456
  * Information about the end user.
460
- * Highly recommended for analytics.
457
+ * Highly recommended for analytics and personalization.
461
458
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
462
459
  * is used to deduce `device_type` for analytics.
463
460
  * @param {string} request.languageCode
@@ -539,6 +536,9 @@ class SearchServiceClient {
539
536
  * Search as you type configuration. Only supported for the
540
537
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
541
538
  * vertical.
539
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
540
+ * Optional. Config for display feature, like match highlighting on search
541
+ * results.
542
542
  * @param {string} request.session
543
543
  * The session resource name. Optional.
544
544
  *
@@ -570,6 +570,16 @@ class SearchServiceClient {
570
570
  * Session specification.
571
571
  *
572
572
  * Can be used only when `session` is set.
573
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
574
+ * The relevance threshold of the search results.
575
+ *
576
+ * Default to Google defined threshold, leveraging a balance of
577
+ * precision and recall to deliver both highly accurate results and
578
+ * comprehensive coverage of relevant information.
579
+ *
580
+ * This feature is not supported for healthcare search.
581
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
582
+ * Optional. The specification for returning the relevance score.
573
583
  * @param {object} [options]
574
584
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
575
585
  * @returns {Stream}
@@ -586,15 +596,12 @@ class SearchServiceClient {
586
596
  options = options || {};
587
597
  options.otherArgs = options.otherArgs || {};
588
598
  options.otherArgs.headers = options.otherArgs.headers || {};
589
- options.otherArgs.headers['x-goog-request-params'] =
590
- this._gaxModule.routingHeader.fromParams({
591
- serving_config: request.servingConfig ?? '',
592
- });
599
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
600
+ 'serving_config': request.servingConfig ?? '',
601
+ });
593
602
  const defaultCallSettings = this._defaults['search'];
594
603
  const callSettings = defaultCallSettings.merge(options);
595
- this.initialize().catch(err => {
596
- throw err;
597
- });
604
+ this.initialize().catch(err => { throw err; });
598
605
  this._log.info('search stream %j', request);
599
606
  return this.descriptors.page.search.createStream(this.innerApiCalls.search, request, callSettings);
600
607
  }
@@ -654,10 +661,13 @@ class SearchServiceClient {
654
661
  * This applies to each OneBox type individually.
655
662
  * Default number is 10.
656
663
  * @param {number[]} request.dataStoreSpecs
657
- * Specs defining dataStores to filter on in a search call and configurations
658
- * for those dataStores. This is only considered for engines with multiple
659
- * dataStores use case. For single dataStore within an engine, they should
660
- * use the specs at the top level.
664
+ * Specifications that define the specific
665
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
666
+ * along with configurations for those data stores. This is only considered
667
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
668
+ * stores. For engines with a single data store, the specs directly under
669
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
670
+ * used.
661
671
  * @param {string} request.filter
662
672
  * The filter syntax consists of an expression language for constructing a
663
673
  * predicate from one or more fields of the documents being filtered. Filter
@@ -702,7 +712,7 @@ class SearchServiceClient {
702
712
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
703
713
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
704
714
  * Information about the end user.
705
- * Highly recommended for analytics.
715
+ * Highly recommended for analytics and personalization.
706
716
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
707
717
  * is used to deduce `device_type` for analytics.
708
718
  * @param {string} request.languageCode
@@ -784,6 +794,9 @@ class SearchServiceClient {
784
794
  * Search as you type configuration. Only supported for the
785
795
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
786
796
  * vertical.
797
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
798
+ * Optional. Config for display feature, like match highlighting on search
799
+ * results.
787
800
  * @param {string} request.session
788
801
  * The session resource name. Optional.
789
802
  *
@@ -815,6 +828,16 @@ class SearchServiceClient {
815
828
  * Session specification.
816
829
  *
817
830
  * Can be used only when `session` is set.
831
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
832
+ * The relevance threshold of the search results.
833
+ *
834
+ * Default to Google defined threshold, leveraging a balance of
835
+ * precision and recall to deliver both highly accurate results and
836
+ * comprehensive coverage of relevant information.
837
+ *
838
+ * This feature is not supported for healthcare search.
839
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
840
+ * Optional. The specification for returning the relevance score.
818
841
  * @param {object} [options]
819
842
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
820
843
  * @returns {Object}
@@ -832,15 +855,12 @@ class SearchServiceClient {
832
855
  options = options || {};
833
856
  options.otherArgs = options.otherArgs || {};
834
857
  options.otherArgs.headers = options.otherArgs.headers || {};
835
- options.otherArgs.headers['x-goog-request-params'] =
836
- this._gaxModule.routingHeader.fromParams({
837
- serving_config: request.servingConfig ?? '',
838
- });
858
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
859
+ 'serving_config': request.servingConfig ?? '',
860
+ });
839
861
  const defaultCallSettings = this._defaults['search'];
840
862
  const callSettings = defaultCallSettings.merge(options);
841
- this.initialize().catch(err => {
842
- throw err;
843
- });
863
+ this.initialize().catch(err => { throw err; });
844
864
  this._log.info('search iterate %j', request);
845
865
  return this.descriptors.page.search.asyncIterate(this.innerApiCalls['search'], request, callSettings);
846
866
  }
@@ -857,13 +877,10 @@ class SearchServiceClient {
857
877
  options = options || {};
858
878
  options.otherArgs = options.otherArgs || {};
859
879
  options.otherArgs.headers = options.otherArgs.headers || {};
860
- options.otherArgs.headers['x-goog-request-params'] =
861
- this._gaxModule.routingHeader.fromParams({
862
- serving_config: request.servingConfig ?? '',
863
- });
864
- this.initialize().catch(err => {
865
- throw err;
880
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
881
+ 'serving_config': request.servingConfig ?? '',
866
882
  });
883
+ this.initialize().catch(err => { throw err; });
867
884
  const wrappedCallback = callback
868
885
  ? (error, values, nextPageRequest, rawResponse) => {
869
886
  this._log.info('searchLite values %j', values);
@@ -932,10 +949,13 @@ class SearchServiceClient {
932
949
  * This applies to each OneBox type individually.
933
950
  * Default number is 10.
934
951
  * @param {number[]} request.dataStoreSpecs
935
- * Specs defining dataStores to filter on in a search call and configurations
936
- * for those dataStores. This is only considered for engines with multiple
937
- * dataStores use case. For single dataStore within an engine, they should
938
- * use the specs at the top level.
952
+ * Specifications that define the specific
953
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
954
+ * along with configurations for those data stores. This is only considered
955
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
956
+ * stores. For engines with a single data store, the specs directly under
957
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
958
+ * used.
939
959
  * @param {string} request.filter
940
960
  * The filter syntax consists of an expression language for constructing a
941
961
  * predicate from one or more fields of the documents being filtered. Filter
@@ -980,7 +1000,7 @@ class SearchServiceClient {
980
1000
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
981
1001
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
982
1002
  * Information about the end user.
983
- * Highly recommended for analytics.
1003
+ * Highly recommended for analytics and personalization.
984
1004
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
985
1005
  * is used to deduce `device_type` for analytics.
986
1006
  * @param {string} request.languageCode
@@ -1062,6 +1082,9 @@ class SearchServiceClient {
1062
1082
  * Search as you type configuration. Only supported for the
1063
1083
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1064
1084
  * vertical.
1085
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1086
+ * Optional. Config for display feature, like match highlighting on search
1087
+ * results.
1065
1088
  * @param {string} request.session
1066
1089
  * The session resource name. Optional.
1067
1090
  *
@@ -1093,6 +1116,16 @@ class SearchServiceClient {
1093
1116
  * Session specification.
1094
1117
  *
1095
1118
  * Can be used only when `session` is set.
1119
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1120
+ * The relevance threshold of the search results.
1121
+ *
1122
+ * Default to Google defined threshold, leveraging a balance of
1123
+ * precision and recall to deliver both highly accurate results and
1124
+ * comprehensive coverage of relevant information.
1125
+ *
1126
+ * This feature is not supported for healthcare search.
1127
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1128
+ * Optional. The specification for returning the relevance score.
1096
1129
  * @param {object} [options]
1097
1130
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1098
1131
  * @returns {Stream}
@@ -1109,15 +1142,12 @@ class SearchServiceClient {
1109
1142
  options = options || {};
1110
1143
  options.otherArgs = options.otherArgs || {};
1111
1144
  options.otherArgs.headers = options.otherArgs.headers || {};
1112
- options.otherArgs.headers['x-goog-request-params'] =
1113
- this._gaxModule.routingHeader.fromParams({
1114
- serving_config: request.servingConfig ?? '',
1115
- });
1145
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
1146
+ 'serving_config': request.servingConfig ?? '',
1147
+ });
1116
1148
  const defaultCallSettings = this._defaults['searchLite'];
1117
1149
  const callSettings = defaultCallSettings.merge(options);
1118
- this.initialize().catch(err => {
1119
- throw err;
1120
- });
1150
+ this.initialize().catch(err => { throw err; });
1121
1151
  this._log.info('searchLite stream %j', request);
1122
1152
  return this.descriptors.page.searchLite.createStream(this.innerApiCalls.searchLite, request, callSettings);
1123
1153
  }
@@ -1177,10 +1207,13 @@ class SearchServiceClient {
1177
1207
  * This applies to each OneBox type individually.
1178
1208
  * Default number is 10.
1179
1209
  * @param {number[]} request.dataStoreSpecs
1180
- * Specs defining dataStores to filter on in a search call and configurations
1181
- * for those dataStores. This is only considered for engines with multiple
1182
- * dataStores use case. For single dataStore within an engine, they should
1183
- * use the specs at the top level.
1210
+ * Specifications that define the specific
1211
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s to be searched,
1212
+ * along with configurations for those data stores. This is only considered
1213
+ * for {@link protos.google.cloud.discoveryengine.v1.Engine|Engine}s with multiple data
1214
+ * stores. For engines with a single data store, the specs directly under
1215
+ * {@link protos.google.cloud.discoveryengine.v1.SearchRequest|SearchRequest} should be
1216
+ * used.
1184
1217
  * @param {string} request.filter
1185
1218
  * The filter syntax consists of an expression language for constructing a
1186
1219
  * predicate from one or more fields of the documents being filtered. Filter
@@ -1225,7 +1258,7 @@ class SearchServiceClient {
1225
1258
  * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1226
1259
  * @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
1227
1260
  * Information about the end user.
1228
- * Highly recommended for analytics.
1261
+ * Highly recommended for analytics and personalization.
1229
1262
  * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
1230
1263
  * is used to deduce `device_type` for analytics.
1231
1264
  * @param {string} request.languageCode
@@ -1307,6 +1340,9 @@ class SearchServiceClient {
1307
1340
  * Search as you type configuration. Only supported for the
1308
1341
  * {@link protos.google.cloud.discoveryengine.v1.IndustryVertical.MEDIA|IndustryVertical.MEDIA}
1309
1342
  * vertical.
1343
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec} [request.displaySpec]
1344
+ * Optional. Config for display feature, like match highlighting on search
1345
+ * results.
1310
1346
  * @param {string} request.session
1311
1347
  * The session resource name. Optional.
1312
1348
  *
@@ -1338,6 +1374,16 @@ class SearchServiceClient {
1338
1374
  * Session specification.
1339
1375
  *
1340
1376
  * Can be used only when `session` is set.
1377
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceThreshold} request.relevanceThreshold
1378
+ * The relevance threshold of the search results.
1379
+ *
1380
+ * Default to Google defined threshold, leveraging a balance of
1381
+ * precision and recall to deliver both highly accurate results and
1382
+ * comprehensive coverage of relevant information.
1383
+ *
1384
+ * This feature is not supported for healthcare search.
1385
+ * @param {google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec} [request.relevanceScoreSpec]
1386
+ * Optional. The specification for returning the relevance score.
1341
1387
  * @param {object} [options]
1342
1388
  * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1343
1389
  * @returns {Object}
@@ -1355,70 +1401,67 @@ class SearchServiceClient {
1355
1401
  options = options || {};
1356
1402
  options.otherArgs = options.otherArgs || {};
1357
1403
  options.otherArgs.headers = options.otherArgs.headers || {};
1358
- options.otherArgs.headers['x-goog-request-params'] =
1359
- this._gaxModule.routingHeader.fromParams({
1360
- serving_config: request.servingConfig ?? '',
1361
- });
1404
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
1405
+ 'serving_config': request.servingConfig ?? '',
1406
+ });
1362
1407
  const defaultCallSettings = this._defaults['searchLite'];
1363
1408
  const callSettings = defaultCallSettings.merge(options);
1364
- this.initialize().catch(err => {
1365
- throw err;
1366
- });
1409
+ this.initialize().catch(err => { throw err; });
1367
1410
  this._log.info('searchLite iterate %j', request);
1368
1411
  return this.descriptors.page.searchLite.asyncIterate(this.innerApiCalls['searchLite'], request, callSettings);
1369
1412
  }
1370
1413
  /**
1371
- * Gets information about a location.
1372
- *
1373
- * @param {Object} request
1374
- * The request object that will be sent.
1375
- * @param {string} request.name
1376
- * Resource name for the location.
1377
- * @param {object} [options]
1378
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
1379
- * @returns {Promise} - The promise which resolves to an array.
1380
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
1381
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
1382
- * for more details and examples.
1383
- * @example
1384
- * ```
1385
- * const [response] = await client.getLocation(request);
1386
- * ```
1387
- */
1414
+ * Gets information about a location.
1415
+ *
1416
+ * @param {Object} request
1417
+ * The request object that will be sent.
1418
+ * @param {string} request.name
1419
+ * Resource name for the location.
1420
+ * @param {object} [options]
1421
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
1422
+ * @returns {Promise} - The promise which resolves to an array.
1423
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
1424
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
1425
+ * for more details and examples.
1426
+ * @example
1427
+ * ```
1428
+ * const [response] = await client.getLocation(request);
1429
+ * ```
1430
+ */
1388
1431
  getLocation(request, options, callback) {
1389
1432
  return this.locationsClient.getLocation(request, options, callback);
1390
1433
  }
1391
1434
  /**
1392
- * Lists information about the supported locations for this service. Returns an iterable object.
1393
- *
1394
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1395
- * @param {Object} request
1396
- * The request object that will be sent.
1397
- * @param {string} request.name
1398
- * The resource that owns the locations collection, if applicable.
1399
- * @param {string} request.filter
1400
- * The standard list filter.
1401
- * @param {number} request.pageSize
1402
- * The standard list page size.
1403
- * @param {string} request.pageToken
1404
- * The standard list page token.
1405
- * @param {object} [options]
1406
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1407
- * @returns {Object}
1408
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1409
- * When you iterate the returned iterable, each element will be an object representing
1410
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
1411
- * so you can stop the iteration when you don't need more results.
1412
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1413
- * for more details and examples.
1414
- * @example
1415
- * ```
1416
- * const iterable = client.listLocationsAsync(request);
1417
- * for await (const response of iterable) {
1418
- * // process response
1419
- * }
1420
- * ```
1421
- */
1435
+ * Lists information about the supported locations for this service. Returns an iterable object.
1436
+ *
1437
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
1438
+ * @param {Object} request
1439
+ * The request object that will be sent.
1440
+ * @param {string} request.name
1441
+ * The resource that owns the locations collection, if applicable.
1442
+ * @param {string} request.filter
1443
+ * The standard list filter.
1444
+ * @param {number} request.pageSize
1445
+ * The standard list page size.
1446
+ * @param {string} request.pageToken
1447
+ * The standard list page token.
1448
+ * @param {object} [options]
1449
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
1450
+ * @returns {Object}
1451
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
1452
+ * When you iterate the returned iterable, each element will be an object representing
1453
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
1454
+ * so you can stop the iteration when you don't need more results.
1455
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
1456
+ * for more details and examples.
1457
+ * @example
1458
+ * ```
1459
+ * const iterable = client.listLocationsAsync(request);
1460
+ * for await (const response of iterable) {
1461
+ * // process response
1462
+ * }
1463
+ * ```
1464
+ */
1422
1465
  listLocationsAsync(request, options) {
1423
1466
  return this.locationsClient.listLocationsAsync(request, options);
1424
1467
  }
@@ -2412,6 +2455,75 @@ class SearchServiceClient {
2412
2455
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
2413
2456
  return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
2414
2457
  }
2458
+ /**
2459
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
2460
+ *
2461
+ * @param {string} project
2462
+ * @param {string} location
2463
+ * @param {string} collection
2464
+ * @param {string} data_store
2465
+ * @param {string} sitemap
2466
+ * @returns {string} Resource name string.
2467
+ */
2468
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project, location, collection, dataStore, sitemap) {
2469
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.render({
2470
+ project: project,
2471
+ location: location,
2472
+ collection: collection,
2473
+ data_store: dataStore,
2474
+ sitemap: sitemap,
2475
+ });
2476
+ }
2477
+ /**
2478
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2479
+ *
2480
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2481
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2482
+ * @returns {string} A string representing the project.
2483
+ */
2484
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2485
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).project;
2486
+ }
2487
+ /**
2488
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2489
+ *
2490
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2491
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2492
+ * @returns {string} A string representing the location.
2493
+ */
2494
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2495
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).location;
2496
+ }
2497
+ /**
2498
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2499
+ *
2500
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2501
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2502
+ * @returns {string} A string representing the collection.
2503
+ */
2504
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2505
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).collection;
2506
+ }
2507
+ /**
2508
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2509
+ *
2510
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2511
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2512
+ * @returns {string} A string representing the data_store.
2513
+ */
2514
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2515
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).data_store;
2516
+ }
2517
+ /**
2518
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
2519
+ *
2520
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
2521
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
2522
+ * @returns {string} A string representing the sitemap.
2523
+ */
2524
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName) {
2525
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineSitemapName).sitemap;
2526
+ }
2415
2527
  /**
2416
2528
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
2417
2529
  *
@@ -3591,6 +3703,63 @@ class SearchServiceClient {
3591
3703
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
3592
3704
  return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
3593
3705
  }
3706
+ /**
3707
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
3708
+ *
3709
+ * @param {string} project
3710
+ * @param {string} location
3711
+ * @param {string} data_store
3712
+ * @param {string} sitemap
3713
+ * @returns {string} Resource name string.
3714
+ */
3715
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project, location, dataStore, sitemap) {
3716
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.render({
3717
+ project: project,
3718
+ location: location,
3719
+ data_store: dataStore,
3720
+ sitemap: sitemap,
3721
+ });
3722
+ }
3723
+ /**
3724
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3725
+ *
3726
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3727
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3728
+ * @returns {string} A string representing the project.
3729
+ */
3730
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3731
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).project;
3732
+ }
3733
+ /**
3734
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3735
+ *
3736
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3737
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3738
+ * @returns {string} A string representing the location.
3739
+ */
3740
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3741
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).location;
3742
+ }
3743
+ /**
3744
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3745
+ *
3746
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3747
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3748
+ * @returns {string} A string representing the data_store.
3749
+ */
3750
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3751
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).data_store;
3752
+ }
3753
+ /**
3754
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
3755
+ *
3756
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
3757
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
3758
+ * @returns {string} A string representing the sitemap.
3759
+ */
3760
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName) {
3761
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineSitemapPathTemplate.match(projectLocationDataStoreSiteSearchEngineSitemapName).sitemap;
3762
+ }
3594
3763
  /**
3595
3764
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
3596
3765
  *
@@ -3660,7 +3829,7 @@ class SearchServiceClient {
3660
3829
  this._log.info('ending gRPC channel');
3661
3830
  this._terminated = true;
3662
3831
  stub.close();
3663
- this.locationsClient.close();
3832
+ this.locationsClient.close().catch(err => { throw err; });
3664
3833
  });
3665
3834
  }
3666
3835
  return Promise.resolve();