@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.
- package/CHANGELOG.md +7 -0
- package/README.md +12 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
- package/build/protos/protos.d.ts +4473 -550
- package/build/protos/protos.js +27437 -19222
- package/build/protos/protos.json +1060 -358
- package/build/src/index.js +1 -1
- package/build/src/v1/completion_service_client.js +1 -1
- package/build/src/v1/conversational_search_service_client.js +1 -1
- package/build/src/v1/document_service_client.js +1 -1
- package/build/src/v1/index.js +1 -1
- package/build/src/v1/schema_service_client.js +1 -1
- package/build/src/v1/search_service_client.js +1 -1
- package/build/src/v1/user_event_service_client.js +1 -1
- package/build/src/v1alpha/completion_service_client.d.ts +219 -0
- package/build/src/v1alpha/completion_service_client.js +302 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +236 -0
- package/build/src/v1alpha/conversational_search_service_client.js +302 -0
- package/build/src/v1alpha/data_store_service_client.d.ts +219 -0
- package/build/src/v1alpha/data_store_service_client.js +310 -2
- package/build/src/v1alpha/document_service_client.d.ts +219 -0
- package/build/src/v1alpha/document_service_client.js +310 -2
- package/build/src/v1alpha/engine_service_client.d.ts +220 -1
- package/build/src/v1alpha/engine_service_client.js +310 -2
- package/build/src/v1alpha/index.d.ts +1 -0
- package/build/src/v1alpha/index.js +3 -1
- package/build/src/v1alpha/recommendation_service_client.d.ts +219 -0
- package/build/src/v1alpha/recommendation_service_client.js +302 -0
- package/build/src/v1alpha/schema_service_client.d.ts +219 -0
- package/build/src/v1alpha/schema_service_client.js +310 -2
- package/build/src/v1alpha/search_service_client.d.ts +258 -0
- package/build/src/v1alpha/search_service_client.js +328 -0
- package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
- package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
- package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +739 -1
- package/build/src/v1alpha/site_search_engine_service_client.js +801 -4
- package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
- package/build/src/v1alpha/user_event_service_client.d.ts +219 -0
- package/build/src/v1alpha/user_event_service_client.js +310 -2
- package/build/src/v1beta/completion_service_client.js +1 -1
- package/build/src/v1beta/conversational_search_service_client.js +1 -1
- package/build/src/v1beta/document_service_client.js +1 -1
- package/build/src/v1beta/index.js +1 -1
- package/build/src/v1beta/recommendation_service_client.js +1 -1
- package/build/src/v1beta/schema_service_client.js +1 -1
- package/build/src/v1beta/search_service_client.js +1 -1
- package/build/src/v1beta/user_event_service_client.js +1 -1
- package/package.json +2 -2
@@ -145,11 +145,21 @@ class SiteSearchEngineServiceClient {
|
|
145
145
|
projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
|
146
146
|
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
147
147
|
projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
|
148
|
+
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
149
|
+
projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
|
148
150
|
projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
|
149
151
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
150
152
|
projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
|
151
153
|
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
152
154
|
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
155
|
+
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
156
|
+
};
|
157
|
+
// Some of the methods on this service return "paged" results,
|
158
|
+
// (e.g. 50 results at a time, with tokens to get subsequent
|
159
|
+
// pages). Denote the keys used for pagination and results.
|
160
|
+
this.descriptors.page = {
|
161
|
+
listTargetSites: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'targetSites'),
|
162
|
+
fetchDomainVerificationStatus: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'targetSites'),
|
153
163
|
};
|
154
164
|
const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
|
155
165
|
// This API contains "long-running operations", which return a
|
@@ -164,8 +174,11 @@ class SiteSearchEngineServiceClient {
|
|
164
174
|
lroOptions.httpRules = [
|
165
175
|
{
|
166
176
|
selector: 'google.longrunning.Operations.GetOperation',
|
167
|
-
get: '/v1alpha/{name=projects/*/locations/*/collections/*/
|
177
|
+
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}',
|
168
178
|
additional_bindings: [
|
179
|
+
{
|
180
|
+
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}',
|
181
|
+
},
|
169
182
|
{
|
170
183
|
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}',
|
171
184
|
},
|
@@ -202,8 +215,11 @@ class SiteSearchEngineServiceClient {
|
|
202
215
|
},
|
203
216
|
{
|
204
217
|
selector: 'google.longrunning.Operations.ListOperations',
|
205
|
-
get: '/v1alpha/{name=projects/*/locations/*/collections/*/
|
218
|
+
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}/operations',
|
206
219
|
additional_bindings: [
|
220
|
+
{
|
221
|
+
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations',
|
222
|
+
},
|
207
223
|
{
|
208
224
|
get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
|
209
225
|
},
|
@@ -243,10 +259,31 @@ class SiteSearchEngineServiceClient {
|
|
243
259
|
this.operationsClient = this._gaxModule
|
244
260
|
.lro(lroOptions)
|
245
261
|
.operationsClient(opts);
|
262
|
+
const createTargetSiteResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.TargetSite');
|
263
|
+
const createTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.CreateTargetSiteMetadata');
|
264
|
+
const batchCreateTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesResponse');
|
265
|
+
const batchCreateTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSiteMetadata');
|
266
|
+
const updateTargetSiteResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.TargetSite');
|
267
|
+
const updateTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.UpdateTargetSiteMetadata');
|
268
|
+
const deleteTargetSiteResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
|
269
|
+
const deleteTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DeleteTargetSiteMetadata');
|
270
|
+
const enableAdvancedSiteSearchResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchResponse');
|
271
|
+
const enableAdvancedSiteSearchMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchMetadata');
|
272
|
+
const disableAdvancedSiteSearchResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchResponse');
|
273
|
+
const disableAdvancedSiteSearchMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchMetadata');
|
246
274
|
const recrawlUrisResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse');
|
247
275
|
const recrawlUrisMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata');
|
276
|
+
const batchVerifyTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse');
|
277
|
+
const batchVerifyTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata');
|
248
278
|
this.descriptors.longrunning = {
|
279
|
+
createTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createTargetSiteResponse.decode.bind(createTargetSiteResponse), createTargetSiteMetadata.decode.bind(createTargetSiteMetadata)),
|
280
|
+
batchCreateTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchCreateTargetSitesResponse.decode.bind(batchCreateTargetSitesResponse), batchCreateTargetSitesMetadata.decode.bind(batchCreateTargetSitesMetadata)),
|
281
|
+
updateTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateTargetSiteResponse.decode.bind(updateTargetSiteResponse), updateTargetSiteMetadata.decode.bind(updateTargetSiteMetadata)),
|
282
|
+
deleteTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteTargetSiteResponse.decode.bind(deleteTargetSiteResponse), deleteTargetSiteMetadata.decode.bind(deleteTargetSiteMetadata)),
|
283
|
+
enableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, enableAdvancedSiteSearchResponse.decode.bind(enableAdvancedSiteSearchResponse), enableAdvancedSiteSearchMetadata.decode.bind(enableAdvancedSiteSearchMetadata)),
|
284
|
+
disableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, disableAdvancedSiteSearchResponse.decode.bind(disableAdvancedSiteSearchResponse), disableAdvancedSiteSearchMetadata.decode.bind(disableAdvancedSiteSearchMetadata)),
|
249
285
|
recrawlUris: new this._gaxModule.LongrunningDescriptor(this.operationsClient, recrawlUrisResponse.decode.bind(recrawlUrisResponse), recrawlUrisMetadata.decode.bind(recrawlUrisMetadata)),
|
286
|
+
batchVerifyTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchVerifyTargetSitesResponse.decode.bind(batchVerifyTargetSitesResponse), batchVerifyTargetSitesMetadata.decode.bind(batchVerifyTargetSitesMetadata)),
|
250
287
|
};
|
251
288
|
// Put together the default options sent with requests.
|
252
289
|
this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.SiteSearchEngineService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
|
@@ -282,7 +319,20 @@ class SiteSearchEngineServiceClient {
|
|
282
319
|
.SiteSearchEngineService, this._opts, this._providedCustomServicePath);
|
283
320
|
// Iterate over each of the methods that the service provides
|
284
321
|
// and create an API call method for each.
|
285
|
-
const siteSearchEngineServiceStubMethods = [
|
322
|
+
const siteSearchEngineServiceStubMethods = [
|
323
|
+
'getSiteSearchEngine',
|
324
|
+
'createTargetSite',
|
325
|
+
'batchCreateTargetSites',
|
326
|
+
'getTargetSite',
|
327
|
+
'updateTargetSite',
|
328
|
+
'deleteTargetSite',
|
329
|
+
'listTargetSites',
|
330
|
+
'enableAdvancedSiteSearch',
|
331
|
+
'disableAdvancedSiteSearch',
|
332
|
+
'recrawlUris',
|
333
|
+
'batchVerifyTargetSites',
|
334
|
+
'fetchDomainVerificationStatus',
|
335
|
+
];
|
286
336
|
for (const methodName of siteSearchEngineServiceStubMethods) {
|
287
337
|
const callPromise = this.siteSearchEngineServiceStub.then(stub => (...args) => {
|
288
338
|
if (this._terminated) {
|
@@ -293,7 +343,9 @@ class SiteSearchEngineServiceClient {
|
|
293
343
|
}, (err) => () => {
|
294
344
|
throw err;
|
295
345
|
});
|
296
|
-
const descriptor = this.descriptors.
|
346
|
+
const descriptor = this.descriptors.page[methodName] ||
|
347
|
+
this.descriptors.longrunning[methodName] ||
|
348
|
+
undefined;
|
297
349
|
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
|
298
350
|
this.innerApiCalls[methodName] = apiCall;
|
299
351
|
}
|
@@ -340,6 +392,276 @@ class SiteSearchEngineServiceClient {
|
|
340
392
|
}
|
341
393
|
return this.auth.getProjectId();
|
342
394
|
}
|
395
|
+
getSiteSearchEngine(request, optionsOrCallback, callback) {
|
396
|
+
var _a;
|
397
|
+
request = request || {};
|
398
|
+
let options;
|
399
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
400
|
+
callback = optionsOrCallback;
|
401
|
+
options = {};
|
402
|
+
}
|
403
|
+
else {
|
404
|
+
options = optionsOrCallback;
|
405
|
+
}
|
406
|
+
options = options || {};
|
407
|
+
options.otherArgs = options.otherArgs || {};
|
408
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
409
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
410
|
+
this._gaxModule.routingHeader.fromParams({
|
411
|
+
name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
|
412
|
+
});
|
413
|
+
this.initialize();
|
414
|
+
return this.innerApiCalls.getSiteSearchEngine(request, options, callback);
|
415
|
+
}
|
416
|
+
getTargetSite(request, optionsOrCallback, callback) {
|
417
|
+
var _a;
|
418
|
+
request = request || {};
|
419
|
+
let options;
|
420
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
421
|
+
callback = optionsOrCallback;
|
422
|
+
options = {};
|
423
|
+
}
|
424
|
+
else {
|
425
|
+
options = optionsOrCallback;
|
426
|
+
}
|
427
|
+
options = options || {};
|
428
|
+
options.otherArgs = options.otherArgs || {};
|
429
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
430
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
431
|
+
this._gaxModule.routingHeader.fromParams({
|
432
|
+
name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
|
433
|
+
});
|
434
|
+
this.initialize();
|
435
|
+
return this.innerApiCalls.getTargetSite(request, options, callback);
|
436
|
+
}
|
437
|
+
createTargetSite(request, optionsOrCallback, callback) {
|
438
|
+
var _a;
|
439
|
+
request = request || {};
|
440
|
+
let options;
|
441
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
442
|
+
callback = optionsOrCallback;
|
443
|
+
options = {};
|
444
|
+
}
|
445
|
+
else {
|
446
|
+
options = optionsOrCallback;
|
447
|
+
}
|
448
|
+
options = options || {};
|
449
|
+
options.otherArgs = options.otherArgs || {};
|
450
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
451
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
452
|
+
this._gaxModule.routingHeader.fromParams({
|
453
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
454
|
+
});
|
455
|
+
this.initialize();
|
456
|
+
return this.innerApiCalls.createTargetSite(request, options, callback);
|
457
|
+
}
|
458
|
+
/**
|
459
|
+
* Check the status of the long running operation returned by `createTargetSite()`.
|
460
|
+
* @param {String} name
|
461
|
+
* The operation name that will be passed.
|
462
|
+
* @returns {Promise} - The promise which resolves to an object.
|
463
|
+
* The decoded operation object has result and metadata field to get information from.
|
464
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
465
|
+
* for more details and examples.
|
466
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.create_target_site.js</caption>
|
467
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_async
|
468
|
+
*/
|
469
|
+
async checkCreateTargetSiteProgress(name) {
|
470
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
471
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
472
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createTargetSite, this._gaxModule.createDefaultBackoffSettings());
|
473
|
+
return decodeOperation;
|
474
|
+
}
|
475
|
+
batchCreateTargetSites(request, optionsOrCallback, callback) {
|
476
|
+
var _a;
|
477
|
+
request = request || {};
|
478
|
+
let options;
|
479
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
480
|
+
callback = optionsOrCallback;
|
481
|
+
options = {};
|
482
|
+
}
|
483
|
+
else {
|
484
|
+
options = optionsOrCallback;
|
485
|
+
}
|
486
|
+
options = options || {};
|
487
|
+
options.otherArgs = options.otherArgs || {};
|
488
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
489
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
490
|
+
this._gaxModule.routingHeader.fromParams({
|
491
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
492
|
+
});
|
493
|
+
this.initialize();
|
494
|
+
return this.innerApiCalls.batchCreateTargetSites(request, options, callback);
|
495
|
+
}
|
496
|
+
/**
|
497
|
+
* Check the status of the long running operation returned by `batchCreateTargetSites()`.
|
498
|
+
* @param {String} name
|
499
|
+
* The operation name that will be passed.
|
500
|
+
* @returns {Promise} - The promise which resolves to an object.
|
501
|
+
* The decoded operation object has result and metadata field to get information from.
|
502
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
503
|
+
* for more details and examples.
|
504
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js</caption>
|
505
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_async
|
506
|
+
*/
|
507
|
+
async checkBatchCreateTargetSitesProgress(name) {
|
508
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
509
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
510
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchCreateTargetSites, this._gaxModule.createDefaultBackoffSettings());
|
511
|
+
return decodeOperation;
|
512
|
+
}
|
513
|
+
updateTargetSite(request, optionsOrCallback, callback) {
|
514
|
+
var _a;
|
515
|
+
request = request || {};
|
516
|
+
let options;
|
517
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
518
|
+
callback = optionsOrCallback;
|
519
|
+
options = {};
|
520
|
+
}
|
521
|
+
else {
|
522
|
+
options = optionsOrCallback;
|
523
|
+
}
|
524
|
+
options = options || {};
|
525
|
+
options.otherArgs = options.otherArgs || {};
|
526
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
527
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
528
|
+
this._gaxModule.routingHeader.fromParams({
|
529
|
+
'target_site.name': (_a = request.targetSite.name) !== null && _a !== void 0 ? _a : '',
|
530
|
+
});
|
531
|
+
this.initialize();
|
532
|
+
return this.innerApiCalls.updateTargetSite(request, options, callback);
|
533
|
+
}
|
534
|
+
/**
|
535
|
+
* Check the status of the long running operation returned by `updateTargetSite()`.
|
536
|
+
* @param {String} name
|
537
|
+
* The operation name that will be passed.
|
538
|
+
* @returns {Promise} - The promise which resolves to an object.
|
539
|
+
* The decoded operation object has result and metadata field to get information from.
|
540
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
541
|
+
* for more details and examples.
|
542
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.update_target_site.js</caption>
|
543
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_async
|
544
|
+
*/
|
545
|
+
async checkUpdateTargetSiteProgress(name) {
|
546
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
547
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
548
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.updateTargetSite, this._gaxModule.createDefaultBackoffSettings());
|
549
|
+
return decodeOperation;
|
550
|
+
}
|
551
|
+
deleteTargetSite(request, optionsOrCallback, callback) {
|
552
|
+
var _a;
|
553
|
+
request = request || {};
|
554
|
+
let options;
|
555
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
556
|
+
callback = optionsOrCallback;
|
557
|
+
options = {};
|
558
|
+
}
|
559
|
+
else {
|
560
|
+
options = optionsOrCallback;
|
561
|
+
}
|
562
|
+
options = options || {};
|
563
|
+
options.otherArgs = options.otherArgs || {};
|
564
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
565
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
566
|
+
this._gaxModule.routingHeader.fromParams({
|
567
|
+
name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
|
568
|
+
});
|
569
|
+
this.initialize();
|
570
|
+
return this.innerApiCalls.deleteTargetSite(request, options, callback);
|
571
|
+
}
|
572
|
+
/**
|
573
|
+
* Check the status of the long running operation returned by `deleteTargetSite()`.
|
574
|
+
* @param {String} name
|
575
|
+
* The operation name that will be passed.
|
576
|
+
* @returns {Promise} - The promise which resolves to an object.
|
577
|
+
* The decoded operation object has result and metadata field to get information from.
|
578
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
579
|
+
* for more details and examples.
|
580
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.delete_target_site.js</caption>
|
581
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_async
|
582
|
+
*/
|
583
|
+
async checkDeleteTargetSiteProgress(name) {
|
584
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
585
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
586
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.deleteTargetSite, this._gaxModule.createDefaultBackoffSettings());
|
587
|
+
return decodeOperation;
|
588
|
+
}
|
589
|
+
enableAdvancedSiteSearch(request, optionsOrCallback, callback) {
|
590
|
+
var _a;
|
591
|
+
request = request || {};
|
592
|
+
let options;
|
593
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
594
|
+
callback = optionsOrCallback;
|
595
|
+
options = {};
|
596
|
+
}
|
597
|
+
else {
|
598
|
+
options = optionsOrCallback;
|
599
|
+
}
|
600
|
+
options = options || {};
|
601
|
+
options.otherArgs = options.otherArgs || {};
|
602
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
603
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
604
|
+
this._gaxModule.routingHeader.fromParams({
|
605
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
606
|
+
});
|
607
|
+
this.initialize();
|
608
|
+
return this.innerApiCalls.enableAdvancedSiteSearch(request, options, callback);
|
609
|
+
}
|
610
|
+
/**
|
611
|
+
* Check the status of the long running operation returned by `enableAdvancedSiteSearch()`.
|
612
|
+
* @param {String} name
|
613
|
+
* The operation name that will be passed.
|
614
|
+
* @returns {Promise} - The promise which resolves to an object.
|
615
|
+
* The decoded operation object has result and metadata field to get information from.
|
616
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
617
|
+
* for more details and examples.
|
618
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js</caption>
|
619
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
|
620
|
+
*/
|
621
|
+
async checkEnableAdvancedSiteSearchProgress(name) {
|
622
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
623
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
624
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.enableAdvancedSiteSearch, this._gaxModule.createDefaultBackoffSettings());
|
625
|
+
return decodeOperation;
|
626
|
+
}
|
627
|
+
disableAdvancedSiteSearch(request, optionsOrCallback, callback) {
|
628
|
+
var _a;
|
629
|
+
request = request || {};
|
630
|
+
let options;
|
631
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
632
|
+
callback = optionsOrCallback;
|
633
|
+
options = {};
|
634
|
+
}
|
635
|
+
else {
|
636
|
+
options = optionsOrCallback;
|
637
|
+
}
|
638
|
+
options = options || {};
|
639
|
+
options.otherArgs = options.otherArgs || {};
|
640
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
641
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
642
|
+
this._gaxModule.routingHeader.fromParams({
|
643
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
644
|
+
});
|
645
|
+
this.initialize();
|
646
|
+
return this.innerApiCalls.disableAdvancedSiteSearch(request, options, callback);
|
647
|
+
}
|
648
|
+
/**
|
649
|
+
* Check the status of the long running operation returned by `disableAdvancedSiteSearch()`.
|
650
|
+
* @param {String} name
|
651
|
+
* The operation name that will be passed.
|
652
|
+
* @returns {Promise} - The promise which resolves to an object.
|
653
|
+
* The decoded operation object has result and metadata field to get information from.
|
654
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
655
|
+
* for more details and examples.
|
656
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js</caption>
|
657
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
|
658
|
+
*/
|
659
|
+
async checkDisableAdvancedSiteSearchProgress(name) {
|
660
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
661
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
662
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.disableAdvancedSiteSearch, this._gaxModule.createDefaultBackoffSettings());
|
663
|
+
return decodeOperation;
|
664
|
+
}
|
343
665
|
recrawlUris(request, optionsOrCallback, callback) {
|
344
666
|
var _a;
|
345
667
|
request = request || {};
|
@@ -378,6 +700,286 @@ class SiteSearchEngineServiceClient {
|
|
378
700
|
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.recrawlUris, this._gaxModule.createDefaultBackoffSettings());
|
379
701
|
return decodeOperation;
|
380
702
|
}
|
703
|
+
batchVerifyTargetSites(request, optionsOrCallback, callback) {
|
704
|
+
var _a;
|
705
|
+
request = request || {};
|
706
|
+
let options;
|
707
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
708
|
+
callback = optionsOrCallback;
|
709
|
+
options = {};
|
710
|
+
}
|
711
|
+
else {
|
712
|
+
options = optionsOrCallback;
|
713
|
+
}
|
714
|
+
options = options || {};
|
715
|
+
options.otherArgs = options.otherArgs || {};
|
716
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
717
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
718
|
+
this._gaxModule.routingHeader.fromParams({
|
719
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
720
|
+
});
|
721
|
+
this.initialize();
|
722
|
+
return this.innerApiCalls.batchVerifyTargetSites(request, options, callback);
|
723
|
+
}
|
724
|
+
/**
|
725
|
+
* Check the status of the long running operation returned by `batchVerifyTargetSites()`.
|
726
|
+
* @param {String} name
|
727
|
+
* The operation name that will be passed.
|
728
|
+
* @returns {Promise} - The promise which resolves to an object.
|
729
|
+
* The decoded operation object has result and metadata field to get information from.
|
730
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
731
|
+
* for more details and examples.
|
732
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js</caption>
|
733
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
|
734
|
+
*/
|
735
|
+
async checkBatchVerifyTargetSitesProgress(name) {
|
736
|
+
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
|
737
|
+
const [operation] = await this.operationsClient.getOperation(request);
|
738
|
+
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchVerifyTargetSites, this._gaxModule.createDefaultBackoffSettings());
|
739
|
+
return decodeOperation;
|
740
|
+
}
|
741
|
+
listTargetSites(request, optionsOrCallback, callback) {
|
742
|
+
var _a;
|
743
|
+
request = request || {};
|
744
|
+
let options;
|
745
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
746
|
+
callback = optionsOrCallback;
|
747
|
+
options = {};
|
748
|
+
}
|
749
|
+
else {
|
750
|
+
options = optionsOrCallback;
|
751
|
+
}
|
752
|
+
options = options || {};
|
753
|
+
options.otherArgs = options.otherArgs || {};
|
754
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
755
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
756
|
+
this._gaxModule.routingHeader.fromParams({
|
757
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
758
|
+
});
|
759
|
+
this.initialize();
|
760
|
+
return this.innerApiCalls.listTargetSites(request, options, callback);
|
761
|
+
}
|
762
|
+
/**
|
763
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
764
|
+
* @param {Object} request
|
765
|
+
* The request object that will be sent.
|
766
|
+
* @param {string} request.parent
|
767
|
+
* Required. The parent site search engine resource name, such as
|
768
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
769
|
+
*
|
770
|
+
* If the caller does not have permission to list
|
771
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
|
772
|
+
* site search engine, regardless of whether or not this branch exists, a
|
773
|
+
* PERMISSION_DENIED error is returned.
|
774
|
+
* @param {number} request.pageSize
|
775
|
+
* Requested page size. Server may return fewer items than requested. If
|
776
|
+
* unspecified, server will pick an appropriate default. The maximum value is
|
777
|
+
* 1000; values above 1000 will be coerced to 1000.
|
778
|
+
*
|
779
|
+
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
780
|
+
* @param {string} request.pageToken
|
781
|
+
* A page token, received from a previous `ListTargetSites` call.
|
782
|
+
* Provide this to retrieve the subsequent page.
|
783
|
+
*
|
784
|
+
* When paginating, all other parameters provided to `ListTargetSites`
|
785
|
+
* must match the call that provided the page token.
|
786
|
+
* @param {object} [options]
|
787
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
788
|
+
* @returns {Stream}
|
789
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
|
790
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
791
|
+
* times as needed. Note that it can affect your quota.
|
792
|
+
* We recommend using `listTargetSitesAsync()`
|
793
|
+
* method described below for async iteration which you can stop as needed.
|
794
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
795
|
+
* for more details and examples.
|
796
|
+
*/
|
797
|
+
listTargetSitesStream(request, options) {
|
798
|
+
var _a;
|
799
|
+
request = request || {};
|
800
|
+
options = options || {};
|
801
|
+
options.otherArgs = options.otherArgs || {};
|
802
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
803
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
804
|
+
this._gaxModule.routingHeader.fromParams({
|
805
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
806
|
+
});
|
807
|
+
const defaultCallSettings = this._defaults['listTargetSites'];
|
808
|
+
const callSettings = defaultCallSettings.merge(options);
|
809
|
+
this.initialize();
|
810
|
+
return this.descriptors.page.listTargetSites.createStream(this.innerApiCalls.listTargetSites, request, callSettings);
|
811
|
+
}
|
812
|
+
/**
|
813
|
+
* Equivalent to `listTargetSites`, but returns an iterable object.
|
814
|
+
*
|
815
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
816
|
+
* @param {Object} request
|
817
|
+
* The request object that will be sent.
|
818
|
+
* @param {string} request.parent
|
819
|
+
* Required. The parent site search engine resource name, such as
|
820
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
821
|
+
*
|
822
|
+
* If the caller does not have permission to list
|
823
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
|
824
|
+
* site search engine, regardless of whether or not this branch exists, a
|
825
|
+
* PERMISSION_DENIED error is returned.
|
826
|
+
* @param {number} request.pageSize
|
827
|
+
* Requested page size. Server may return fewer items than requested. If
|
828
|
+
* unspecified, server will pick an appropriate default. The maximum value is
|
829
|
+
* 1000; values above 1000 will be coerced to 1000.
|
830
|
+
*
|
831
|
+
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
832
|
+
* @param {string} request.pageToken
|
833
|
+
* A page token, received from a previous `ListTargetSites` call.
|
834
|
+
* Provide this to retrieve the subsequent page.
|
835
|
+
*
|
836
|
+
* When paginating, all other parameters provided to `ListTargetSites`
|
837
|
+
* must match the call that provided the page token.
|
838
|
+
* @param {object} [options]
|
839
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
840
|
+
* @returns {Object}
|
841
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
842
|
+
* When you iterate the returned iterable, each element will be an object representing
|
843
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
|
844
|
+
* so you can stop the iteration when you don't need more results.
|
845
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
846
|
+
* for more details and examples.
|
847
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.list_target_sites.js</caption>
|
848
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_ListTargetSites_async
|
849
|
+
*/
|
850
|
+
listTargetSitesAsync(request, options) {
|
851
|
+
var _a;
|
852
|
+
request = request || {};
|
853
|
+
options = options || {};
|
854
|
+
options.otherArgs = options.otherArgs || {};
|
855
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
856
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
857
|
+
this._gaxModule.routingHeader.fromParams({
|
858
|
+
parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
|
859
|
+
});
|
860
|
+
const defaultCallSettings = this._defaults['listTargetSites'];
|
861
|
+
const callSettings = defaultCallSettings.merge(options);
|
862
|
+
this.initialize();
|
863
|
+
return this.descriptors.page.listTargetSites.asyncIterate(this.innerApiCalls['listTargetSites'], request, callSettings);
|
864
|
+
}
|
865
|
+
fetchDomainVerificationStatus(request, optionsOrCallback, callback) {
|
866
|
+
var _a;
|
867
|
+
request = request || {};
|
868
|
+
let options;
|
869
|
+
if (typeof optionsOrCallback === 'function' && callback === undefined) {
|
870
|
+
callback = optionsOrCallback;
|
871
|
+
options = {};
|
872
|
+
}
|
873
|
+
else {
|
874
|
+
options = optionsOrCallback;
|
875
|
+
}
|
876
|
+
options = options || {};
|
877
|
+
options.otherArgs = options.otherArgs || {};
|
878
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
879
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
880
|
+
this._gaxModule.routingHeader.fromParams({
|
881
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
882
|
+
});
|
883
|
+
this.initialize();
|
884
|
+
return this.innerApiCalls.fetchDomainVerificationStatus(request, options, callback);
|
885
|
+
}
|
886
|
+
/**
|
887
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
888
|
+
* @param {Object} request
|
889
|
+
* The request object that will be sent.
|
890
|
+
* @param {string} request.siteSearchEngine
|
891
|
+
* Required. The site search engine resource under which we fetch all the
|
892
|
+
* domain verification status.
|
893
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
894
|
+
* @param {number} request.pageSize
|
895
|
+
* Requested page size. Server may return fewer items than requested. If
|
896
|
+
* unspecified, server will pick an appropriate default. The maximum value is
|
897
|
+
* 1000; values above 1000 will be coerced to 1000.
|
898
|
+
*
|
899
|
+
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
900
|
+
* @param {string} request.pageToken
|
901
|
+
* A page token, received from a previous `FetchDomainVerificationStatus`
|
902
|
+
* call. Provide this to retrieve the subsequent page.
|
903
|
+
*
|
904
|
+
* When paginating, all other parameters provided to
|
905
|
+
* `FetchDomainVerificationStatus` must match the call that provided the page
|
906
|
+
* token.
|
907
|
+
* @param {object} [options]
|
908
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
909
|
+
* @returns {Stream}
|
910
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
|
911
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
912
|
+
* times as needed. Note that it can affect your quota.
|
913
|
+
* We recommend using `fetchDomainVerificationStatusAsync()`
|
914
|
+
* method described below for async iteration which you can stop as needed.
|
915
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
916
|
+
* for more details and examples.
|
917
|
+
*/
|
918
|
+
fetchDomainVerificationStatusStream(request, options) {
|
919
|
+
var _a;
|
920
|
+
request = request || {};
|
921
|
+
options = options || {};
|
922
|
+
options.otherArgs = options.otherArgs || {};
|
923
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
924
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
925
|
+
this._gaxModule.routingHeader.fromParams({
|
926
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
927
|
+
});
|
928
|
+
const defaultCallSettings = this._defaults['fetchDomainVerificationStatus'];
|
929
|
+
const callSettings = defaultCallSettings.merge(options);
|
930
|
+
this.initialize();
|
931
|
+
return this.descriptors.page.fetchDomainVerificationStatus.createStream(this.innerApiCalls.fetchDomainVerificationStatus, request, callSettings);
|
932
|
+
}
|
933
|
+
/**
|
934
|
+
* Equivalent to `fetchDomainVerificationStatus`, but returns an iterable object.
|
935
|
+
*
|
936
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
937
|
+
* @param {Object} request
|
938
|
+
* The request object that will be sent.
|
939
|
+
* @param {string} request.siteSearchEngine
|
940
|
+
* Required. The site search engine resource under which we fetch all the
|
941
|
+
* domain verification status.
|
942
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
|
943
|
+
* @param {number} request.pageSize
|
944
|
+
* Requested page size. Server may return fewer items than requested. If
|
945
|
+
* unspecified, server will pick an appropriate default. The maximum value is
|
946
|
+
* 1000; values above 1000 will be coerced to 1000.
|
947
|
+
*
|
948
|
+
* If this field is negative, an INVALID_ARGUMENT error is returned.
|
949
|
+
* @param {string} request.pageToken
|
950
|
+
* A page token, received from a previous `FetchDomainVerificationStatus`
|
951
|
+
* call. Provide this to retrieve the subsequent page.
|
952
|
+
*
|
953
|
+
* When paginating, all other parameters provided to
|
954
|
+
* `FetchDomainVerificationStatus` must match the call that provided the page
|
955
|
+
* token.
|
956
|
+
* @param {object} [options]
|
957
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
958
|
+
* @returns {Object}
|
959
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
960
|
+
* When you iterate the returned iterable, each element will be an object representing
|
961
|
+
* {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
|
962
|
+
* so you can stop the iteration when you don't need more results.
|
963
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
964
|
+
* for more details and examples.
|
965
|
+
* @example <caption>include:samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js</caption>
|
966
|
+
* region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async
|
967
|
+
*/
|
968
|
+
fetchDomainVerificationStatusAsync(request, options) {
|
969
|
+
var _a;
|
970
|
+
request = request || {};
|
971
|
+
options = options || {};
|
972
|
+
options.otherArgs = options.otherArgs || {};
|
973
|
+
options.otherArgs.headers = options.otherArgs.headers || {};
|
974
|
+
options.otherArgs.headers['x-goog-request-params'] =
|
975
|
+
this._gaxModule.routingHeader.fromParams({
|
976
|
+
site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
|
977
|
+
});
|
978
|
+
const defaultCallSettings = this._defaults['fetchDomainVerificationStatus'];
|
979
|
+
const callSettings = defaultCallSettings.merge(options);
|
980
|
+
this.initialize();
|
981
|
+
return this.descriptors.page.fetchDomainVerificationStatus.asyncIterate(this.innerApiCalls['fetchDomainVerificationStatus'], request, callSettings);
|
982
|
+
}
|
381
983
|
/**
|
382
984
|
* Gets information about a location.
|
383
985
|
*
|
@@ -954,6 +1556,144 @@ class SiteSearchEngineServiceClient {
|
|
954
1556
|
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
|
955
1557
|
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
|
956
1558
|
}
|
1559
|
+
/**
|
1560
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
|
1561
|
+
*
|
1562
|
+
* @param {string} project
|
1563
|
+
* @param {string} location
|
1564
|
+
* @param {string} collection
|
1565
|
+
* @param {string} data_store
|
1566
|
+
* @param {string} target_site
|
1567
|
+
* @returns {string} Resource name string.
|
1568
|
+
*/
|
1569
|
+
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
|
1570
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
|
1571
|
+
project: project,
|
1572
|
+
location: location,
|
1573
|
+
collection: collection,
|
1574
|
+
data_store: dataStore,
|
1575
|
+
target_site: targetSite,
|
1576
|
+
});
|
1577
|
+
}
|
1578
|
+
/**
|
1579
|
+
* Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1580
|
+
*
|
1581
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1582
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1583
|
+
* @returns {string} A string representing the project.
|
1584
|
+
*/
|
1585
|
+
matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1586
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
|
1587
|
+
}
|
1588
|
+
/**
|
1589
|
+
* Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1590
|
+
*
|
1591
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1592
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1593
|
+
* @returns {string} A string representing the location.
|
1594
|
+
*/
|
1595
|
+
matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1596
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
|
1597
|
+
}
|
1598
|
+
/**
|
1599
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1600
|
+
*
|
1601
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1602
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1603
|
+
* @returns {string} A string representing the collection.
|
1604
|
+
*/
|
1605
|
+
matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1606
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
|
1607
|
+
}
|
1608
|
+
/**
|
1609
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1610
|
+
*
|
1611
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1612
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1613
|
+
* @returns {string} A string representing the data_store.
|
1614
|
+
*/
|
1615
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1616
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
|
1617
|
+
}
|
1618
|
+
/**
|
1619
|
+
* Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1620
|
+
*
|
1621
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1622
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1623
|
+
* @returns {string} A string representing the target_site.
|
1624
|
+
*/
|
1625
|
+
matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1626
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
|
1627
|
+
}
|
1628
|
+
/**
|
1629
|
+
* Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
|
1630
|
+
*
|
1631
|
+
* @param {string} project
|
1632
|
+
* @param {string} location
|
1633
|
+
* @param {string} collection
|
1634
|
+
* @param {string} engine
|
1635
|
+
* @param {string} conversation
|
1636
|
+
* @returns {string} Resource name string.
|
1637
|
+
*/
|
1638
|
+
projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
|
1639
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
|
1640
|
+
project: project,
|
1641
|
+
location: location,
|
1642
|
+
collection: collection,
|
1643
|
+
engine: engine,
|
1644
|
+
conversation: conversation,
|
1645
|
+
});
|
1646
|
+
}
|
1647
|
+
/**
|
1648
|
+
* Parse the project from ProjectLocationCollectionEngineConversation resource.
|
1649
|
+
*
|
1650
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1651
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1652
|
+
* @returns {string} A string representing the project.
|
1653
|
+
*/
|
1654
|
+
matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1655
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
|
1656
|
+
}
|
1657
|
+
/**
|
1658
|
+
* Parse the location from ProjectLocationCollectionEngineConversation resource.
|
1659
|
+
*
|
1660
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1661
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1662
|
+
* @returns {string} A string representing the location.
|
1663
|
+
*/
|
1664
|
+
matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1665
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
|
1666
|
+
}
|
1667
|
+
/**
|
1668
|
+
* Parse the collection from ProjectLocationCollectionEngineConversation resource.
|
1669
|
+
*
|
1670
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1671
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1672
|
+
* @returns {string} A string representing the collection.
|
1673
|
+
*/
|
1674
|
+
matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1675
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
|
1676
|
+
}
|
1677
|
+
/**
|
1678
|
+
* Parse the engine from ProjectLocationCollectionEngineConversation resource.
|
1679
|
+
*
|
1680
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1681
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1682
|
+
* @returns {string} A string representing the engine.
|
1683
|
+
*/
|
1684
|
+
matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1685
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
|
1686
|
+
}
|
1687
|
+
/**
|
1688
|
+
* Parse the conversation from ProjectLocationCollectionEngineConversation resource.
|
1689
|
+
*
|
1690
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1691
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1692
|
+
* @returns {string} A string representing the conversation.
|
1693
|
+
*/
|
1694
|
+
matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1695
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
|
1696
|
+
}
|
957
1697
|
/**
|
958
1698
|
* Return a fully-qualified projectLocationDataStore resource name string.
|
959
1699
|
*
|
@@ -1227,6 +1967,63 @@ class SiteSearchEngineServiceClient {
|
|
1227
1967
|
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
|
1228
1968
|
return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
|
1229
1969
|
}
|
1970
|
+
/**
|
1971
|
+
* Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
|
1972
|
+
*
|
1973
|
+
* @param {string} project
|
1974
|
+
* @param {string} location
|
1975
|
+
* @param {string} data_store
|
1976
|
+
* @param {string} target_site
|
1977
|
+
* @returns {string} Resource name string.
|
1978
|
+
*/
|
1979
|
+
projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
|
1980
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
|
1981
|
+
project: project,
|
1982
|
+
location: location,
|
1983
|
+
data_store: dataStore,
|
1984
|
+
target_site: targetSite,
|
1985
|
+
});
|
1986
|
+
}
|
1987
|
+
/**
|
1988
|
+
* Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1989
|
+
*
|
1990
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1991
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1992
|
+
* @returns {string} A string representing the project.
|
1993
|
+
*/
|
1994
|
+
matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
1995
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
|
1996
|
+
}
|
1997
|
+
/**
|
1998
|
+
* Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1999
|
+
*
|
2000
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
2001
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
2002
|
+
* @returns {string} A string representing the location.
|
2003
|
+
*/
|
2004
|
+
matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2005
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
|
2006
|
+
}
|
2007
|
+
/**
|
2008
|
+
* Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
2009
|
+
*
|
2010
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
2011
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
2012
|
+
* @returns {string} A string representing the data_store.
|
2013
|
+
*/
|
2014
|
+
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2015
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
|
2016
|
+
}
|
2017
|
+
/**
|
2018
|
+
* Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
2019
|
+
*
|
2020
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
2021
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
2022
|
+
* @returns {string} A string representing the target_site.
|
2023
|
+
*/
|
2024
|
+
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
2025
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
2026
|
+
}
|
1230
2027
|
/**
|
1231
2028
|
* Terminate the gRPC channel and close the client.
|
1232
2029
|
*
|