@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
@@ -48,6 +48,18 @@
48
48
  "retry_codes_name": "non_idempotent",
49
49
  "retry_params_name": "default"
50
50
  },
51
+ "CreateSitemap": {
52
+ "retry_codes_name": "non_idempotent",
53
+ "retry_params_name": "default"
54
+ },
55
+ "DeleteSitemap": {
56
+ "retry_codes_name": "non_idempotent",
57
+ "retry_params_name": "default"
58
+ },
59
+ "FetchSitemaps": {
60
+ "retry_codes_name": "non_idempotent",
61
+ "retry_params_name": "default"
62
+ },
51
63
  "EnableAdvancedSiteSearch": {
52
64
  "retry_codes_name": "non_idempotent",
53
65
  "retry_params_name": "default"
@@ -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",
@@ -127,9 +127,9 @@ export declare class UserEventServiceClient {
127
127
  * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore} level, the format
128
128
  * is:
129
129
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
130
- * If the write user event action is applied in {@link protos.|Location} level, for
131
- * example, the event with
132
- * {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
130
+ * If the write user event action is applied in
131
+ * {@link protos.google.cloud.location.Location|Location} level, for example, the event
132
+ * with {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
133
133
  * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}, the format is:
134
134
  * `projects/{project}/locations/{location}`.
135
135
  * @param {google.cloud.discoveryengine.v1.UserEvent} request.userEvent
@@ -163,8 +163,16 @@ export declare class UserEventServiceClient {
163
163
  * @param {Object} request
164
164
  * The request object that will be sent.
165
165
  * @param {string} request.parent
166
- * Required. The parent DataStore resource name, such as
166
+ * Required. The parent resource name.
167
+ * If the collect user event action is applied in
168
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore} level, the format
169
+ * is:
167
170
  * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
171
+ * If the collect user event action is applied in
172
+ * {@link protos.google.cloud.location.Location|Location} level, for example, the event
173
+ * with {@link protos.google.cloud.discoveryengine.v1.Document|Document} across multiple
174
+ * {@link protos.google.cloud.discoveryengine.v1.DataStore|DataStore}, the format is:
175
+ * `projects/{project}/locations/{location}`.
168
176
  * @param {string} request.userEvent
169
177
  * Required. URL encoded UserEvent proto with a length limit of 2,000,000
170
178
  * characters.
@@ -188,7 +196,7 @@ export declare class UserEventServiceClient {
188
196
  */
189
197
  collectUserEvent(request?: protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest, options?: CallOptions): Promise<[
190
198
  protos.google.api.IHttpBody,
191
- (protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest | undefined),
199
+ protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest | undefined,
192
200
  {} | undefined
193
201
  ]>;
194
202
  collectUserEvent(request: protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
@@ -218,16 +226,20 @@ export declare class UserEventServiceClient {
218
226
  * * `userId`: Double quoted string. Specifying this will delete all events
219
227
  * associated with a user.
220
228
  *
229
+ * Note: This API only supports purging a max range of 30 days.
230
+ *
221
231
  * Examples:
222
232
  *
223
233
  * * Deleting all events in a time range:
224
234
  * `eventTime > "2012-04-23T18:25:43.511Z"
225
235
  * eventTime < "2012-04-23T18:30:43.511Z"`
226
- * * Deleting specific eventType:
227
- * `eventType = "search"`
228
- * * Deleting all events for a specific visitor:
229
- * `userPseudoId = "visitor1024"`
230
- * * Deleting all events inside a DataStore:
236
+ * * Deleting specific eventType in a time range:
237
+ * `eventTime > "2012-04-23T18:25:43.511Z"
238
+ * eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`
239
+ * * Deleting all events for a specific visitor in a time range:
240
+ * `eventTime > "2012-04-23T18:25:43.511Z"
241
+ * eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`
242
+ * * Deleting the past 30 days of events inside a DataStore:
231
243
  * `*`
232
244
  *
233
245
  * The filtering fields are assumed to have an implicit AND.
@@ -322,86 +334,86 @@ export declare class UserEventServiceClient {
322
334
  */
323
335
  checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1.ImportUserEventsMetadata>>;
324
336
  /**
325
- * Gets information about a location.
326
- *
327
- * @param {Object} request
328
- * The request object that will be sent.
329
- * @param {string} request.name
330
- * Resource name for the location.
331
- * @param {object} [options]
332
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
333
- * @returns {Promise} - The promise which resolves to an array.
334
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
335
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
336
- * for more details and examples.
337
- * @example
338
- * ```
339
- * const [response] = await client.getLocation(request);
340
- * ```
341
- */
337
+ * Gets information about a location.
338
+ *
339
+ * @param {Object} request
340
+ * The request object that will be sent.
341
+ * @param {string} request.name
342
+ * Resource name for the location.
343
+ * @param {object} [options]
344
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
345
+ * @returns {Promise} - The promise which resolves to an array.
346
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
347
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
348
+ * for more details and examples.
349
+ * @example
350
+ * ```
351
+ * const [response] = await client.getLocation(request);
352
+ * ```
353
+ */
342
354
  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>;
343
355
  /**
344
- * Lists information about the supported locations for this service. Returns an iterable object.
345
- *
346
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
347
- * @param {Object} request
348
- * The request object that will be sent.
349
- * @param {string} request.name
350
- * The resource that owns the locations collection, if applicable.
351
- * @param {string} request.filter
352
- * The standard list filter.
353
- * @param {number} request.pageSize
354
- * The standard list page size.
355
- * @param {string} request.pageToken
356
- * The standard list page token.
357
- * @param {object} [options]
358
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
359
- * @returns {Object}
360
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
361
- * When you iterate the returned iterable, each element will be an object representing
362
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
363
- * so you can stop the iteration when you don't need more results.
364
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
365
- * for more details and examples.
366
- * @example
367
- * ```
368
- * const iterable = client.listLocationsAsync(request);
369
- * for await (const response of iterable) {
370
- * // process response
371
- * }
372
- * ```
373
- */
356
+ * Lists information about the supported locations for this service. Returns an iterable object.
357
+ *
358
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
359
+ * @param {Object} request
360
+ * The request object that will be sent.
361
+ * @param {string} request.name
362
+ * The resource that owns the locations collection, if applicable.
363
+ * @param {string} request.filter
364
+ * The standard list filter.
365
+ * @param {number} request.pageSize
366
+ * The standard list page size.
367
+ * @param {string} request.pageToken
368
+ * The standard list page token.
369
+ * @param {object} [options]
370
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
371
+ * @returns {Object}
372
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
373
+ * When you iterate the returned iterable, each element will be an object representing
374
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
375
+ * so you can stop the iteration when you don't need more results.
376
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
377
+ * for more details and examples.
378
+ * @example
379
+ * ```
380
+ * const iterable = client.listLocationsAsync(request);
381
+ * for await (const response of iterable) {
382
+ * // process response
383
+ * }
384
+ * ```
385
+ */
374
386
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
375
387
  /**
376
- * Gets the latest state of a long-running operation. Clients can use this
377
- * method to poll the operation result at intervals as recommended by the API
378
- * service.
379
- *
380
- * @param {Object} request - The request object that will be sent.
381
- * @param {string} request.name - The name of the operation resource.
382
- * @param {Object=} options
383
- * Optional parameters. You can override the default settings for this call,
384
- * e.g, timeout, retries, paginations, etc. See {@link
385
- * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
386
- * for the details.
387
- * @param {function(?Error, ?Object)=} callback
388
- * The function which will be called with the result of the API call.
389
- *
390
- * The second parameter to the callback is an object representing
391
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
392
- * @return {Promise} - The promise which resolves to an array.
393
- * The first element of the array is an object representing
394
- * {@link google.longrunning.Operation | google.longrunning.Operation}.
395
- * The promise has a method named "cancel" which cancels the ongoing API call.
396
- *
397
- * @example
398
- * ```
399
- * const client = longrunning.operationsClient();
400
- * const name = '';
401
- * const [response] = await client.getOperation({name});
402
- * // doThingsWith(response)
403
- * ```
404
- */
388
+ * Gets the latest state of a long-running operation. Clients can use this
389
+ * method to poll the operation result at intervals as recommended by the API
390
+ * service.
391
+ *
392
+ * @param {Object} request - The request object that will be sent.
393
+ * @param {string} request.name - The name of the operation resource.
394
+ * @param {Object=} options
395
+ * Optional parameters. You can override the default settings for this call,
396
+ * e.g, timeout, retries, paginations, etc. See {@link
397
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
398
+ * for the details.
399
+ * @param {function(?Error, ?Object)=} callback
400
+ * The function which will be called with the result of the API call.
401
+ *
402
+ * The second parameter to the callback is an object representing
403
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
404
+ * @return {Promise} - The promise which resolves to an array.
405
+ * The first element of the array is an object representing
406
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
407
+ * The promise has a method named "cancel" which cancels the ongoing API call.
408
+ *
409
+ * @example
410
+ * ```
411
+ * const client = longrunning.operationsClient();
412
+ * const name = '';
413
+ * const [response] = await client.getOperation({name});
414
+ * // doThingsWith(response)
415
+ * ```
416
+ */
405
417
  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]>;
406
418
  /**
407
419
  * Lists operations that match the specified filter in the request. If the
@@ -966,6 +978,57 @@ export declare class UserEventServiceClient {
966
978
  * @returns {string} A string representing the schema.
967
979
  */
968
980
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
981
+ /**
982
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
983
+ *
984
+ * @param {string} project
985
+ * @param {string} location
986
+ * @param {string} collection
987
+ * @param {string} data_store
988
+ * @param {string} serving_config
989
+ * @returns {string} Resource name string.
990
+ */
991
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
992
+ /**
993
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
994
+ *
995
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
996
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
997
+ * @returns {string} A string representing the project.
998
+ */
999
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1000
+ /**
1001
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1002
+ *
1003
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1004
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1005
+ * @returns {string} A string representing the location.
1006
+ */
1007
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1008
+ /**
1009
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1010
+ *
1011
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1012
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1013
+ * @returns {string} A string representing the collection.
1014
+ */
1015
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1016
+ /**
1017
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1018
+ *
1019
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1020
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1021
+ * @returns {string} A string representing the data_store.
1022
+ */
1023
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
1024
+ /**
1025
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1026
+ *
1027
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1028
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1029
+ * @returns {string} A string representing the serving_config.
1030
+ */
1031
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
969
1032
  /**
970
1033
  * Return a fully-qualified projectLocationCollectionDataStoreSession resource name string.
971
1034
  *
@@ -1119,6 +1182,57 @@ export declare class UserEventServiceClient {
1119
1182
  * @returns {string} A string representing the data_store.
1120
1183
  */
1121
1184
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1185
+ /**
1186
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineSitemap resource name string.
1187
+ *
1188
+ * @param {string} project
1189
+ * @param {string} location
1190
+ * @param {string} collection
1191
+ * @param {string} data_store
1192
+ * @param {string} sitemap
1193
+ * @returns {string} Resource name string.
1194
+ */
1195
+ projectLocationCollectionDataStoreSiteSearchEngineSitemapPath(project: string, location: string, collection: string, dataStore: string, sitemap: string): string;
1196
+ /**
1197
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1198
+ *
1199
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1200
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1201
+ * @returns {string} A string representing the project.
1202
+ */
1203
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1204
+ /**
1205
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1206
+ *
1207
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1208
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1209
+ * @returns {string} A string representing the location.
1210
+ */
1211
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1212
+ /**
1213
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1214
+ *
1215
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1216
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1217
+ * @returns {string} A string representing the collection.
1218
+ */
1219
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1220
+ /**
1221
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1222
+ *
1223
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1224
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1225
+ * @returns {string} A string representing the data_store.
1226
+ */
1227
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1228
+ /**
1229
+ * Parse the sitemap from ProjectLocationCollectionDataStoreSiteSearchEngineSitemap resource.
1230
+ *
1231
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineSitemapName
1232
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_sitemap resource.
1233
+ * @returns {string} A string representing the sitemap.
1234
+ */
1235
+ matchSitemapFromProjectLocationCollectionDataStoreSiteSearchEngineSitemapName(projectLocationCollectionDataStoreSiteSearchEngineSitemapName: string): string | number;
1122
1236
  /**
1123
1237
  * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1124
1238
  *
@@ -1272,6 +1386,57 @@ export declare class UserEventServiceClient {
1272
1386
  * @returns {string} A string representing the conversation.
1273
1387
  */
1274
1388
  matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1389
+ /**
1390
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1391
+ *
1392
+ * @param {string} project
1393
+ * @param {string} location
1394
+ * @param {string} collection
1395
+ * @param {string} engine
1396
+ * @param {string} serving_config
1397
+ * @returns {string} Resource name string.
1398
+ */
1399
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
1400
+ /**
1401
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1402
+ *
1403
+ * @param {string} projectLocationCollectionEngineServingConfigName
1404
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1405
+ * @returns {string} A string representing the project.
1406
+ */
1407
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1408
+ /**
1409
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1410
+ *
1411
+ * @param {string} projectLocationCollectionEngineServingConfigName
1412
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1413
+ * @returns {string} A string representing the location.
1414
+ */
1415
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1416
+ /**
1417
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1418
+ *
1419
+ * @param {string} projectLocationCollectionEngineServingConfigName
1420
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1421
+ * @returns {string} A string representing the collection.
1422
+ */
1423
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1424
+ /**
1425
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1426
+ *
1427
+ * @param {string} projectLocationCollectionEngineServingConfigName
1428
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1429
+ * @returns {string} A string representing the engine.
1430
+ */
1431
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1432
+ /**
1433
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1434
+ *
1435
+ * @param {string} projectLocationCollectionEngineServingConfigName
1436
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1437
+ * @returns {string} A string representing the serving_config.
1438
+ */
1439
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
1275
1440
  /**
1276
1441
  * Return a fully-qualified projectLocationCollectionEngineSession resource name string.
1277
1442
  *
@@ -1728,6 +1893,48 @@ export declare class UserEventServiceClient {
1728
1893
  * @returns {string} A string representing the schema.
1729
1894
  */
1730
1895
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1896
+ /**
1897
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1898
+ *
1899
+ * @param {string} project
1900
+ * @param {string} location
1901
+ * @param {string} data_store
1902
+ * @param {string} serving_config
1903
+ * @returns {string} Resource name string.
1904
+ */
1905
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
1906
+ /**
1907
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1908
+ *
1909
+ * @param {string} projectLocationDataStoreServingConfigName
1910
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1911
+ * @returns {string} A string representing the project.
1912
+ */
1913
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1914
+ /**
1915
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1916
+ *
1917
+ * @param {string} projectLocationDataStoreServingConfigName
1918
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1919
+ * @returns {string} A string representing the location.
1920
+ */
1921
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1922
+ /**
1923
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1924
+ *
1925
+ * @param {string} projectLocationDataStoreServingConfigName
1926
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1927
+ * @returns {string} A string representing the data_store.
1928
+ */
1929
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1930
+ /**
1931
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1932
+ *
1933
+ * @param {string} projectLocationDataStoreServingConfigName
1934
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1935
+ * @returns {string} A string representing the serving_config.
1936
+ */
1937
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1731
1938
  /**
1732
1939
  * Return a fully-qualified projectLocationDataStoreSession resource name string.
1733
1940
  *
@@ -1854,6 +2061,48 @@ export declare class UserEventServiceClient {
1854
2061
  * @returns {string} A string representing the data_store.
1855
2062
  */
1856
2063
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
2064
+ /**
2065
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineSitemap resource name string.
2066
+ *
2067
+ * @param {string} project
2068
+ * @param {string} location
2069
+ * @param {string} data_store
2070
+ * @param {string} sitemap
2071
+ * @returns {string} Resource name string.
2072
+ */
2073
+ projectLocationDataStoreSiteSearchEngineSitemapPath(project: string, location: string, dataStore: string, sitemap: string): string;
2074
+ /**
2075
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2076
+ *
2077
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2078
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2079
+ * @returns {string} A string representing the project.
2080
+ */
2081
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2082
+ /**
2083
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2084
+ *
2085
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2086
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2087
+ * @returns {string} A string representing the location.
2088
+ */
2089
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2090
+ /**
2091
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2092
+ *
2093
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2094
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2095
+ * @returns {string} A string representing the data_store.
2096
+ */
2097
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
2098
+ /**
2099
+ * Parse the sitemap from ProjectLocationDataStoreSiteSearchEngineSitemap resource.
2100
+ *
2101
+ * @param {string} projectLocationDataStoreSiteSearchEngineSitemapName
2102
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_sitemap resource.
2103
+ * @returns {string} A string representing the sitemap.
2104
+ */
2105
+ matchSitemapFromProjectLocationDataStoreSiteSearchEngineSitemapName(projectLocationDataStoreSiteSearchEngineSitemapName: string): string | number;
1857
2106
  /**
1858
2107
  * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1859
2108
  *