@google-cloud/discoveryengine 1.3.0 → 1.3.1

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 (57) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +12 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  12. package/build/protos/protos.d.ts +4473 -550
  13. package/build/protos/protos.js +27437 -19222
  14. package/build/protos/protos.json +1060 -358
  15. package/build/src/index.js +1 -1
  16. package/build/src/v1/completion_service_client.js +1 -1
  17. package/build/src/v1/conversational_search_service_client.js +1 -1
  18. package/build/src/v1/document_service_client.js +1 -1
  19. package/build/src/v1/index.js +1 -1
  20. package/build/src/v1/schema_service_client.js +1 -1
  21. package/build/src/v1/search_service_client.js +1 -1
  22. package/build/src/v1/user_event_service_client.js +1 -1
  23. package/build/src/v1alpha/completion_service_client.d.ts +219 -0
  24. package/build/src/v1alpha/completion_service_client.js +302 -0
  25. package/build/src/v1alpha/conversational_search_service_client.d.ts +236 -0
  26. package/build/src/v1alpha/conversational_search_service_client.js +302 -0
  27. package/build/src/v1alpha/data_store_service_client.d.ts +219 -0
  28. package/build/src/v1alpha/data_store_service_client.js +310 -2
  29. package/build/src/v1alpha/document_service_client.d.ts +219 -0
  30. package/build/src/v1alpha/document_service_client.js +310 -2
  31. package/build/src/v1alpha/engine_service_client.d.ts +220 -1
  32. package/build/src/v1alpha/engine_service_client.js +310 -2
  33. package/build/src/v1alpha/index.d.ts +1 -0
  34. package/build/src/v1alpha/index.js +3 -1
  35. package/build/src/v1alpha/recommendation_service_client.d.ts +219 -0
  36. package/build/src/v1alpha/recommendation_service_client.js +302 -0
  37. package/build/src/v1alpha/schema_service_client.d.ts +219 -0
  38. package/build/src/v1alpha/schema_service_client.js +310 -2
  39. package/build/src/v1alpha/search_service_client.d.ts +258 -0
  40. package/build/src/v1alpha/search_service_client.js +328 -0
  41. package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
  42. package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
  43. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  44. package/build/src/v1alpha/site_search_engine_service_client.d.ts +739 -1
  45. package/build/src/v1alpha/site_search_engine_service_client.js +801 -4
  46. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  47. package/build/src/v1alpha/user_event_service_client.d.ts +219 -0
  48. package/build/src/v1alpha/user_event_service_client.js +310 -2
  49. package/build/src/v1beta/completion_service_client.js +1 -1
  50. package/build/src/v1beta/conversational_search_service_client.js +1 -1
  51. package/build/src/v1beta/document_service_client.js +1 -1
  52. package/build/src/v1beta/index.js +1 -1
  53. package/build/src/v1beta/recommendation_service_client.js +1 -1
  54. package/build/src/v1beta/schema_service_client.js +1 -1
  55. package/build/src/v1beta/search_service_client.js +1 -1
  56. package/build/src/v1beta/user_event_service_client.js +1 -1
  57. package/package.json +2 -2
@@ -1,5 +1,7 @@
1
+ /// <reference types="node" />
1
2
  import type * as gax from 'google-gax';
2
- import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, LocationsClient, LocationProtos } from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
+ import { Transform } from 'stream';
3
5
  import * as protos from '../../protos/protos';
4
6
  /**
5
7
  * Service for managing site search related resources.
@@ -106,6 +108,326 @@ export declare class SiteSearchEngineServiceClient {
106
108
  static get scopes(): string[];
107
109
  getProjectId(): Promise<string>;
108
110
  getProjectId(callback: Callback<string, undefined, undefined>): void;
111
+ /**
112
+ * Gets the
113
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine}.
114
+ *
115
+ * @param {Object} request
116
+ * The request object that will be sent.
117
+ * @param {string} request.name
118
+ * Required. Resource name of
119
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
120
+ * such as
121
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
122
+ *
123
+ * If the caller does not have permission to access the [SiteSearchEngine],
124
+ * regardless of whether or not it exists, a PERMISSION_DENIED error is
125
+ * returned.
126
+ * @param {object} [options]
127
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
128
+ * @returns {Promise} - The promise which resolves to an array.
129
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine}.
130
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
131
+ * for more details and examples.
132
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.get_site_search_engine.js</caption>
133
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_GetSiteSearchEngine_async
134
+ */
135
+ getSiteSearchEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest, options?: CallOptions): Promise<[
136
+ protos.google.cloud.discoveryengine.v1alpha.ISiteSearchEngine,
137
+ (protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest | undefined),
138
+ {} | undefined
139
+ ]>;
140
+ getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;
141
+ getSiteSearchEngine(request: protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ISiteSearchEngine, protos.google.cloud.discoveryengine.v1alpha.IGetSiteSearchEngineRequest | null | undefined, {} | null | undefined>): void;
142
+ /**
143
+ * Gets a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
144
+ *
145
+ * @param {Object} request
146
+ * The request object that will be sent.
147
+ * @param {string} request.name
148
+ * Required. Full resource name of
149
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, such as
150
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
151
+ *
152
+ * If the caller does not have permission to access the
153
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, regardless
154
+ * of whether or not it exists, a PERMISSION_DENIED error is returned.
155
+ *
156
+ * If the requested
157
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} does not
158
+ * exist, a NOT_FOUND error is returned.
159
+ * @param {object} [options]
160
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
161
+ * @returns {Promise} - The promise which resolves to an array.
162
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
163
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
164
+ * for more details and examples.
165
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.get_target_site.js</caption>
166
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_GetTargetSite_async
167
+ */
168
+ getTargetSite(request?: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, options?: CallOptions): Promise<[
169
+ protos.google.cloud.discoveryengine.v1alpha.ITargetSite,
170
+ (protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | undefined),
171
+ {} | undefined
172
+ ]>;
173
+ getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
174
+ getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
175
+ /**
176
+ * Creates a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
177
+ *
178
+ * @param {Object} request
179
+ * The request object that will be sent.
180
+ * @param {string} request.parent
181
+ * Required. Parent resource name of
182
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, such as
183
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
184
+ * @param {google.cloud.discoveryengine.v1alpha.TargetSite} request.targetSite
185
+ * Required. The {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}
186
+ * to create.
187
+ * @param {object} [options]
188
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
189
+ * @returns {Promise} - The promise which resolves to an array.
190
+ * The first element of the array is an object representing
191
+ * a long running operation. Its `promise()` method returns a promise
192
+ * you can `await` for.
193
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
194
+ * for more details and examples.
195
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.create_target_site.js</caption>
196
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_async
197
+ */
198
+ createTargetSite(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteRequest, options?: CallOptions): Promise<[
199
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteMetadata>,
200
+ protos.google.longrunning.IOperation | undefined,
201
+ {} | undefined
202
+ ]>;
203
+ createTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
204
+ createTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.ICreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
205
+ /**
206
+ * Check the status of the long running operation returned by `createTargetSite()`.
207
+ * @param {String} name
208
+ * The operation name that will be passed.
209
+ * @returns {Promise} - The promise which resolves to an object.
210
+ * The decoded operation object has result and metadata field to get information from.
211
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
212
+ * for more details and examples.
213
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.create_target_site.js</caption>
214
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_async
215
+ */
216
+ checkCreateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TargetSite, protos.google.cloud.discoveryengine.v1alpha.CreateTargetSiteMetadata>>;
217
+ /**
218
+ * Creates {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} in a
219
+ * batch.
220
+ *
221
+ * @param {Object} request
222
+ * The request object that will be sent.
223
+ * @param {string} request.parent
224
+ * Required. The parent resource shared by all TargetSites being created.
225
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
226
+ * The parent field in the CreateBookRequest messages must either be empty or
227
+ * match this field.
228
+ * @param {number[]} request.requests
229
+ * Required. The request message specifying the resources to create.
230
+ * A maximum of 20 TargetSites can be created in a batch.
231
+ * @param {object} [options]
232
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
233
+ * @returns {Promise} - The promise which resolves to an array.
234
+ * The first element of the array is an object representing
235
+ * a long running operation. Its `promise()` method returns a promise
236
+ * you can `await` for.
237
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
238
+ * for more details and examples.
239
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js</caption>
240
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_async
241
+ */
242
+ batchCreateTargetSites(request?: protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesRequest, options?: CallOptions): Promise<[
243
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSiteMetadata>,
244
+ protos.google.longrunning.IOperation | undefined,
245
+ {} | undefined
246
+ ]>;
247
+ batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
248
+ batchCreateTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchCreateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
249
+ /**
250
+ * Check the status of the long running operation returned by `batchCreateTargetSites()`.
251
+ * @param {String} name
252
+ * The operation name that will be passed.
253
+ * @returns {Promise} - The promise which resolves to an object.
254
+ * The decoded operation object has result and metadata field to get information from.
255
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
256
+ * for more details and examples.
257
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js</caption>
258
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_async
259
+ */
260
+ checkBatchCreateTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSiteMetadata>>;
261
+ /**
262
+ * Updates a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
263
+ *
264
+ * @param {Object} request
265
+ * The request object that will be sent.
266
+ * @param {google.cloud.discoveryengine.v1alpha.TargetSite} request.targetSite
267
+ * Required. The target site to update.
268
+ * If the caller does not have permission to update the
269
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, regardless
270
+ * of whether or not it exists, a PERMISSION_DENIED error is returned.
271
+ *
272
+ * If the {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} to
273
+ * update does not exist, a NOT_FOUND error is returned.
274
+ * @param {object} [options]
275
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
276
+ * @returns {Promise} - The promise which resolves to an array.
277
+ * The first element of the array is an object representing
278
+ * a long running operation. Its `promise()` method returns a promise
279
+ * you can `await` for.
280
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
281
+ * for more details and examples.
282
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.update_target_site.js</caption>
283
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_async
284
+ */
285
+ updateTargetSite(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteRequest, options?: CallOptions): Promise<[
286
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteMetadata>,
287
+ protos.google.longrunning.IOperation | undefined,
288
+ {} | undefined
289
+ ]>;
290
+ updateTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
291
+ updateTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IUpdateTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
292
+ /**
293
+ * Check the status of the long running operation returned by `updateTargetSite()`.
294
+ * @param {String} name
295
+ * The operation name that will be passed.
296
+ * @returns {Promise} - The promise which resolves to an object.
297
+ * The decoded operation object has result and metadata field to get information from.
298
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
299
+ * for more details and examples.
300
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.update_target_site.js</caption>
301
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_async
302
+ */
303
+ checkUpdateTargetSiteProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TargetSite, protos.google.cloud.discoveryengine.v1alpha.UpdateTargetSiteMetadata>>;
304
+ /**
305
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
306
+ *
307
+ * @param {Object} request
308
+ * The request object that will be sent.
309
+ * @param {string} request.name
310
+ * Required. Full resource name of
311
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, such as
312
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
313
+ *
314
+ * If the caller does not have permission to access the
315
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}, regardless
316
+ * of whether or not it exists, a PERMISSION_DENIED error is returned.
317
+ *
318
+ * If the requested
319
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} does not
320
+ * exist, a NOT_FOUND error is returned.
321
+ * @param {object} [options]
322
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
323
+ * @returns {Promise} - The promise which resolves to an array.
324
+ * The first element of the array is an object representing
325
+ * a long running operation. Its `promise()` method returns a promise
326
+ * you can `await` for.
327
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
328
+ * for more details and examples.
329
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.delete_target_site.js</caption>
330
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_async
331
+ */
332
+ deleteTargetSite(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteRequest, options?: CallOptions): Promise<[
333
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteMetadata>,
334
+ protos.google.longrunning.IOperation | undefined,
335
+ {} | undefined
336
+ ]>;
337
+ deleteTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
338
+ deleteTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteTargetSiteMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
339
+ /**
340
+ * Check the status of the long running operation returned by `deleteTargetSite()`.
341
+ * @param {String} name
342
+ * The operation name that will be passed.
343
+ * @returns {Promise} - The promise which resolves to an object.
344
+ * The decoded operation object has result and metadata field to get information from.
345
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
346
+ * for more details and examples.
347
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.delete_target_site.js</caption>
348
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_async
349
+ */
350
+ checkDeleteTargetSiteProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteTargetSiteMetadata>>;
351
+ /**
352
+ * Upgrade from basic site search to advanced site search.
353
+ *
354
+ * @param {Object} request
355
+ * The request object that will be sent.
356
+ * @param {string} request.siteSearchEngine
357
+ * Required. Full resource name of the
358
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
359
+ * such as
360
+ * `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
361
+ * @param {object} [options]
362
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
363
+ * @returns {Promise} - The promise which resolves to an array.
364
+ * The first element of the array is an object representing
365
+ * a long running operation. Its `promise()` method returns a promise
366
+ * you can `await` for.
367
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
368
+ * for more details and examples.
369
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js</caption>
370
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
371
+ */
372
+ enableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
373
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchMetadata>,
374
+ protos.google.longrunning.IOperation | undefined,
375
+ {} | undefined
376
+ ]>;
377
+ enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
378
+ enableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IEnableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
379
+ /**
380
+ * Check the status of the long running operation returned by `enableAdvancedSiteSearch()`.
381
+ * @param {String} name
382
+ * The operation name that will be passed.
383
+ * @returns {Promise} - The promise which resolves to an object.
384
+ * The decoded operation object has result and metadata field to get information from.
385
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
386
+ * for more details and examples.
387
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js</caption>
388
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
389
+ */
390
+ checkEnableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchMetadata>>;
391
+ /**
392
+ * Downgrade from advanced site search to basic site search.
393
+ *
394
+ * @param {Object} request
395
+ * The request object that will be sent.
396
+ * @param {string} request.siteSearchEngine
397
+ * Required. Full resource name of the
398
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
399
+ * such as
400
+ * `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.
401
+ * @param {object} [options]
402
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
403
+ * @returns {Promise} - The promise which resolves to an array.
404
+ * The first element of the array is an object representing
405
+ * a long running operation. Its `promise()` method returns a promise
406
+ * you can `await` for.
407
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
408
+ * for more details and examples.
409
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js</caption>
410
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
411
+ */
412
+ disableAdvancedSiteSearch(request?: protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchRequest, options?: CallOptions): Promise<[
413
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchMetadata>,
414
+ protos.google.longrunning.IOperation | undefined,
415
+ {} | undefined
416
+ ]>;
417
+ disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
418
+ disableAdvancedSiteSearch(request: protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.IDisableAdvancedSiteSearchMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
419
+ /**
420
+ * Check the status of the long running operation returned by `disableAdvancedSiteSearch()`.
421
+ * @param {String} name
422
+ * The operation name that will be passed.
423
+ * @returns {Promise} - The promise which resolves to an object.
424
+ * The decoded operation object has result and metadata field to get information from.
425
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
426
+ * for more details and examples.
427
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js</caption>
428
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
429
+ */
430
+ checkDisableAdvancedSiteSearchProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchResponse, protos.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchMetadata>>;
109
431
  /**
110
432
  * Request on-demand recrawl for a list of URIs.
111
433
  *
@@ -151,6 +473,278 @@ export declare class SiteSearchEngineServiceClient {
151
473
  * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_RecrawlUris_async
152
474
  */
153
475
  checkRecrawlUrisProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse, protos.google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata>>;
476
+ /**
477
+ * Verify target sites' ownership and validity.
478
+ * This API sends all the target sites under site search engine for
479
+ * verification.
480
+ *
481
+ * @param {Object} request
482
+ * The request object that will be sent.
483
+ * @param {string} request.parent
484
+ * Required. The parent resource shared by all TargetSites being verified.
485
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
486
+ * @param {object} [options]
487
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
488
+ * @returns {Promise} - The promise which resolves to an array.
489
+ * The first element of the array is an object representing
490
+ * a long running operation. Its `promise()` method returns a promise
491
+ * you can `await` for.
492
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
493
+ * for more details and examples.
494
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js</caption>
495
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
496
+ */
497
+ batchVerifyTargetSites(request?: protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesRequest, options?: CallOptions): Promise<[
498
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesMetadata>,
499
+ protos.google.longrunning.IOperation | undefined,
500
+ {} | undefined
501
+ ]>;
502
+ batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
503
+ batchVerifyTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.IBatchVerifyTargetSitesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
504
+ /**
505
+ * Check the status of the long running operation returned by `batchVerifyTargetSites()`.
506
+ * @param {String} name
507
+ * The operation name that will be passed.
508
+ * @returns {Promise} - The promise which resolves to an object.
509
+ * The decoded operation object has result and metadata field to get information from.
510
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
511
+ * for more details and examples.
512
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js</caption>
513
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
514
+ */
515
+ checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata>>;
516
+ /**
517
+ * Gets a list of
518
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s.
519
+ *
520
+ * @param {Object} request
521
+ * The request object that will be sent.
522
+ * @param {string} request.parent
523
+ * Required. The parent site search engine resource name, such as
524
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
525
+ *
526
+ * If the caller does not have permission to list
527
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
528
+ * site search engine, regardless of whether or not this branch exists, a
529
+ * PERMISSION_DENIED error is returned.
530
+ * @param {number} request.pageSize
531
+ * Requested page size. Server may return fewer items than requested. If
532
+ * unspecified, server will pick an appropriate default. The maximum value is
533
+ * 1000; values above 1000 will be coerced to 1000.
534
+ *
535
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
536
+ * @param {string} request.pageToken
537
+ * A page token, received from a previous `ListTargetSites` call.
538
+ * Provide this to retrieve the subsequent page.
539
+ *
540
+ * When paginating, all other parameters provided to `ListTargetSites`
541
+ * must match the call that provided the page token.
542
+ * @param {object} [options]
543
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
544
+ * @returns {Promise} - The promise which resolves to an array.
545
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
546
+ * The client library will perform auto-pagination by default: it will call the API as many
547
+ * times as needed and will merge results from all the pages into this array.
548
+ * Note that it can affect your quota.
549
+ * We recommend using `listTargetSitesAsync()`
550
+ * method described below for async iteration which you can stop as needed.
551
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
552
+ * for more details and examples.
553
+ */
554
+ listTargetSites(request?: protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, options?: CallOptions): Promise<[
555
+ protos.google.cloud.discoveryengine.v1alpha.ITargetSite[],
556
+ protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest | null,
557
+ protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesResponse
558
+ ]>;
559
+ listTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ITargetSite>): void;
560
+ listTargetSites(request: protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ITargetSite>): void;
561
+ /**
562
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
563
+ * @param {Object} request
564
+ * The request object that will be sent.
565
+ * @param {string} request.parent
566
+ * Required. The parent site search engine resource name, such as
567
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
568
+ *
569
+ * If the caller does not have permission to list
570
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
571
+ * site search engine, regardless of whether or not this branch exists, a
572
+ * PERMISSION_DENIED error is returned.
573
+ * @param {number} request.pageSize
574
+ * Requested page size. Server may return fewer items than requested. If
575
+ * unspecified, server will pick an appropriate default. The maximum value is
576
+ * 1000; values above 1000 will be coerced to 1000.
577
+ *
578
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
579
+ * @param {string} request.pageToken
580
+ * A page token, received from a previous `ListTargetSites` call.
581
+ * Provide this to retrieve the subsequent page.
582
+ *
583
+ * When paginating, all other parameters provided to `ListTargetSites`
584
+ * must match the call that provided the page token.
585
+ * @param {object} [options]
586
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
587
+ * @returns {Stream}
588
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
589
+ * The client library will perform auto-pagination by default: it will call the API as many
590
+ * times as needed. Note that it can affect your quota.
591
+ * We recommend using `listTargetSitesAsync()`
592
+ * method described below for async iteration which you can stop as needed.
593
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
594
+ * for more details and examples.
595
+ */
596
+ listTargetSitesStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, options?: CallOptions): Transform;
597
+ /**
598
+ * Equivalent to `listTargetSites`, but returns an iterable object.
599
+ *
600
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
601
+ * @param {Object} request
602
+ * The request object that will be sent.
603
+ * @param {string} request.parent
604
+ * Required. The parent site search engine resource name, such as
605
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
606
+ *
607
+ * If the caller does not have permission to list
608
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
609
+ * site search engine, regardless of whether or not this branch exists, a
610
+ * PERMISSION_DENIED error is returned.
611
+ * @param {number} request.pageSize
612
+ * Requested page size. Server may return fewer items than requested. If
613
+ * unspecified, server will pick an appropriate default. The maximum value is
614
+ * 1000; values above 1000 will be coerced to 1000.
615
+ *
616
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
617
+ * @param {string} request.pageToken
618
+ * A page token, received from a previous `ListTargetSites` call.
619
+ * Provide this to retrieve the subsequent page.
620
+ *
621
+ * When paginating, all other parameters provided to `ListTargetSites`
622
+ * must match the call that provided the page token.
623
+ * @param {object} [options]
624
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
625
+ * @returns {Object}
626
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
627
+ * When you iterate the returned iterable, each element will be an object representing
628
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
629
+ * so you can stop the iteration when you don't need more results.
630
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
631
+ * for more details and examples.
632
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.list_target_sites.js</caption>
633
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_ListTargetSites_async
634
+ */
635
+ listTargetSitesAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListTargetSitesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ITargetSite>;
636
+ /**
637
+ * Returns list of target sites with its domain verification status.
638
+ * This method can only be called under data store with BASIC_SITE_SEARCH
639
+ * state at the moment.
640
+ *
641
+ * @param {Object} request
642
+ * The request object that will be sent.
643
+ * @param {string} request.siteSearchEngine
644
+ * Required. The site search engine resource under which we fetch all the
645
+ * domain verification status.
646
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
647
+ * @param {number} request.pageSize
648
+ * Requested page size. Server may return fewer items than requested. If
649
+ * unspecified, server will pick an appropriate default. The maximum value is
650
+ * 1000; values above 1000 will be coerced to 1000.
651
+ *
652
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
653
+ * @param {string} request.pageToken
654
+ * A page token, received from a previous `FetchDomainVerificationStatus`
655
+ * call. Provide this to retrieve the subsequent page.
656
+ *
657
+ * When paginating, all other parameters provided to
658
+ * `FetchDomainVerificationStatus` must match the call that provided the page
659
+ * token.
660
+ * @param {object} [options]
661
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
662
+ * @returns {Promise} - The promise which resolves to an array.
663
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
664
+ * The client library will perform auto-pagination by default: it will call the API as many
665
+ * times as needed and will merge results from all the pages into this array.
666
+ * Note that it can affect your quota.
667
+ * We recommend using `fetchDomainVerificationStatusAsync()`
668
+ * method described below for async iteration which you can stop as needed.
669
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
670
+ * for more details and examples.
671
+ */
672
+ fetchDomainVerificationStatus(request?: protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, options?: CallOptions): Promise<[
673
+ protos.google.cloud.discoveryengine.v1alpha.ITargetSite[],
674
+ protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest | null,
675
+ protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusResponse
676
+ ]>;
677
+ fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ITargetSite>): void;
678
+ fetchDomainVerificationStatus(request: protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.ITargetSite>): void;
679
+ /**
680
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
681
+ * @param {Object} request
682
+ * The request object that will be sent.
683
+ * @param {string} request.siteSearchEngine
684
+ * Required. The site search engine resource under which we fetch all the
685
+ * domain verification status.
686
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
687
+ * @param {number} request.pageSize
688
+ * Requested page size. Server may return fewer items than requested. If
689
+ * unspecified, server will pick an appropriate default. The maximum value is
690
+ * 1000; values above 1000 will be coerced to 1000.
691
+ *
692
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
693
+ * @param {string} request.pageToken
694
+ * A page token, received from a previous `FetchDomainVerificationStatus`
695
+ * call. Provide this to retrieve the subsequent page.
696
+ *
697
+ * When paginating, all other parameters provided to
698
+ * `FetchDomainVerificationStatus` must match the call that provided the page
699
+ * token.
700
+ * @param {object} [options]
701
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
702
+ * @returns {Stream}
703
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
704
+ * The client library will perform auto-pagination by default: it will call the API as many
705
+ * times as needed. Note that it can affect your quota.
706
+ * We recommend using `fetchDomainVerificationStatusAsync()`
707
+ * method described below for async iteration which you can stop as needed.
708
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
709
+ * for more details and examples.
710
+ */
711
+ fetchDomainVerificationStatusStream(request?: protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, options?: CallOptions): Transform;
712
+ /**
713
+ * Equivalent to `fetchDomainVerificationStatus`, but returns an iterable object.
714
+ *
715
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
716
+ * @param {Object} request
717
+ * The request object that will be sent.
718
+ * @param {string} request.siteSearchEngine
719
+ * Required. The site search engine resource under which we fetch all the
720
+ * domain verification status.
721
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
722
+ * @param {number} request.pageSize
723
+ * Requested page size. Server may return fewer items than requested. If
724
+ * unspecified, server will pick an appropriate default. The maximum value is
725
+ * 1000; values above 1000 will be coerced to 1000.
726
+ *
727
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
728
+ * @param {string} request.pageToken
729
+ * A page token, received from a previous `FetchDomainVerificationStatus`
730
+ * call. Provide this to retrieve the subsequent page.
731
+ *
732
+ * When paginating, all other parameters provided to
733
+ * `FetchDomainVerificationStatus` must match the call that provided the page
734
+ * token.
735
+ * @param {object} [options]
736
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
737
+ * @returns {Object}
738
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
739
+ * When you iterate the returned iterable, each element will be an object representing
740
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
741
+ * so you can stop the iteration when you don't need more results.
742
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
743
+ * for more details and examples.
744
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js</caption>
745
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async
746
+ */
747
+ fetchDomainVerificationStatusAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IFetchDomainVerificationStatusRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.ITargetSite>;
154
748
  /**
155
749
  * Gets information about a location.
156
750
  *
@@ -610,6 +1204,108 @@ export declare class SiteSearchEngineServiceClient {
610
1204
  * @returns {string} A string representing the data_store.
611
1205
  */
612
1206
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
1207
+ /**
1208
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1209
+ *
1210
+ * @param {string} project
1211
+ * @param {string} location
1212
+ * @param {string} collection
1213
+ * @param {string} data_store
1214
+ * @param {string} target_site
1215
+ * @returns {string} Resource name string.
1216
+ */
1217
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
1218
+ /**
1219
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1220
+ *
1221
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1222
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1223
+ * @returns {string} A string representing the project.
1224
+ */
1225
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1226
+ /**
1227
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1228
+ *
1229
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1230
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1231
+ * @returns {string} A string representing the location.
1232
+ */
1233
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1234
+ /**
1235
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1236
+ *
1237
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1238
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1239
+ * @returns {string} A string representing the collection.
1240
+ */
1241
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1242
+ /**
1243
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1244
+ *
1245
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1246
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1247
+ * @returns {string} A string representing the data_store.
1248
+ */
1249
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1250
+ /**
1251
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1252
+ *
1253
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1254
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1255
+ * @returns {string} A string representing the target_site.
1256
+ */
1257
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1258
+ /**
1259
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1260
+ *
1261
+ * @param {string} project
1262
+ * @param {string} location
1263
+ * @param {string} collection
1264
+ * @param {string} engine
1265
+ * @param {string} conversation
1266
+ * @returns {string} Resource name string.
1267
+ */
1268
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
1269
+ /**
1270
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1271
+ *
1272
+ * @param {string} projectLocationCollectionEngineConversationName
1273
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1274
+ * @returns {string} A string representing the project.
1275
+ */
1276
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1277
+ /**
1278
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1279
+ *
1280
+ * @param {string} projectLocationCollectionEngineConversationName
1281
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1282
+ * @returns {string} A string representing the location.
1283
+ */
1284
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1285
+ /**
1286
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1287
+ *
1288
+ * @param {string} projectLocationCollectionEngineConversationName
1289
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1290
+ * @returns {string} A string representing the collection.
1291
+ */
1292
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1293
+ /**
1294
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1295
+ *
1296
+ * @param {string} projectLocationCollectionEngineConversationName
1297
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1298
+ * @returns {string} A string representing the engine.
1299
+ */
1300
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
1301
+ /**
1302
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1303
+ *
1304
+ * @param {string} projectLocationCollectionEngineConversationName
1305
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1306
+ * @returns {string} A string representing the conversation.
1307
+ */
1308
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
613
1309
  /**
614
1310
  * Return a fully-qualified projectLocationDataStore resource name string.
615
1311
  *
@@ -811,6 +1507,48 @@ export declare class SiteSearchEngineServiceClient {
811
1507
  * @returns {string} A string representing the data_store.
812
1508
  */
813
1509
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1510
+ /**
1511
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1512
+ *
1513
+ * @param {string} project
1514
+ * @param {string} location
1515
+ * @param {string} data_store
1516
+ * @param {string} target_site
1517
+ * @returns {string} Resource name string.
1518
+ */
1519
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1520
+ /**
1521
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1522
+ *
1523
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1524
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1525
+ * @returns {string} A string representing the project.
1526
+ */
1527
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1528
+ /**
1529
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1530
+ *
1531
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1532
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1533
+ * @returns {string} A string representing the location.
1534
+ */
1535
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1536
+ /**
1537
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1538
+ *
1539
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1540
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1541
+ * @returns {string} A string representing the data_store.
1542
+ */
1543
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1544
+ /**
1545
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1546
+ *
1547
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1548
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1549
+ * @returns {string} A string representing the target_site.
1550
+ */
1551
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
814
1552
  /**
815
1553
  * Terminate the gRPC channel and close the client.
816
1554
  *