@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
@@ -98,26 +98,17 @@ class ServingConfigServiceClient {
98
98
  constructor(opts, gaxInstance) {
99
99
  // Ensure that options include all the required fields.
100
100
  const staticMembers = this.constructor;
101
- if (opts?.universe_domain &&
102
- opts?.universeDomain &&
103
- opts?.universe_domain !== opts?.universeDomain) {
101
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
104
102
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
105
103
  }
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';
104
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
105
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
114
106
  this._servicePath = 'discoveryengine.' + this._universeDomain;
115
107
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
116
108
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
117
109
  const port = opts?.port || staticMembers.port;
118
110
  const clientConfig = opts?.clientConfig ?? {};
119
- const fallback = opts?.fallback ??
120
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
111
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
121
112
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
122
113
  // Request numeric enum values if REST transport is used.
123
114
  opts.numericEnums = true;
@@ -147,7 +138,10 @@ class ServingConfigServiceClient {
147
138
  }
148
139
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
149
140
  // Determine the client header string.
150
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
141
+ const clientHeader = [
142
+ `gax/${this._gaxModule.version}`,
143
+ `gapic/${version}`,
144
+ ];
151
145
  if (typeof process === 'object' && 'versions' in process) {
152
146
  clientHeader.push(`gl-node/${process.versions.node}`);
153
147
  }
@@ -232,11 +226,10 @@ class ServingConfigServiceClient {
232
226
  }
233
227
  // Put together the "service stub" for
234
228
  // google.cloud.discoveryengine.v1.ServingConfigService.
235
- this.servingConfigServiceStub = this._gaxGrpc.createStub(this._opts.fallback
236
- ? this._protos.lookupService('google.cloud.discoveryengine.v1.ServingConfigService')
237
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
238
- this._protos.google.cloud.discoveryengine.v1
239
- .ServingConfigService, this._opts, this._providedCustomServicePath);
229
+ this.servingConfigServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
230
+ this._protos.lookupService('google.cloud.discoveryengine.v1.ServingConfigService') :
231
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
232
+ this._protos.google.cloud.discoveryengine.v1.ServingConfigService, this._opts, this._providedCustomServicePath);
240
233
  // Iterate over each of the methods that the service provides
241
234
  // and create an API call method for each.
242
235
  const servingConfigServiceStubMethods = ['updateServingConfig'];
@@ -262,8 +255,7 @@ class ServingConfigServiceClient {
262
255
  * @returns {string} The DNS address for this service.
263
256
  */
264
257
  static get servicePath() {
265
- if (typeof process === 'object' &&
266
- typeof process.emitWarning === 'function') {
258
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
267
259
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
268
260
  }
269
261
  return 'discoveryengine.googleapis.com';
@@ -274,8 +266,7 @@ class ServingConfigServiceClient {
274
266
  * @returns {string} The DNS address for this service.
275
267
  */
276
268
  static get apiEndpoint() {
277
- if (typeof process === 'object' &&
278
- typeof process.emitWarning === 'function') {
269
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
279
270
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
280
271
  }
281
272
  return 'discoveryengine.googleapis.com';
@@ -303,7 +294,9 @@ class ServingConfigServiceClient {
303
294
  * @returns {string[]} List of default scopes.
304
295
  */
305
296
  static get scopes() {
306
- return ['https://www.googleapis.com/auth/cloud-platform'];
297
+ return [
298
+ 'https://www.googleapis.com/auth/cloud-platform'
299
+ ];
307
300
  }
308
301
  /**
309
302
  * Return the project ID used by this class.
@@ -329,13 +322,10 @@ class ServingConfigServiceClient {
329
322
  options = options || {};
330
323
  options.otherArgs = options.otherArgs || {};
331
324
  options.otherArgs.headers = options.otherArgs.headers || {};
332
- options.otherArgs.headers['x-goog-request-params'] =
333
- this._gaxModule.routingHeader.fromParams({
334
- 'serving_config.name': request.servingConfig.name ?? '',
335
- });
336
- this.initialize().catch(err => {
337
- throw err;
325
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
326
+ 'serving_config.name': request.servingConfig.name ?? '',
338
327
  });
328
+ this.initialize().catch(err => { throw err; });
339
329
  this._log.info('updateServingConfig request %j', request);
340
330
  const wrappedCallback = callback
341
331
  ? (error, response, options, rawResponse) => {
@@ -343,65 +333,64 @@ class ServingConfigServiceClient {
343
333
  callback(error, response, options, rawResponse); // We verified callback above.
344
334
  }
345
335
  : undefined;
346
- return this.innerApiCalls
347
- .updateServingConfig(request, options, wrappedCallback)
336
+ return this.innerApiCalls.updateServingConfig(request, options, wrappedCallback)
348
337
  ?.then(([response, options, rawResponse]) => {
349
338
  this._log.info('updateServingConfig response %j', response);
350
339
  return [response, options, rawResponse];
351
340
  });
352
341
  }
353
342
  /**
354
- * Gets information about a location.
355
- *
356
- * @param {Object} request
357
- * The request object that will be sent.
358
- * @param {string} request.name
359
- * Resource name for the location.
360
- * @param {object} [options]
361
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
362
- * @returns {Promise} - The promise which resolves to an array.
363
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
364
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
365
- * for more details and examples.
366
- * @example
367
- * ```
368
- * const [response] = await client.getLocation(request);
369
- * ```
370
- */
343
+ * Gets information about a location.
344
+ *
345
+ * @param {Object} request
346
+ * The request object that will be sent.
347
+ * @param {string} request.name
348
+ * Resource name for the location.
349
+ * @param {object} [options]
350
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
351
+ * @returns {Promise} - The promise which resolves to an array.
352
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
353
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
354
+ * for more details and examples.
355
+ * @example
356
+ * ```
357
+ * const [response] = await client.getLocation(request);
358
+ * ```
359
+ */
371
360
  getLocation(request, options, callback) {
372
361
  return this.locationsClient.getLocation(request, options, callback);
373
362
  }
374
363
  /**
375
- * Lists information about the supported locations for this service. Returns an iterable object.
376
- *
377
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
378
- * @param {Object} request
379
- * The request object that will be sent.
380
- * @param {string} request.name
381
- * The resource that owns the locations collection, if applicable.
382
- * @param {string} request.filter
383
- * The standard list filter.
384
- * @param {number} request.pageSize
385
- * The standard list page size.
386
- * @param {string} request.pageToken
387
- * The standard list page token.
388
- * @param {object} [options]
389
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
390
- * @returns {Object}
391
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
392
- * When you iterate the returned iterable, each element will be an object representing
393
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
394
- * so you can stop the iteration when you don't need more results.
395
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
396
- * for more details and examples.
397
- * @example
398
- * ```
399
- * const iterable = client.listLocationsAsync(request);
400
- * for await (const response of iterable) {
401
- * // process response
402
- * }
403
- * ```
404
- */
364
+ * Lists information about the supported locations for this service. Returns an iterable object.
365
+ *
366
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
367
+ * @param {Object} request
368
+ * The request object that will be sent.
369
+ * @param {string} request.name
370
+ * The resource that owns the locations collection, if applicable.
371
+ * @param {string} request.filter
372
+ * The standard list filter.
373
+ * @param {number} request.pageSize
374
+ * The standard list page size.
375
+ * @param {string} request.pageToken
376
+ * The standard list page token.
377
+ * @param {object} [options]
378
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
379
+ * @returns {Object}
380
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
381
+ * When you iterate the returned iterable, each element will be an object representing
382
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
383
+ * so you can stop the iteration when you don't need more results.
384
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
385
+ * for more details and examples.
386
+ * @example
387
+ * ```
388
+ * const iterable = client.listLocationsAsync(request);
389
+ * for await (const response of iterable) {
390
+ * // process response
391
+ * }
392
+ * ```
393
+ */
405
394
  listLocationsAsync(request, options) {
406
395
  return this.locationsClient.listLocationsAsync(request, options);
407
396
  }
@@ -2643,7 +2632,7 @@ class ServingConfigServiceClient {
2643
2632
  this._log.info('ending gRPC channel');
2644
2633
  this._terminated = true;
2645
2634
  stub.close();
2646
- this.locationsClient.close();
2635
+ this.locationsClient.close().catch(err => { throw err; });
2647
2636
  });
2648
2637
  }
2649
2638
  return Promise.resolve();
@@ -143,7 +143,7 @@ export declare class SiteSearchEngineServiceClient {
143
143
  */
144
144
  getSiteSearchEngine(request?: protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, options?: CallOptions): Promise<[
145
145
  protos.google.cloud.discoveryengine.v1.ISiteSearchEngine,
146
- (protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | undefined),
146
+ protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | undefined,
147
147
  {} | undefined
148
148
  ]>;
149
149
  getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;
@@ -640,42 +640,42 @@ export declare class SiteSearchEngineServiceClient {
640
640
  */
641
641
  checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1.BatchVerifyTargetSitesMetadata>>;
642
642
  /**
643
- * Gets a list of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s.
644
- *
645
- * @param {Object} request
646
- * The request object that will be sent.
647
- * @param {string} request.parent
648
- * Required. The parent site search engine resource name, such as
649
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
650
- *
651
- * If the caller does not have permission to list
652
- * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s under this site
653
- * search engine, regardless of whether or not this branch exists, a
654
- * PERMISSION_DENIED error is returned.
655
- * @param {number} request.pageSize
656
- * Requested page size. Server may return fewer items than requested. If
657
- * unspecified, server will pick an appropriate default. The maximum value is
658
- * 1000; values above 1000 will be coerced to 1000.
659
- *
660
- * If this field is negative, an INVALID_ARGUMENT error is returned.
661
- * @param {string} request.pageToken
662
- * A page token, received from a previous `ListTargetSites` call.
663
- * Provide this to retrieve the subsequent page.
664
- *
665
- * When paginating, all other parameters provided to `ListTargetSites`
666
- * must match the call that provided the page token.
667
- * @param {object} [options]
668
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
669
- * @returns {Promise} - The promise which resolves to an array.
670
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
671
- * The client library will perform auto-pagination by default: it will call the API as many
672
- * times as needed and will merge results from all the pages into this array.
673
- * Note that it can affect your quota.
674
- * We recommend using `listTargetSitesAsync()`
675
- * method described below for async iteration which you can stop as needed.
676
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
677
- * for more details and examples.
678
- */
643
+ * Gets a list of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s.
644
+ *
645
+ * @param {Object} request
646
+ * The request object that will be sent.
647
+ * @param {string} request.parent
648
+ * Required. The parent site search engine resource name, such as
649
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
650
+ *
651
+ * If the caller does not have permission to list
652
+ * {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}s under this site
653
+ * search engine, regardless of whether or not this branch exists, a
654
+ * PERMISSION_DENIED error is returned.
655
+ * @param {number} request.pageSize
656
+ * Requested page size. Server may return fewer items than requested. If
657
+ * unspecified, server will pick an appropriate default. The maximum value is
658
+ * 1000; values above 1000 will be coerced to 1000.
659
+ *
660
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
661
+ * @param {string} request.pageToken
662
+ * A page token, received from a previous `ListTargetSites` call.
663
+ * Provide this to retrieve the subsequent page.
664
+ *
665
+ * When paginating, all other parameters provided to `ListTargetSites`
666
+ * must match the call that provided the page token.
667
+ * @param {object} [options]
668
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
669
+ * @returns {Promise} - The promise which resolves to an array.
670
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
671
+ * The client library will perform auto-pagination by default: it will call the API as many
672
+ * times as needed and will merge results from all the pages into this array.
673
+ * Note that it can affect your quota.
674
+ * We recommend using `listTargetSitesAsync()`
675
+ * method described below for async iteration which you can stop as needed.
676
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
677
+ * for more details and examples.
678
+ */
679
679
  listTargetSites(request?: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options?: CallOptions): Promise<[
680
680
  protos.google.cloud.discoveryengine.v1.ITargetSite[],
681
681
  protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest | null,
@@ -759,41 +759,41 @@ export declare class SiteSearchEngineServiceClient {
759
759
  */
760
760
  listTargetSitesAsync(request?: protos.google.cloud.discoveryengine.v1.IListTargetSitesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ITargetSite>;
761
761
  /**
762
- * Returns list of target sites with its domain verification status.
763
- * This method can only be called under data store with BASIC_SITE_SEARCH
764
- * state at the moment.
765
- *
766
- * @param {Object} request
767
- * The request object that will be sent.
768
- * @param {string} request.siteSearchEngine
769
- * Required. The site search engine resource under which we fetch all the
770
- * domain verification status.
771
- * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
772
- * @param {number} request.pageSize
773
- * Requested page size. Server may return fewer items than requested. If
774
- * unspecified, server will pick an appropriate default. The maximum value is
775
- * 1000; values above 1000 will be coerced to 1000.
776
- *
777
- * If this field is negative, an INVALID_ARGUMENT error is returned.
778
- * @param {string} request.pageToken
779
- * A page token, received from a previous `FetchDomainVerificationStatus`
780
- * call. Provide this to retrieve the subsequent page.
781
- *
782
- * When paginating, all other parameters provided to
783
- * `FetchDomainVerificationStatus` must match the call that provided the page
784
- * token.
785
- * @param {object} [options]
786
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
787
- * @returns {Promise} - The promise which resolves to an array.
788
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
789
- * The client library will perform auto-pagination by default: it will call the API as many
790
- * times as needed and will merge results from all the pages into this array.
791
- * Note that it can affect your quota.
792
- * We recommend using `fetchDomainVerificationStatusAsync()`
793
- * method described below for async iteration which you can stop as needed.
794
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
795
- * for more details and examples.
796
- */
762
+ * Returns list of target sites with its domain verification status.
763
+ * This method can only be called under data store with BASIC_SITE_SEARCH
764
+ * state at the moment.
765
+ *
766
+ * @param {Object} request
767
+ * The request object that will be sent.
768
+ * @param {string} request.siteSearchEngine
769
+ * Required. The site search engine resource under which we fetch all the
770
+ * domain verification status.
771
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
772
+ * @param {number} request.pageSize
773
+ * Requested page size. Server may return fewer items than requested. If
774
+ * unspecified, server will pick an appropriate default. The maximum value is
775
+ * 1000; values above 1000 will be coerced to 1000.
776
+ *
777
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
778
+ * @param {string} request.pageToken
779
+ * A page token, received from a previous `FetchDomainVerificationStatus`
780
+ * call. Provide this to retrieve the subsequent page.
781
+ *
782
+ * When paginating, all other parameters provided to
783
+ * `FetchDomainVerificationStatus` must match the call that provided the page
784
+ * token.
785
+ * @param {object} [options]
786
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
787
+ * @returns {Promise} - The promise which resolves to an array.
788
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.TargetSite|TargetSite}.
789
+ * The client library will perform auto-pagination by default: it will call the API as many
790
+ * times as needed and will merge results from all the pages into this array.
791
+ * Note that it can affect your quota.
792
+ * We recommend using `fetchDomainVerificationStatusAsync()`
793
+ * method described below for async iteration which you can stop as needed.
794
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
795
+ * for more details and examples.
796
+ */
797
797
  fetchDomainVerificationStatus(request?: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options?: CallOptions): Promise<[
798
798
  protos.google.cloud.discoveryengine.v1.ITargetSite[],
799
799
  protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest | null,
@@ -871,86 +871,86 @@ export declare class SiteSearchEngineServiceClient {
871
871
  */
872
872
  fetchDomainVerificationStatusAsync(request?: protos.google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.ITargetSite>;
873
873
  /**
874
- * Gets information about a location.
875
- *
876
- * @param {Object} request
877
- * The request object that will be sent.
878
- * @param {string} request.name
879
- * Resource name for the location.
880
- * @param {object} [options]
881
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
882
- * @returns {Promise} - The promise which resolves to an array.
883
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
884
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
885
- * for more details and examples.
886
- * @example
887
- * ```
888
- * const [response] = await client.getLocation(request);
889
- * ```
890
- */
874
+ * Gets information about a location.
875
+ *
876
+ * @param {Object} request
877
+ * The request object that will be sent.
878
+ * @param {string} request.name
879
+ * Resource name for the location.
880
+ * @param {object} [options]
881
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
882
+ * @returns {Promise} - The promise which resolves to an array.
883
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
884
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
885
+ * for more details and examples.
886
+ * @example
887
+ * ```
888
+ * const [response] = await client.getLocation(request);
889
+ * ```
890
+ */
891
891
  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>;
892
892
  /**
893
- * Lists information about the supported locations for this service. Returns an iterable object.
894
- *
895
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
896
- * @param {Object} request
897
- * The request object that will be sent.
898
- * @param {string} request.name
899
- * The resource that owns the locations collection, if applicable.
900
- * @param {string} request.filter
901
- * The standard list filter.
902
- * @param {number} request.pageSize
903
- * The standard list page size.
904
- * @param {string} request.pageToken
905
- * The standard list page token.
906
- * @param {object} [options]
907
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
908
- * @returns {Object}
909
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
910
- * When you iterate the returned iterable, each element will be an object representing
911
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
912
- * so you can stop the iteration when you don't need more results.
913
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
914
- * for more details and examples.
915
- * @example
916
- * ```
917
- * const iterable = client.listLocationsAsync(request);
918
- * for await (const response of iterable) {
919
- * // process response
920
- * }
921
- * ```
922
- */
893
+ * Lists information about the supported locations for this service. Returns an iterable object.
894
+ *
895
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
896
+ * @param {Object} request
897
+ * The request object that will be sent.
898
+ * @param {string} request.name
899
+ * The resource that owns the locations collection, if applicable.
900
+ * @param {string} request.filter
901
+ * The standard list filter.
902
+ * @param {number} request.pageSize
903
+ * The standard list page size.
904
+ * @param {string} request.pageToken
905
+ * The standard list page token.
906
+ * @param {object} [options]
907
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
908
+ * @returns {Object}
909
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
910
+ * When you iterate the returned iterable, each element will be an object representing
911
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
912
+ * so you can stop the iteration when you don't need more results.
913
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
914
+ * for more details and examples.
915
+ * @example
916
+ * ```
917
+ * const iterable = client.listLocationsAsync(request);
918
+ * for await (const response of iterable) {
919
+ * // process response
920
+ * }
921
+ * ```
922
+ */
923
923
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
924
924
  /**
925
- * Gets the latest state of a long-running operation. Clients can use this
926
- * method to poll the operation result at intervals as recommended by the API
927
- * service.
928
- *
929
- * @param {Object} request - The request object that will be sent.
930
- * @param {string} request.name - The name of the operation resource.
931
- * @param {Object=} options
932
- * Optional parameters. You can override the default settings for this call,
933
- * e.g, timeout, retries, paginations, etc. See {@link
934
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
935
- * for the details.
936
- * @param {function(?Error, ?Object)=} callback
937
- * The function which will be called with the result of the API call.
938
- *
939
- * The second parameter to the callback is an object representing
940
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
941
- * @return {Promise} - The promise which resolves to an array.
942
- * The first element of the array is an object representing
943
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
944
- * The promise has a method named "cancel" which cancels the ongoing API call.
945
- *
946
- * @example
947
- * ```
948
- * const client = longrunning.operationsClient();
949
- * const name = '';
950
- * const [response] = await client.getOperation({name});
951
- * // doThingsWith(response)
952
- * ```
953
- */
925
+ * Gets the latest state of a long-running operation. Clients can use this
926
+ * method to poll the operation result at intervals as recommended by the API
927
+ * service.
928
+ *
929
+ * @param {Object} request - The request object that will be sent.
930
+ * @param {string} request.name - The name of the operation resource.
931
+ * @param {Object=} options
932
+ * Optional parameters. You can override the default settings for this call,
933
+ * e.g, timeout, retries, paginations, etc. See {@link
934
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
935
+ * for the details.
936
+ * @param {function(?Error, ?Object)=} callback
937
+ * The function which will be called with the result of the API call.
938
+ *
939
+ * The second parameter to the callback is an object representing
940
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
941
+ * @return {Promise} - The promise which resolves to an array.
942
+ * The first element of the array is an object representing
943
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
944
+ * The promise has a method named "cancel" which cancels the ongoing API call.
945
+ *
946
+ * @example
947
+ * ```
948
+ * const client = longrunning.operationsClient();
949
+ * const name = '';
950
+ * const [response] = await client.getOperation({name});
951
+ * // doThingsWith(response)
952
+ * ```
953
+ */
954
954
  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]>;
955
955
  /**
956
956
  * Lists operations that match the specified filter in the request. If the