@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
@@ -67,6 +67,11 @@
67
67
  "retry_codes_name": "unavailable",
68
68
  "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
69
69
  },
70
+ "StreamAnswerQuery": {
71
+ "timeout_millis": 30000,
72
+ "retry_codes_name": "unavailable",
73
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
74
+ },
70
75
  "GetAnswer": {
71
76
  "timeout_millis": 30000,
72
77
  "retry_codes_name": "unavailable",
@@ -24,10 +24,13 @@
24
24
  "../../protos/google/cloud/discoveryengine/v1/purge_config.proto",
25
25
  "../../protos/google/cloud/discoveryengine/v1/rank_service.proto",
26
26
  "../../protos/google/cloud/discoveryengine/v1/recommendation_service.proto",
27
+ "../../protos/google/cloud/discoveryengine/v1/safety.proto",
27
28
  "../../protos/google/cloud/discoveryengine/v1/schema.proto",
28
29
  "../../protos/google/cloud/discoveryengine/v1/schema_service.proto",
29
30
  "../../protos/google/cloud/discoveryengine/v1/search_service.proto",
30
31
  "../../protos/google/cloud/discoveryengine/v1/search_tuning_service.proto",
32
+ "../../protos/google/cloud/discoveryengine/v1/serving_config.proto",
33
+ "../../protos/google/cloud/discoveryengine/v1/serving_config_service.proto",
31
34
  "../../protos/google/cloud/discoveryengine/v1/session.proto",
32
35
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
33
36
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
@@ -182,7 +182,7 @@ export declare class DataStoreServiceClient {
182
182
  */
183
183
  updateDataStore(request?: protos.google.cloud.discoveryengine.v1.IUpdateDataStoreRequest, options?: CallOptions): Promise<[
184
184
  protos.google.cloud.discoveryengine.v1.IDataStore,
185
- (protos.google.cloud.discoveryengine.v1.IUpdateDataStoreRequest | undefined),
185
+ protos.google.cloud.discoveryengine.v1.IUpdateDataStoreRequest | undefined,
186
186
  {} | undefined
187
187
  ]>;
188
188
  updateDataStore(request: protos.google.cloud.discoveryengine.v1.IUpdateDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDataStore, protos.google.cloud.discoveryengine.v1.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
@@ -305,51 +305,51 @@ export declare class DataStoreServiceClient {
305
305
  */
306
306
  checkDeleteDataStoreProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1.DeleteDataStoreMetadata>>;
307
307
  /**
308
- * Lists all the {@link protos.google.cloud.discoveryengine.v1.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.v1.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 {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s
323
- * to return. If unspecified, defaults to 10. The maximum allowed value is 50.
324
- * Values above 50 will be coerced to 50.
325
- *
326
- * If this field is negative, an INVALID_ARGUMENT is returned.
327
- * @param {string} request.pageToken
328
- * A page token
329
- * {@link protos.google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
330
- * received from a previous
331
- * {@link protos.google.cloud.discoveryengine.v1.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
332
- * call. Provide this to retrieve the subsequent page.
333
- *
334
- * When paginating, all other parameters provided to
335
- * {@link protos.google.cloud.discoveryengine.v1.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
336
- * must match the call that provided the page token. Otherwise, an
337
- * INVALID_ARGUMENT error is returned.
338
- * @param {string} request.filter
339
- * Filter by solution type .
340
- * For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
341
- * @param {object} [options]
342
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
343
- * @returns {Promise} - The promise which resolves to an array.
344
- * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
345
- * The client library will perform auto-pagination by default: it will call the API as many
346
- * times as needed and will merge results from all the pages into this array.
347
- * Note that it can affect your quota.
348
- * We recommend using `listDataStoresAsync()`
349
- * method described below for async iteration which you can stop as needed.
350
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
351
- * for more details and examples.
352
- */
308
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1.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.v1.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 {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}s
323
+ * to return. If unspecified, defaults to 10. The maximum allowed value is 50.
324
+ * Values above 50 will be coerced to 50.
325
+ *
326
+ * If this field is negative, an INVALID_ARGUMENT is returned.
327
+ * @param {string} request.pageToken
328
+ * A page token
329
+ * {@link protos.google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
330
+ * received from a previous
331
+ * {@link protos.google.cloud.discoveryengine.v1.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
332
+ * call. Provide this to retrieve the subsequent page.
333
+ *
334
+ * When paginating, all other parameters provided to
335
+ * {@link protos.google.cloud.discoveryengine.v1.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
336
+ * must match the call that provided the page token. Otherwise, an
337
+ * INVALID_ARGUMENT error is returned.
338
+ * @param {string} request.filter
339
+ * Filter by solution type .
340
+ * For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
341
+ * @param {object} [options]
342
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
343
+ * @returns {Promise} - The promise which resolves to an array.
344
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}.
345
+ * The client library will perform auto-pagination by default: it will call the API as many
346
+ * times as needed and will merge results from all the pages into this array.
347
+ * Note that it can affect your quota.
348
+ * We recommend using `listDataStoresAsync()`
349
+ * method described below for async iteration which you can stop as needed.
350
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
351
+ * for more details and examples.
352
+ */
353
353
  listDataStores(request?: protos.google.cloud.discoveryengine.v1.IListDataStoresRequest, options?: CallOptions): Promise<[
354
354
  protos.google.cloud.discoveryengine.v1.IDataStore[],
355
355
  protos.google.cloud.discoveryengine.v1.IListDataStoresRequest | null,
@@ -449,86 +449,86 @@ export declare class DataStoreServiceClient {
449
449
  */
450
450
  listDataStoresAsync(request?: protos.google.cloud.discoveryengine.v1.IListDataStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IDataStore>;
451
451
  /**
452
- * Gets information about a location.
453
- *
454
- * @param {Object} request
455
- * The request object that will be sent.
456
- * @param {string} request.name
457
- * Resource name for the location.
458
- * @param {object} [options]
459
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
460
- * @returns {Promise} - The promise which resolves to an array.
461
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
462
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
463
- * for more details and examples.
464
- * @example
465
- * ```
466
- * const [response] = await client.getLocation(request);
467
- * ```
468
- */
452
+ * Gets information about a location.
453
+ *
454
+ * @param {Object} request
455
+ * The request object that will be sent.
456
+ * @param {string} request.name
457
+ * Resource name for the location.
458
+ * @param {object} [options]
459
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
460
+ * @returns {Promise} - The promise which resolves to an array.
461
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
462
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
463
+ * for more details and examples.
464
+ * @example
465
+ * ```
466
+ * const [response] = await client.getLocation(request);
467
+ * ```
468
+ */
469
469
  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>;
470
470
  /**
471
- * Lists information about the supported locations for this service. Returns an iterable object.
472
- *
473
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
474
- * @param {Object} request
475
- * The request object that will be sent.
476
- * @param {string} request.name
477
- * The resource that owns the locations collection, if applicable.
478
- * @param {string} request.filter
479
- * The standard list filter.
480
- * @param {number} request.pageSize
481
- * The standard list page size.
482
- * @param {string} request.pageToken
483
- * The standard list page token.
484
- * @param {object} [options]
485
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
486
- * @returns {Object}
487
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
488
- * When you iterate the returned iterable, each element will be an object representing
489
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
490
- * so you can stop the iteration when you don't need more results.
491
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
492
- * for more details and examples.
493
- * @example
494
- * ```
495
- * const iterable = client.listLocationsAsync(request);
496
- * for await (const response of iterable) {
497
- * // process response
498
- * }
499
- * ```
500
- */
471
+ * Lists information about the supported locations for this service. Returns an iterable object.
472
+ *
473
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
474
+ * @param {Object} request
475
+ * The request object that will be sent.
476
+ * @param {string} request.name
477
+ * The resource that owns the locations collection, if applicable.
478
+ * @param {string} request.filter
479
+ * The standard list filter.
480
+ * @param {number} request.pageSize
481
+ * The standard list page size.
482
+ * @param {string} request.pageToken
483
+ * The standard list page token.
484
+ * @param {object} [options]
485
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
486
+ * @returns {Object}
487
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
488
+ * When you iterate the returned iterable, each element will be an object representing
489
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
490
+ * so you can stop the iteration when you don't need more results.
491
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
492
+ * for more details and examples.
493
+ * @example
494
+ * ```
495
+ * const iterable = client.listLocationsAsync(request);
496
+ * for await (const response of iterable) {
497
+ * // process response
498
+ * }
499
+ * ```
500
+ */
501
501
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
502
502
  /**
503
- * Gets the latest state of a long-running operation. Clients can use this
504
- * method to poll the operation result at intervals as recommended by the API
505
- * service.
506
- *
507
- * @param {Object} request - The request object that will be sent.
508
- * @param {string} request.name - The name of the operation resource.
509
- * @param {Object=} options
510
- * Optional parameters. You can override the default settings for this call,
511
- * e.g, timeout, retries, paginations, etc. See {@link
512
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
513
- * for the details.
514
- * @param {function(?Error, ?Object)=} callback
515
- * The function which will be called with the result of the API call.
516
- *
517
- * The second parameter to the callback is an object representing
518
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
519
- * @return {Promise} - The promise which resolves to an array.
520
- * The first element of the array is an object representing
521
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
522
- * The promise has a method named "cancel" which cancels the ongoing API call.
523
- *
524
- * @example
525
- * ```
526
- * const client = longrunning.operationsClient();
527
- * const name = '';
528
- * const [response] = await client.getOperation({name});
529
- * // doThingsWith(response)
530
- * ```
531
- */
503
+ * Gets the latest state of a long-running operation. Clients can use this
504
+ * method to poll the operation result at intervals as recommended by the API
505
+ * service.
506
+ *
507
+ * @param {Object} request - The request object that will be sent.
508
+ * @param {string} request.name - The name of the operation resource.
509
+ * @param {Object=} options
510
+ * Optional parameters. You can override the default settings for this call,
511
+ * e.g, timeout, retries, paginations, etc. See {@link
512
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
513
+ * for the details.
514
+ * @param {function(?Error, ?Object)=} callback
515
+ * The function which will be called with the result of the API call.
516
+ *
517
+ * The second parameter to the callback is an object representing
518
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
519
+ * @return {Promise} - The promise which resolves to an array.
520
+ * The first element of the array is an object representing
521
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
522
+ * The promise has a method named "cancel" which cancels the ongoing API call.
523
+ *
524
+ * @example
525
+ * ```
526
+ * const client = longrunning.operationsClient();
527
+ * const name = '';
528
+ * const [response] = await client.getOperation({name});
529
+ * // doThingsWith(response)
530
+ * ```
531
+ */
532
532
  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]>;
533
533
  /**
534
534
  * Lists operations that match the specified filter in the request. If the
@@ -1126,6 +1126,57 @@ export declare class DataStoreServiceClient {
1126
1126
  * @returns {string} A string representing the schema.
1127
1127
  */
1128
1128
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1129
+ /**
1130
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1131
+ *
1132
+ * @param {string} project
1133
+ * @param {string} location
1134
+ * @param {string} collection
1135
+ * @param {string} data_store
1136
+ * @param {string} serving_config
1137
+ * @returns {string} Resource name string.
1138
+ */
1139
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
1140
+ /**
1141
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1142
+ *
1143
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1144
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1145
+ * @returns {string} A string representing the project.
1146
+ */
1147
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1148
+ /**
1149
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1150
+ *
1151
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1152
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1153
+ * @returns {string} A string representing the location.
1154
+ */
1155
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1156
+ /**
1157
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1158
+ *
1159
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1160
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1161
+ * @returns {string} A string representing the collection.
1162
+ */
1163
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1164
+ /**
1165
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1166
+ *
1167
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1168
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1169
+ * @returns {string} A string representing the data_store.
1170
+ */
1171
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1172
+ /**
1173
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1174
+ *
1175
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1176
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1177
+ * @returns {string} A string representing the serving_config.
1178
+ */
1179
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1129
1180
  /**
1130
1181
  * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
1131
1182
  *
@@ -1279,6 +1330,57 @@ export declare class DataStoreServiceClient {
1279
1330
  * @returns {string} A string representing the data_store.
1280
1331
  */
1281
1332
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1333
+ /**
1334
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
1335
+ *
1336
+ * @param {string} project
1337
+ * @param {string} location
1338
+ * @param {string} collection
1339
+ * @param {string} data_store
1340
+ * @param {string} sitemap
1341
+ * @returns {string} Resource name string.
1342
+ */
1343
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
1344
+ /**
1345
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1346
+ *
1347
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1348
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1349
+ * @returns {string} A string representing the project.
1350
+ */
1351
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1352
+ /**
1353
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1354
+ *
1355
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1356
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1357
+ * @returns {string} A string representing the location.
1358
+ */
1359
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1360
+ /**
1361
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1362
+ *
1363
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1364
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1365
+ * @returns {string} A string representing the collection.
1366
+ */
1367
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1368
+ /**
1369
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1370
+ *
1371
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1372
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1373
+ * @returns {string} A string representing the data_store.
1374
+ */
1375
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1376
+ /**
1377
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1378
+ *
1379
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1380
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1381
+ * @returns {string} A string representing the sitemap.
1382
+ */
1383
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1282
1384
  /**
1283
1385
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1284
1386
  *
@@ -1432,6 +1534,57 @@ export declare class DataStoreServiceClient {
1432
1534
  * @returns {string} A string representing the conversation.
1433
1535
  */
1434
1536
  matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1537
+ /**
1538
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1539
+ *
1540
+ * @param {string} project
1541
+ * @param {string} location
1542
+ * @param {string} collection
1543
+ * @param {string} engine
1544
+ * @param {string} serving_config
1545
+ * @returns {string} Resource name string.
1546
+ */
1547
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1548
+ /**
1549
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1550
+ *
1551
+ * @param {string} projectLocationCollectionEngineServingConfigName
1552
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1553
+ * @returns {string} A string representing the project.
1554
+ */
1555
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1556
+ /**
1557
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1558
+ *
1559
+ * @param {string} projectLocationCollectionEngineServingConfigName
1560
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1561
+ * @returns {string} A string representing the location.
1562
+ */
1563
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1564
+ /**
1565
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1566
+ *
1567
+ * @param {string} projectLocationCollectionEngineServingConfigName
1568
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1569
+ * @returns {string} A string representing the collection.
1570
+ */
1571
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1572
+ /**
1573
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1574
+ *
1575
+ * @param {string} projectLocationCollectionEngineServingConfigName
1576
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1577
+ * @returns {string} A string representing the engine.
1578
+ */
1579
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1580
+ /**
1581
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1582
+ *
1583
+ * @param {string} projectLocationCollectionEngineServingConfigName
1584
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1585
+ * @returns {string} A string representing the serving_config.
1586
+ */
1587
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1435
1588
  /**
1436
1589
  * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1437
1590
  *
@@ -1888,6 +2041,48 @@ export declare class DataStoreServiceClient {
1888
2041
  * @returns {string} A string representing the schema.
1889
2042
  */
1890
2043
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
2044
+ /**
2045
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
2046
+ *
2047
+ * @param {string} project
2048
+ * @param {string} location
2049
+ * @param {string} data_store
2050
+ * @param {string} serving_config
2051
+ * @returns {string} Resource name string.
2052
+ */
2053
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
2054
+ /**
2055
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
2056
+ *
2057
+ * @param {string} projectLocationDataStoreServingConfigName
2058
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2059
+ * @returns {string} A string representing the project.
2060
+ */
2061
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2062
+ /**
2063
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
2064
+ *
2065
+ * @param {string} projectLocationDataStoreServingConfigName
2066
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2067
+ * @returns {string} A string representing the location.
2068
+ */
2069
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2070
+ /**
2071
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
2072
+ *
2073
+ * @param {string} projectLocationDataStoreServingConfigName
2074
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2075
+ * @returns {string} A string representing the data_store.
2076
+ */
2077
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
2078
+ /**
2079
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
2080
+ *
2081
+ * @param {string} projectLocationDataStoreServingConfigName
2082
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
2083
+ * @returns {string} A string representing the serving_config.
2084
+ */
2085
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1891
2086
  /**
1892
2087
  * Return a fully-qualified projectLocationDataStoreSession resource name string.
1893
2088
  *
@@ -2014,6 +2209,48 @@ export declare class DataStoreServiceClient {
2014
2209
  * @returns {string} A string representing the data_store.
2015
2210
  */
2016
2211
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
2212
+ /**
2213
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
2214
+ *
2215
+ * @param {string} project
2216
+ * @param {string} location
2217
+ * @param {string} data_store
2218
+ * @param {string} sitemap
2219
+ * @returns {string} Resource name string.
2220
+ */
2221
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
2222
+ /**
2223
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2224
+ *
2225
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2226
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2227
+ * @returns {string} A string representing the project.
2228
+ */
2229
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2230
+ /**
2231
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2232
+ *
2233
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2234
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2235
+ * @returns {string} A string representing the location.
2236
+ */
2237
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2238
+ /**
2239
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2240
+ *
2241
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2242
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2243
+ * @returns {string} A string representing the data_store.
2244
+ */
2245
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2246
+ /**
2247
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2248
+ *
2249
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2250
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2251
+ * @returns {string} A string representing the sitemap.
2252
+ */
2253
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2017
2254
  /**
2018
2255
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
2019
2256
  *