@google-cloud/discoveryengine 2.1.0 → 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 (121) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/build/protos/protos.d.ts +31 -316
  3. package/build/protos/protos.js +146 -593
  4. package/build/protos/protos.json +25 -1
  5. package/build/src/index.d.ts +1 -1
  6. package/build/src/index.js +1 -21
  7. package/build/src/v1/completion_service_client.d.ts +76 -76
  8. package/build/src/v1/completion_service_client.js +125 -262
  9. package/build/src/v1/control_service_client.d.ts +81 -81
  10. package/build/src/v1/control_service_client.js +96 -132
  11. package/build/src/v1/conversational_search_service_client.d.ts +143 -143
  12. package/build/src/v1/conversational_search_service_client.js +138 -226
  13. package/build/src/v1/data_store_service_client.d.ts +122 -122
  14. package/build/src/v1/data_store_service_client.js +134 -280
  15. package/build/src/v1/document_service_client.d.ts +120 -120
  16. package/build/src/v1/document_service_client.js +143 -300
  17. package/build/src/v1/engine_service_client.d.ts +103 -103
  18. package/build/src/v1/engine_service_client.js +134 -279
  19. package/build/src/v1/grounded_generation_service_client.d.ts +48 -48
  20. package/build/src/v1/grounded_generation_service_client.js +79 -100
  21. package/build/src/v1/project_service_client.d.ts +76 -76
  22. package/build/src/v1/project_service_client.js +108 -222
  23. package/build/src/v1/rank_service_client.d.ts +47 -47
  24. package/build/src/v1/rank_service_client.js +72 -85
  25. package/build/src/v1/recommendation_service_client.d.ts +47 -47
  26. package/build/src/v1/recommendation_service_client.js +70 -82
  27. package/build/src/v1/schema_service_client.d.ts +111 -111
  28. package/build/src/v1/schema_service_client.js +131 -273
  29. package/build/src/v1/search_service_client.d.ts +545 -545
  30. package/build/src/v1/search_service_client.js +90 -113
  31. package/build/src/v1/search_tuning_service_client.d.ts +77 -77
  32. package/build/src/v1/search_tuning_service_client.js +113 -235
  33. package/build/src/v1/serving_config_service_client.d.ts +48 -48
  34. package/build/src/v1/serving_config_service_client.js +69 -80
  35. package/build/src/v1/site_search_engine_service_client.d.ts +148 -148
  36. package/build/src/v1/site_search_engine_service_client.js +179 -378
  37. package/build/src/v1/user_event_service_client.d.ts +77 -77
  38. package/build/src/v1/user_event_service_client.js +121 -253
  39. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  40. package/build/src/v1alpha/acl_config_service_client.js +82 -106
  41. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  42. package/build/src/v1alpha/chunk_service_client.js +92 -120
  43. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  44. package/build/src/v1alpha/completion_service_client.js +134 -280
  45. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  46. package/build/src/v1alpha/control_service_client.js +105 -151
  47. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  48. package/build/src/v1alpha/conversational_search_service_client.js +145 -237
  49. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  50. package/build/src/v1alpha/data_store_service_client.js +151 -316
  51. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  52. package/build/src/v1alpha/document_service_client.js +156 -328
  53. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  54. package/build/src/v1alpha/engine_service_client.js +155 -325
  55. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  56. package/build/src/v1alpha/estimate_billing_service_client.js +118 -243
  57. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  58. package/build/src/v1alpha/evaluation_service_client.js +143 -295
  59. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  60. package/build/src/v1alpha/grounded_generation_service_client.js +79 -100
  61. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  62. package/build/src/v1alpha/project_service_client.js +126 -262
  63. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  64. package/build/src/v1alpha/rank_service_client.js +81 -104
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  66. package/build/src/v1alpha/recommendation_service_client.js +79 -100
  67. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  68. package/build/src/v1alpha/sample_query_service_client.js +144 -301
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  70. package/build/src/v1alpha/sample_query_set_service_client.js +106 -153
  71. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  72. package/build/src/v1alpha/schema_service_client.js +140 -292
  73. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  74. package/build/src/v1alpha/search_service_client.js +88 -112
  75. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  76. package/build/src/v1alpha/search_tuning_service_client.js +122 -253
  77. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  78. package/build/src/v1alpha/serving_config_service_client.js +97 -133
  79. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  80. package/build/src/v1alpha/site_search_engine_service_client.js +184 -387
  81. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  82. package/build/src/v1alpha/user_event_service_client.js +130 -271
  83. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  84. package/build/src/v1beta/completion_service_client.js +136 -279
  85. package/build/src/v1beta/control_service_client.d.ts +84 -84
  86. package/build/src/v1beta/control_service_client.js +103 -147
  87. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  88. package/build/src/v1beta/conversational_search_service_client.js +143 -233
  89. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  90. package/build/src/v1beta/data_store_service_client.js +141 -288
  91. package/build/src/v1beta/document_service_client.d.ts +124 -124
  92. package/build/src/v1beta/document_service_client.js +150 -309
  93. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  94. package/build/src/v1beta/engine_service_client.js +153 -315
  95. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  96. package/build/src/v1beta/evaluation_service_client.js +141 -285
  97. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  98. package/build/src/v1beta/grounded_generation_service_client.js +86 -114
  99. package/build/src/v1beta/project_service_client.d.ts +76 -76
  100. package/build/src/v1beta/project_service_client.js +115 -231
  101. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  102. package/build/src/v1beta/rank_service_client.js +79 -99
  103. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  104. package/build/src/v1beta/recommendation_service_client.js +77 -96
  105. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  106. package/build/src/v1beta/sample_query_service_client.js +142 -291
  107. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  108. package/build/src/v1beta/sample_query_set_service_client.js +104 -149
  109. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  110. package/build/src/v1beta/schema_service_client.js +138 -282
  111. package/build/src/v1beta/search_service_client.d.ts +665 -665
  112. package/build/src/v1beta/search_service_client.js +97 -128
  113. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  114. package/build/src/v1beta/search_tuning_service_client.js +120 -243
  115. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  116. package/build/src/v1beta/serving_config_service_client.js +95 -129
  117. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  118. package/build/src/v1beta/site_search_engine_service_client.js +186 -386
  119. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  120. package/build/src/v1beta/user_event_service_client.js +128 -261
  121. package/package.json +1 -1
@@ -96,28 +96,18 @@ class RecommendationServiceClient {
96
96
  */
97
97
  constructor(opts, gaxInstance) {
98
98
  // Ensure that options include all the required fields.
99
- const staticMembers = this
100
- .constructor;
101
- if (opts?.universe_domain &&
102
- opts?.universeDomain &&
103
- opts?.universe_domain !== opts?.universeDomain) {
99
+ const staticMembers = this.constructor;
100
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
104
101
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
105
102
  }
106
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
107
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
108
- : undefined;
109
- this._universeDomain =
110
- opts?.universeDomain ??
111
- opts?.universe_domain ??
112
- universeDomainEnvVar ??
113
- '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';
114
105
  this._servicePath = 'discoveryengine.' + this._universeDomain;
115
106
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
116
107
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
117
108
  const port = opts?.port || staticMembers.port;
118
109
  const clientConfig = opts?.clientConfig ?? {};
119
- const fallback = opts?.fallback ??
120
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
110
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
121
111
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
122
112
  // Request numeric enum values if REST transport is used.
123
113
  opts.numericEnums = true;
@@ -147,7 +137,10 @@ class RecommendationServiceClient {
147
137
  }
148
138
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
149
139
  // Determine the client header string.
150
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
140
+ const clientHeader = [
141
+ `gax/${this._gaxModule.version}`,
142
+ `gapic/${version}`,
143
+ ];
151
144
  if (typeof process === 'object' && 'versions' in process) {
152
145
  clientHeader.push(`gl-node/${process.versions.node}`);
153
146
  }
@@ -234,11 +227,10 @@ class RecommendationServiceClient {
234
227
  }
235
228
  // Put together the "service stub" for
236
229
  // google.cloud.discoveryengine.v1alpha.RecommendationService.
237
- this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
238
- ? this._protos.lookupService('google.cloud.discoveryengine.v1alpha.RecommendationService')
239
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
240
- this._protos.google.cloud.discoveryengine.v1alpha
241
- .RecommendationService, this._opts, this._providedCustomServicePath);
230
+ this.recommendationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
231
+ this._protos.lookupService('google.cloud.discoveryengine.v1alpha.RecommendationService') :
232
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
233
+ this._protos.google.cloud.discoveryengine.v1alpha.RecommendationService, this._opts, this._providedCustomServicePath);
242
234
  // Iterate over each of the methods that the service provides
243
235
  // and create an API call method for each.
244
236
  const recommendationServiceStubMethods = ['recommend'];
@@ -264,8 +256,7 @@ class RecommendationServiceClient {
264
256
  * @returns {string} The DNS address for this service.
265
257
  */
266
258
  static get servicePath() {
267
- if (typeof process === 'object' &&
268
- typeof process.emitWarning === 'function') {
259
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
269
260
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
270
261
  }
271
262
  return 'discoveryengine.googleapis.com';
@@ -276,8 +267,7 @@ class RecommendationServiceClient {
276
267
  * @returns {string} The DNS address for this service.
277
268
  */
278
269
  static get apiEndpoint() {
279
- if (typeof process === 'object' &&
280
- typeof process.emitWarning === 'function') {
270
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
281
271
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
282
272
  }
283
273
  return 'discoveryengine.googleapis.com';
@@ -305,7 +295,9 @@ class RecommendationServiceClient {
305
295
  * @returns {string[]} List of default scopes.
306
296
  */
307
297
  static get scopes() {
308
- return ['https://www.googleapis.com/auth/cloud-platform'];
298
+ return [
299
+ 'https://www.googleapis.com/auth/cloud-platform'
300
+ ];
309
301
  }
310
302
  /**
311
303
  * Return the project ID used by this class.
@@ -331,13 +323,10 @@ class RecommendationServiceClient {
331
323
  options = options || {};
332
324
  options.otherArgs = options.otherArgs || {};
333
325
  options.otherArgs.headers = options.otherArgs.headers || {};
334
- options.otherArgs.headers['x-goog-request-params'] =
335
- this._gaxModule.routingHeader.fromParams({
336
- serving_config: request.servingConfig ?? '',
337
- });
338
- this.initialize().catch(err => {
339
- throw err;
326
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
327
+ 'serving_config': request.servingConfig ?? '',
340
328
  });
329
+ this.initialize().catch(err => { throw err; });
341
330
  this._log.info('recommend request %j', request);
342
331
  const wrappedCallback = callback
343
332
  ? (error, response, options, rawResponse) => {
@@ -345,65 +334,64 @@ class RecommendationServiceClient {
345
334
  callback(error, response, options, rawResponse); // We verified callback above.
346
335
  }
347
336
  : undefined;
348
- return this.innerApiCalls
349
- .recommend(request, options, wrappedCallback)
337
+ return this.innerApiCalls.recommend(request, options, wrappedCallback)
350
338
  ?.then(([response, options, rawResponse]) => {
351
339
  this._log.info('recommend response %j', response);
352
340
  return [response, options, rawResponse];
353
341
  });
354
342
  }
355
343
  /**
356
- * Gets information about a location.
357
- *
358
- * @param {Object} request
359
- * The request object that will be sent.
360
- * @param {string} request.name
361
- * Resource name for the location.
362
- * @param {object} [options]
363
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
364
- * @returns {Promise} - The promise which resolves to an array.
365
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
366
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
367
- * for more details and examples.
368
- * @example
369
- * ```
370
- * const [response] = await client.getLocation(request);
371
- * ```
372
- */
344
+ * Gets information about a location.
345
+ *
346
+ * @param {Object} request
347
+ * The request object that will be sent.
348
+ * @param {string} request.name
349
+ * Resource name for the location.
350
+ * @param {object} [options]
351
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
352
+ * @returns {Promise} - The promise which resolves to an array.
353
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
354
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
355
+ * for more details and examples.
356
+ * @example
357
+ * ```
358
+ * const [response] = await client.getLocation(request);
359
+ * ```
360
+ */
373
361
  getLocation(request, options, callback) {
374
362
  return this.locationsClient.getLocation(request, options, callback);
375
363
  }
376
364
  /**
377
- * Lists information about the supported locations for this service. Returns an iterable object.
378
- *
379
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
380
- * @param {Object} request
381
- * The request object that will be sent.
382
- * @param {string} request.name
383
- * The resource that owns the locations collection, if applicable.
384
- * @param {string} request.filter
385
- * The standard list filter.
386
- * @param {number} request.pageSize
387
- * The standard list page size.
388
- * @param {string} request.pageToken
389
- * The standard list page token.
390
- * @param {object} [options]
391
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
392
- * @returns {Object}
393
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
394
- * When you iterate the returned iterable, each element will be an object representing
395
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
396
- * so you can stop the iteration when you don't need more results.
397
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
398
- * for more details and examples.
399
- * @example
400
- * ```
401
- * const iterable = client.listLocationsAsync(request);
402
- * for await (const response of iterable) {
403
- * // process response
404
- * }
405
- * ```
406
- */
365
+ * Lists information about the supported locations for this service. Returns an iterable object.
366
+ *
367
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
368
+ * @param {Object} request
369
+ * The request object that will be sent.
370
+ * @param {string} request.name
371
+ * The resource that owns the locations collection, if applicable.
372
+ * @param {string} request.filter
373
+ * The standard list filter.
374
+ * @param {number} request.pageSize
375
+ * The standard list page size.
376
+ * @param {string} request.pageToken
377
+ * The standard list page token.
378
+ * @param {object} [options]
379
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
380
+ * @returns {Object}
381
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
382
+ * When you iterate the returned iterable, each element will be an object representing
383
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
384
+ * so you can stop the iteration when you don't need more results.
385
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
386
+ * for more details and examples.
387
+ * @example
388
+ * ```
389
+ * const iterable = client.listLocationsAsync(request);
390
+ * for await (const response of iterable) {
391
+ * // process response
392
+ * }
393
+ * ```
394
+ */
407
395
  listLocationsAsync(request, options) {
408
396
  return this.locationsClient.listLocationsAsync(request, options);
409
397
  }
@@ -431,8 +419,7 @@ class RecommendationServiceClient {
431
419
  * @returns {string} A string representing the project.
432
420
  */
433
421
  matchProjectFromAclConfigName(aclConfigName) {
434
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
435
- .project;
422
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).project;
436
423
  }
437
424
  /**
438
425
  * Parse the location from AclConfig resource.
@@ -442,8 +429,7 @@ class RecommendationServiceClient {
442
429
  * @returns {string} A string representing the location.
443
430
  */
444
431
  matchLocationFromAclConfigName(aclConfigName) {
445
- return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
446
- .location;
432
+ return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).location;
447
433
  }
448
434
  /**
449
435
  * Return a fully-qualified engine resource name string.
@@ -525,8 +511,7 @@ class RecommendationServiceClient {
525
511
  * @returns {string} A string representing the project.
526
512
  */
527
513
  matchProjectFromEvaluationName(evaluationName) {
528
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
529
- .project;
514
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
530
515
  }
531
516
  /**
532
517
  * Parse the location from Evaluation resource.
@@ -536,8 +521,7 @@ class RecommendationServiceClient {
536
521
  * @returns {string} A string representing the location.
537
522
  */
538
523
  matchLocationFromEvaluationName(evaluationName) {
539
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
540
- .location;
524
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
541
525
  }
542
526
  /**
543
527
  * Parse the evaluation from Evaluation resource.
@@ -547,8 +531,7 @@ class RecommendationServiceClient {
547
531
  * @returns {string} A string representing the evaluation.
548
532
  */
549
533
  matchEvaluationFromEvaluationName(evaluationName) {
550
- return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
551
- .evaluation;
534
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
552
535
  }
553
536
  /**
554
537
  * Return a fully-qualified project resource name string.
@@ -2615,8 +2598,7 @@ class RecommendationServiceClient {
2615
2598
  * @returns {string} A string representing the project.
2616
2599
  */
2617
2600
  matchProjectFromSampleQueryName(sampleQueryName) {
2618
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2619
- .project;
2601
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
2620
2602
  }
2621
2603
  /**
2622
2604
  * Parse the location from SampleQuery resource.
@@ -2626,8 +2608,7 @@ class RecommendationServiceClient {
2626
2608
  * @returns {string} A string representing the location.
2627
2609
  */
2628
2610
  matchLocationFromSampleQueryName(sampleQueryName) {
2629
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2630
- .location;
2611
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
2631
2612
  }
2632
2613
  /**
2633
2614
  * Parse the sample_query_set from SampleQuery resource.
@@ -2637,8 +2618,7 @@ class RecommendationServiceClient {
2637
2618
  * @returns {string} A string representing the sample_query_set.
2638
2619
  */
2639
2620
  matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2640
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2641
- .sample_query_set;
2621
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
2642
2622
  }
2643
2623
  /**
2644
2624
  * Parse the sample_query from SampleQuery resource.
@@ -2648,8 +2628,7 @@ class RecommendationServiceClient {
2648
2628
  * @returns {string} A string representing the sample_query.
2649
2629
  */
2650
2630
  matchSampleQueryFromSampleQueryName(sampleQueryName) {
2651
- return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2652
- .sample_query;
2631
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
2653
2632
  }
2654
2633
  /**
2655
2634
  * Return a fully-qualified sampleQuerySet resource name string.
@@ -2708,7 +2687,7 @@ class RecommendationServiceClient {
2708
2687
  this._log.info('ending gRPC channel');
2709
2688
  this._terminated = true;
2710
2689
  stub.close();
2711
- this.locationsClient.close();
2690
+ this.locationsClient.close().catch(err => { throw err; });
2712
2691
  });
2713
2692
  }
2714
2693
  return Promise.resolve();
@@ -146,7 +146,7 @@ export declare class SampleQueryServiceClient {
146
146
  */
147
147
  getSampleQuery(request?: protos.google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest, options?: CallOptions): Promise<[
148
148
  protos.google.cloud.discoveryengine.v1alpha.ISampleQuery,
149
- (protos.google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest | undefined),
149
+ protos.google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest | undefined,
150
150
  {} | undefined
151
151
  ]>;
152
152
  getSampleQuery(request: protos.google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISampleQuery, protos.google.cloud.discoveryengine.v1alpha.IGetSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -192,7 +192,7 @@ export declare class SampleQueryServiceClient {
192
192
  */
193
193
  createSampleQuery(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest, options?: CallOptions): Promise<[
194
194
  protos.google.cloud.discoveryengine.v1alpha.ISampleQuery,
195
- (protos.google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest | undefined),
195
+ protos.google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest | undefined,
196
196
  {} | undefined
197
197
  ]>;
198
198
  createSampleQuery(request: protos.google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISampleQuery, protos.google.cloud.discoveryengine.v1alpha.ICreateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -225,7 +225,7 @@ export declare class SampleQueryServiceClient {
225
225
  */
226
226
  updateSampleQuery(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest, options?: CallOptions): Promise<[
227
227
  protos.google.cloud.discoveryengine.v1alpha.ISampleQuery,
228
- (protos.google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest | undefined),
228
+ protos.google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest | undefined,
229
229
  {} | undefined
230
230
  ]>;
231
231
  updateSampleQuery(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISampleQuery, protos.google.cloud.discoveryengine.v1alpha.IUpdateSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -257,7 +257,7 @@ export declare class SampleQueryServiceClient {
257
257
  */
258
258
  deleteSampleQuery(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest, options?: CallOptions): Promise<[
259
259
  protos.google.protobuf.IEmpty,
260
- (protos.google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest | undefined),
260
+ protos.google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest | undefined,
261
261
  {} | undefined
262
262
  ]>;
263
263
  deleteSampleQuery(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteSampleQueryRequest | null | undefined, {} | null | undefined>): void;
@@ -320,49 +320,49 @@ export declare class SampleQueryServiceClient {
320
320
  */
321
321
  checkImportSampleQueriesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.ImportSampleQueriesResponse, protos.google.cloud.discoveryengine.v1alpha.ImportSampleQueriesMetadata>>;
322
322
  /**
323
- * Gets a list of
324
- * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s.
325
- *
326
- * @param {Object} request
327
- * The request object that will be sent.
328
- * @param {string} request.parent
329
- * Required. The parent sample query set resource name, such as
330
- * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
331
- *
332
- * If the caller does not have permission to list
333
- * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s under this
334
- * sample query set, regardless of whether or not this sample query set
335
- * exists, a `PERMISSION_DENIED` error is returned.
336
- * @param {number} request.pageSize
337
- * Maximum number of
338
- * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s to return.
339
- * If unspecified, defaults to 100. The maximum allowed value is 1000. Values
340
- * above 1000 will be coerced to 1000.
341
- *
342
- * If this field is negative, an `INVALID_ARGUMENT` error is returned.
343
- * @param {string} request.pageToken
344
- * A page token
345
- * {@link protos.google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token|ListSampleQueriesResponse.next_page_token},
346
- * received from a previous
347
- * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
348
- * call. Provide this to retrieve the subsequent page.
349
- *
350
- * When paginating, all other parameters provided to
351
- * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
352
- * must match the call that provided the page token. Otherwise, an
353
- * `INVALID_ARGUMENT` error is returned.
354
- * @param {object} [options]
355
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
356
- * @returns {Promise} - The promise which resolves to an array.
357
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}.
358
- * The client library will perform auto-pagination by default: it will call the API as many
359
- * times as needed and will merge results from all the pages into this array.
360
- * Note that it can affect your quota.
361
- * We recommend using `listSampleQueriesAsync()`
362
- * method described below for async iteration which you can stop as needed.
363
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
364
- * for more details and examples.
365
- */
323
+ * Gets a list of
324
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s.
325
+ *
326
+ * @param {Object} request
327
+ * The request object that will be sent.
328
+ * @param {string} request.parent
329
+ * Required. The parent sample query set resource name, such as
330
+ * `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
331
+ *
332
+ * If the caller does not have permission to list
333
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s under this
334
+ * sample query set, regardless of whether or not this sample query set
335
+ * exists, a `PERMISSION_DENIED` error is returned.
336
+ * @param {number} request.pageSize
337
+ * Maximum number of
338
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}s to return.
339
+ * If unspecified, defaults to 100. The maximum allowed value is 1000. Values
340
+ * above 1000 will be coerced to 1000.
341
+ *
342
+ * If this field is negative, an `INVALID_ARGUMENT` error is returned.
343
+ * @param {string} request.pageToken
344
+ * A page token
345
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse.next_page_token|ListSampleQueriesResponse.next_page_token},
346
+ * received from a previous
347
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
348
+ * call. Provide this to retrieve the subsequent page.
349
+ *
350
+ * When paginating, all other parameters provided to
351
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SampleQueryService.ListSampleQueries|SampleQueryService.ListSampleQueries}
352
+ * must match the call that provided the page token. Otherwise, an
353
+ * `INVALID_ARGUMENT` error is returned.
354
+ * @param {object} [options]
355
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
356
+ * @returns {Promise} - The promise which resolves to an array.
357
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.SampleQuery|SampleQuery}.
358
+ * The client library will perform auto-pagination by default: it will call the API as many
359
+ * times as needed and will merge results from all the pages into this array.
360
+ * Note that it can affect your quota.
361
+ * We recommend using `listSampleQueriesAsync()`
362
+ * method described below for async iteration which you can stop as needed.
363
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
364
+ * for more details and examples.
365
+ */
366
366
  listSampleQueries(request?: protos.google.cloud.discoveryengine.v1alpha.IListSampleQueriesRequest, options?: CallOptions): Promise<[
367
367
  protos.google.cloud.discoveryengine.v1alpha.ISampleQuery[],
368
368
  protos.google.cloud.discoveryengine.v1alpha.IListSampleQueriesRequest | null,
@@ -458,86 +458,86 @@ export declare class SampleQueryServiceClient {
458
458
  */
459
459
  listSampleQueriesAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListSampleQueriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ISampleQuery>;
460
460
  /**
461
- * Gets information about a location.
462
- *
463
- * @param {Object} request
464
- * The request object that will be sent.
465
- * @param {string} request.name
466
- * Resource name for the location.
467
- * @param {object} [options]
468
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
469
- * @returns {Promise} - The promise which resolves to an array.
470
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
471
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
472
- * for more details and examples.
473
- * @example
474
- * ```
475
- * const [response] = await client.getLocation(request);
476
- * ```
477
- */
461
+ * Gets information about a location.
462
+ *
463
+ * @param {Object} request
464
+ * The request object that will be sent.
465
+ * @param {string} request.name
466
+ * Resource name for the location.
467
+ * @param {object} [options]
468
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
469
+ * @returns {Promise} - The promise which resolves to an array.
470
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
471
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
472
+ * for more details and examples.
473
+ * @example
474
+ * ```
475
+ * const [response] = await client.getLocation(request);
476
+ * ```
477
+ */
478
478
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
479
479
  /**
480
- * Lists information about the supported locations for this service. Returns an iterable object.
481
- *
482
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
483
- * @param {Object} request
484
- * The request object that will be sent.
485
- * @param {string} request.name
486
- * The resource that owns the locations collection, if applicable.
487
- * @param {string} request.filter
488
- * The standard list filter.
489
- * @param {number} request.pageSize
490
- * The standard list page size.
491
- * @param {string} request.pageToken
492
- * The standard list page token.
493
- * @param {object} [options]
494
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
495
- * @returns {Object}
496
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
497
- * When you iterate the returned iterable, each element will be an object representing
498
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
499
- * so you can stop the iteration when you don't need more results.
500
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
501
- * for more details and examples.
502
- * @example
503
- * ```
504
- * const iterable = client.listLocationsAsync(request);
505
- * for await (const response of iterable) {
506
- * // process response
507
- * }
508
- * ```
509
- */
480
+ * Lists information about the supported locations for this service. Returns an iterable object.
481
+ *
482
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
483
+ * @param {Object} request
484
+ * The request object that will be sent.
485
+ * @param {string} request.name
486
+ * The resource that owns the locations collection, if applicable.
487
+ * @param {string} request.filter
488
+ * The standard list filter.
489
+ * @param {number} request.pageSize
490
+ * The standard list page size.
491
+ * @param {string} request.pageToken
492
+ * The standard list page token.
493
+ * @param {object} [options]
494
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
495
+ * @returns {Object}
496
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
497
+ * When you iterate the returned iterable, each element will be an object representing
498
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
499
+ * so you can stop the iteration when you don't need more results.
500
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
501
+ * for more details and examples.
502
+ * @example
503
+ * ```
504
+ * const iterable = client.listLocationsAsync(request);
505
+ * for await (const response of iterable) {
506
+ * // process response
507
+ * }
508
+ * ```
509
+ */
510
510
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
511
511
  /**
512
- * Gets the latest state of a long-running operation. Clients can use this
513
- * method to poll the operation result at intervals as recommended by the API
514
- * service.
515
- *
516
- * @param {Object} request - The request object that will be sent.
517
- * @param {string} request.name - The name of the operation resource.
518
- * @param {Object=} options
519
- * Optional parameters. You can override the default settings for this call,
520
- * e.g, timeout, retries, paginations, etc. See {@link
521
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
522
- * for the details.
523
- * @param {function(?Error, ?Object)=} callback
524
- * The function which will be called with the result of the API call.
525
- *
526
- * The second parameter to the callback is an object representing
527
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
528
- * @return {Promise} - The promise which resolves to an array.
529
- * The first element of the array is an object representing
530
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
531
- * The promise has a method named "cancel" which cancels the ongoing API call.
532
- *
533
- * @example
534
- * ```
535
- * const client = longrunning.operationsClient();
536
- * const name = '';
537
- * const [response] = await client.getOperation({name});
538
- * // doThingsWith(response)
539
- * ```
540
- */
512
+ * Gets the latest state of a long-running operation. Clients can use this
513
+ * method to poll the operation result at intervals as recommended by the API
514
+ * service.
515
+ *
516
+ * @param {Object} request - The request object that will be sent.
517
+ * @param {string} request.name - The name of the operation resource.
518
+ * @param {Object=} options
519
+ * Optional parameters. You can override the default settings for this call,
520
+ * e.g, timeout, retries, paginations, etc. See {@link
521
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
522
+ * for the details.
523
+ * @param {function(?Error, ?Object)=} callback
524
+ * The function which will be called with the result of the API call.
525
+ *
526
+ * The second parameter to the callback is an object representing
527
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
528
+ * @return {Promise} - The promise which resolves to an array.
529
+ * The first element of the array is an object representing
530
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
531
+ * The promise has a method named "cancel" which cancels the ongoing API call.
532
+ *
533
+ * @example
534
+ * ```
535
+ * const client = longrunning.operationsClient();
536
+ * const name = '';
537
+ * const [response] = await client.getOperation({name});
538
+ * // doThingsWith(response)
539
+ * ```
540
+ */
541
541
  getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
542
542
  /**
543
543
  * Lists operations that match the specified filter in the request. If the