@google-cloud/discoveryengine 2.1.0 → 2.3.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 (172) hide show
  1. package/README.md +13 -0
  2. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +17 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +52 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto +300 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +67 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/control.proto +1 -3
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +3 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +54 -2
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +14 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +95 -4
  11. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +28 -1
  12. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +131 -6
  13. package/build/protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto +8 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/grounding.proto +9 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto +84 -0
  16. package/build/protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto +375 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +6 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +6 -0
  19. package/build/protos/google/cloud/discoveryengine/v1/user_license.proto +98 -0
  20. package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto +191 -0
  21. package/build/protos/protos.d.ts +5415 -578
  22. package/build/protos/protos.js +77830 -63391
  23. package/build/protos/protos.json +1537 -92
  24. package/build/src/index.d.ts +10 -1
  25. package/build/src/index.js +8 -22
  26. package/build/src/v1/cmek_config_service_client.d.ts +2287 -0
  27. package/build/src/v1/cmek_config_service_client.js +3274 -0
  28. package/build/src/v1/cmek_config_service_client_config.json +42 -0
  29. package/build/src/v1/cmek_config_service_proto_list.json +44 -0
  30. package/build/src/v1/completion_service_client.d.ts +166 -76
  31. package/build/src/v1/completion_service_client.js +258 -263
  32. package/build/src/v1/completion_service_proto_list.json +6 -1
  33. package/build/src/v1/control_service_client.d.ts +171 -81
  34. package/build/src/v1/control_service_client.js +246 -132
  35. package/build/src/v1/control_service_proto_list.json +6 -1
  36. package/build/src/v1/conversational_search_service_client.d.ts +233 -143
  37. package/build/src/v1/conversational_search_service_client.js +330 -226
  38. package/build/src/v1/conversational_search_service_proto_list.json +6 -1
  39. package/build/src/v1/data_store_service_client.d.ts +218 -122
  40. package/build/src/v1/data_store_service_client.js +273 -281
  41. package/build/src/v1/data_store_service_proto_list.json +6 -1
  42. package/build/src/v1/document_service_client.d.ts +210 -120
  43. package/build/src/v1/document_service_client.js +300 -301
  44. package/build/src/v1/document_service_proto_list.json +6 -1
  45. package/build/src/v1/engine_service_client.d.ts +193 -103
  46. package/build/src/v1/engine_service_client.js +273 -280
  47. package/build/src/v1/engine_service_proto_list.json +6 -1
  48. package/build/src/v1/gapic_metadata.json +184 -0
  49. package/build/src/v1/grounded_generation_service_client.d.ts +138 -48
  50. package/build/src/v1/grounded_generation_service_client.js +217 -100
  51. package/build/src/v1/grounded_generation_service_proto_list.json +6 -1
  52. package/build/src/v1/identity_mapping_store_service_client.d.ts +2470 -0
  53. package/build/src/v1/identity_mapping_store_service_client.js +3449 -0
  54. package/build/src/v1/identity_mapping_store_service_client_config.json +54 -0
  55. package/build/src/v1/identity_mapping_store_service_proto_list.json +44 -0
  56. package/build/src/v1/index.d.ts +3 -0
  57. package/build/src/v1/index.js +7 -1
  58. package/build/src/v1/project_service_client.d.ts +166 -76
  59. package/build/src/v1/project_service_client.js +235 -223
  60. package/build/src/v1/project_service_proto_list.json +6 -1
  61. package/build/src/v1/rank_service_client.d.ts +137 -47
  62. package/build/src/v1/rank_service_client.js +204 -85
  63. package/build/src/v1/rank_service_proto_list.json +6 -1
  64. package/build/src/v1/recommendation_service_client.d.ts +137 -47
  65. package/build/src/v1/recommendation_service_client.js +202 -82
  66. package/build/src/v1/recommendation_service_proto_list.json +6 -1
  67. package/build/src/v1/schema_service_client.d.ts +201 -111
  68. package/build/src/v1/schema_service_client.js +264 -274
  69. package/build/src/v1/schema_service_proto_list.json +6 -1
  70. package/build/src/v1/search_service_client.d.ts +661 -571
  71. package/build/src/v1/search_service_client.js +216 -113
  72. package/build/src/v1/search_service_proto_list.json +6 -1
  73. package/build/src/v1/search_tuning_service_client.d.ts +167 -77
  74. package/build/src/v1/search_tuning_service_client.js +246 -236
  75. package/build/src/v1/search_tuning_service_proto_list.json +6 -1
  76. package/build/src/v1/serving_config_service_client.d.ts +138 -48
  77. package/build/src/v1/serving_config_service_client.js +201 -80
  78. package/build/src/v1/serving_config_service_proto_list.json +6 -1
  79. package/build/src/v1/site_search_engine_service_client.d.ts +238 -148
  80. package/build/src/v1/site_search_engine_service_client.js +324 -379
  81. package/build/src/v1/site_search_engine_service_proto_list.json +6 -1
  82. package/build/src/v1/user_event_service_client.d.ts +167 -77
  83. package/build/src/v1/user_event_service_client.js +260 -254
  84. package/build/src/v1/user_event_service_proto_list.json +6 -1
  85. package/build/src/v1/user_license_service_client.d.ts +2256 -0
  86. package/build/src/v1/user_license_service_client.js +3194 -0
  87. package/build/src/v1/user_license_service_client_config.json +34 -0
  88. package/build/src/v1/user_license_service_proto_list.json +44 -0
  89. package/build/src/v1alpha/acl_config_service_client.d.ts +49 -49
  90. package/build/src/v1alpha/acl_config_service_client.js +94 -106
  91. package/build/src/v1alpha/chunk_service_client.d.ts +88 -88
  92. package/build/src/v1alpha/chunk_service_client.js +98 -120
  93. package/build/src/v1alpha/completion_service_client.d.ts +77 -77
  94. package/build/src/v1alpha/completion_service_client.js +141 -281
  95. package/build/src/v1alpha/control_service_client.d.ts +85 -85
  96. package/build/src/v1alpha/control_service_client.js +129 -151
  97. package/build/src/v1alpha/conversational_search_service_client.d.ts +143 -143
  98. package/build/src/v1alpha/conversational_search_service_client.js +211 -237
  99. package/build/src/v1alpha/data_store_service_client.d.ts +126 -126
  100. package/build/src/v1alpha/data_store_service_client.js +176 -317
  101. package/build/src/v1alpha/document_service_client.d.ts +126 -126
  102. package/build/src/v1alpha/document_service_client.js +193 -329
  103. package/build/src/v1alpha/engine_service_client.d.ts +106 -106
  104. package/build/src/v1alpha/engine_service_client.js +180 -326
  105. package/build/src/v1alpha/estimate_billing_service_client.d.ts +76 -76
  106. package/build/src/v1alpha/estimate_billing_service_client.js +119 -244
  107. package/build/src/v1alpha/evaluation_service_client.d.ts +161 -161
  108. package/build/src/v1alpha/evaluation_service_client.js +150 -296
  109. package/build/src/v1alpha/grounded_generation_service_client.d.ts +48 -48
  110. package/build/src/v1alpha/grounded_generation_service_client.js +85 -100
  111. package/build/src/v1alpha/project_service_client.d.ts +78 -78
  112. package/build/src/v1alpha/project_service_client.js +139 -263
  113. package/build/src/v1alpha/rank_service_client.d.ts +47 -47
  114. package/build/src/v1alpha/rank_service_client.js +87 -104
  115. package/build/src/v1alpha/recommendation_service_client.d.ts +47 -47
  116. package/build/src/v1alpha/recommendation_service_client.js +85 -100
  117. package/build/src/v1alpha/sample_query_service_client.d.ts +123 -123
  118. package/build/src/v1alpha/sample_query_service_client.js +169 -302
  119. package/build/src/v1alpha/sample_query_set_service_client.d.ts +94 -94
  120. package/build/src/v1alpha/sample_query_set_service_client.js +130 -153
  121. package/build/src/v1alpha/schema_service_client.d.ts +112 -112
  122. package/build/src/v1alpha/schema_service_client.js +147 -293
  123. package/build/src/v1alpha/search_service_client.d.ts +327 -327
  124. package/build/src/v1alpha/search_service_client.js +88 -112
  125. package/build/src/v1alpha/search_tuning_service_client.d.ts +77 -77
  126. package/build/src/v1alpha/search_tuning_service_client.js +129 -254
  127. package/build/src/v1alpha/serving_config_service_client.d.ts +75 -75
  128. package/build/src/v1alpha/serving_config_service_client.js +109 -133
  129. package/build/src/v1alpha/site_search_engine_service_client.d.ts +151 -151
  130. package/build/src/v1alpha/site_search_engine_service_client.js +203 -388
  131. package/build/src/v1alpha/user_event_service_client.d.ts +78 -78
  132. package/build/src/v1alpha/user_event_service_client.js +143 -272
  133. package/build/src/v1beta/completion_service_client.d.ts +78 -78
  134. package/build/src/v1beta/completion_service_client.js +149 -280
  135. package/build/src/v1beta/control_service_client.d.ts +84 -84
  136. package/build/src/v1beta/control_service_client.js +127 -147
  137. package/build/src/v1beta/conversational_search_service_client.d.ts +142 -142
  138. package/build/src/v1beta/conversational_search_service_client.js +209 -233
  139. package/build/src/v1beta/data_store_service_client.d.ts +124 -124
  140. package/build/src/v1beta/data_store_service_client.js +154 -289
  141. package/build/src/v1beta/document_service_client.d.ts +124 -124
  142. package/build/src/v1beta/document_service_client.js +181 -310
  143. package/build/src/v1beta/engine_service_client.d.ts +106 -106
  144. package/build/src/v1beta/engine_service_client.js +178 -316
  145. package/build/src/v1beta/evaluation_service_client.d.ts +161 -161
  146. package/build/src/v1beta/evaluation_service_client.js +148 -286
  147. package/build/src/v1beta/grounded_generation_service_client.d.ts +49 -49
  148. package/build/src/v1beta/grounded_generation_service_client.js +98 -114
  149. package/build/src/v1beta/project_service_client.d.ts +76 -76
  150. package/build/src/v1beta/project_service_client.js +116 -232
  151. package/build/src/v1beta/rank_service_client.d.ts +47 -47
  152. package/build/src/v1beta/rank_service_client.js +85 -99
  153. package/build/src/v1beta/recommendation_service_client.d.ts +47 -47
  154. package/build/src/v1beta/recommendation_service_client.js +83 -96
  155. package/build/src/v1beta/sample_query_service_client.d.ts +123 -123
  156. package/build/src/v1beta/sample_query_service_client.js +167 -292
  157. package/build/src/v1beta/sample_query_set_service_client.d.ts +94 -94
  158. package/build/src/v1beta/sample_query_set_service_client.js +128 -149
  159. package/build/src/v1beta/schema_service_client.d.ts +111 -111
  160. package/build/src/v1beta/schema_service_client.js +145 -283
  161. package/build/src/v1beta/search_service_client.d.ts +665 -665
  162. package/build/src/v1beta/search_service_client.js +97 -128
  163. package/build/src/v1beta/search_tuning_service_client.d.ts +77 -77
  164. package/build/src/v1beta/search_tuning_service_client.js +127 -244
  165. package/build/src/v1beta/serving_config_service_client.d.ts +75 -75
  166. package/build/src/v1beta/serving_config_service_client.js +107 -129
  167. package/build/src/v1beta/site_search_engine_service_client.d.ts +151 -151
  168. package/build/src/v1beta/site_search_engine_service_client.js +205 -387
  169. package/build/src/v1beta/user_event_service_client.d.ts +78 -78
  170. package/build/src/v1beta/user_event_service_client.js +141 -262
  171. package/package.json +7 -7
  172. package/CHANGELOG.md +0 -267
@@ -1,6 +1,7 @@
1
1
  [
2
2
  "../../protos/google/cloud/discoveryengine/v1/answer.proto",
3
3
  "../../protos/google/cloud/discoveryengine/v1/chunk.proto",
4
+ "../../protos/google/cloud/discoveryengine/v1/cmek_config_service.proto",
4
5
  "../../protos/google/cloud/discoveryengine/v1/common.proto",
5
6
  "../../protos/google/cloud/discoveryengine/v1/completion.proto",
6
7
  "../../protos/google/cloud/discoveryengine/v1/completion_service.proto",
@@ -18,6 +19,8 @@
18
19
  "../../protos/google/cloud/discoveryengine/v1/engine_service.proto",
19
20
  "../../protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto",
20
21
  "../../protos/google/cloud/discoveryengine/v1/grounding.proto",
22
+ "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto",
23
+ "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
21
24
  "../../protos/google/cloud/discoveryengine/v1/import_config.proto",
22
25
  "../../protos/google/cloud/discoveryengine/v1/project.proto",
23
26
  "../../protos/google/cloud/discoveryengine/v1/project_service.proto",
@@ -35,5 +38,7 @@
35
38
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
36
39
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
37
40
  "../../protos/google/cloud/discoveryengine/v1/user_event.proto",
38
- "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto"
41
+ "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto",
42
+ "../../protos/google/cloud/discoveryengine/v1/user_license.proto",
43
+ "../../protos/google/cloud/discoveryengine/v1/user_license_service.proto"
39
44
  ]
@@ -144,61 +144,61 @@ export declare class ServingConfigServiceClient {
144
144
  */
145
145
  updateServingConfig(request?: protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest, options?: CallOptions): Promise<[
146
146
  protos.google.cloud.discoveryengine.v1.IServingConfig,
147
- (protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest | undefined),
147
+ protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest | undefined,
148
148
  {} | undefined
149
149
  ]>;
150
150
  updateServingConfig(request: protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IServingConfig, protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;
151
151
  updateServingConfig(request: protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IServingConfig, protos.google.cloud.discoveryengine.v1.IUpdateServingConfigRequest | null | undefined, {} | null | undefined>): void;
152
152
  /**
153
- * Gets information about a location.
154
- *
155
- * @param {Object} request
156
- * The request object that will be sent.
157
- * @param {string} request.name
158
- * Resource name for the location.
159
- * @param {object} [options]
160
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
161
- * @returns {Promise} - The promise which resolves to an array.
162
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
163
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
164
- * for more details and examples.
165
- * @example
166
- * ```
167
- * const [response] = await client.getLocation(request);
168
- * ```
169
- */
153
+ * Gets information about a location.
154
+ *
155
+ * @param {Object} request
156
+ * The request object that will be sent.
157
+ * @param {string} request.name
158
+ * Resource name for the location.
159
+ * @param {object} [options]
160
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
161
+ * @returns {Promise} - The promise which resolves to an array.
162
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
163
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
164
+ * for more details and examples.
165
+ * @example
166
+ * ```
167
+ * const [response] = await client.getLocation(request);
168
+ * ```
169
+ */
170
170
  getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
171
171
  /**
172
- * Lists information about the supported locations for this service. Returns an iterable object.
173
- *
174
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
175
- * @param {Object} request
176
- * The request object that will be sent.
177
- * @param {string} request.name
178
- * The resource that owns the locations collection, if applicable.
179
- * @param {string} request.filter
180
- * The standard list filter.
181
- * @param {number} request.pageSize
182
- * The standard list page size.
183
- * @param {string} request.pageToken
184
- * The standard list page token.
185
- * @param {object} [options]
186
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
187
- * @returns {Object}
188
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
189
- * When you iterate the returned iterable, each element will be an object representing
190
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
191
- * so you can stop the iteration when you don't need more results.
192
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
193
- * for more details and examples.
194
- * @example
195
- * ```
196
- * const iterable = client.listLocationsAsync(request);
197
- * for await (const response of iterable) {
198
- * // process response
199
- * }
200
- * ```
201
- */
172
+ * Lists information about the supported locations for this service. Returns an iterable object.
173
+ *
174
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
175
+ * @param {Object} request
176
+ * The request object that will be sent.
177
+ * @param {string} request.name
178
+ * The resource that owns the locations collection, if applicable.
179
+ * @param {string} request.filter
180
+ * The standard list filter.
181
+ * @param {number} request.pageSize
182
+ * The standard list page size.
183
+ * @param {string} request.pageToken
184
+ * The standard list page token.
185
+ * @param {object} [options]
186
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
187
+ * @returns {Object}
188
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
189
+ * When you iterate the returned iterable, each element will be an object representing
190
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
191
+ * so you can stop the iteration when you don't need more results.
192
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
193
+ * for more details and examples.
194
+ * @example
195
+ * ```
196
+ * const iterable = client.listLocationsAsync(request);
197
+ * for await (const response of iterable) {
198
+ * // process response
199
+ * }
200
+ * ```
201
+ */
202
202
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
203
203
  /**
204
204
  * Return a fully-qualified engine resource name string.
@@ -242,6 +242,39 @@ export declare class ServingConfigServiceClient {
242
242
  * @returns {string} A string representing the engine.
243
243
  */
244
244
  matchEngineFromEngineName(engineName: string): string | number;
245
+ /**
246
+ * Return a fully-qualified identityMappingStore resource name string.
247
+ *
248
+ * @param {string} project
249
+ * @param {string} location
250
+ * @param {string} identity_mapping_store
251
+ * @returns {string} Resource name string.
252
+ */
253
+ identityMappingStorePath(project: string, location: string, identityMappingStore: string): string;
254
+ /**
255
+ * Parse the project from IdentityMappingStore resource.
256
+ *
257
+ * @param {string} identityMappingStoreName
258
+ * A fully-qualified path representing IdentityMappingStore resource.
259
+ * @returns {string} A string representing the project.
260
+ */
261
+ matchProjectFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
262
+ /**
263
+ * Parse the location from IdentityMappingStore resource.
264
+ *
265
+ * @param {string} identityMappingStoreName
266
+ * A fully-qualified path representing IdentityMappingStore resource.
267
+ * @returns {string} A string representing the location.
268
+ */
269
+ matchLocationFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
270
+ /**
271
+ * Parse the identity_mapping_store from IdentityMappingStore resource.
272
+ *
273
+ * @param {string} identityMappingStoreName
274
+ * A fully-qualified path representing IdentityMappingStore resource.
275
+ * @returns {string} A string representing the identity_mapping_store.
276
+ */
277
+ matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName: string): string | number;
245
278
  /**
246
279
  * Return a fully-qualified project resource name string.
247
280
  *
@@ -257,6 +290,63 @@ export declare class ServingConfigServiceClient {
257
290
  * @returns {string} A string representing the project.
258
291
  */
259
292
  matchProjectFromProjectName(projectName: string): string | number;
293
+ /**
294
+ * Return a fully-qualified projectLocationCmekConfig resource name string.
295
+ *
296
+ * @param {string} project
297
+ * @param {string} location
298
+ * @returns {string} Resource name string.
299
+ */
300
+ projectLocationCmekConfigPath(project: string, location: string): string;
301
+ /**
302
+ * Parse the project from ProjectLocationCmekConfig resource.
303
+ *
304
+ * @param {string} projectLocationCmekConfigName
305
+ * A fully-qualified path representing project_location_cmekConfig resource.
306
+ * @returns {string} A string representing the project.
307
+ */
308
+ matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
309
+ /**
310
+ * Parse the location from ProjectLocationCmekConfig resource.
311
+ *
312
+ * @param {string} projectLocationCmekConfigName
313
+ * A fully-qualified path representing project_location_cmekConfig resource.
314
+ * @returns {string} A string representing the location.
315
+ */
316
+ matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName: string): string | number;
317
+ /**
318
+ * Return a fully-qualified projectLocationCmekConfigs resource name string.
319
+ *
320
+ * @param {string} project
321
+ * @param {string} location
322
+ * @param {string} cmek_config
323
+ * @returns {string} Resource name string.
324
+ */
325
+ projectLocationCmekConfigsPath(project: string, location: string, cmekConfig: string): string;
326
+ /**
327
+ * Parse the project from ProjectLocationCmekConfigs resource.
328
+ *
329
+ * @param {string} projectLocationCmekConfigsName
330
+ * A fully-qualified path representing project_location_cmekConfigs resource.
331
+ * @returns {string} A string representing the project.
332
+ */
333
+ matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
334
+ /**
335
+ * Parse the location from ProjectLocationCmekConfigs resource.
336
+ *
337
+ * @param {string} projectLocationCmekConfigsName
338
+ * A fully-qualified path representing project_location_cmekConfigs resource.
339
+ * @returns {string} A string representing the location.
340
+ */
341
+ matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
342
+ /**
343
+ * Parse the cmek_config from ProjectLocationCmekConfigs resource.
344
+ *
345
+ * @param {string} projectLocationCmekConfigsName
346
+ * A fully-qualified path representing project_location_cmekConfigs resource.
347
+ * @returns {string} A string representing the cmek_config.
348
+ */
349
+ matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName: string): string | number;
260
350
  /**
261
351
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
262
352
  *
@@ -98,26 +98,17 @@ class ServingConfigServiceClient {
98
98
  constructor(opts, gaxInstance) {
99
99
  // Ensure that options include all the required fields.
100
100
  const staticMembers = this.constructor;
101
- if (opts?.universe_domain &&
102
- opts?.universeDomain &&
103
- opts?.universe_domain !== opts?.universeDomain) {
101
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
104
102
  throw new Error('Please set either universe_domain or universeDomain, but not both.');
105
103
  }
106
- const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
107
- ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
108
- : undefined;
109
- this._universeDomain =
110
- opts?.universeDomain ??
111
- opts?.universe_domain ??
112
- universeDomainEnvVar ??
113
- 'googleapis.com';
104
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
105
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
114
106
  this._servicePath = 'discoveryengine.' + this._universeDomain;
115
107
  const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
116
108
  this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
117
109
  const port = opts?.port || staticMembers.port;
118
110
  const clientConfig = opts?.clientConfig ?? {};
119
- const fallback = opts?.fallback ??
120
- (typeof window !== 'undefined' && typeof window?.fetch === 'function');
111
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
121
112
  opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
122
113
  // Request numeric enum values if REST transport is used.
123
114
  opts.numericEnums = true;
@@ -147,7 +138,10 @@ class ServingConfigServiceClient {
147
138
  }
148
139
  this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
149
140
  // Determine the client header string.
150
- const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
141
+ const clientHeader = [
142
+ `gax/${this._gaxModule.version}`,
143
+ `gapic/${version}`,
144
+ ];
151
145
  if (typeof process === 'object' && 'versions' in process) {
152
146
  clientHeader.push(`gl-node/${process.versions.node}`);
153
147
  }
@@ -170,7 +164,10 @@ class ServingConfigServiceClient {
170
164
  // Create useful helper objects for these.
171
165
  this.pathTemplates = {
172
166
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
167
+ identityMappingStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}'),
173
168
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
169
+ projectLocationCmekConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfig'),
170
+ projectLocationCmekConfigsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfigs/{cmek_config}'),
174
171
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
175
172
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
176
173
  projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
@@ -232,11 +229,10 @@ class ServingConfigServiceClient {
232
229
  }
233
230
  // Put together the "service stub" for
234
231
  // google.cloud.discoveryengine.v1.ServingConfigService.
235
- this.servingConfigServiceStub = this._gaxGrpc.createStub(this._opts.fallback
236
- ? this._protos.lookupService('google.cloud.discoveryengine.v1.ServingConfigService')
237
- : // eslint-disable-next-line @typescript-eslint/no-explicit-any
238
- this._protos.google.cloud.discoveryengine.v1
239
- .ServingConfigService, this._opts, this._providedCustomServicePath);
232
+ this.servingConfigServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
233
+ this._protos.lookupService('google.cloud.discoveryengine.v1.ServingConfigService') :
234
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
235
+ this._protos.google.cloud.discoveryengine.v1.ServingConfigService, this._opts, this._providedCustomServicePath);
240
236
  // Iterate over each of the methods that the service provides
241
237
  // and create an API call method for each.
242
238
  const servingConfigServiceStubMethods = ['updateServingConfig'];
@@ -262,8 +258,7 @@ class ServingConfigServiceClient {
262
258
  * @returns {string} The DNS address for this service.
263
259
  */
264
260
  static get servicePath() {
265
- if (typeof process === 'object' &&
266
- typeof process.emitWarning === 'function') {
261
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
267
262
  process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
268
263
  }
269
264
  return 'discoveryengine.googleapis.com';
@@ -274,8 +269,7 @@ class ServingConfigServiceClient {
274
269
  * @returns {string} The DNS address for this service.
275
270
  */
276
271
  static get apiEndpoint() {
277
- if (typeof process === 'object' &&
278
- typeof process.emitWarning === 'function') {
272
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
279
273
  process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
280
274
  }
281
275
  return 'discoveryengine.googleapis.com';
@@ -303,7 +297,9 @@ class ServingConfigServiceClient {
303
297
  * @returns {string[]} List of default scopes.
304
298
  */
305
299
  static get scopes() {
306
- return ['https://www.googleapis.com/auth/cloud-platform'];
300
+ return [
301
+ 'https://www.googleapis.com/auth/cloud-platform'
302
+ ];
307
303
  }
308
304
  /**
309
305
  * Return the project ID used by this class.
@@ -329,13 +325,10 @@ class ServingConfigServiceClient {
329
325
  options = options || {};
330
326
  options.otherArgs = options.otherArgs || {};
331
327
  options.otherArgs.headers = options.otherArgs.headers || {};
332
- options.otherArgs.headers['x-goog-request-params'] =
333
- this._gaxModule.routingHeader.fromParams({
334
- 'serving_config.name': request.servingConfig.name ?? '',
335
- });
336
- this.initialize().catch(err => {
337
- throw err;
328
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
329
+ 'serving_config.name': request.servingConfig.name ?? '',
338
330
  });
331
+ this.initialize().catch(err => { throw err; });
339
332
  this._log.info('updateServingConfig request %j', request);
340
333
  const wrappedCallback = callback
341
334
  ? (error, response, options, rawResponse) => {
@@ -343,65 +336,70 @@ class ServingConfigServiceClient {
343
336
  callback(error, response, options, rawResponse); // We verified callback above.
344
337
  }
345
338
  : undefined;
346
- return this.innerApiCalls
347
- .updateServingConfig(request, options, wrappedCallback)
339
+ return this.innerApiCalls.updateServingConfig(request, options, wrappedCallback)
348
340
  ?.then(([response, options, rawResponse]) => {
349
341
  this._log.info('updateServingConfig response %j', response);
350
342
  return [response, options, rawResponse];
343
+ }).catch((error) => {
344
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
345
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
346
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
347
+ }
348
+ throw error;
351
349
  });
352
350
  }
353
351
  /**
354
- * Gets information about a location.
355
- *
356
- * @param {Object} request
357
- * The request object that will be sent.
358
- * @param {string} request.name
359
- * Resource name for the location.
360
- * @param {object} [options]
361
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
362
- * @returns {Promise} - The promise which resolves to an array.
363
- * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
364
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
365
- * for more details and examples.
366
- * @example
367
- * ```
368
- * const [response] = await client.getLocation(request);
369
- * ```
370
- */
352
+ * Gets information about a location.
353
+ *
354
+ * @param {Object} request
355
+ * The request object that will be sent.
356
+ * @param {string} request.name
357
+ * Resource name for the location.
358
+ * @param {object} [options]
359
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
360
+ * @returns {Promise} - The promise which resolves to an array.
361
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
362
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
363
+ * for more details and examples.
364
+ * @example
365
+ * ```
366
+ * const [response] = await client.getLocation(request);
367
+ * ```
368
+ */
371
369
  getLocation(request, options, callback) {
372
370
  return this.locationsClient.getLocation(request, options, callback);
373
371
  }
374
372
  /**
375
- * Lists information about the supported locations for this service. Returns an iterable object.
376
- *
377
- * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
378
- * @param {Object} request
379
- * The request object that will be sent.
380
- * @param {string} request.name
381
- * The resource that owns the locations collection, if applicable.
382
- * @param {string} request.filter
383
- * The standard list filter.
384
- * @param {number} request.pageSize
385
- * The standard list page size.
386
- * @param {string} request.pageToken
387
- * The standard list page token.
388
- * @param {object} [options]
389
- * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
390
- * @returns {Object}
391
- * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
392
- * When you iterate the returned iterable, each element will be an object representing
393
- * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
394
- * so you can stop the iteration when you don't need more results.
395
- * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
396
- * for more details and examples.
397
- * @example
398
- * ```
399
- * const iterable = client.listLocationsAsync(request);
400
- * for await (const response of iterable) {
401
- * // process response
402
- * }
403
- * ```
404
- */
373
+ * Lists information about the supported locations for this service. Returns an iterable object.
374
+ *
375
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
376
+ * @param {Object} request
377
+ * The request object that will be sent.
378
+ * @param {string} request.name
379
+ * The resource that owns the locations collection, if applicable.
380
+ * @param {string} request.filter
381
+ * The standard list filter.
382
+ * @param {number} request.pageSize
383
+ * The standard list page size.
384
+ * @param {string} request.pageToken
385
+ * The standard list page token.
386
+ * @param {object} [options]
387
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
388
+ * @returns {Object}
389
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
390
+ * When you iterate the returned iterable, each element will be an object representing
391
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
392
+ * so you can stop the iteration when you don't need more results.
393
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
394
+ * for more details and examples.
395
+ * @example
396
+ * ```
397
+ * const iterable = client.listLocationsAsync(request);
398
+ * for await (const response of iterable) {
399
+ * // process response
400
+ * }
401
+ * ```
402
+ */
405
403
  listLocationsAsync(request, options) {
406
404
  return this.locationsClient.listLocationsAsync(request, options);
407
405
  }
@@ -465,6 +463,51 @@ class ServingConfigServiceClient {
465
463
  matchEngineFromEngineName(engineName) {
466
464
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
467
465
  }
466
+ /**
467
+ * Return a fully-qualified identityMappingStore resource name string.
468
+ *
469
+ * @param {string} project
470
+ * @param {string} location
471
+ * @param {string} identity_mapping_store
472
+ * @returns {string} Resource name string.
473
+ */
474
+ identityMappingStorePath(project, location, identityMappingStore) {
475
+ return this.pathTemplates.identityMappingStorePathTemplate.render({
476
+ project: project,
477
+ location: location,
478
+ identity_mapping_store: identityMappingStore,
479
+ });
480
+ }
481
+ /**
482
+ * Parse the project from IdentityMappingStore resource.
483
+ *
484
+ * @param {string} identityMappingStoreName
485
+ * A fully-qualified path representing IdentityMappingStore resource.
486
+ * @returns {string} A string representing the project.
487
+ */
488
+ matchProjectFromIdentityMappingStoreName(identityMappingStoreName) {
489
+ return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).project;
490
+ }
491
+ /**
492
+ * Parse the location from IdentityMappingStore resource.
493
+ *
494
+ * @param {string} identityMappingStoreName
495
+ * A fully-qualified path representing IdentityMappingStore resource.
496
+ * @returns {string} A string representing the location.
497
+ */
498
+ matchLocationFromIdentityMappingStoreName(identityMappingStoreName) {
499
+ return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).location;
500
+ }
501
+ /**
502
+ * Parse the identity_mapping_store from IdentityMappingStore resource.
503
+ *
504
+ * @param {string} identityMappingStoreName
505
+ * A fully-qualified path representing IdentityMappingStore resource.
506
+ * @returns {string} A string representing the identity_mapping_store.
507
+ */
508
+ matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName) {
509
+ return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).identity_mapping_store;
510
+ }
468
511
  /**
469
512
  * Return a fully-qualified project resource name string.
470
513
  *
@@ -486,6 +529,84 @@ class ServingConfigServiceClient {
486
529
  matchProjectFromProjectName(projectName) {
487
530
  return this.pathTemplates.projectPathTemplate.match(projectName).project;
488
531
  }
532
+ /**
533
+ * Return a fully-qualified projectLocationCmekConfig resource name string.
534
+ *
535
+ * @param {string} project
536
+ * @param {string} location
537
+ * @returns {string} Resource name string.
538
+ */
539
+ projectLocationCmekConfigPath(project, location) {
540
+ return this.pathTemplates.projectLocationCmekConfigPathTemplate.render({
541
+ project: project,
542
+ location: location,
543
+ });
544
+ }
545
+ /**
546
+ * Parse the project from ProjectLocationCmekConfig resource.
547
+ *
548
+ * @param {string} projectLocationCmekConfigName
549
+ * A fully-qualified path representing project_location_cmekConfig resource.
550
+ * @returns {string} A string representing the project.
551
+ */
552
+ matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
553
+ return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).project;
554
+ }
555
+ /**
556
+ * Parse the location from ProjectLocationCmekConfig resource.
557
+ *
558
+ * @param {string} projectLocationCmekConfigName
559
+ * A fully-qualified path representing project_location_cmekConfig resource.
560
+ * @returns {string} A string representing the location.
561
+ */
562
+ matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
563
+ return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).location;
564
+ }
565
+ /**
566
+ * Return a fully-qualified projectLocationCmekConfigs resource name string.
567
+ *
568
+ * @param {string} project
569
+ * @param {string} location
570
+ * @param {string} cmek_config
571
+ * @returns {string} Resource name string.
572
+ */
573
+ projectLocationCmekConfigsPath(project, location, cmekConfig) {
574
+ return this.pathTemplates.projectLocationCmekConfigsPathTemplate.render({
575
+ project: project,
576
+ location: location,
577
+ cmek_config: cmekConfig,
578
+ });
579
+ }
580
+ /**
581
+ * Parse the project from ProjectLocationCmekConfigs resource.
582
+ *
583
+ * @param {string} projectLocationCmekConfigsName
584
+ * A fully-qualified path representing project_location_cmekConfigs resource.
585
+ * @returns {string} A string representing the project.
586
+ */
587
+ matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
588
+ return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).project;
589
+ }
590
+ /**
591
+ * Parse the location from ProjectLocationCmekConfigs resource.
592
+ *
593
+ * @param {string} projectLocationCmekConfigsName
594
+ * A fully-qualified path representing project_location_cmekConfigs resource.
595
+ * @returns {string} A string representing the location.
596
+ */
597
+ matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
598
+ return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).location;
599
+ }
600
+ /**
601
+ * Parse the cmek_config from ProjectLocationCmekConfigs resource.
602
+ *
603
+ * @param {string} projectLocationCmekConfigsName
604
+ * A fully-qualified path representing project_location_cmekConfigs resource.
605
+ * @returns {string} A string representing the cmek_config.
606
+ */
607
+ matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
608
+ return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).cmek_config;
609
+ }
489
610
  /**
490
611
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
491
612
  *
@@ -2643,7 +2764,7 @@ class ServingConfigServiceClient {
2643
2764
  this._log.info('ending gRPC channel');
2644
2765
  this._terminated = true;
2645
2766
  stub.close();
2646
- this.locationsClient.close();
2767
+ this.locationsClient.close().catch(err => { throw err; });
2647
2768
  });
2648
2769
  }
2649
2770
  return Promise.resolve();
@@ -1,6 +1,7 @@
1
1
  [
2
2
  "../../protos/google/cloud/discoveryengine/v1/answer.proto",
3
3
  "../../protos/google/cloud/discoveryengine/v1/chunk.proto",
4
+ "../../protos/google/cloud/discoveryengine/v1/cmek_config_service.proto",
4
5
  "../../protos/google/cloud/discoveryengine/v1/common.proto",
5
6
  "../../protos/google/cloud/discoveryengine/v1/completion.proto",
6
7
  "../../protos/google/cloud/discoveryengine/v1/completion_service.proto",
@@ -18,6 +19,8 @@
18
19
  "../../protos/google/cloud/discoveryengine/v1/engine_service.proto",
19
20
  "../../protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto",
20
21
  "../../protos/google/cloud/discoveryengine/v1/grounding.proto",
22
+ "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto",
23
+ "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
21
24
  "../../protos/google/cloud/discoveryengine/v1/import_config.proto",
22
25
  "../../protos/google/cloud/discoveryengine/v1/project.proto",
23
26
  "../../protos/google/cloud/discoveryengine/v1/project_service.proto",
@@ -35,5 +38,7 @@
35
38
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
36
39
  "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
37
40
  "../../protos/google/cloud/discoveryengine/v1/user_event.proto",
38
- "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto"
41
+ "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto",
42
+ "../../protos/google/cloud/discoveryengine/v1/user_license.proto",
43
+ "../../protos/google/cloud/discoveryengine/v1/user_license_service.proto"
39
44
  ]