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