@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
@@ -145,7 +145,7 @@ export declare class DataStoreServiceClient {
145
145
  */
146
146
  getDataStore(request?: protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest, options?: CallOptions): Promise<[
147
147
  protos.google.cloud.discoveryengine.v1beta.IDataStore,
148
- (protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | undefined),
148
+ protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | undefined,
149
149
  {} | undefined
150
150
  ]>;
151
151
  getDataStore(request: protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IGetDataStoreRequest | null | undefined, {} | null | undefined>): void;
@@ -182,7 +182,7 @@ export declare class DataStoreServiceClient {
182
182
  */
183
183
  updateDataStore(request?: protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest, options?: CallOptions): Promise<[
184
184
  protos.google.cloud.discoveryengine.v1beta.IDataStore,
185
- (protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | undefined),
185
+ protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | undefined,
186
186
  {} | undefined
187
187
  ]>;
188
188
  updateDataStore(request: protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IDataStore, protos.google.cloud.discoveryengine.v1beta.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
@@ -305,52 +305,52 @@ export declare class DataStoreServiceClient {
305
305
  */
306
306
  checkDeleteDataStoreProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata>>;
307
307
  /**
308
- * Lists all the {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s
309
- * associated with the project.
310
- *
311
- * @param {Object} request
312
- * The request object that will be sent.
313
- * @param {string} request.parent
314
- * Required. The parent branch resource name, such as
315
- * `projects/{project}/locations/{location}/collections/{collection_id}`.
316
- *
317
- * If the caller does not have permission to list
318
- * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
319
- * location, regardless of whether or not this data store exists, a
320
- * PERMISSION_DENIED error is returned.
321
- * @param {number} request.pageSize
322
- * Maximum number of
323
- * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
324
- * unspecified, defaults to 10. The maximum allowed value is 50. Values above
325
- * 50 will be coerced to 50.
326
- *
327
- * If this field is negative, an INVALID_ARGUMENT is returned.
328
- * @param {string} request.pageToken
329
- * A page token
330
- * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
331
- * received from a previous
332
- * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
333
- * call. Provide this to retrieve the subsequent page.
334
- *
335
- * When paginating, all other parameters provided to
336
- * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
337
- * must match the call that provided the page token. Otherwise, an
338
- * INVALID_ARGUMENT error is returned.
339
- * @param {string} request.filter
340
- * Filter by solution type .
341
- * For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
342
- * @param {object} [options]
343
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
344
- * @returns {Promise} - The promise which resolves to an array.
345
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
346
- * The client library will perform auto-pagination by default: it will call the API as many
347
- * times as needed and will merge results from all the pages into this array.
348
- * Note that it can affect your quota.
349
- * We recommend using `listDataStoresAsync()`
350
- * method described below for async iteration which you can stop as needed.
351
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
352
- * for more details and examples.
353
- */
308
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s
309
+ * associated with the project.
310
+ *
311
+ * @param {Object} request
312
+ * The request object that will be sent.
313
+ * @param {string} request.parent
314
+ * Required. The parent branch resource name, such as
315
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
316
+ *
317
+ * If the caller does not have permission to list
318
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
319
+ * location, regardless of whether or not this data store exists, a
320
+ * PERMISSION_DENIED error is returned.
321
+ * @param {number} request.pageSize
322
+ * Maximum number of
323
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
324
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
325
+ * 50 will be coerced to 50.
326
+ *
327
+ * If this field is negative, an INVALID_ARGUMENT is returned.
328
+ * @param {string} request.pageToken
329
+ * A page token
330
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
331
+ * received from a previous
332
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
333
+ * call. Provide this to retrieve the subsequent page.
334
+ *
335
+ * When paginating, all other parameters provided to
336
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
337
+ * must match the call that provided the page token. Otherwise, an
338
+ * INVALID_ARGUMENT error is returned.
339
+ * @param {string} request.filter
340
+ * Filter by solution type .
341
+ * For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
342
+ * @param {object} [options]
343
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
344
+ * @returns {Promise} - The promise which resolves to an array.
345
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}.
346
+ * The client library will perform auto-pagination by default: it will call the API as many
347
+ * times as needed and will merge results from all the pages into this array.
348
+ * Note that it can affect your quota.
349
+ * We recommend using `listDataStoresAsync()`
350
+ * method described below for async iteration which you can stop as needed.
351
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
352
+ * for more details and examples.
353
+ */
354
354
  listDataStores(request?: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options?: CallOptions): Promise<[
355
355
  protos.google.cloud.discoveryengine.v1beta.IDataStore[],
356
356
  protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest | null,
@@ -452,86 +452,86 @@ export declare class DataStoreServiceClient {
452
452
  */
453
453
  listDataStoresAsync(request?: protos.google.cloud.discoveryengine.v1beta.IListDataStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1beta.IDataStore>;
454
454
  /**
455
- * Gets information about a location.
456
- *
457
- * @param {Object} request
458
- * The request object that will be sent.
459
- * @param {string} request.name
460
- * Resource name for the location.
461
- * @param {object} [options]
462
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
463
- * @returns {Promise} - The promise which resolves to an array.
464
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
465
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
466
- * for more details and examples.
467
- * @example
468
- * ```
469
- * const [response] = await client.getLocation(request);
470
- * ```
471
- */
455
+ * Gets information about a location.
456
+ *
457
+ * @param {Object} request
458
+ * The request object that will be sent.
459
+ * @param {string} request.name
460
+ * Resource name for the location.
461
+ * @param {object} [options]
462
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
463
+ * @returns {Promise} - The promise which resolves to an array.
464
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
465
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
466
+ * for more details and examples.
467
+ * @example
468
+ * ```
469
+ * const [response] = await client.getLocation(request);
470
+ * ```
471
+ */
472
472
  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>;
473
473
  /**
474
- * Lists information about the supported locations for this service. Returns an iterable object.
475
- *
476
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
477
- * @param {Object} request
478
- * The request object that will be sent.
479
- * @param {string} request.name
480
- * The resource that owns the locations collection, if applicable.
481
- * @param {string} request.filter
482
- * The standard list filter.
483
- * @param {number} request.pageSize
484
- * The standard list page size.
485
- * @param {string} request.pageToken
486
- * The standard list page token.
487
- * @param {object} [options]
488
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
489
- * @returns {Object}
490
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
491
- * When you iterate the returned iterable, each element will be an object representing
492
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
493
- * so you can stop the iteration when you don't need more results.
494
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
495
- * for more details and examples.
496
- * @example
497
- * ```
498
- * const iterable = client.listLocationsAsync(request);
499
- * for await (const response of iterable) {
500
- * // process response
501
- * }
502
- * ```
503
- */
474
+ * Lists information about the supported locations for this service. Returns an iterable object.
475
+ *
476
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
477
+ * @param {Object} request
478
+ * The request object that will be sent.
479
+ * @param {string} request.name
480
+ * The resource that owns the locations collection, if applicable.
481
+ * @param {string} request.filter
482
+ * The standard list filter.
483
+ * @param {number} request.pageSize
484
+ * The standard list page size.
485
+ * @param {string} request.pageToken
486
+ * The standard list page token.
487
+ * @param {object} [options]
488
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
489
+ * @returns {Object}
490
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
491
+ * When you iterate the returned iterable, each element will be an object representing
492
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
493
+ * so you can stop the iteration when you don't need more results.
494
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
495
+ * for more details and examples.
496
+ * @example
497
+ * ```
498
+ * const iterable = client.listLocationsAsync(request);
499
+ * for await (const response of iterable) {
500
+ * // process response
501
+ * }
502
+ * ```
503
+ */
504
504
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
505
505
  /**
506
- * Gets the latest state of a long-running operation. Clients can use this
507
- * method to poll the operation result at intervals as recommended by the API
508
- * service.
509
- *
510
- * @param {Object} request - The request object that will be sent.
511
- * @param {string} request.name - The name of the operation resource.
512
- * @param {Object=} options
513
- * Optional parameters. You can override the default settings for this call,
514
- * e.g, timeout, retries, paginations, etc. See {@link
515
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
516
- * for the details.
517
- * @param {function(?Error, ?Object)=} callback
518
- * The function which will be called with the result of the API call.
519
- *
520
- * The second parameter to the callback is an object representing
521
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
522
- * @return {Promise} - The promise which resolves to an array.
523
- * The first element of the array is an object representing
524
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
525
- * The promise has a method named "cancel" which cancels the ongoing API call.
526
- *
527
- * @example
528
- * ```
529
- * const client = longrunning.operationsClient();
530
- * const name = '';
531
- * const [response] = await client.getOperation({name});
532
- * // doThingsWith(response)
533
- * ```
534
- */
506
+ * Gets the latest state of a long-running operation. Clients can use this
507
+ * method to poll the operation result at intervals as recommended by the API
508
+ * service.
509
+ *
510
+ * @param {Object} request - The request object that will be sent.
511
+ * @param {string} request.name - The name of the operation resource.
512
+ * @param {Object=} options
513
+ * Optional parameters. You can override the default settings for this call,
514
+ * e.g, timeout, retries, paginations, etc. See {@link
515
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
516
+ * for the details.
517
+ * @param {function(?Error, ?Object)=} callback
518
+ * The function which will be called with the result of the API call.
519
+ *
520
+ * The second parameter to the callback is an object representing
521
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
522
+ * @return {Promise} - The promise which resolves to an array.
523
+ * The first element of the array is an object representing
524
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
525
+ * The promise has a method named "cancel" which cancels the ongoing API call.
526
+ *
527
+ * @example
528
+ * ```
529
+ * const client = longrunning.operationsClient();
530
+ * const name = '';
531
+ * const [response] = await client.getOperation({name});
532
+ * // doThingsWith(response)
533
+ * ```
534
+ */
535
535
  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]>;
536
536
  /**
537
537
  * Lists operations that match the specified filter in the request. If the