@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,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -72,7 +72,7 @@ class SiteSearchEngineServiceClient {
72
72
  * ```
73
73
  */
74
74
  constructor(opts, gaxInstance) {
75
- var _a, _b;
75
+ var _a, _b, _c, _d;
76
76
  this._terminated = false;
77
77
  this.descriptors = {
78
78
  page: {},
@@ -83,16 +83,24 @@ class SiteSearchEngineServiceClient {
83
83
  // Ensure that options include all the required fields.
84
84
  const staticMembers = this
85
85
  .constructor;
86
- const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
86
+ if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
87
+ (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
88
+ (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
89
+ throw new Error('Please set either universe_domain or universeDomain, but not both.');
90
+ }
91
+ this._universeDomain =
92
+ (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
93
+ this._servicePath = 'discoveryengine.' + this._universeDomain;
94
+ const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
87
95
  this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
88
96
  const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
89
- const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
90
- const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
97
+ const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
98
+ const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
91
99
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
92
100
  // Request numeric enum values if REST transport is used.
93
101
  opts.numericEnums = true;
94
102
  // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
95
- if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
103
+ if (servicePath !== this._servicePath && !('scopes' in opts)) {
96
104
  opts['scopes'] = staticMembers.scopes;
97
105
  }
98
106
  // Load google-gax module synchronously if needed
@@ -110,9 +118,9 @@ class SiteSearchEngineServiceClient {
110
118
  // Set useJWTAccessWithScope on the auth object.
111
119
  this.auth.useJWTAccessWithScope = true;
112
120
  // Set defaultServicePath on the auth object.
113
- this.auth.defaultServicePath = staticMembers.servicePath;
121
+ this.auth.defaultServicePath = this._servicePath;
114
122
  // Set the default scopes in auth client if needed.
115
- if (servicePath === staticMembers.servicePath) {
123
+ if (servicePath === this._servicePath) {
116
124
  this.auth.defaultScopes = staticMembers.scopes;
117
125
  }
118
126
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
@@ -145,11 +153,21 @@ class SiteSearchEngineServiceClient {
145
153
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
146
154
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
147
155
  projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
156
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
157
+ projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
148
158
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
149
159
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
150
160
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
151
161
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
152
162
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
163
+ projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
164
+ };
165
+ // Some of the methods on this service return "paged" results,
166
+ // (e.g. 50 results at a time, with tokens to get subsequent
167
+ // pages). Denote the keys used for pagination and results.
168
+ this.descriptors.page = {
169
+ listTargetSites: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'targetSites'),
170
+ fetchDomainVerificationStatus: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'targetSites'),
153
171
  };
154
172
  const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
155
173
  // This API contains "long-running operations", which return a
@@ -164,8 +182,11 @@ class SiteSearchEngineServiceClient {
164
182
  lroOptions.httpRules = [
165
183
  {
166
184
  selector: 'google.longrunning.Operations.GetOperation',
167
- get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}',
185
+ get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}',
168
186
  additional_bindings: [
187
+ {
188
+ get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}',
189
+ },
169
190
  {
170
191
  get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}',
171
192
  },
@@ -202,8 +223,11 @@ class SiteSearchEngineServiceClient {
202
223
  },
203
224
  {
204
225
  selector: 'google.longrunning.Operations.ListOperations',
205
- get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations',
226
+ get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}/operations',
206
227
  additional_bindings: [
228
+ {
229
+ get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations',
230
+ },
207
231
  {
208
232
  get: '/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
209
233
  },
@@ -243,10 +267,31 @@ class SiteSearchEngineServiceClient {
243
267
  this.operationsClient = this._gaxModule
244
268
  .lro(lroOptions)
245
269
  .operationsClient(opts);
270
+ const createTargetSiteResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.TargetSite');
271
+ const createTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.CreateTargetSiteMetadata');
272
+ const batchCreateTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSitesResponse');
273
+ const batchCreateTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchCreateTargetSiteMetadata');
274
+ const updateTargetSiteResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.TargetSite');
275
+ const updateTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.UpdateTargetSiteMetadata');
276
+ const deleteTargetSiteResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
277
+ const deleteTargetSiteMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DeleteTargetSiteMetadata');
278
+ const enableAdvancedSiteSearchResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchResponse');
279
+ const enableAdvancedSiteSearchMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.EnableAdvancedSiteSearchMetadata');
280
+ const disableAdvancedSiteSearchResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchResponse');
281
+ const disableAdvancedSiteSearchMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.DisableAdvancedSiteSearchMetadata');
246
282
  const recrawlUrisResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisResponse');
247
283
  const recrawlUrisMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata');
284
+ const batchVerifyTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse');
285
+ const batchVerifyTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata');
248
286
  this.descriptors.longrunning = {
287
+ createTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createTargetSiteResponse.decode.bind(createTargetSiteResponse), createTargetSiteMetadata.decode.bind(createTargetSiteMetadata)),
288
+ batchCreateTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchCreateTargetSitesResponse.decode.bind(batchCreateTargetSitesResponse), batchCreateTargetSitesMetadata.decode.bind(batchCreateTargetSitesMetadata)),
289
+ updateTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateTargetSiteResponse.decode.bind(updateTargetSiteResponse), updateTargetSiteMetadata.decode.bind(updateTargetSiteMetadata)),
290
+ deleteTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteTargetSiteResponse.decode.bind(deleteTargetSiteResponse), deleteTargetSiteMetadata.decode.bind(deleteTargetSiteMetadata)),
291
+ enableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, enableAdvancedSiteSearchResponse.decode.bind(enableAdvancedSiteSearchResponse), enableAdvancedSiteSearchMetadata.decode.bind(enableAdvancedSiteSearchMetadata)),
292
+ disableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, disableAdvancedSiteSearchResponse.decode.bind(disableAdvancedSiteSearchResponse), disableAdvancedSiteSearchMetadata.decode.bind(disableAdvancedSiteSearchMetadata)),
249
293
  recrawlUris: new this._gaxModule.LongrunningDescriptor(this.operationsClient, recrawlUrisResponse.decode.bind(recrawlUrisResponse), recrawlUrisMetadata.decode.bind(recrawlUrisMetadata)),
294
+ batchVerifyTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchVerifyTargetSitesResponse.decode.bind(batchVerifyTargetSitesResponse), batchVerifyTargetSitesMetadata.decode.bind(batchVerifyTargetSitesMetadata)),
250
295
  };
251
296
  // Put together the default options sent with requests.
252
297
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.SiteSearchEngineService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -282,7 +327,20 @@ class SiteSearchEngineServiceClient {
282
327
  .SiteSearchEngineService, this._opts, this._providedCustomServicePath);
283
328
  // Iterate over each of the methods that the service provides
284
329
  // and create an API call method for each.
285
- const siteSearchEngineServiceStubMethods = ['recrawlUris'];
330
+ const siteSearchEngineServiceStubMethods = [
331
+ 'getSiteSearchEngine',
332
+ 'createTargetSite',
333
+ 'batchCreateTargetSites',
334
+ 'getTargetSite',
335
+ 'updateTargetSite',
336
+ 'deleteTargetSite',
337
+ 'listTargetSites',
338
+ 'enableAdvancedSiteSearch',
339
+ 'disableAdvancedSiteSearch',
340
+ 'recrawlUris',
341
+ 'batchVerifyTargetSites',
342
+ 'fetchDomainVerificationStatus',
343
+ ];
286
344
  for (const methodName of siteSearchEngineServiceStubMethods) {
287
345
  const callPromise = this.siteSearchEngineServiceStub.then(stub => (...args) => {
288
346
  if (this._terminated) {
@@ -293,7 +351,9 @@ class SiteSearchEngineServiceClient {
293
351
  }, (err) => () => {
294
352
  throw err;
295
353
  });
296
- const descriptor = this.descriptors.longrunning[methodName] || undefined;
354
+ const descriptor = this.descriptors.page[methodName] ||
355
+ this.descriptors.longrunning[methodName] ||
356
+ undefined;
297
357
  const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
298
358
  this.innerApiCalls[methodName] = apiCall;
299
359
  }
@@ -301,19 +361,38 @@ class SiteSearchEngineServiceClient {
301
361
  }
302
362
  /**
303
363
  * The DNS address for this API service.
364
+ * @deprecated Use the apiEndpoint method of the client instance.
304
365
  * @returns {string} The DNS address for this service.
305
366
  */
306
367
  static get servicePath() {
368
+ if (typeof process !== undefined &&
369
+ typeof process.emitWarning === 'function') {
370
+ process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
371
+ }
307
372
  return 'discoveryengine.googleapis.com';
308
373
  }
309
374
  /**
310
- * The DNS address for this API service - same as servicePath(),
311
- * exists for compatibility reasons.
375
+ * The DNS address for this API service - same as servicePath.
376
+ * @deprecated Use the apiEndpoint method of the client instance.
312
377
  * @returns {string} The DNS address for this service.
313
378
  */
314
379
  static get apiEndpoint() {
380
+ if (typeof process !== undefined &&
381
+ typeof process.emitWarning === 'function') {
382
+ process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
383
+ }
315
384
  return 'discoveryengine.googleapis.com';
316
385
  }
386
+ /**
387
+ * The DNS address for this API service.
388
+ * @returns {string} The DNS address for this service.
389
+ */
390
+ get apiEndpoint() {
391
+ return this._servicePath;
392
+ }
393
+ get universeDomain() {
394
+ return this._universeDomain;
395
+ }
317
396
  /**
318
397
  * The port for this API service.
319
398
  * @returns {number} The default port for this service.
@@ -340,6 +419,276 @@ class SiteSearchEngineServiceClient {
340
419
  }
341
420
  return this.auth.getProjectId();
342
421
  }
422
+ getSiteSearchEngine(request, optionsOrCallback, callback) {
423
+ var _a;
424
+ request = request || {};
425
+ let options;
426
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
427
+ callback = optionsOrCallback;
428
+ options = {};
429
+ }
430
+ else {
431
+ options = optionsOrCallback;
432
+ }
433
+ options = options || {};
434
+ options.otherArgs = options.otherArgs || {};
435
+ options.otherArgs.headers = options.otherArgs.headers || {};
436
+ options.otherArgs.headers['x-goog-request-params'] =
437
+ this._gaxModule.routingHeader.fromParams({
438
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
439
+ });
440
+ this.initialize();
441
+ return this.innerApiCalls.getSiteSearchEngine(request, options, callback);
442
+ }
443
+ getTargetSite(request, optionsOrCallback, callback) {
444
+ var _a;
445
+ request = request || {};
446
+ let options;
447
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
448
+ callback = optionsOrCallback;
449
+ options = {};
450
+ }
451
+ else {
452
+ options = optionsOrCallback;
453
+ }
454
+ options = options || {};
455
+ options.otherArgs = options.otherArgs || {};
456
+ options.otherArgs.headers = options.otherArgs.headers || {};
457
+ options.otherArgs.headers['x-goog-request-params'] =
458
+ this._gaxModule.routingHeader.fromParams({
459
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
460
+ });
461
+ this.initialize();
462
+ return this.innerApiCalls.getTargetSite(request, options, callback);
463
+ }
464
+ createTargetSite(request, optionsOrCallback, callback) {
465
+ var _a;
466
+ request = request || {};
467
+ let options;
468
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
469
+ callback = optionsOrCallback;
470
+ options = {};
471
+ }
472
+ else {
473
+ options = optionsOrCallback;
474
+ }
475
+ options = options || {};
476
+ options.otherArgs = options.otherArgs || {};
477
+ options.otherArgs.headers = options.otherArgs.headers || {};
478
+ options.otherArgs.headers['x-goog-request-params'] =
479
+ this._gaxModule.routingHeader.fromParams({
480
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
481
+ });
482
+ this.initialize();
483
+ return this.innerApiCalls.createTargetSite(request, options, callback);
484
+ }
485
+ /**
486
+ * Check the status of the long running operation returned by `createTargetSite()`.
487
+ * @param {String} name
488
+ * The operation name that will be passed.
489
+ * @returns {Promise} - The promise which resolves to an object.
490
+ * The decoded operation object has result and metadata field to get information from.
491
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
492
+ * for more details and examples.
493
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.create_target_site.js</caption>
494
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_CreateTargetSite_async
495
+ */
496
+ async checkCreateTargetSiteProgress(name) {
497
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
498
+ const [operation] = await this.operationsClient.getOperation(request);
499
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createTargetSite, this._gaxModule.createDefaultBackoffSettings());
500
+ return decodeOperation;
501
+ }
502
+ batchCreateTargetSites(request, optionsOrCallback, callback) {
503
+ var _a;
504
+ request = request || {};
505
+ let options;
506
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
507
+ callback = optionsOrCallback;
508
+ options = {};
509
+ }
510
+ else {
511
+ options = optionsOrCallback;
512
+ }
513
+ options = options || {};
514
+ options.otherArgs = options.otherArgs || {};
515
+ options.otherArgs.headers = options.otherArgs.headers || {};
516
+ options.otherArgs.headers['x-goog-request-params'] =
517
+ this._gaxModule.routingHeader.fromParams({
518
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
519
+ });
520
+ this.initialize();
521
+ return this.innerApiCalls.batchCreateTargetSites(request, options, callback);
522
+ }
523
+ /**
524
+ * Check the status of the long running operation returned by `batchCreateTargetSites()`.
525
+ * @param {String} name
526
+ * The operation name that will be passed.
527
+ * @returns {Promise} - The promise which resolves to an object.
528
+ * The decoded operation object has result and metadata field to get information from.
529
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
530
+ * for more details and examples.
531
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_create_target_sites.js</caption>
532
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchCreateTargetSites_async
533
+ */
534
+ async checkBatchCreateTargetSitesProgress(name) {
535
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
536
+ const [operation] = await this.operationsClient.getOperation(request);
537
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchCreateTargetSites, this._gaxModule.createDefaultBackoffSettings());
538
+ return decodeOperation;
539
+ }
540
+ updateTargetSite(request, optionsOrCallback, callback) {
541
+ var _a;
542
+ request = request || {};
543
+ let options;
544
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
545
+ callback = optionsOrCallback;
546
+ options = {};
547
+ }
548
+ else {
549
+ options = optionsOrCallback;
550
+ }
551
+ options = options || {};
552
+ options.otherArgs = options.otherArgs || {};
553
+ options.otherArgs.headers = options.otherArgs.headers || {};
554
+ options.otherArgs.headers['x-goog-request-params'] =
555
+ this._gaxModule.routingHeader.fromParams({
556
+ 'target_site.name': (_a = request.targetSite.name) !== null && _a !== void 0 ? _a : '',
557
+ });
558
+ this.initialize();
559
+ return this.innerApiCalls.updateTargetSite(request, options, callback);
560
+ }
561
+ /**
562
+ * Check the status of the long running operation returned by `updateTargetSite()`.
563
+ * @param {String} name
564
+ * The operation name that will be passed.
565
+ * @returns {Promise} - The promise which resolves to an object.
566
+ * The decoded operation object has result and metadata field to get information from.
567
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
568
+ * for more details and examples.
569
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.update_target_site.js</caption>
570
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_UpdateTargetSite_async
571
+ */
572
+ async checkUpdateTargetSiteProgress(name) {
573
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
574
+ const [operation] = await this.operationsClient.getOperation(request);
575
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.updateTargetSite, this._gaxModule.createDefaultBackoffSettings());
576
+ return decodeOperation;
577
+ }
578
+ deleteTargetSite(request, optionsOrCallback, callback) {
579
+ var _a;
580
+ request = request || {};
581
+ let options;
582
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
583
+ callback = optionsOrCallback;
584
+ options = {};
585
+ }
586
+ else {
587
+ options = optionsOrCallback;
588
+ }
589
+ options = options || {};
590
+ options.otherArgs = options.otherArgs || {};
591
+ options.otherArgs.headers = options.otherArgs.headers || {};
592
+ options.otherArgs.headers['x-goog-request-params'] =
593
+ this._gaxModule.routingHeader.fromParams({
594
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
595
+ });
596
+ this.initialize();
597
+ return this.innerApiCalls.deleteTargetSite(request, options, callback);
598
+ }
599
+ /**
600
+ * Check the status of the long running operation returned by `deleteTargetSite()`.
601
+ * @param {String} name
602
+ * The operation name that will be passed.
603
+ * @returns {Promise} - The promise which resolves to an object.
604
+ * The decoded operation object has result and metadata field to get information from.
605
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
606
+ * for more details and examples.
607
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.delete_target_site.js</caption>
608
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DeleteTargetSite_async
609
+ */
610
+ async checkDeleteTargetSiteProgress(name) {
611
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
612
+ const [operation] = await this.operationsClient.getOperation(request);
613
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.deleteTargetSite, this._gaxModule.createDefaultBackoffSettings());
614
+ return decodeOperation;
615
+ }
616
+ enableAdvancedSiteSearch(request, optionsOrCallback, callback) {
617
+ var _a;
618
+ request = request || {};
619
+ let options;
620
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
621
+ callback = optionsOrCallback;
622
+ options = {};
623
+ }
624
+ else {
625
+ options = optionsOrCallback;
626
+ }
627
+ options = options || {};
628
+ options.otherArgs = options.otherArgs || {};
629
+ options.otherArgs.headers = options.otherArgs.headers || {};
630
+ options.otherArgs.headers['x-goog-request-params'] =
631
+ this._gaxModule.routingHeader.fromParams({
632
+ site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
633
+ });
634
+ this.initialize();
635
+ return this.innerApiCalls.enableAdvancedSiteSearch(request, options, callback);
636
+ }
637
+ /**
638
+ * Check the status of the long running operation returned by `enableAdvancedSiteSearch()`.
639
+ * @param {String} name
640
+ * The operation name that will be passed.
641
+ * @returns {Promise} - The promise which resolves to an object.
642
+ * The decoded operation object has result and metadata field to get information from.
643
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
644
+ * for more details and examples.
645
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.enable_advanced_site_search.js</caption>
646
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_EnableAdvancedSiteSearch_async
647
+ */
648
+ async checkEnableAdvancedSiteSearchProgress(name) {
649
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
650
+ const [operation] = await this.operationsClient.getOperation(request);
651
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.enableAdvancedSiteSearch, this._gaxModule.createDefaultBackoffSettings());
652
+ return decodeOperation;
653
+ }
654
+ disableAdvancedSiteSearch(request, optionsOrCallback, callback) {
655
+ var _a;
656
+ request = request || {};
657
+ let options;
658
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
659
+ callback = optionsOrCallback;
660
+ options = {};
661
+ }
662
+ else {
663
+ options = optionsOrCallback;
664
+ }
665
+ options = options || {};
666
+ options.otherArgs = options.otherArgs || {};
667
+ options.otherArgs.headers = options.otherArgs.headers || {};
668
+ options.otherArgs.headers['x-goog-request-params'] =
669
+ this._gaxModule.routingHeader.fromParams({
670
+ site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
671
+ });
672
+ this.initialize();
673
+ return this.innerApiCalls.disableAdvancedSiteSearch(request, options, callback);
674
+ }
675
+ /**
676
+ * Check the status of the long running operation returned by `disableAdvancedSiteSearch()`.
677
+ * @param {String} name
678
+ * The operation name that will be passed.
679
+ * @returns {Promise} - The promise which resolves to an object.
680
+ * The decoded operation object has result and metadata field to get information from.
681
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
682
+ * for more details and examples.
683
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.disable_advanced_site_search.js</caption>
684
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_DisableAdvancedSiteSearch_async
685
+ */
686
+ async checkDisableAdvancedSiteSearchProgress(name) {
687
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
688
+ const [operation] = await this.operationsClient.getOperation(request);
689
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.disableAdvancedSiteSearch, this._gaxModule.createDefaultBackoffSettings());
690
+ return decodeOperation;
691
+ }
343
692
  recrawlUris(request, optionsOrCallback, callback) {
344
693
  var _a;
345
694
  request = request || {};
@@ -378,6 +727,286 @@ class SiteSearchEngineServiceClient {
378
727
  const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.recrawlUris, this._gaxModule.createDefaultBackoffSettings());
379
728
  return decodeOperation;
380
729
  }
730
+ batchVerifyTargetSites(request, optionsOrCallback, callback) {
731
+ var _a;
732
+ request = request || {};
733
+ let options;
734
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
735
+ callback = optionsOrCallback;
736
+ options = {};
737
+ }
738
+ else {
739
+ options = optionsOrCallback;
740
+ }
741
+ options = options || {};
742
+ options.otherArgs = options.otherArgs || {};
743
+ options.otherArgs.headers = options.otherArgs.headers || {};
744
+ options.otherArgs.headers['x-goog-request-params'] =
745
+ this._gaxModule.routingHeader.fromParams({
746
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
747
+ });
748
+ this.initialize();
749
+ return this.innerApiCalls.batchVerifyTargetSites(request, options, callback);
750
+ }
751
+ /**
752
+ * Check the status of the long running operation returned by `batchVerifyTargetSites()`.
753
+ * @param {String} name
754
+ * The operation name that will be passed.
755
+ * @returns {Promise} - The promise which resolves to an object.
756
+ * The decoded operation object has result and metadata field to get information from.
757
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
758
+ * for more details and examples.
759
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.batch_verify_target_sites.js</caption>
760
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
761
+ */
762
+ async checkBatchVerifyTargetSitesProgress(name) {
763
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
764
+ const [operation] = await this.operationsClient.getOperation(request);
765
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchVerifyTargetSites, this._gaxModule.createDefaultBackoffSettings());
766
+ return decodeOperation;
767
+ }
768
+ listTargetSites(request, optionsOrCallback, callback) {
769
+ var _a;
770
+ request = request || {};
771
+ let options;
772
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
773
+ callback = optionsOrCallback;
774
+ options = {};
775
+ }
776
+ else {
777
+ options = optionsOrCallback;
778
+ }
779
+ options = options || {};
780
+ options.otherArgs = options.otherArgs || {};
781
+ options.otherArgs.headers = options.otherArgs.headers || {};
782
+ options.otherArgs.headers['x-goog-request-params'] =
783
+ this._gaxModule.routingHeader.fromParams({
784
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
785
+ });
786
+ this.initialize();
787
+ return this.innerApiCalls.listTargetSites(request, options, callback);
788
+ }
789
+ /**
790
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
791
+ * @param {Object} request
792
+ * The request object that will be sent.
793
+ * @param {string} request.parent
794
+ * Required. The parent site search engine resource name, such as
795
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
796
+ *
797
+ * If the caller does not have permission to list
798
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
799
+ * site search engine, regardless of whether or not this branch exists, a
800
+ * PERMISSION_DENIED error is returned.
801
+ * @param {number} request.pageSize
802
+ * Requested page size. Server may return fewer items than requested. If
803
+ * unspecified, server will pick an appropriate default. The maximum value is
804
+ * 1000; values above 1000 will be coerced to 1000.
805
+ *
806
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
807
+ * @param {string} request.pageToken
808
+ * A page token, received from a previous `ListTargetSites` call.
809
+ * Provide this to retrieve the subsequent page.
810
+ *
811
+ * When paginating, all other parameters provided to `ListTargetSites`
812
+ * must match the call that provided the page token.
813
+ * @param {object} [options]
814
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
815
+ * @returns {Stream}
816
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
817
+ * The client library will perform auto-pagination by default: it will call the API as many
818
+ * times as needed. Note that it can affect your quota.
819
+ * We recommend using `listTargetSitesAsync()`
820
+ * method described below for async iteration which you can stop as needed.
821
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
822
+ * for more details and examples.
823
+ */
824
+ listTargetSitesStream(request, options) {
825
+ var _a;
826
+ request = request || {};
827
+ options = options || {};
828
+ options.otherArgs = options.otherArgs || {};
829
+ options.otherArgs.headers = options.otherArgs.headers || {};
830
+ options.otherArgs.headers['x-goog-request-params'] =
831
+ this._gaxModule.routingHeader.fromParams({
832
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
833
+ });
834
+ const defaultCallSettings = this._defaults['listTargetSites'];
835
+ const callSettings = defaultCallSettings.merge(options);
836
+ this.initialize();
837
+ return this.descriptors.page.listTargetSites.createStream(this.innerApiCalls.listTargetSites, request, callSettings);
838
+ }
839
+ /**
840
+ * Equivalent to `listTargetSites`, but returns an iterable object.
841
+ *
842
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
843
+ * @param {Object} request
844
+ * The request object that will be sent.
845
+ * @param {string} request.parent
846
+ * Required. The parent site search engine resource name, such as
847
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
848
+ *
849
+ * If the caller does not have permission to list
850
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s under this
851
+ * site search engine, regardless of whether or not this branch exists, a
852
+ * PERMISSION_DENIED error is returned.
853
+ * @param {number} request.pageSize
854
+ * Requested page size. Server may return fewer items than requested. If
855
+ * unspecified, server will pick an appropriate default. The maximum value is
856
+ * 1000; values above 1000 will be coerced to 1000.
857
+ *
858
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
859
+ * @param {string} request.pageToken
860
+ * A page token, received from a previous `ListTargetSites` call.
861
+ * Provide this to retrieve the subsequent page.
862
+ *
863
+ * When paginating, all other parameters provided to `ListTargetSites`
864
+ * must match the call that provided the page token.
865
+ * @param {object} [options]
866
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
867
+ * @returns {Object}
868
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
869
+ * When you iterate the returned iterable, each element will be an object representing
870
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
871
+ * so you can stop the iteration when you don't need more results.
872
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
873
+ * for more details and examples.
874
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.list_target_sites.js</caption>
875
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_ListTargetSites_async
876
+ */
877
+ listTargetSitesAsync(request, options) {
878
+ var _a;
879
+ request = request || {};
880
+ options = options || {};
881
+ options.otherArgs = options.otherArgs || {};
882
+ options.otherArgs.headers = options.otherArgs.headers || {};
883
+ options.otherArgs.headers['x-goog-request-params'] =
884
+ this._gaxModule.routingHeader.fromParams({
885
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
886
+ });
887
+ const defaultCallSettings = this._defaults['listTargetSites'];
888
+ const callSettings = defaultCallSettings.merge(options);
889
+ this.initialize();
890
+ return this.descriptors.page.listTargetSites.asyncIterate(this.innerApiCalls['listTargetSites'], request, callSettings);
891
+ }
892
+ fetchDomainVerificationStatus(request, optionsOrCallback, callback) {
893
+ var _a;
894
+ request = request || {};
895
+ let options;
896
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
897
+ callback = optionsOrCallback;
898
+ options = {};
899
+ }
900
+ else {
901
+ options = optionsOrCallback;
902
+ }
903
+ options = options || {};
904
+ options.otherArgs = options.otherArgs || {};
905
+ options.otherArgs.headers = options.otherArgs.headers || {};
906
+ options.otherArgs.headers['x-goog-request-params'] =
907
+ this._gaxModule.routingHeader.fromParams({
908
+ site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
909
+ });
910
+ this.initialize();
911
+ return this.innerApiCalls.fetchDomainVerificationStatus(request, options, callback);
912
+ }
913
+ /**
914
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
915
+ * @param {Object} request
916
+ * The request object that will be sent.
917
+ * @param {string} request.siteSearchEngine
918
+ * Required. The site search engine resource under which we fetch all the
919
+ * domain verification status.
920
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
921
+ * @param {number} request.pageSize
922
+ * Requested page size. Server may return fewer items than requested. If
923
+ * unspecified, server will pick an appropriate default. The maximum value is
924
+ * 1000; values above 1000 will be coerced to 1000.
925
+ *
926
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
927
+ * @param {string} request.pageToken
928
+ * A page token, received from a previous `FetchDomainVerificationStatus`
929
+ * call. Provide this to retrieve the subsequent page.
930
+ *
931
+ * When paginating, all other parameters provided to
932
+ * `FetchDomainVerificationStatus` must match the call that provided the page
933
+ * token.
934
+ * @param {object} [options]
935
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
936
+ * @returns {Stream}
937
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite} on 'data' event.
938
+ * The client library will perform auto-pagination by default: it will call the API as many
939
+ * times as needed. Note that it can affect your quota.
940
+ * We recommend using `fetchDomainVerificationStatusAsync()`
941
+ * method described below for async iteration which you can stop as needed.
942
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
943
+ * for more details and examples.
944
+ */
945
+ fetchDomainVerificationStatusStream(request, options) {
946
+ var _a;
947
+ request = request || {};
948
+ options = options || {};
949
+ options.otherArgs = options.otherArgs || {};
950
+ options.otherArgs.headers = options.otherArgs.headers || {};
951
+ options.otherArgs.headers['x-goog-request-params'] =
952
+ this._gaxModule.routingHeader.fromParams({
953
+ site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
954
+ });
955
+ const defaultCallSettings = this._defaults['fetchDomainVerificationStatus'];
956
+ const callSettings = defaultCallSettings.merge(options);
957
+ this.initialize();
958
+ return this.descriptors.page.fetchDomainVerificationStatus.createStream(this.innerApiCalls.fetchDomainVerificationStatus, request, callSettings);
959
+ }
960
+ /**
961
+ * Equivalent to `fetchDomainVerificationStatus`, but returns an iterable object.
962
+ *
963
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
964
+ * @param {Object} request
965
+ * The request object that will be sent.
966
+ * @param {string} request.siteSearchEngine
967
+ * Required. The site search engine resource under which we fetch all the
968
+ * domain verification status.
969
+ * `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
970
+ * @param {number} request.pageSize
971
+ * Requested page size. Server may return fewer items than requested. If
972
+ * unspecified, server will pick an appropriate default. The maximum value is
973
+ * 1000; values above 1000 will be coerced to 1000.
974
+ *
975
+ * If this field is negative, an INVALID_ARGUMENT error is returned.
976
+ * @param {string} request.pageToken
977
+ * A page token, received from a previous `FetchDomainVerificationStatus`
978
+ * call. Provide this to retrieve the subsequent page.
979
+ *
980
+ * When paginating, all other parameters provided to
981
+ * `FetchDomainVerificationStatus` must match the call that provided the page
982
+ * token.
983
+ * @param {object} [options]
984
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
985
+ * @returns {Object}
986
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
987
+ * When you iterate the returned iterable, each element will be an object representing
988
+ * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}. The API will be called under the hood as needed, once per the page,
989
+ * so you can stop the iteration when you don't need more results.
990
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
991
+ * for more details and examples.
992
+ * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.fetch_domain_verification_status.js</caption>
993
+ * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_FetchDomainVerificationStatus_async
994
+ */
995
+ fetchDomainVerificationStatusAsync(request, options) {
996
+ var _a;
997
+ request = request || {};
998
+ options = options || {};
999
+ options.otherArgs = options.otherArgs || {};
1000
+ options.otherArgs.headers = options.otherArgs.headers || {};
1001
+ options.otherArgs.headers['x-goog-request-params'] =
1002
+ this._gaxModule.routingHeader.fromParams({
1003
+ site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
1004
+ });
1005
+ const defaultCallSettings = this._defaults['fetchDomainVerificationStatus'];
1006
+ const callSettings = defaultCallSettings.merge(options);
1007
+ this.initialize();
1008
+ return this.descriptors.page.fetchDomainVerificationStatus.asyncIterate(this.innerApiCalls['fetchDomainVerificationStatus'], request, callSettings);
1009
+ }
381
1010
  /**
382
1011
  * Gets information about a location.
383
1012
  *
@@ -954,6 +1583,144 @@ class SiteSearchEngineServiceClient {
954
1583
  matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
955
1584
  return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
956
1585
  }
1586
+ /**
1587
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1588
+ *
1589
+ * @param {string} project
1590
+ * @param {string} location
1591
+ * @param {string} collection
1592
+ * @param {string} data_store
1593
+ * @param {string} target_site
1594
+ * @returns {string} Resource name string.
1595
+ */
1596
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1597
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1598
+ project: project,
1599
+ location: location,
1600
+ collection: collection,
1601
+ data_store: dataStore,
1602
+ target_site: targetSite,
1603
+ });
1604
+ }
1605
+ /**
1606
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1607
+ *
1608
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1609
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1610
+ * @returns {string} A string representing the project.
1611
+ */
1612
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1613
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1614
+ }
1615
+ /**
1616
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1617
+ *
1618
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1619
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1620
+ * @returns {string} A string representing the location.
1621
+ */
1622
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1623
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1624
+ }
1625
+ /**
1626
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1627
+ *
1628
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1629
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1630
+ * @returns {string} A string representing the collection.
1631
+ */
1632
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1633
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1634
+ }
1635
+ /**
1636
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1637
+ *
1638
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1639
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1640
+ * @returns {string} A string representing the data_store.
1641
+ */
1642
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1643
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1644
+ }
1645
+ /**
1646
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1647
+ *
1648
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1649
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1650
+ * @returns {string} A string representing the target_site.
1651
+ */
1652
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1653
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1654
+ }
1655
+ /**
1656
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1657
+ *
1658
+ * @param {string} project
1659
+ * @param {string} location
1660
+ * @param {string} collection
1661
+ * @param {string} engine
1662
+ * @param {string} conversation
1663
+ * @returns {string} Resource name string.
1664
+ */
1665
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1666
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1667
+ project: project,
1668
+ location: location,
1669
+ collection: collection,
1670
+ engine: engine,
1671
+ conversation: conversation,
1672
+ });
1673
+ }
1674
+ /**
1675
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1676
+ *
1677
+ * @param {string} projectLocationCollectionEngineConversationName
1678
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1679
+ * @returns {string} A string representing the project.
1680
+ */
1681
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1682
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1683
+ }
1684
+ /**
1685
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1686
+ *
1687
+ * @param {string} projectLocationCollectionEngineConversationName
1688
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1689
+ * @returns {string} A string representing the location.
1690
+ */
1691
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1692
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1693
+ }
1694
+ /**
1695
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1696
+ *
1697
+ * @param {string} projectLocationCollectionEngineConversationName
1698
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1699
+ * @returns {string} A string representing the collection.
1700
+ */
1701
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1702
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1703
+ }
1704
+ /**
1705
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1706
+ *
1707
+ * @param {string} projectLocationCollectionEngineConversationName
1708
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1709
+ * @returns {string} A string representing the engine.
1710
+ */
1711
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1712
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1713
+ }
1714
+ /**
1715
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1716
+ *
1717
+ * @param {string} projectLocationCollectionEngineConversationName
1718
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1719
+ * @returns {string} A string representing the conversation.
1720
+ */
1721
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1722
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1723
+ }
957
1724
  /**
958
1725
  * Return a fully-qualified projectLocationDataStore resource name string.
959
1726
  *
@@ -1227,6 +1994,63 @@ class SiteSearchEngineServiceClient {
1227
1994
  matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1228
1995
  return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1229
1996
  }
1997
+ /**
1998
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1999
+ *
2000
+ * @param {string} project
2001
+ * @param {string} location
2002
+ * @param {string} data_store
2003
+ * @param {string} target_site
2004
+ * @returns {string} Resource name string.
2005
+ */
2006
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
2007
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
2008
+ project: project,
2009
+ location: location,
2010
+ data_store: dataStore,
2011
+ target_site: targetSite,
2012
+ });
2013
+ }
2014
+ /**
2015
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
2016
+ *
2017
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
2018
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
2019
+ * @returns {string} A string representing the project.
2020
+ */
2021
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2022
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
2023
+ }
2024
+ /**
2025
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
2026
+ *
2027
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
2028
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
2029
+ * @returns {string} A string representing the location.
2030
+ */
2031
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2032
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
2033
+ }
2034
+ /**
2035
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
2036
+ *
2037
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
2038
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
2039
+ * @returns {string} A string representing the data_store.
2040
+ */
2041
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2042
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
2043
+ }
2044
+ /**
2045
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
2046
+ *
2047
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
2048
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
2049
+ * @returns {string} A string representing the target_site.
2050
+ */
2051
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2052
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2053
+ }
1230
2054
  /**
1231
2055
  * Terminate the gRPC channel and close the client.
1232
2056
  *