google-apis-discoveryengine_v1alpha 0.52.0 → 0.53.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/OVERVIEW.md +1 -1
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +8816 -3332
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +2782 -596
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +1663 -219
- data/lib/google/apis/discoveryengine_v1alpha.rb +1 -1
- metadata +4 -7
@@ -30,7 +30,7 @@ module Google
|
|
30
30
|
# Discoveryengine = Google::Apis::DiscoveryengineV1alpha # Alias the module
|
31
31
|
# service = Discoveryengine::DiscoveryEngineService.new
|
32
32
|
#
|
33
|
-
# @see https://cloud.google.com/
|
33
|
+
# @see https://cloud.google.com/generative-ai-app-builder/docs/
|
34
34
|
class DiscoveryEngineService < Google::Apis::Core::BaseService
|
35
35
|
DEFAULT_ENDPOINT_TEMPLATE = "https://discoveryengine.$UNIVERSE_DOMAIN$/"
|
36
36
|
|
@@ -189,11 +189,508 @@ module Google
|
|
189
189
|
execute_or_queue_command(command, &block)
|
190
190
|
end
|
191
191
|
|
192
|
+
# Generates grounded content.
|
193
|
+
# @param [String] location
|
194
|
+
# Required. Location resource. Format: `projects/`project`/locations/`location``.
|
195
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest] google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object
|
196
|
+
# @param [String] fields
|
197
|
+
# Selector specifying which fields to include in a partial response.
|
198
|
+
# @param [String] quota_user
|
199
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
200
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
201
|
+
# @param [Google::Apis::RequestOptions] options
|
202
|
+
# Request-specific options
|
203
|
+
#
|
204
|
+
# @yield [result, err] Result & error if block supplied
|
205
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse] parsed result object
|
206
|
+
# @yieldparam err [StandardError] error object if request failed
|
207
|
+
#
|
208
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse]
|
209
|
+
#
|
210
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
211
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
212
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
213
|
+
def generate_project_location_grounded_content(location, google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
214
|
+
command = make_simple_command(:post, 'v1alpha/{+location}:generateGroundedContent', options)
|
215
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentRequest::Representation
|
216
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_generate_grounded_content_request_object
|
217
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse::Representation
|
218
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGenerateGroundedContentResponse
|
219
|
+
command.params['location'] = location unless location.nil?
|
220
|
+
command.query['fields'] = fields unless fields.nil?
|
221
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
222
|
+
execute_or_queue_command(command, &block)
|
223
|
+
end
|
224
|
+
|
192
225
|
# Gets the AclConfig.
|
193
226
|
# @param [String] name
|
194
|
-
# Required. Resource name of AclConfig, such as `projects/*/locations/*/
|
195
|
-
# aclConfig`. If the caller does not have permission to access the AclConfig,
|
196
|
-
# regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
227
|
+
# Required. Resource name of AclConfig, such as `projects/*/locations/*/
|
228
|
+
# aclConfig`. If the caller does not have permission to access the AclConfig,
|
229
|
+
# regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
|
230
|
+
# @param [String] fields
|
231
|
+
# Selector specifying which fields to include in a partial response.
|
232
|
+
# @param [String] quota_user
|
233
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
234
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
235
|
+
# @param [Google::Apis::RequestOptions] options
|
236
|
+
# Request-specific options
|
237
|
+
#
|
238
|
+
# @yield [result, err] Result & error if block supplied
|
239
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig] parsed result object
|
240
|
+
# @yieldparam err [StandardError] error object if request failed
|
241
|
+
#
|
242
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig]
|
243
|
+
#
|
244
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
245
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
246
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
247
|
+
def get_project_location_acl_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
248
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
249
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig::Representation
|
250
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig
|
251
|
+
command.params['name'] = name unless name.nil?
|
252
|
+
command.query['fields'] = fields unless fields.nil?
|
253
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
254
|
+
execute_or_queue_command(command, &block)
|
255
|
+
end
|
256
|
+
|
257
|
+
# Gets the CmekConfig.
|
258
|
+
# @param [String] name
|
259
|
+
# Required. Resource name of CmekConfig, such as `projects/*/locations/*/
|
260
|
+
# cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not
|
261
|
+
# have permission to access the CmekConfig, regardless of whether or not it
|
262
|
+
# exists, a PERMISSION_DENIED error is returned.
|
263
|
+
# @param [String] fields
|
264
|
+
# Selector specifying which fields to include in a partial response.
|
265
|
+
# @param [String] quota_user
|
266
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
267
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
268
|
+
# @param [Google::Apis::RequestOptions] options
|
269
|
+
# Request-specific options
|
270
|
+
#
|
271
|
+
# @yield [result, err] Result & error if block supplied
|
272
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] parsed result object
|
273
|
+
# @yieldparam err [StandardError] error object if request failed
|
274
|
+
#
|
275
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig]
|
276
|
+
#
|
277
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
278
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
279
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
280
|
+
def get_project_location_single_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
281
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
282
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig::Representation
|
283
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig
|
284
|
+
command.params['name'] = name unless name.nil?
|
285
|
+
command.query['fields'] = fields unless fields.nil?
|
286
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
287
|
+
execute_or_queue_command(command, &block)
|
288
|
+
end
|
289
|
+
|
290
|
+
# Obtains the time series data of organic or dedicated crawl rate for monitoring.
|
291
|
+
# When dedicated crawl rate is not set, it will return vertex AI's organic
|
292
|
+
# crawl rate time series. Organic crawl means Google automatically crawl the
|
293
|
+
# internet at its own convenience. When dedicated crawl rate is set, it will
|
294
|
+
# return vertex AI's dedicated crawl rate time series.
|
295
|
+
# @param [String] location
|
296
|
+
# Required. The location resource where crawl rate management will be performed.
|
297
|
+
# Format: `projects/`project`/locations/`location``
|
298
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest] google_cloud_discoveryengine_v1alpha_obtain_crawl_rate_request_object
|
299
|
+
# @param [String] fields
|
300
|
+
# Selector specifying which fields to include in a partial response.
|
301
|
+
# @param [String] quota_user
|
302
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
303
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
304
|
+
# @param [Google::Apis::RequestOptions] options
|
305
|
+
# Request-specific options
|
306
|
+
#
|
307
|
+
# @yield [result, err] Result & error if block supplied
|
308
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse] parsed result object
|
309
|
+
# @yieldparam err [StandardError] error object if request failed
|
310
|
+
#
|
311
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse]
|
312
|
+
#
|
313
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
314
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
315
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
316
|
+
def obtain_project_location_crawl_rate(location, google_cloud_discoveryengine_v1alpha_obtain_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
317
|
+
command = make_simple_command(:post, 'v1alpha/{+location}:obtainCrawlRate', options)
|
318
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest::Representation
|
319
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_obtain_crawl_rate_request_object
|
320
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse::Representation
|
321
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse
|
322
|
+
command.params['location'] = location unless location.nil?
|
323
|
+
command.query['fields'] = fields unless fields.nil?
|
324
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
325
|
+
execute_or_queue_command(command, &block)
|
326
|
+
end
|
327
|
+
|
328
|
+
# Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl
|
329
|
+
# rate was set, this will disable vertex AI's crawl bot from using the dedicated
|
330
|
+
# crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-
|
331
|
+
# op.
|
332
|
+
# @param [String] location
|
333
|
+
# Required. The location resource where crawl rate management will be performed.
|
334
|
+
# Format: `projects/`project`/locations/`location``
|
335
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest] google_cloud_discoveryengine_v1alpha_remove_dedicated_crawl_rate_request_object
|
336
|
+
# @param [String] fields
|
337
|
+
# Selector specifying which fields to include in a partial response.
|
338
|
+
# @param [String] quota_user
|
339
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
340
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
341
|
+
# @param [Google::Apis::RequestOptions] options
|
342
|
+
# Request-specific options
|
343
|
+
#
|
344
|
+
# @yield [result, err] Result & error if block supplied
|
345
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
346
|
+
# @yieldparam err [StandardError] error object if request failed
|
347
|
+
#
|
348
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
349
|
+
#
|
350
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
351
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
352
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
353
|
+
def remove_project_location_dedicated_crawl_rate(location, google_cloud_discoveryengine_v1alpha_remove_dedicated_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
354
|
+
command = make_simple_command(:post, 'v1alpha/{+location}:removeDedicatedCrawlRate', options)
|
355
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateRequest::Representation
|
356
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_remove_dedicated_crawl_rate_request_object
|
357
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
358
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
359
|
+
command.params['location'] = location unless location.nil?
|
360
|
+
command.query['fields'] = fields unless fields.nil?
|
361
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
362
|
+
execute_or_queue_command(command, &block)
|
363
|
+
end
|
364
|
+
|
365
|
+
# Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl
|
366
|
+
# rate was not set, this will enable vertex AI's crawl bot to use the new
|
367
|
+
# dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex
|
368
|
+
# AI's crawl bot will try to update the rate to the new value. If the new value
|
369
|
+
# is too high, the crawl bot may crawl at a lower rate to avoid overloading the
|
370
|
+
# user's website.
|
371
|
+
# @param [String] location
|
372
|
+
# Required. The location resource where crawl rate management will be performed.
|
373
|
+
# Format: `projects/`project`/locations/`location``
|
374
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest] google_cloud_discoveryengine_v1alpha_set_dedicated_crawl_rate_request_object
|
375
|
+
# @param [String] fields
|
376
|
+
# Selector specifying which fields to include in a partial response.
|
377
|
+
# @param [String] quota_user
|
378
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
379
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
380
|
+
# @param [Google::Apis::RequestOptions] options
|
381
|
+
# Request-specific options
|
382
|
+
#
|
383
|
+
# @yield [result, err] Result & error if block supplied
|
384
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
385
|
+
# @yieldparam err [StandardError] error object if request failed
|
386
|
+
#
|
387
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
388
|
+
#
|
389
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
390
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
391
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
392
|
+
def set_project_location_dedicated_crawl_rate(location, google_cloud_discoveryengine_v1alpha_set_dedicated_crawl_rate_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
393
|
+
command = make_simple_command(:post, 'v1alpha/{+location}:setDedicatedCrawlRate', options)
|
394
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateRequest::Representation
|
395
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_set_dedicated_crawl_rate_request_object
|
396
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
397
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
398
|
+
command.params['location'] = location unless location.nil?
|
399
|
+
command.query['fields'] = fields unless fields.nil?
|
400
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
401
|
+
execute_or_queue_command(command, &block)
|
402
|
+
end
|
403
|
+
|
404
|
+
# Creates a Collection and sets up the DataConnector for it. To stop a
|
405
|
+
# DataConnector after setup, use the CollectionService.DeleteCollection method.
|
406
|
+
# @param [String] parent
|
407
|
+
# Required. The parent of Collection, in the format of `projects/`project`/
|
408
|
+
# locations/`location``.
|
409
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest] google_cloud_discoveryengine_v1alpha_set_up_data_connector_request_object
|
410
|
+
# @param [String] fields
|
411
|
+
# Selector specifying which fields to include in a partial response.
|
412
|
+
# @param [String] quota_user
|
413
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
414
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
415
|
+
# @param [Google::Apis::RequestOptions] options
|
416
|
+
# Request-specific options
|
417
|
+
#
|
418
|
+
# @yield [result, err] Result & error if block supplied
|
419
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
420
|
+
# @yieldparam err [StandardError] error object if request failed
|
421
|
+
#
|
422
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
423
|
+
#
|
424
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
425
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
426
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
427
|
+
def set_project_location_up_data_connector(parent, google_cloud_discoveryengine_v1alpha_set_up_data_connector_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
428
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}:setUpDataConnector', options)
|
429
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorRequest::Representation
|
430
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_set_up_data_connector_request_object
|
431
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
432
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
433
|
+
command.params['parent'] = parent unless parent.nil?
|
434
|
+
command.query['fields'] = fields unless fields.nil?
|
435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
436
|
+
execute_or_queue_command(command, &block)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Default ACL configuration for use in a location of a customer's project.
|
440
|
+
# Updates will only reflect to new data stores. Existing data stores will still
|
441
|
+
# use the old value.
|
442
|
+
# @param [String] name
|
443
|
+
# Immutable. The full resource name of the acl configuration. Format: `projects/`
|
444
|
+
# project`/locations/`location`/aclConfig`. This field must be a UTF-8 encoded
|
445
|
+
# string with a length limit of 1024 characters.
|
446
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig] google_cloud_discoveryengine_v1alpha_acl_config_object
|
447
|
+
# @param [String] fields
|
448
|
+
# Selector specifying which fields to include in a partial response.
|
449
|
+
# @param [String] quota_user
|
450
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
451
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
452
|
+
# @param [Google::Apis::RequestOptions] options
|
453
|
+
# Request-specific options
|
454
|
+
#
|
455
|
+
# @yield [result, err] Result & error if block supplied
|
456
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig] parsed result object
|
457
|
+
# @yieldparam err [StandardError] error object if request failed
|
458
|
+
#
|
459
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig]
|
460
|
+
#
|
461
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
462
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
463
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
464
|
+
def update_project_location_acl_config(name, google_cloud_discoveryengine_v1alpha_acl_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
465
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
466
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig::Representation
|
467
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_acl_config_object
|
468
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig::Representation
|
469
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAclConfig
|
470
|
+
command.params['name'] = name unless name.nil?
|
471
|
+
command.query['fields'] = fields unless fields.nil?
|
472
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
473
|
+
execute_or_queue_command(command, &block)
|
474
|
+
end
|
475
|
+
|
476
|
+
# Provisions a CMEK key for use in a location of a customer's project. This
|
477
|
+
# method will also conduct location validation on the provided cmekConfig to
|
478
|
+
# make sure the key is valid and can be used in the selected location.
|
479
|
+
# @param [String] name
|
480
|
+
# Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
|
481
|
+
# location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
|
482
|
+
# cmekConfig``.
|
483
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
|
484
|
+
# @param [Boolean] set_default
|
485
|
+
# Set the following CmekConfig as the default to be used for child resources if
|
486
|
+
# one is not specified.
|
487
|
+
# @param [String] fields
|
488
|
+
# Selector specifying which fields to include in a partial response.
|
489
|
+
# @param [String] quota_user
|
490
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
491
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
492
|
+
# @param [Google::Apis::RequestOptions] options
|
493
|
+
# Request-specific options
|
494
|
+
#
|
495
|
+
# @yield [result, err] Result & error if block supplied
|
496
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
497
|
+
# @yieldparam err [StandardError] error object if request failed
|
498
|
+
#
|
499
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
500
|
+
#
|
501
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
502
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
503
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
504
|
+
def update_project_location_cmek_config(name, google_cloud_discoveryengine_v1alpha_cmek_config_object = nil, set_default: nil, fields: nil, quota_user: nil, options: nil, &block)
|
505
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
506
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig::Representation
|
507
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_cmek_config_object
|
508
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
509
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
510
|
+
command.params['name'] = name unless name.nil?
|
511
|
+
command.query['setDefault'] = set_default unless set_default.nil?
|
512
|
+
command.query['fields'] = fields unless fields.nil?
|
513
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
514
|
+
execute_or_queue_command(command, &block)
|
515
|
+
end
|
516
|
+
|
517
|
+
# Gets the CmekConfig.
|
518
|
+
# @param [String] name
|
519
|
+
# Required. Resource name of CmekConfig, such as `projects/*/locations/*/
|
520
|
+
# cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not
|
521
|
+
# have permission to access the CmekConfig, regardless of whether or not it
|
522
|
+
# exists, a PERMISSION_DENIED error is returned.
|
523
|
+
# @param [String] fields
|
524
|
+
# Selector specifying which fields to include in a partial response.
|
525
|
+
# @param [String] quota_user
|
526
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
527
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
528
|
+
# @param [Google::Apis::RequestOptions] options
|
529
|
+
# Request-specific options
|
530
|
+
#
|
531
|
+
# @yield [result, err] Result & error if block supplied
|
532
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] parsed result object
|
533
|
+
# @yieldparam err [StandardError] error object if request failed
|
534
|
+
#
|
535
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig]
|
536
|
+
#
|
537
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
538
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
539
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
540
|
+
def get_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
541
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
542
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig::Representation
|
543
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig
|
544
|
+
command.params['name'] = name unless name.nil?
|
545
|
+
command.query['fields'] = fields unless fields.nil?
|
546
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
547
|
+
execute_or_queue_command(command, &block)
|
548
|
+
end
|
549
|
+
|
550
|
+
# Lists all the CmekConfigs with the project.
|
551
|
+
# @param [String] parent
|
552
|
+
# Required. The parent location resource name, such as `projects/`project`/
|
553
|
+
# locations/`location``. If the caller does not have permission to list
|
554
|
+
# CmekConfigs under this location, regardless of whether or not a CmekConfig
|
555
|
+
# exists, a PERMISSION_DENIED error is returned.
|
556
|
+
# @param [String] fields
|
557
|
+
# Selector specifying which fields to include in a partial response.
|
558
|
+
# @param [String] quota_user
|
559
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
560
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
561
|
+
# @param [Google::Apis::RequestOptions] options
|
562
|
+
# Request-specific options
|
563
|
+
#
|
564
|
+
# @yield [result, err] Result & error if block supplied
|
565
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse] parsed result object
|
566
|
+
# @yieldparam err [StandardError] error object if request failed
|
567
|
+
#
|
568
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse]
|
569
|
+
#
|
570
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
571
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
572
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
573
|
+
def list_project_location_cmek_configs(parent, fields: nil, quota_user: nil, options: nil, &block)
|
574
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/cmekConfigs', options)
|
575
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse::Representation
|
576
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCmekConfigsResponse
|
577
|
+
command.params['parent'] = parent unless parent.nil?
|
578
|
+
command.query['fields'] = fields unless fields.nil?
|
579
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
580
|
+
execute_or_queue_command(command, &block)
|
581
|
+
end
|
582
|
+
|
583
|
+
# Provisions a CMEK key for use in a location of a customer's project. This
|
584
|
+
# method will also conduct location validation on the provided cmekConfig to
|
585
|
+
# make sure the key is valid and can be used in the selected location.
|
586
|
+
# @param [String] name
|
587
|
+
# Required. Name of the CmekConfig, of the form `projects/`project`/locations/`
|
588
|
+
# location`/cmekConfig` or `projects/`project`/locations/`location`/cmekConfigs/`
|
589
|
+
# cmekConfig``.
|
590
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig] google_cloud_discoveryengine_v1alpha_cmek_config_object
|
591
|
+
# @param [Boolean] set_default
|
592
|
+
# Set the following CmekConfig as the default to be used for child resources if
|
593
|
+
# one is not specified.
|
594
|
+
# @param [String] fields
|
595
|
+
# Selector specifying which fields to include in a partial response.
|
596
|
+
# @param [String] quota_user
|
597
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
598
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
599
|
+
# @param [Google::Apis::RequestOptions] options
|
600
|
+
# Request-specific options
|
601
|
+
#
|
602
|
+
# @yield [result, err] Result & error if block supplied
|
603
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
604
|
+
# @yieldparam err [StandardError] error object if request failed
|
605
|
+
#
|
606
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
607
|
+
#
|
608
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
609
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
610
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
611
|
+
def patch_project_location_cmek_config(name, google_cloud_discoveryengine_v1alpha_cmek_config_object = nil, set_default: nil, fields: nil, quota_user: nil, options: nil, &block)
|
612
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
613
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCmekConfig::Representation
|
614
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_cmek_config_object
|
615
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
616
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
617
|
+
command.params['name'] = name unless name.nil?
|
618
|
+
command.query['setDefault'] = set_default unless set_default.nil?
|
619
|
+
command.query['fields'] = fields unless fields.nil?
|
620
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
621
|
+
execute_or_queue_command(command, &block)
|
622
|
+
end
|
623
|
+
|
624
|
+
# Deletes a Collection.
|
625
|
+
# @param [String] name
|
626
|
+
# Required. The full resource name of the Collection, in the format of `projects/
|
627
|
+
# `project`/locations/`location`/collections/`collection``.
|
628
|
+
# @param [String] fields
|
629
|
+
# Selector specifying which fields to include in a partial response.
|
630
|
+
# @param [String] quota_user
|
631
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
632
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
633
|
+
# @param [Google::Apis::RequestOptions] options
|
634
|
+
# Request-specific options
|
635
|
+
#
|
636
|
+
# @yield [result, err] Result & error if block supplied
|
637
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
638
|
+
# @yieldparam err [StandardError] error object if request failed
|
639
|
+
#
|
640
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
641
|
+
#
|
642
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
643
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
644
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
645
|
+
def delete_project_location_collection(name, fields: nil, quota_user: nil, options: nil, &block)
|
646
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
647
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
648
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
649
|
+
command.params['name'] = name unless name.nil?
|
650
|
+
command.query['fields'] = fields unless fields.nil?
|
651
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
652
|
+
execute_or_queue_command(command, &block)
|
653
|
+
end
|
654
|
+
|
655
|
+
# Gets a Collection.
|
656
|
+
# @param [String] name
|
657
|
+
# Required. The full resource name, in the format of `projects/`project`/
|
658
|
+
# locations/`location`/collections/`collection``.
|
659
|
+
# @param [String] fields
|
660
|
+
# Selector specifying which fields to include in a partial response.
|
661
|
+
# @param [String] quota_user
|
662
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
663
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
664
|
+
# @param [Google::Apis::RequestOptions] options
|
665
|
+
# Request-specific options
|
666
|
+
#
|
667
|
+
# @yield [result, err] Result & error if block supplied
|
668
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection] parsed result object
|
669
|
+
# @yieldparam err [StandardError] error object if request failed
|
670
|
+
#
|
671
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection]
|
672
|
+
#
|
673
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
674
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
675
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
676
|
+
def get_project_location_collection(name, fields: nil, quota_user: nil, options: nil, &block)
|
677
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
678
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection::Representation
|
679
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection
|
680
|
+
command.params['name'] = name unless name.nil?
|
681
|
+
command.query['fields'] = fields unless fields.nil?
|
682
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
683
|
+
execute_or_queue_command(command, &block)
|
684
|
+
end
|
685
|
+
|
686
|
+
# Gets the DataConnector. DataConnector is a singleton resource for each
|
687
|
+
# Collection.
|
688
|
+
# @param [String] name
|
689
|
+
# Required. Full resource name of DataConnector, such as `projects/`project`/
|
690
|
+
# locations/`location`/collections/`collection_id`/dataConnector`. If the caller
|
691
|
+
# does not have permission to access the DataConnector, regardless of whether or
|
692
|
+
# not it exists, a PERMISSION_DENIED error is returned. If the requested
|
693
|
+
# DataConnector does not exist, a NOT_FOUND error is returned.
|
197
694
|
# @param [String] fields
|
198
695
|
# Selector specifying which fields to include in a partial response.
|
199
696
|
# @param [String] quota_user
|
@@ -203,32 +700,79 @@ module Google
|
|
203
700
|
# Request-specific options
|
204
701
|
#
|
205
702
|
# @yield [result, err] Result & error if block supplied
|
206
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
703
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector] parsed result object
|
207
704
|
# @yieldparam err [StandardError] error object if request failed
|
208
705
|
#
|
209
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
706
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector]
|
210
707
|
#
|
211
708
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
212
709
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
213
710
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
214
|
-
def
|
711
|
+
def get_project_location_collection_data_connector(name, fields: nil, quota_user: nil, options: nil, &block)
|
215
712
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
216
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
217
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
713
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector::Representation
|
714
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector
|
218
715
|
command.params['name'] = name unless name.nil?
|
219
716
|
command.query['fields'] = fields unless fields.nil?
|
220
717
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
221
718
|
execute_or_queue_command(command, &block)
|
222
719
|
end
|
223
720
|
|
224
|
-
#
|
225
|
-
#
|
226
|
-
#
|
721
|
+
# Gets a list of Collections.
|
722
|
+
# @param [String] parent
|
723
|
+
# Required. The parent data store resource name, in the format of `projects/`
|
724
|
+
# project`/locations/`location``.
|
725
|
+
# @param [String] filter
|
726
|
+
# Filter returned collections by associated data connector data sources. For
|
727
|
+
# example: `filter = 'data_source:jira confluence'`. If the filter is empty, we
|
728
|
+
# return all collections under a project and location.
|
729
|
+
# @param [Fixnum] page_size
|
730
|
+
# The maximum number of Collections to return. The service may return fewer than
|
731
|
+
# this value. If unspecified, at most 100 Collections will be returned. The
|
732
|
+
# maximum value is 1000; values above 1000 will be coerced to 1000.
|
733
|
+
# @param [String] page_token
|
734
|
+
# A page token, received from a previous CollectionService.ListCollections call.
|
735
|
+
# Provide this to retrieve the subsequent page. When paginating, all other
|
736
|
+
# parameters provided to CollectionService.ListCollections must match the call
|
737
|
+
# that provided the page token.
|
738
|
+
# @param [String] fields
|
739
|
+
# Selector specifying which fields to include in a partial response.
|
740
|
+
# @param [String] quota_user
|
741
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
742
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
743
|
+
# @param [Google::Apis::RequestOptions] options
|
744
|
+
# Request-specific options
|
745
|
+
#
|
746
|
+
# @yield [result, err] Result & error if block supplied
|
747
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCollectionsResponse] parsed result object
|
748
|
+
# @yieldparam err [StandardError] error object if request failed
|
749
|
+
#
|
750
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCollectionsResponse]
|
751
|
+
#
|
752
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
753
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
754
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
755
|
+
def list_project_location_collections(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
756
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/collections', options)
|
757
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCollectionsResponse::Representation
|
758
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCollectionsResponse
|
759
|
+
command.params['parent'] = parent unless parent.nil?
|
760
|
+
command.query['filter'] = filter unless filter.nil?
|
761
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
762
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
763
|
+
command.query['fields'] = fields unless fields.nil?
|
764
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
765
|
+
execute_or_queue_command(command, &block)
|
766
|
+
end
|
767
|
+
|
768
|
+
# Updates a Collection.
|
227
769
|
# @param [String] name
|
228
|
-
# Immutable. The full resource name of the
|
229
|
-
# project`/locations/`location`/
|
230
|
-
# string with a length limit of 1024 characters.
|
231
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::
|
770
|
+
# Immutable. The full resource name of the Collection. Format: `projects/`
|
771
|
+
# project`/locations/`location`/collections/`collection_id``. This field must be
|
772
|
+
# a UTF-8 encoded string with a length limit of 1024 characters.
|
773
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection] google_cloud_discoveryengine_v1alpha_collection_object
|
774
|
+
# @param [String] update_mask
|
775
|
+
# Optional. The list of fields to be updated.
|
232
776
|
# @param [String] fields
|
233
777
|
# Selector specifying which fields to include in a partial response.
|
234
778
|
# @param [String] quota_user
|
@@ -238,21 +782,147 @@ module Google
|
|
238
782
|
# Request-specific options
|
239
783
|
#
|
240
784
|
# @yield [result, err] Result & error if block supplied
|
241
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
785
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
242
786
|
# @yieldparam err [StandardError] error object if request failed
|
243
787
|
#
|
244
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
788
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
245
789
|
#
|
246
790
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
247
791
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
248
792
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
249
|
-
def
|
793
|
+
def patch_project_location_collection(name, google_cloud_discoveryengine_v1alpha_collection_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
250
794
|
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
251
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
252
|
-
command.request_object =
|
253
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
254
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
795
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCollection::Representation
|
796
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_collection_object
|
797
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
798
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
799
|
+
command.params['name'] = name unless name.nil?
|
800
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
801
|
+
command.query['fields'] = fields unless fields.nil?
|
802
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
803
|
+
execute_or_queue_command(command, &block)
|
804
|
+
end
|
805
|
+
|
806
|
+
# Updates a DataConnector.
|
807
|
+
# @param [String] name
|
808
|
+
# Output only. The full resource name of the Data Connector. Format: `projects/*/
|
809
|
+
# locations/*/collections/*/dataConnector`.
|
810
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector] google_cloud_discoveryengine_v1alpha_data_connector_object
|
811
|
+
# @param [String] update_mask
|
812
|
+
# Indicates which fields in the provided DataConnector to update. Supported
|
813
|
+
# field paths include: - refresh_interval - params - auto_run_disabled -
|
814
|
+
# action_config - destination_configs - blocking_reasons Note: Support for these
|
815
|
+
# fields may vary depending on the connector type. For example, not all
|
816
|
+
# connectors support `destination_configs`. If an unsupported or unknown field
|
817
|
+
# path is provided, the request will return an INVALID_ARGUMENT error.
|
818
|
+
# @param [String] fields
|
819
|
+
# Selector specifying which fields to include in a partial response.
|
820
|
+
# @param [String] quota_user
|
821
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
822
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
823
|
+
# @param [Google::Apis::RequestOptions] options
|
824
|
+
# Request-specific options
|
825
|
+
#
|
826
|
+
# @yield [result, err] Result & error if block supplied
|
827
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector] parsed result object
|
828
|
+
# @yieldparam err [StandardError] error object if request failed
|
829
|
+
#
|
830
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector]
|
831
|
+
#
|
832
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
833
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
834
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
835
|
+
def update_project_location_collection_data_connector(name, google_cloud_discoveryengine_v1alpha_data_connector_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
836
|
+
command = make_simple_command(:patch, 'v1alpha/{+name}', options)
|
837
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector::Representation
|
838
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_data_connector_object
|
839
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector::Representation
|
840
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnector
|
255
841
|
command.params['name'] = name unless name.nil?
|
842
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
843
|
+
command.query['fields'] = fields unless fields.nil?
|
844
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
845
|
+
execute_or_queue_command(command, &block)
|
846
|
+
end
|
847
|
+
|
848
|
+
# Starts an immediate synchronization process for a DataConnector. Third Party
|
849
|
+
# Connector Users must specify which entities should be synced. FHIR Connectors
|
850
|
+
# must provide a timestamp to indicate the point in time from which data should
|
851
|
+
# be synced.
|
852
|
+
# @param [String] parent
|
853
|
+
# Required. Connector name of the form projects/`project`/locations/`location`/
|
854
|
+
# collections/ `collection_id`/dataConnector
|
855
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest] google_cloud_discoveryengine_v1alpha_start_connector_run_request_object
|
856
|
+
# @param [String] fields
|
857
|
+
# Selector specifying which fields to include in a partial response.
|
858
|
+
# @param [String] quota_user
|
859
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
860
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
861
|
+
# @param [Google::Apis::RequestOptions] options
|
862
|
+
# Request-specific options
|
863
|
+
#
|
864
|
+
# @yield [result, err] Result & error if block supplied
|
865
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRun] parsed result object
|
866
|
+
# @yieldparam err [StandardError] error object if request failed
|
867
|
+
#
|
868
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRun]
|
869
|
+
#
|
870
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
871
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
872
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
873
|
+
def start_project_location_collection_data_connector_connector_run(parent, google_cloud_discoveryengine_v1alpha_start_connector_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
874
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}:startConnectorRun', options)
|
875
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaStartConnectorRunRequest::Representation
|
876
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_start_connector_run_request_object
|
877
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRun::Representation
|
878
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRun
|
879
|
+
command.params['parent'] = parent unless parent.nil?
|
880
|
+
command.query['fields'] = fields unless fields.nil?
|
881
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
882
|
+
execute_or_queue_command(command, &block)
|
883
|
+
end
|
884
|
+
|
885
|
+
# Lists the ConnectorRuns of a DataConnector.
|
886
|
+
# @param [String] parent
|
887
|
+
# Required. The parent DataConnector resource name, such as `projects/`project`/
|
888
|
+
# locations/`location`/collections/`collection_id`/dataConnector`. If the caller
|
889
|
+
# does not have permission to list ConnectorRuns under this DataConnector,
|
890
|
+
# regardless of whether or not this DataConnector exists, a PERMISSION_DENIED
|
891
|
+
# error is returned.
|
892
|
+
# @param [Fixnum] page_size
|
893
|
+
# Requested page size. Server may return fewer items than requested. If
|
894
|
+
# unspecified, defaults to 10. The maximum value is 50; values above 50 will be
|
895
|
+
# coerced to 50. If this field is negative, an INVALID_ARGUMENT error is
|
896
|
+
# returned.
|
897
|
+
# @param [String] page_token
|
898
|
+
# A page token, received from a previous `ListConnectorRuns` call. Provide this
|
899
|
+
# to retrieve the subsequent page. When paginating, all other parameters
|
900
|
+
# provided to `ListConnectorRuns` must match the call that provided the page
|
901
|
+
# token.
|
902
|
+
# @param [String] fields
|
903
|
+
# Selector specifying which fields to include in a partial response.
|
904
|
+
# @param [String] quota_user
|
905
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
906
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
907
|
+
# @param [Google::Apis::RequestOptions] options
|
908
|
+
# Request-specific options
|
909
|
+
#
|
910
|
+
# @yield [result, err] Result & error if block supplied
|
911
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse] parsed result object
|
912
|
+
# @yieldparam err [StandardError] error object if request failed
|
913
|
+
#
|
914
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse]
|
915
|
+
#
|
916
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
917
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
918
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
919
|
+
def list_project_location_collection_data_connector_connector_runs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
920
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/connectorRuns', options)
|
921
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse::Representation
|
922
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListConnectorRunsResponse
|
923
|
+
command.params['parent'] = parent unless parent.nil?
|
924
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
925
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
256
926
|
command.query['fields'] = fields unless fields.nil?
|
257
927
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
258
928
|
execute_or_queue_command(command, &block)
|
@@ -399,6 +1069,8 @@ module Google
|
|
399
1069
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
400
1070
|
# location`/collections/`collection``.
|
401
1071
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
|
1072
|
+
# @param [String] cmek_config_name
|
1073
|
+
# Resource name of the CmekConfig to use for protecting this DataStore.
|
402
1074
|
# @param [Boolean] create_advanced_site_search
|
403
1075
|
# A boolean flag indicating whether user want to directly create an advanced
|
404
1076
|
# data store for site search. If the data store is not configured as site search
|
@@ -409,6 +1081,15 @@ module Google
|
|
409
1081
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
410
1082
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
411
1083
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
1084
|
+
# @param [Boolean] disable_cmek
|
1085
|
+
# DataStore without CMEK protections. If a default CmekConfig is set for the
|
1086
|
+
# project, setting this field will override the default CmekConfig as well.
|
1087
|
+
# @param [Boolean] skip_default_schema_creation
|
1088
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
1089
|
+
# data store. Only enable this flag if you are certain that the default schema
|
1090
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
1091
|
+
# schema for the data store before any documents can be ingested. This flag
|
1092
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
412
1093
|
# @param [String] fields
|
413
1094
|
# Selector specifying which fields to include in a partial response.
|
414
1095
|
# @param [String] quota_user
|
@@ -426,15 +1107,18 @@ module Google
|
|
426
1107
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
427
1108
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
428
1109
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
429
|
-
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1110
|
+
def create_project_location_collection_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
430
1111
|
command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
|
431
1112
|
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
|
432
1113
|
command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
|
433
1114
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
434
1115
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
435
1116
|
command.params['parent'] = parent unless parent.nil?
|
1117
|
+
command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
|
436
1118
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
437
1119
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
1120
|
+
command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
|
1121
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
438
1122
|
command.query['fields'] = fields unless fields.nil?
|
439
1123
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
440
1124
|
execute_or_queue_command(command, &block)
|
@@ -511,8 +1195,8 @@ module Google
|
|
511
1195
|
# Gets a DocumentProcessingConfig.
|
512
1196
|
# @param [String] name
|
513
1197
|
# Required. Full DocumentProcessingConfig resource name. Format: `projects/`
|
514
|
-
#
|
515
|
-
#
|
1198
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
1199
|
+
# data_store_id`/documentProcessingConfig`
|
516
1200
|
# @param [String] fields
|
517
1201
|
# Selector specifying which fields to include in a partial response.
|
518
1202
|
# @param [String] quota_user
|
@@ -739,6 +1423,46 @@ module Google
|
|
739
1423
|
execute_or_queue_command(command, &block)
|
740
1424
|
end
|
741
1425
|
|
1426
|
+
# Gets index freshness metadata for Documents. Supported for website search only.
|
1427
|
+
# @param [String] parent
|
1428
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
1429
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
1430
|
+
# `branch``.
|
1431
|
+
# @param [Array<String>, String] matcher_fhir_matcher_fhir_resources
|
1432
|
+
# Required. The FHIR resources to match by. Format: projects/`project`/locations/
|
1433
|
+
# `location`/datasets/`dataset`/fhirStores/`fhir_store`/fhir/`resource_type`/`
|
1434
|
+
# fhir_resource_id`
|
1435
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
1436
|
+
# The exact URIs to match by.
|
1437
|
+
# @param [String] fields
|
1438
|
+
# Selector specifying which fields to include in a partial response.
|
1439
|
+
# @param [String] quota_user
|
1440
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1441
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1442
|
+
# @param [Google::Apis::RequestOptions] options
|
1443
|
+
# Request-specific options
|
1444
|
+
#
|
1445
|
+
# @yield [result, err] Result & error if block supplied
|
1446
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse] parsed result object
|
1447
|
+
# @yieldparam err [StandardError] error object if request failed
|
1448
|
+
#
|
1449
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse]
|
1450
|
+
#
|
1451
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1452
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1453
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1454
|
+
def batch_project_location_collection_data_store_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1455
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/batchGetDocumentsMetadata', options)
|
1456
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse::Representation
|
1457
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse
|
1458
|
+
command.params['parent'] = parent unless parent.nil?
|
1459
|
+
command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
|
1460
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
|
1461
|
+
command.query['fields'] = fields unless fields.nil?
|
1462
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1463
|
+
execute_or_queue_command(command, &block)
|
1464
|
+
end
|
1465
|
+
|
742
1466
|
# Creates a Document.
|
743
1467
|
# @param [String] parent
|
744
1468
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
@@ -751,7 +1475,7 @@ module Google
|
|
751
1475
|
# is returned. This field must be unique among all Documents with the same
|
752
1476
|
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
753
1477
|
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
754
|
-
# length limit of
|
1478
|
+
# length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
755
1479
|
# returned.
|
756
1480
|
# @param [String] fields
|
757
1481
|
# Selector specifying which fields to include in a partial response.
|
@@ -1147,8 +1871,8 @@ module Google
|
|
1147
1871
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
1148
1872
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
1149
1873
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
1150
|
-
# an operation with an Operation.error value with a google.rpc.Status.code of 1
|
1151
|
-
# corresponding to `Code.CANCELLED`.
|
1874
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of `1`
|
1875
|
+
# , corresponding to `Code.CANCELLED`.
|
1152
1876
|
# @param [String] name
|
1153
1877
|
# The name of the operation resource to be cancelled.
|
1154
1878
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
@@ -1252,6 +1976,42 @@ module Google
|
|
1252
1976
|
execute_or_queue_command(command, &block)
|
1253
1977
|
end
|
1254
1978
|
|
1979
|
+
# Completes the user input with advanced keyword suggestions.
|
1980
|
+
# @param [String] completion_config
|
1981
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
1982
|
+
# name for which the completion is performed, such as `projects/*/locations/
|
1983
|
+
# global/collections/default_collection/dataStores/*/completionConfig` `projects/
|
1984
|
+
# */locations/global/collections/default_collection/engines/*/completionConfig`.
|
1985
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
1986
|
+
# @param [String] fields
|
1987
|
+
# Selector specifying which fields to include in a partial response.
|
1988
|
+
# @param [String] quota_user
|
1989
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1990
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1991
|
+
# @param [Google::Apis::RequestOptions] options
|
1992
|
+
# Request-specific options
|
1993
|
+
#
|
1994
|
+
# @yield [result, err] Result & error if block supplied
|
1995
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse] parsed result object
|
1996
|
+
# @yieldparam err [StandardError] error object if request failed
|
1997
|
+
#
|
1998
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse]
|
1999
|
+
#
|
2000
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2001
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2002
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2003
|
+
def complete_project_location_collection_data_store_completion_config_query(completion_config, google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2004
|
+
command = make_simple_command(:post, 'v1alpha/{+completionConfig}:completeQuery', options)
|
2005
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest::Representation
|
2006
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
2007
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse::Representation
|
2008
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse
|
2009
|
+
command.params['completionConfig'] = completion_config unless completion_config.nil?
|
2010
|
+
command.query['fields'] = fields unless fields.nil?
|
2011
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2012
|
+
execute_or_queue_command(command, &block)
|
2013
|
+
end
|
2014
|
+
|
1255
2015
|
# Imports CompletionSuggestions for a DataStore.
|
1256
2016
|
# @param [String] parent
|
1257
2017
|
# Required. The parent data store resource name for which to import customer
|
@@ -1325,10 +2085,10 @@ module Google
|
|
1325
2085
|
# request can be submitted to adjust this limit. If the Control to create
|
1326
2086
|
# already exists, an ALREADY_EXISTS error is returned.
|
1327
2087
|
# @param [String] parent
|
1328
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
1329
|
-
#
|
1330
|
-
#
|
1331
|
-
#
|
2088
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
2089
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
|
2090
|
+
# or `projects/`project`/locations/`location`/collections/`collection_id`/
|
2091
|
+
# engines/`engine_id``.
|
1332
2092
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
|
1333
2093
|
# @param [String] control_id
|
1334
2094
|
# Required. The ID to use for the Control, which will become the final component
|
@@ -1368,8 +2128,8 @@ module Google
|
|
1368
2128
|
# is returned.
|
1369
2129
|
# @param [String] name
|
1370
2130
|
# Required. The resource name of the Control to delete. Format: `projects/`
|
1371
|
-
#
|
1372
|
-
#
|
2131
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
2132
|
+
# data_store_id`/controls/`control_id``
|
1373
2133
|
# @param [String] fields
|
1374
2134
|
# Selector specifying which fields to include in a partial response.
|
1375
2135
|
# @param [String] quota_user
|
@@ -1399,9 +2159,9 @@ module Google
|
|
1399
2159
|
|
1400
2160
|
# Gets a Control.
|
1401
2161
|
# @param [String] name
|
1402
|
-
# Required. The resource name of the Control to get. Format: `projects/`
|
1403
|
-
#
|
1404
|
-
#
|
2162
|
+
# Required. The resource name of the Control to get. Format: `projects/`project`/
|
2163
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
|
2164
|
+
# controls/`control_id``
|
1405
2165
|
# @param [String] fields
|
1406
2166
|
# Selector specifying which fields to include in a partial response.
|
1407
2167
|
# @param [String] quota_user
|
@@ -1431,10 +2191,10 @@ module Google
|
|
1431
2191
|
|
1432
2192
|
# Lists all Controls by their parent DataStore.
|
1433
2193
|
# @param [String] parent
|
1434
|
-
# Required. The data store resource name. Format: `projects/`
|
1435
|
-
#
|
1436
|
-
#
|
1437
|
-
#
|
2194
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
2195
|
+
# location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
|
2196
|
+
# `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
|
2197
|
+
# .
|
1438
2198
|
# @param [String] filter
|
1439
2199
|
# Optional. A filter to apply on the list results. Supported features: * List
|
1440
2200
|
# all the products under the parent branch if filter is unset. Currently this
|
@@ -1518,9 +2278,9 @@ module Google
|
|
1518
2278
|
# Converses a conversation.
|
1519
2279
|
# @param [String] name
|
1520
2280
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
1521
|
-
#
|
1522
|
-
# data_store_id`/conversations/`conversation_id``. Use `projects/`
|
1523
|
-
#
|
2281
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
2282
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
|
2283
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
1524
2284
|
# conversations/-` to activate auto session mode, which automatically creates a
|
1525
2285
|
# new conversation inside a ConverseConversation session.
|
1526
2286
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
@@ -1556,9 +2316,8 @@ module Google
|
|
1556
2316
|
# Creates a Conversation. If the Conversation to create already exists, an
|
1557
2317
|
# ALREADY_EXISTS error is returned.
|
1558
2318
|
# @param [String] parent
|
1559
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
1560
|
-
#
|
1561
|
-
# data_store_id``
|
2319
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
2320
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
1562
2321
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
1563
2322
|
# @param [String] fields
|
1564
2323
|
# Selector specifying which fields to include in a partial response.
|
@@ -1593,7 +2352,7 @@ module Google
|
|
1593
2352
|
# NOT_FOUND error is returned.
|
1594
2353
|
# @param [String] name
|
1595
2354
|
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
1596
|
-
#
|
2355
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
1597
2356
|
# data_store_id`/conversations/`conversation_id``
|
1598
2357
|
# @param [String] fields
|
1599
2358
|
# Selector specifying which fields to include in a partial response.
|
@@ -1625,7 +2384,7 @@ module Google
|
|
1625
2384
|
# Gets a Conversation.
|
1626
2385
|
# @param [String] name
|
1627
2386
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
1628
|
-
#
|
2387
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
1629
2388
|
# data_store_id`/conversations/`conversation_id``
|
1630
2389
|
# @param [String] fields
|
1631
2390
|
# Selector specifying which fields to include in a partial response.
|
@@ -1656,8 +2415,8 @@ module Google
|
|
1656
2415
|
|
1657
2416
|
# Lists all Conversations by their parent DataStore.
|
1658
2417
|
# @param [String] parent
|
1659
|
-
# Required. The data store resource name. Format: `projects/`
|
1660
|
-
#
|
2418
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
2419
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
1661
2420
|
# @param [String] filter
|
1662
2421
|
# A filter to apply on the list results. The supported features are:
|
1663
2422
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
@@ -2217,7 +2976,7 @@ module Google
|
|
2217
2976
|
# exist.
|
2218
2977
|
# @param [String] name
|
2219
2978
|
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
2220
|
-
#
|
2979
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine`/
|
2221
2980
|
# servingConfigs/`serving_config_id``
|
2222
2981
|
# @param [String] fields
|
2223
2982
|
# Selector specifying which fields to include in a partial response.
|
@@ -2249,7 +3008,7 @@ module Google
|
|
2249
3008
|
# Lists all ServingConfigs linked to this dataStore.
|
2250
3009
|
# @param [String] parent
|
2251
3010
|
# Required. Full resource name of the parent resource. Format: `projects/`
|
2252
|
-
#
|
3011
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine``
|
2253
3012
|
# @param [Fixnum] page_size
|
2254
3013
|
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
2255
3014
|
# If a value greater than 100 is provided, at most 100 results are returned.
|
@@ -2366,15 +3125,99 @@ module Google
|
|
2366
3125
|
execute_or_queue_command(command, &block)
|
2367
3126
|
end
|
2368
3127
|
|
2369
|
-
# Performs a search.
|
3128
|
+
# Performs a search.
|
3129
|
+
# @param [String] serving_config
|
3130
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3131
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3132
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3133
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
3134
|
+
# default_serving_config`. This field is used to identify the serving
|
3135
|
+
# configuration name, set of models used to make the search.
|
3136
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
3137
|
+
# @param [String] fields
|
3138
|
+
# Selector specifying which fields to include in a partial response.
|
3139
|
+
# @param [String] quota_user
|
3140
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3141
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3142
|
+
# @param [Google::Apis::RequestOptions] options
|
3143
|
+
# Request-specific options
|
3144
|
+
#
|
3145
|
+
# @yield [result, err] Result & error if block supplied
|
3146
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
3147
|
+
# @yieldparam err [StandardError] error object if request failed
|
3148
|
+
#
|
3149
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
3150
|
+
#
|
3151
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3152
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3153
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3154
|
+
def search_project_location_collection_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3155
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
|
3156
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
3157
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
3158
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
3159
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
3160
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3161
|
+
command.query['fields'] = fields unless fields.nil?
|
3162
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3163
|
+
execute_or_queue_command(command, &block)
|
3164
|
+
end
|
3165
|
+
|
3166
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
3167
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
3168
|
+
# not required. Only public website search is supported by this method. If data
|
3169
|
+
# stores and engines not associated with public website search are specified, a `
|
3170
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
3171
|
+
# onboarding without having to implement an authentication backend. However, it
|
3172
|
+
# is strongly recommended to use SearchService.Search instead with required
|
3173
|
+
# OAuth and IAM checks to provide better data security.
|
3174
|
+
# @param [String] serving_config
|
3175
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3176
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3177
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3178
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
3179
|
+
# default_serving_config`. This field is used to identify the serving
|
3180
|
+
# configuration name, set of models used to make the search.
|
3181
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
3182
|
+
# @param [String] fields
|
3183
|
+
# Selector specifying which fields to include in a partial response.
|
3184
|
+
# @param [String] quota_user
|
3185
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3186
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3187
|
+
# @param [Google::Apis::RequestOptions] options
|
3188
|
+
# Request-specific options
|
3189
|
+
#
|
3190
|
+
# @yield [result, err] Result & error if block supplied
|
3191
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
3192
|
+
# @yieldparam err [StandardError] error object if request failed
|
3193
|
+
#
|
3194
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
3195
|
+
#
|
3196
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3197
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3198
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3199
|
+
def search_project_location_collection_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3200
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:searchLite', options)
|
3201
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
3202
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
3203
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
3204
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
3205
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3206
|
+
command.query['fields'] = fields unless fields.nil?
|
3207
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3208
|
+
execute_or_queue_command(command, &block)
|
3209
|
+
end
|
3210
|
+
|
3211
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
3212
|
+
# multiple AnswerQueryResponse messages in a stream.
|
2370
3213
|
# @param [String] serving_config
|
2371
3214
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
2372
3215
|
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
2373
3216
|
# default_serving_config`, or `projects/*/locations/global/collections/
|
2374
|
-
# default_collection/dataStores
|
2375
|
-
#
|
2376
|
-
#
|
2377
|
-
# @param [Google::Apis::DiscoveryengineV1alpha::
|
3217
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
3218
|
+
# field is used to identify the serving configuration name, set of models used
|
3219
|
+
# to make the search.
|
3220
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
2378
3221
|
# @param [String] fields
|
2379
3222
|
# Selector specifying which fields to include in a partial response.
|
2380
3223
|
# @param [String] quota_user
|
@@ -2384,20 +3227,20 @@ module Google
|
|
2384
3227
|
# Request-specific options
|
2385
3228
|
#
|
2386
3229
|
# @yield [result, err] Result & error if block supplied
|
2387
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::
|
3230
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
|
2388
3231
|
# @yieldparam err [StandardError] error object if request failed
|
2389
3232
|
#
|
2390
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
3233
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
|
2391
3234
|
#
|
2392
3235
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2393
3236
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2394
3237
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2395
|
-
def
|
2396
|
-
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:
|
2397
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
2398
|
-
command.request_object =
|
2399
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
2400
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
3238
|
+
def stream_project_location_collection_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3239
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:streamAnswer', options)
|
3240
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
|
3241
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
3242
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
|
3243
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
|
2401
3244
|
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
2402
3245
|
command.query['fields'] = fields unless fields.nil?
|
2403
3246
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
@@ -2407,9 +3250,8 @@ module Google
|
|
2407
3250
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
2408
3251
|
# error is returned.
|
2409
3252
|
# @param [String] parent
|
2410
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
2411
|
-
#
|
2412
|
-
# data_store_id``
|
3253
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
3254
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
2413
3255
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
|
2414
3256
|
# @param [String] fields
|
2415
3257
|
# Selector specifying which fields to include in a partial response.
|
@@ -2444,7 +3286,7 @@ module Google
|
|
2444
3286
|
# is returned.
|
2445
3287
|
# @param [String] name
|
2446
3288
|
# Required. The resource name of the Session to delete. Format: `projects/`
|
2447
|
-
#
|
3289
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
2448
3290
|
# data_store_id`/sessions/`session_id``
|
2449
3291
|
# @param [String] fields
|
2450
3292
|
# Selector specifying which fields to include in a partial response.
|
@@ -2475,9 +3317,12 @@ module Google
|
|
2475
3317
|
|
2476
3318
|
# Gets a Session.
|
2477
3319
|
# @param [String] name
|
2478
|
-
# Required. The resource name of the Session to get. Format: `projects/`
|
2479
|
-
#
|
2480
|
-
#
|
3320
|
+
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
3321
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
3322
|
+
# sessions/`session_id``
|
3323
|
+
# @param [Boolean] include_answer_details
|
3324
|
+
# Optional. If set to true, the full session including all answer details will
|
3325
|
+
# be returned.
|
2481
3326
|
# @param [String] fields
|
2482
3327
|
# Selector specifying which fields to include in a partial response.
|
2483
3328
|
# @param [String] quota_user
|
@@ -2495,11 +3340,12 @@ module Google
|
|
2495
3340
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2496
3341
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2497
3342
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2498
|
-
def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
3343
|
+
def get_project_location_collection_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2499
3344
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
2500
3345
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
|
2501
3346
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
|
2502
3347
|
command.params['name'] = name unless name.nil?
|
3348
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
2503
3349
|
command.query['fields'] = fields unless fields.nil?
|
2504
3350
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2505
3351
|
execute_or_queue_command(command, &block)
|
@@ -2507,15 +3353,17 @@ module Google
|
|
2507
3353
|
|
2508
3354
|
# Lists all Sessions by their parent DataStore.
|
2509
3355
|
# @param [String] parent
|
2510
|
-
# Required. The data store resource name. Format: `projects/`
|
2511
|
-
#
|
3356
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
3357
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
2512
3358
|
# @param [String] filter
|
2513
3359
|
# A filter to apply on the list results. The supported features are:
|
2514
3360
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
2515
3361
|
# @param [String] order_by
|
2516
3362
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
2517
3363
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
2518
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
3364
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
3365
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
3366
|
+
# first, then by update_time.
|
2519
3367
|
# @param [Fixnum] page_size
|
2520
3368
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
2521
3369
|
# allowed value is 1000.
|
@@ -2595,9 +3443,9 @@ module Google
|
|
2595
3443
|
|
2596
3444
|
# Gets a Answer.
|
2597
3445
|
# @param [String] name
|
2598
|
-
# Required. The resource name of the Answer to get. Format: `projects/`
|
2599
|
-
#
|
2600
|
-
#
|
3446
|
+
# Required. The resource name of the Answer to get. Format: `projects/`project`/
|
3447
|
+
# locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
|
3448
|
+
# session_id`/answers/`answer_id``
|
2601
3449
|
# @param [String] fields
|
2602
3450
|
# Selector specifying which fields to include in a partial response.
|
2603
3451
|
# @param [String] quota_user
|
@@ -2946,6 +3794,75 @@ module Google
|
|
2946
3794
|
execute_or_queue_command(command, &block)
|
2947
3795
|
end
|
2948
3796
|
|
3797
|
+
# Creates a Sitemap.
|
3798
|
+
# @param [String] parent
|
3799
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
3800
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
3801
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSitemap] google_cloud_discoveryengine_v1alpha_sitemap_object
|
3802
|
+
# @param [String] fields
|
3803
|
+
# Selector specifying which fields to include in a partial response.
|
3804
|
+
# @param [String] quota_user
|
3805
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3806
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3807
|
+
# @param [Google::Apis::RequestOptions] options
|
3808
|
+
# Request-specific options
|
3809
|
+
#
|
3810
|
+
# @yield [result, err] Result & error if block supplied
|
3811
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
3812
|
+
# @yieldparam err [StandardError] error object if request failed
|
3813
|
+
#
|
3814
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
3815
|
+
#
|
3816
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3817
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3818
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3819
|
+
def create_project_location_collection_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1alpha_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3820
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/sitemaps', options)
|
3821
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSitemap::Representation
|
3822
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sitemap_object
|
3823
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
3824
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
3825
|
+
command.params['parent'] = parent unless parent.nil?
|
3826
|
+
command.query['fields'] = fields unless fields.nil?
|
3827
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3828
|
+
execute_or_queue_command(command, &block)
|
3829
|
+
end
|
3830
|
+
|
3831
|
+
# Deletes a Sitemap.
|
3832
|
+
# @param [String] name
|
3833
|
+
# Required. Full resource name of Sitemap, such as `projects/`project`/locations/
|
3834
|
+
# `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
|
3835
|
+
# sitemaps/`sitemap``. If the caller does not have permission to access the
|
3836
|
+
# Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
|
3837
|
+
# returned. If the requested Sitemap does not exist, a NOT_FOUND error is
|
3838
|
+
# returned.
|
3839
|
+
# @param [String] fields
|
3840
|
+
# Selector specifying which fields to include in a partial response.
|
3841
|
+
# @param [String] quota_user
|
3842
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3843
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3844
|
+
# @param [Google::Apis::RequestOptions] options
|
3845
|
+
# Request-specific options
|
3846
|
+
#
|
3847
|
+
# @yield [result, err] Result & error if block supplied
|
3848
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
3849
|
+
# @yieldparam err [StandardError] error object if request failed
|
3850
|
+
#
|
3851
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
3852
|
+
#
|
3853
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3854
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3855
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3856
|
+
def delete_project_location_collection_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
|
3857
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
3858
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
3859
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
3860
|
+
command.params['name'] = name unless name.nil?
|
3861
|
+
command.query['fields'] = fields unless fields.nil?
|
3862
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3863
|
+
execute_or_queue_command(command, &block)
|
3864
|
+
end
|
3865
|
+
|
2949
3866
|
# Creates TargetSite in a batch.
|
2950
3867
|
# @param [String] parent
|
2951
3868
|
# Required. The parent resource shared by all TargetSites being created. `
|
@@ -3312,8 +4229,12 @@ module Google
|
|
3312
4229
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
3313
4230
|
# Users should not call this method directly.
|
3314
4231
|
# @param [String] parent
|
3315
|
-
# Required. The parent
|
3316
|
-
#
|
4232
|
+
# Required. The parent resource name. If the collect user event action is
|
4233
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
4234
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
4235
|
+
# user event action is applied in Location level, for example, the event with
|
4236
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
4237
|
+
# locations/`location``.
|
3317
4238
|
# @param [Fixnum] ets
|
3318
4239
|
# The event timestamp in milliseconds. This prevents browser caching of
|
3319
4240
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
@@ -3399,8 +4320,8 @@ module Google
|
|
3399
4320
|
# first.
|
3400
4321
|
# @param [String] parent
|
3401
4322
|
# Required. The resource name of the catalog under which the events are created.
|
3402
|
-
# The format is `projects
|
3403
|
-
#
|
4323
|
+
# The format is `projects/`project`/locations/global/collections/`collection`/
|
4324
|
+
# dataStores/`dataStore``.
|
3404
4325
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
|
3405
4326
|
# @param [String] fields
|
3406
4327
|
# Selector specifying which fields to include in a partial response.
|
@@ -3623,9 +4544,9 @@ module Google
|
|
3623
4544
|
# @param [String] name
|
3624
4545
|
# Immutable. The fully qualified resource name of the engine. This field must be
|
3625
4546
|
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
3626
|
-
# projects/`
|
3627
|
-
#
|
3628
|
-
#
|
4547
|
+
# projects/`project`/locations/`location`/collections/`collection`/engines/`
|
4548
|
+
# engine`` engine should be 1-63 characters, and valid characters are /a-z0-9*/.
|
4549
|
+
# Otherwise, an INVALID_ARGUMENT error is returned.
|
3629
4550
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
|
3630
4551
|
# @param [String] update_mask
|
3631
4552
|
# Indicates which fields in the provided Engine to update. If an unsupported or
|
@@ -3663,8 +4584,8 @@ module Google
|
|
3663
4584
|
# Pauses the training of an existing engine. Only applicable if SolutionType is
|
3664
4585
|
# SOLUTION_TYPE_RECOMMENDATION.
|
3665
4586
|
# @param [String] name
|
3666
|
-
# Required. The name of the engine to pause. Format: `projects/`
|
3667
|
-
# locations/`
|
4587
|
+
# Required. The name of the engine to pause. Format: `projects/`project`/
|
4588
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
3668
4589
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest] google_cloud_discoveryengine_v1alpha_pause_engine_request_object
|
3669
4590
|
# @param [String] fields
|
3670
4591
|
# Selector specifying which fields to include in a partial response.
|
@@ -3698,8 +4619,8 @@ module Google
|
|
3698
4619
|
# Resumes the training of an existing engine. Only applicable if SolutionType is
|
3699
4620
|
# SOLUTION_TYPE_RECOMMENDATION.
|
3700
4621
|
# @param [String] name
|
3701
|
-
# Required. The name of the engine to resume. Format: `projects/`
|
3702
|
-
# locations/`
|
4622
|
+
# Required. The name of the engine to resume. Format: `projects/`project`/
|
4623
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
3703
4624
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest] google_cloud_discoveryengine_v1alpha_resume_engine_request_object
|
3704
4625
|
# @param [String] fields
|
3705
4626
|
# Selector specifying which fields to include in a partial response.
|
@@ -3733,9 +4654,8 @@ module Google
|
|
3733
4654
|
# Tunes an existing engine. Only applicable if SolutionType is
|
3734
4655
|
# SOLUTION_TYPE_RECOMMENDATION.
|
3735
4656
|
# @param [String] name
|
3736
|
-
# Required. The resource name of the engine to tune. Format: `projects/`
|
3737
|
-
#
|
3738
|
-
# engine_id``
|
4657
|
+
# Required. The resource name of the engine to tune. Format: `projects/`project`/
|
4658
|
+
# locations/`location`/collections/`collection_id`/engines/`engine_id``
|
3739
4659
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest] google_cloud_discoveryengine_v1alpha_tune_engine_request_object
|
3740
4660
|
# @param [String] fields
|
3741
4661
|
# Selector specifying which fields to include in a partial response.
|
@@ -3766,14 +4686,50 @@ module Google
|
|
3766
4686
|
execute_or_queue_command(command, &block)
|
3767
4687
|
end
|
3768
4688
|
|
4689
|
+
# Completes the user input with advanced keyword suggestions.
|
4690
|
+
# @param [String] completion_config
|
4691
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
4692
|
+
# name for which the completion is performed, such as `projects/*/locations/
|
4693
|
+
# global/collections/default_collection/dataStores/*/completionConfig` `projects/
|
4694
|
+
# */locations/global/collections/default_collection/engines/*/completionConfig`.
|
4695
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
4696
|
+
# @param [String] fields
|
4697
|
+
# Selector specifying which fields to include in a partial response.
|
4698
|
+
# @param [String] quota_user
|
4699
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4700
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4701
|
+
# @param [Google::Apis::RequestOptions] options
|
4702
|
+
# Request-specific options
|
4703
|
+
#
|
4704
|
+
# @yield [result, err] Result & error if block supplied
|
4705
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse] parsed result object
|
4706
|
+
# @yieldparam err [StandardError] error object if request failed
|
4707
|
+
#
|
4708
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse]
|
4709
|
+
#
|
4710
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4711
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4712
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4713
|
+
def complete_project_location_collection_engine_completion_config_query(completion_config, google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4714
|
+
command = make_simple_command(:post, 'v1alpha/{+completionConfig}:completeQuery', options)
|
4715
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest::Representation
|
4716
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
4717
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse::Representation
|
4718
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse
|
4719
|
+
command.params['completionConfig'] = completion_config unless completion_config.nil?
|
4720
|
+
command.query['fields'] = fields unless fields.nil?
|
4721
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4722
|
+
execute_or_queue_command(command, &block)
|
4723
|
+
end
|
4724
|
+
|
3769
4725
|
# Creates a Control. By default 1000 controls are allowed for a data store. A
|
3770
4726
|
# request can be submitted to adjust this limit. If the Control to create
|
3771
4727
|
# already exists, an ALREADY_EXISTS error is returned.
|
3772
4728
|
# @param [String] parent
|
3773
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
3774
|
-
#
|
3775
|
-
#
|
3776
|
-
#
|
4729
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
4730
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
|
4731
|
+
# or `projects/`project`/locations/`location`/collections/`collection_id`/
|
4732
|
+
# engines/`engine_id``.
|
3777
4733
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
|
3778
4734
|
# @param [String] control_id
|
3779
4735
|
# Required. The ID to use for the Control, which will become the final component
|
@@ -3813,8 +4769,8 @@ module Google
|
|
3813
4769
|
# is returned.
|
3814
4770
|
# @param [String] name
|
3815
4771
|
# Required. The resource name of the Control to delete. Format: `projects/`
|
3816
|
-
#
|
3817
|
-
#
|
4772
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
4773
|
+
# data_store_id`/controls/`control_id``
|
3818
4774
|
# @param [String] fields
|
3819
4775
|
# Selector specifying which fields to include in a partial response.
|
3820
4776
|
# @param [String] quota_user
|
@@ -3844,9 +4800,9 @@ module Google
|
|
3844
4800
|
|
3845
4801
|
# Gets a Control.
|
3846
4802
|
# @param [String] name
|
3847
|
-
# Required. The resource name of the Control to get. Format: `projects/`
|
3848
|
-
#
|
3849
|
-
#
|
4803
|
+
# Required. The resource name of the Control to get. Format: `projects/`project`/
|
4804
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
|
4805
|
+
# controls/`control_id``
|
3850
4806
|
# @param [String] fields
|
3851
4807
|
# Selector specifying which fields to include in a partial response.
|
3852
4808
|
# @param [String] quota_user
|
@@ -3876,10 +4832,10 @@ module Google
|
|
3876
4832
|
|
3877
4833
|
# Lists all Controls by their parent DataStore.
|
3878
4834
|
# @param [String] parent
|
3879
|
-
# Required. The data store resource name. Format: `projects/`
|
3880
|
-
#
|
3881
|
-
#
|
3882
|
-
#
|
4835
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
4836
|
+
# location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
|
4837
|
+
# `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
|
4838
|
+
# .
|
3883
4839
|
# @param [String] filter
|
3884
4840
|
# Optional. A filter to apply on the list results. Supported features: * List
|
3885
4841
|
# all the products under the parent branch if filter is unset. Currently this
|
@@ -3963,9 +4919,9 @@ module Google
|
|
3963
4919
|
# Converses a conversation.
|
3964
4920
|
# @param [String] name
|
3965
4921
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
3966
|
-
#
|
3967
|
-
# data_store_id`/conversations/`conversation_id``. Use `projects/`
|
3968
|
-
#
|
4922
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
4923
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
|
4924
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
3969
4925
|
# conversations/-` to activate auto session mode, which automatically creates a
|
3970
4926
|
# new conversation inside a ConverseConversation session.
|
3971
4927
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
@@ -4001,9 +4957,8 @@ module Google
|
|
4001
4957
|
# Creates a Conversation. If the Conversation to create already exists, an
|
4002
4958
|
# ALREADY_EXISTS error is returned.
|
4003
4959
|
# @param [String] parent
|
4004
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
4005
|
-
#
|
4006
|
-
# data_store_id``
|
4960
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
4961
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
4007
4962
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
4008
4963
|
# @param [String] fields
|
4009
4964
|
# Selector specifying which fields to include in a partial response.
|
@@ -4038,7 +4993,7 @@ module Google
|
|
4038
4993
|
# NOT_FOUND error is returned.
|
4039
4994
|
# @param [String] name
|
4040
4995
|
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
4041
|
-
#
|
4996
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
4042
4997
|
# data_store_id`/conversations/`conversation_id``
|
4043
4998
|
# @param [String] fields
|
4044
4999
|
# Selector specifying which fields to include in a partial response.
|
@@ -4070,7 +5025,7 @@ module Google
|
|
4070
5025
|
# Gets a Conversation.
|
4071
5026
|
# @param [String] name
|
4072
5027
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
4073
|
-
#
|
5028
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
4074
5029
|
# data_store_id`/conversations/`conversation_id``
|
4075
5030
|
# @param [String] fields
|
4076
5031
|
# Selector specifying which fields to include in a partial response.
|
@@ -4101,8 +5056,8 @@ module Google
|
|
4101
5056
|
|
4102
5057
|
# Lists all Conversations by their parent DataStore.
|
4103
5058
|
# @param [String] parent
|
4104
|
-
# Required. The data store resource name. Format: `projects/`
|
4105
|
-
#
|
5059
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
5060
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
4106
5061
|
# @param [String] filter
|
4107
5062
|
# A filter to apply on the list results. The supported features are:
|
4108
5063
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
@@ -4301,7 +5256,7 @@ module Google
|
|
4301
5256
|
# exist.
|
4302
5257
|
# @param [String] name
|
4303
5258
|
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
4304
|
-
#
|
5259
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine`/
|
4305
5260
|
# servingConfigs/`serving_config_id``
|
4306
5261
|
# @param [String] fields
|
4307
5262
|
# Selector specifying which fields to include in a partial response.
|
@@ -4333,7 +5288,7 @@ module Google
|
|
4333
5288
|
# Lists all ServingConfigs linked to this dataStore.
|
4334
5289
|
# @param [String] parent
|
4335
5290
|
# Required. Full resource name of the parent resource. Format: `projects/`
|
4336
|
-
#
|
5291
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine``
|
4337
5292
|
# @param [Fixnum] page_size
|
4338
5293
|
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
4339
5294
|
# If a value greater than 100 is provided, at most 100 results are returned.
|
@@ -4488,12 +5443,95 @@ module Google
|
|
4488
5443
|
execute_or_queue_command(command, &block)
|
4489
5444
|
end
|
4490
5445
|
|
5446
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
5447
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
5448
|
+
# not required. Only public website search is supported by this method. If data
|
5449
|
+
# stores and engines not associated with public website search are specified, a `
|
5450
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
5451
|
+
# onboarding without having to implement an authentication backend. However, it
|
5452
|
+
# is strongly recommended to use SearchService.Search instead with required
|
5453
|
+
# OAuth and IAM checks to provide better data security.
|
5454
|
+
# @param [String] serving_config
|
5455
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
5456
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
5457
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
5458
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
5459
|
+
# default_serving_config`. This field is used to identify the serving
|
5460
|
+
# configuration name, set of models used to make the search.
|
5461
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
5462
|
+
# @param [String] fields
|
5463
|
+
# Selector specifying which fields to include in a partial response.
|
5464
|
+
# @param [String] quota_user
|
5465
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5466
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5467
|
+
# @param [Google::Apis::RequestOptions] options
|
5468
|
+
# Request-specific options
|
5469
|
+
#
|
5470
|
+
# @yield [result, err] Result & error if block supplied
|
5471
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
5472
|
+
# @yieldparam err [StandardError] error object if request failed
|
5473
|
+
#
|
5474
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
5475
|
+
#
|
5476
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5477
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5478
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5479
|
+
def search_project_location_collection_engine_serving_config_lite(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5480
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:searchLite', options)
|
5481
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
5482
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
5483
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
5484
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
5485
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
5486
|
+
command.query['fields'] = fields unless fields.nil?
|
5487
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5488
|
+
execute_or_queue_command(command, &block)
|
5489
|
+
end
|
5490
|
+
|
5491
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
5492
|
+
# multiple AnswerQueryResponse messages in a stream.
|
5493
|
+
# @param [String] serving_config
|
5494
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
5495
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
5496
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
5497
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
5498
|
+
# field is used to identify the serving configuration name, set of models used
|
5499
|
+
# to make the search.
|
5500
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
5501
|
+
# @param [String] fields
|
5502
|
+
# Selector specifying which fields to include in a partial response.
|
5503
|
+
# @param [String] quota_user
|
5504
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5505
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5506
|
+
# @param [Google::Apis::RequestOptions] options
|
5507
|
+
# Request-specific options
|
5508
|
+
#
|
5509
|
+
# @yield [result, err] Result & error if block supplied
|
5510
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
|
5511
|
+
# @yieldparam err [StandardError] error object if request failed
|
5512
|
+
#
|
5513
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
|
5514
|
+
#
|
5515
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5516
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5517
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5518
|
+
def stream_project_location_collection_engine_serving_config_answer(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5519
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:streamAnswer', options)
|
5520
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
|
5521
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
5522
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
|
5523
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
|
5524
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
5525
|
+
command.query['fields'] = fields unless fields.nil?
|
5526
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5527
|
+
execute_or_queue_command(command, &block)
|
5528
|
+
end
|
5529
|
+
|
4491
5530
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
4492
5531
|
# error is returned.
|
4493
5532
|
# @param [String] parent
|
4494
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
4495
|
-
#
|
4496
|
-
# data_store_id``
|
5533
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
5534
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
4497
5535
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
|
4498
5536
|
# @param [String] fields
|
4499
5537
|
# Selector specifying which fields to include in a partial response.
|
@@ -4528,7 +5566,7 @@ module Google
|
|
4528
5566
|
# is returned.
|
4529
5567
|
# @param [String] name
|
4530
5568
|
# Required. The resource name of the Session to delete. Format: `projects/`
|
4531
|
-
#
|
5569
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
4532
5570
|
# data_store_id`/sessions/`session_id``
|
4533
5571
|
# @param [String] fields
|
4534
5572
|
# Selector specifying which fields to include in a partial response.
|
@@ -4559,9 +5597,12 @@ module Google
|
|
4559
5597
|
|
4560
5598
|
# Gets a Session.
|
4561
5599
|
# @param [String] name
|
4562
|
-
# Required. The resource name of the Session to get. Format: `projects/`
|
4563
|
-
#
|
4564
|
-
#
|
5600
|
+
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
5601
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
5602
|
+
# sessions/`session_id``
|
5603
|
+
# @param [Boolean] include_answer_details
|
5604
|
+
# Optional. If set to true, the full session including all answer details will
|
5605
|
+
# be returned.
|
4565
5606
|
# @param [String] fields
|
4566
5607
|
# Selector specifying which fields to include in a partial response.
|
4567
5608
|
# @param [String] quota_user
|
@@ -4579,11 +5620,12 @@ module Google
|
|
4579
5620
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4580
5621
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4581
5622
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4582
|
-
def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
5623
|
+
def get_project_location_collection_engine_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4583
5624
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
4584
5625
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
|
4585
5626
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
|
4586
5627
|
command.params['name'] = name unless name.nil?
|
5628
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
4587
5629
|
command.query['fields'] = fields unless fields.nil?
|
4588
5630
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4589
5631
|
execute_or_queue_command(command, &block)
|
@@ -4591,15 +5633,17 @@ module Google
|
|
4591
5633
|
|
4592
5634
|
# Lists all Sessions by their parent DataStore.
|
4593
5635
|
# @param [String] parent
|
4594
|
-
# Required. The data store resource name. Format: `projects/`
|
4595
|
-
#
|
5636
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
5637
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
4596
5638
|
# @param [String] filter
|
4597
5639
|
# A filter to apply on the list results. The supported features are:
|
4598
5640
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
4599
5641
|
# @param [String] order_by
|
4600
5642
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
4601
5643
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
4602
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
5644
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
5645
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
5646
|
+
# first, then by update_time.
|
4603
5647
|
# @param [Fixnum] page_size
|
4604
5648
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
4605
5649
|
# allowed value is 1000.
|
@@ -4679,9 +5723,9 @@ module Google
|
|
4679
5723
|
|
4680
5724
|
# Gets a Answer.
|
4681
5725
|
# @param [String] name
|
4682
|
-
# Required. The resource name of the Answer to get. Format: `projects/`
|
4683
|
-
#
|
4684
|
-
#
|
5726
|
+
# Required. The resource name of the Answer to get. Format: `projects/`project`/
|
5727
|
+
# locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
|
5728
|
+
# session_id`/answers/`answer_id``
|
4685
5729
|
# @param [String] fields
|
4686
5730
|
# Selector specifying which fields to include in a partial response.
|
4687
5731
|
# @param [String] quota_user
|
@@ -4850,6 +5894,8 @@ module Google
|
|
4850
5894
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
4851
5895
|
# location`/collections/`collection``.
|
4852
5896
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
|
5897
|
+
# @param [String] cmek_config_name
|
5898
|
+
# Resource name of the CmekConfig to use for protecting this DataStore.
|
4853
5899
|
# @param [Boolean] create_advanced_site_search
|
4854
5900
|
# A boolean flag indicating whether user want to directly create an advanced
|
4855
5901
|
# data store for site search. If the data store is not configured as site search
|
@@ -4860,6 +5906,15 @@ module Google
|
|
4860
5906
|
# component of the DataStore's resource name. This field must conform to [RFC-
|
4861
5907
|
# 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
|
4862
5908
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
5909
|
+
# @param [Boolean] disable_cmek
|
5910
|
+
# DataStore without CMEK protections. If a default CmekConfig is set for the
|
5911
|
+
# project, setting this field will override the default CmekConfig as well.
|
5912
|
+
# @param [Boolean] skip_default_schema_creation
|
5913
|
+
# A boolean flag indicating whether to skip the default schema creation for the
|
5914
|
+
# data store. Only enable this flag if you are certain that the default schema
|
5915
|
+
# is incompatible with your use case. If set to true, you must manually create a
|
5916
|
+
# schema for the data store before any documents can be ingested. This flag
|
5917
|
+
# cannot be specified if `data_store.starting_schema` is specified.
|
4863
5918
|
# @param [String] fields
|
4864
5919
|
# Selector specifying which fields to include in a partial response.
|
4865
5920
|
# @param [String] quota_user
|
@@ -4877,15 +5932,18 @@ module Google
|
|
4877
5932
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4878
5933
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4879
5934
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4880
|
-
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, create_advanced_site_search: nil, data_store_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5935
|
+
def create_project_location_data_store(parent, google_cloud_discoveryengine_v1alpha_data_store_object = nil, cmek_config_name: nil, create_advanced_site_search: nil, data_store_id: nil, disable_cmek: nil, skip_default_schema_creation: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4881
5936
|
command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
|
4882
5937
|
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
|
4883
5938
|
command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
|
4884
5939
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
4885
5940
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
4886
5941
|
command.params['parent'] = parent unless parent.nil?
|
5942
|
+
command.query['cmekConfigName'] = cmek_config_name unless cmek_config_name.nil?
|
4887
5943
|
command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
|
4888
5944
|
command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
|
5945
|
+
command.query['disableCmek'] = disable_cmek unless disable_cmek.nil?
|
5946
|
+
command.query['skipDefaultSchemaCreation'] = skip_default_schema_creation unless skip_default_schema_creation.nil?
|
4889
5947
|
command.query['fields'] = fields unless fields.nil?
|
4890
5948
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4891
5949
|
execute_or_queue_command(command, &block)
|
@@ -4962,8 +6020,8 @@ module Google
|
|
4962
6020
|
# Gets a DocumentProcessingConfig.
|
4963
6021
|
# @param [String] name
|
4964
6022
|
# Required. Full DocumentProcessingConfig resource name. Format: `projects/`
|
4965
|
-
#
|
4966
|
-
#
|
6023
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
6024
|
+
# data_store_id`/documentProcessingConfig`
|
4967
6025
|
# @param [String] fields
|
4968
6026
|
# Selector specifying which fields to include in a partial response.
|
4969
6027
|
# @param [String] quota_user
|
@@ -5155,6 +6213,46 @@ module Google
|
|
5155
6213
|
execute_or_queue_command(command, &block)
|
5156
6214
|
end
|
5157
6215
|
|
6216
|
+
# Gets index freshness metadata for Documents. Supported for website search only.
|
6217
|
+
# @param [String] parent
|
6218
|
+
# Required. The parent branch resource name, such as `projects/`project`/
|
6219
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
6220
|
+
# `branch``.
|
6221
|
+
# @param [Array<String>, String] matcher_fhir_matcher_fhir_resources
|
6222
|
+
# Required. The FHIR resources to match by. Format: projects/`project`/locations/
|
6223
|
+
# `location`/datasets/`dataset`/fhirStores/`fhir_store`/fhir/`resource_type`/`
|
6224
|
+
# fhir_resource_id`
|
6225
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
6226
|
+
# The exact URIs to match by.
|
6227
|
+
# @param [String] fields
|
6228
|
+
# Selector specifying which fields to include in a partial response.
|
6229
|
+
# @param [String] quota_user
|
6230
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6231
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6232
|
+
# @param [Google::Apis::RequestOptions] options
|
6233
|
+
# Request-specific options
|
6234
|
+
#
|
6235
|
+
# @yield [result, err] Result & error if block supplied
|
6236
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse] parsed result object
|
6237
|
+
# @yieldparam err [StandardError] error object if request failed
|
6238
|
+
#
|
6239
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse]
|
6240
|
+
#
|
6241
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6242
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6243
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6244
|
+
def batch_project_location_data_store_branch_get_documents_metadata(parent, matcher_fhir_matcher_fhir_resources: nil, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6245
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/batchGetDocumentsMetadata', options)
|
6246
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse::Representation
|
6247
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse
|
6248
|
+
command.params['parent'] = parent unless parent.nil?
|
6249
|
+
command.query['matcher.fhirMatcher.fhirResources'] = matcher_fhir_matcher_fhir_resources unless matcher_fhir_matcher_fhir_resources.nil?
|
6250
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
|
6251
|
+
command.query['fields'] = fields unless fields.nil?
|
6252
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6253
|
+
execute_or_queue_command(command, &block)
|
6254
|
+
end
|
6255
|
+
|
5158
6256
|
# Creates a Document.
|
5159
6257
|
# @param [String] parent
|
5160
6258
|
# Required. The parent resource name, such as `projects/`project`/locations/`
|
@@ -5167,7 +6265,7 @@ module Google
|
|
5167
6265
|
# is returned. This field must be unique among all Documents with the same
|
5168
6266
|
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
5169
6267
|
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
5170
|
-
# length limit of
|
6268
|
+
# length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
5171
6269
|
# returned.
|
5172
6270
|
# @param [String] fields
|
5173
6271
|
# Selector specifying which fields to include in a partial response.
|
@@ -5563,8 +6661,8 @@ module Google
|
|
5563
6661
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
5564
6662
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
5565
6663
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
5566
|
-
# an operation with an Operation.error value with a google.rpc.Status.code of 1
|
5567
|
-
# corresponding to `Code.CANCELLED`.
|
6664
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of `1`
|
6665
|
+
# , corresponding to `Code.CANCELLED`.
|
5568
6666
|
# @param [String] name
|
5569
6667
|
# The name of the operation resource to be cancelled.
|
5570
6668
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
@@ -5668,6 +6766,42 @@ module Google
|
|
5668
6766
|
execute_or_queue_command(command, &block)
|
5669
6767
|
end
|
5670
6768
|
|
6769
|
+
# Completes the user input with advanced keyword suggestions.
|
6770
|
+
# @param [String] completion_config
|
6771
|
+
# Required. The completion_config of the parent dataStore or engine resource
|
6772
|
+
# name for which the completion is performed, such as `projects/*/locations/
|
6773
|
+
# global/collections/default_collection/dataStores/*/completionConfig` `projects/
|
6774
|
+
# */locations/global/collections/default_collection/engines/*/completionConfig`.
|
6775
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest] google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
6776
|
+
# @param [String] fields
|
6777
|
+
# Selector specifying which fields to include in a partial response.
|
6778
|
+
# @param [String] quota_user
|
6779
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6780
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6781
|
+
# @param [Google::Apis::RequestOptions] options
|
6782
|
+
# Request-specific options
|
6783
|
+
#
|
6784
|
+
# @yield [result, err] Result & error if block supplied
|
6785
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse] parsed result object
|
6786
|
+
# @yieldparam err [StandardError] error object if request failed
|
6787
|
+
#
|
6788
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse]
|
6789
|
+
#
|
6790
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6791
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6792
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6793
|
+
def complete_project_location_data_store_completion_config_query(completion_config, google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
6794
|
+
command = make_simple_command(:post, 'v1alpha/{+completionConfig}:completeQuery', options)
|
6795
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest::Representation
|
6796
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_advanced_complete_query_request_object
|
6797
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse::Representation
|
6798
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryResponse
|
6799
|
+
command.params['completionConfig'] = completion_config unless completion_config.nil?
|
6800
|
+
command.query['fields'] = fields unless fields.nil?
|
6801
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6802
|
+
execute_or_queue_command(command, &block)
|
6803
|
+
end
|
6804
|
+
|
5671
6805
|
# Imports CompletionSuggestions for a DataStore.
|
5672
6806
|
# @param [String] parent
|
5673
6807
|
# Required. The parent data store resource name for which to import customer
|
@@ -5741,10 +6875,10 @@ module Google
|
|
5741
6875
|
# request can be submitted to adjust this limit. If the Control to create
|
5742
6876
|
# already exists, an ALREADY_EXISTS error is returned.
|
5743
6877
|
# @param [String] parent
|
5744
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
5745
|
-
#
|
5746
|
-
#
|
5747
|
-
#
|
6878
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
6879
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id``
|
6880
|
+
# or `projects/`project`/locations/`location`/collections/`collection_id`/
|
6881
|
+
# engines/`engine_id``.
|
5748
6882
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaControl] google_cloud_discoveryengine_v1alpha_control_object
|
5749
6883
|
# @param [String] control_id
|
5750
6884
|
# Required. The ID to use for the Control, which will become the final component
|
@@ -5784,8 +6918,8 @@ module Google
|
|
5784
6918
|
# is returned.
|
5785
6919
|
# @param [String] name
|
5786
6920
|
# Required. The resource name of the Control to delete. Format: `projects/`
|
5787
|
-
#
|
5788
|
-
#
|
6921
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
6922
|
+
# data_store_id`/controls/`control_id``
|
5789
6923
|
# @param [String] fields
|
5790
6924
|
# Selector specifying which fields to include in a partial response.
|
5791
6925
|
# @param [String] quota_user
|
@@ -5815,9 +6949,9 @@ module Google
|
|
5815
6949
|
|
5816
6950
|
# Gets a Control.
|
5817
6951
|
# @param [String] name
|
5818
|
-
# Required. The resource name of the Control to get. Format: `projects/`
|
5819
|
-
#
|
5820
|
-
#
|
6952
|
+
# Required. The resource name of the Control to get. Format: `projects/`project`/
|
6953
|
+
# locations/`location`/collections/`collection_id`/dataStores/`data_store_id`/
|
6954
|
+
# controls/`control_id``
|
5821
6955
|
# @param [String] fields
|
5822
6956
|
# Selector specifying which fields to include in a partial response.
|
5823
6957
|
# @param [String] quota_user
|
@@ -5847,10 +6981,10 @@ module Google
|
|
5847
6981
|
|
5848
6982
|
# Lists all Controls by their parent DataStore.
|
5849
6983
|
# @param [String] parent
|
5850
|
-
# Required. The data store resource name. Format: `projects/`
|
5851
|
-
#
|
5852
|
-
#
|
5853
|
-
#
|
6984
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
6985
|
+
# location`/collections/`collection_id`/dataStores/`data_store_id`` or `projects/
|
6986
|
+
# `project`/locations/`location`/collections/`collection_id`/engines/`engine_id``
|
6987
|
+
# .
|
5854
6988
|
# @param [String] filter
|
5855
6989
|
# Optional. A filter to apply on the list results. Supported features: * List
|
5856
6990
|
# all the products under the parent branch if filter is unset. Currently this
|
@@ -5934,9 +7068,9 @@ module Google
|
|
5934
7068
|
# Converses a conversation.
|
5935
7069
|
# @param [String] name
|
5936
7070
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
5937
|
-
#
|
5938
|
-
# data_store_id`/conversations/`conversation_id``. Use `projects/`
|
5939
|
-
#
|
7071
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
7072
|
+
# data_store_id`/conversations/`conversation_id``. Use `projects/`project`/
|
7073
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
5940
7074
|
# conversations/-` to activate auto session mode, which automatically creates a
|
5941
7075
|
# new conversation inside a ConverseConversation session.
|
5942
7076
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest] google_cloud_discoveryengine_v1alpha_converse_conversation_request_object
|
@@ -5972,9 +7106,8 @@ module Google
|
|
5972
7106
|
# Creates a Conversation. If the Conversation to create already exists, an
|
5973
7107
|
# ALREADY_EXISTS error is returned.
|
5974
7108
|
# @param [String] parent
|
5975
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
5976
|
-
#
|
5977
|
-
# data_store_id``
|
7109
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
7110
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
5978
7111
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation] google_cloud_discoveryengine_v1alpha_conversation_object
|
5979
7112
|
# @param [String] fields
|
5980
7113
|
# Selector specifying which fields to include in a partial response.
|
@@ -6009,7 +7142,7 @@ module Google
|
|
6009
7142
|
# NOT_FOUND error is returned.
|
6010
7143
|
# @param [String] name
|
6011
7144
|
# Required. The resource name of the Conversation to delete. Format: `projects/`
|
6012
|
-
#
|
7145
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
6013
7146
|
# data_store_id`/conversations/`conversation_id``
|
6014
7147
|
# @param [String] fields
|
6015
7148
|
# Selector specifying which fields to include in a partial response.
|
@@ -6041,7 +7174,7 @@ module Google
|
|
6041
7174
|
# Gets a Conversation.
|
6042
7175
|
# @param [String] name
|
6043
7176
|
# Required. The resource name of the Conversation to get. Format: `projects/`
|
6044
|
-
#
|
7177
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
6045
7178
|
# data_store_id`/conversations/`conversation_id``
|
6046
7179
|
# @param [String] fields
|
6047
7180
|
# Selector specifying which fields to include in a partial response.
|
@@ -6072,8 +7205,8 @@ module Google
|
|
6072
7205
|
|
6073
7206
|
# Lists all Conversations by their parent DataStore.
|
6074
7207
|
# @param [String] parent
|
6075
|
-
# Required. The data store resource name. Format: `projects/`
|
6076
|
-
#
|
7208
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
7209
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
6077
7210
|
# @param [String] filter
|
6078
7211
|
# A filter to apply on the list results. The supported features are:
|
6079
7212
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
@@ -6530,7 +7663,7 @@ module Google
|
|
6530
7663
|
# exist.
|
6531
7664
|
# @param [String] name
|
6532
7665
|
# Required. The resource name of the ServingConfig to get. Format: `projects/`
|
6533
|
-
#
|
7666
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine`/
|
6534
7667
|
# servingConfigs/`serving_config_id``
|
6535
7668
|
# @param [String] fields
|
6536
7669
|
# Selector specifying which fields to include in a partial response.
|
@@ -6562,7 +7695,7 @@ module Google
|
|
6562
7695
|
# Lists all ServingConfigs linked to this dataStore.
|
6563
7696
|
# @param [String] parent
|
6564
7697
|
# Required. Full resource name of the parent resource. Format: `projects/`
|
6565
|
-
#
|
7698
|
+
# project`/locations/`location`/collections/`collection`/engines/`engine``
|
6566
7699
|
# @param [Fixnum] page_size
|
6567
7700
|
# Optional. Maximum number of results to return. If unspecified, defaults to 100.
|
6568
7701
|
# If a value greater than 100 is provided, at most 100 results are returned.
|
@@ -6659,27 +7792,72 @@ module Google
|
|
6659
7792
|
# Request-specific options
|
6660
7793
|
#
|
6661
7794
|
# @yield [result, err] Result & error if block supplied
|
6662
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
|
7795
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
|
7796
|
+
# @yieldparam err [StandardError] error object if request failed
|
7797
|
+
#
|
7798
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
|
7799
|
+
#
|
7800
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7801
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7802
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7803
|
+
def recommend_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7804
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
|
7805
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
|
7806
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
|
7807
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
|
7808
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
|
7809
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
7810
|
+
command.query['fields'] = fields unless fields.nil?
|
7811
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7812
|
+
execute_or_queue_command(command, &block)
|
7813
|
+
end
|
7814
|
+
|
7815
|
+
# Performs a search.
|
7816
|
+
# @param [String] serving_config
|
7817
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
7818
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
7819
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
7820
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
7821
|
+
# default_serving_config`. This field is used to identify the serving
|
7822
|
+
# configuration name, set of models used to make the search.
|
7823
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
7824
|
+
# @param [String] fields
|
7825
|
+
# Selector specifying which fields to include in a partial response.
|
7826
|
+
# @param [String] quota_user
|
7827
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7828
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7829
|
+
# @param [Google::Apis::RequestOptions] options
|
7830
|
+
# Request-specific options
|
7831
|
+
#
|
7832
|
+
# @yield [result, err] Result & error if block supplied
|
7833
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
6663
7834
|
# @yieldparam err [StandardError] error object if request failed
|
6664
7835
|
#
|
6665
|
-
# @return [Google::Apis::DiscoveryengineV1alpha::
|
7836
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
6666
7837
|
#
|
6667
7838
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6668
7839
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6669
7840
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6670
|
-
def
|
6671
|
-
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:
|
6672
|
-
command.request_representation = Google::Apis::DiscoveryengineV1alpha::
|
6673
|
-
command.request_object =
|
6674
|
-
command.response_representation = Google::Apis::DiscoveryengineV1alpha::
|
6675
|
-
command.response_class = Google::Apis::DiscoveryengineV1alpha::
|
7841
|
+
def search_project_location_data_store_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7842
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
|
7843
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
7844
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
7845
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
7846
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
6676
7847
|
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
6677
7848
|
command.query['fields'] = fields unless fields.nil?
|
6678
7849
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6679
7850
|
execute_or_queue_command(command, &block)
|
6680
7851
|
end
|
6681
7852
|
|
6682
|
-
# Performs a search.
|
7853
|
+
# Performs a search. Similar to the SearchService.Search method, but a lite
|
7854
|
+
# version that allows API key for authentication, where OAuth and IAM checks are
|
7855
|
+
# not required. Only public website search is supported by this method. If data
|
7856
|
+
# stores and engines not associated with public website search are specified, a `
|
7857
|
+
# FAILED_PRECONDITION` error is returned. This method can be used for easy
|
7858
|
+
# onboarding without having to implement an authentication backend. However, it
|
7859
|
+
# is strongly recommended to use SearchService.Search instead with required
|
7860
|
+
# OAuth and IAM checks to provide better data security.
|
6683
7861
|
# @param [String] serving_config
|
6684
7862
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
6685
7863
|
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
@@ -6705,8 +7883,8 @@ module Google
|
|
6705
7883
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6706
7884
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6707
7885
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6708
|
-
def
|
6709
|
-
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:
|
7886
|
+
def search_project_location_data_store_serving_config_lite(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7887
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:searchLite', options)
|
6710
7888
|
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
6711
7889
|
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
6712
7890
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
@@ -6717,12 +7895,50 @@ module Google
|
|
6717
7895
|
execute_or_queue_command(command, &block)
|
6718
7896
|
end
|
6719
7897
|
|
7898
|
+
# Answer query method (streaming). It takes one AnswerQueryRequest and returns
|
7899
|
+
# multiple AnswerQueryResponse messages in a stream.
|
7900
|
+
# @param [String] serving_config
|
7901
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
7902
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
7903
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
7904
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
7905
|
+
# field is used to identify the serving configuration name, set of models used
|
7906
|
+
# to make the search.
|
7907
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest] google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
7908
|
+
# @param [String] fields
|
7909
|
+
# Selector specifying which fields to include in a partial response.
|
7910
|
+
# @param [String] quota_user
|
7911
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
7912
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
7913
|
+
# @param [Google::Apis::RequestOptions] options
|
7914
|
+
# Request-specific options
|
7915
|
+
#
|
7916
|
+
# @yield [result, err] Result & error if block supplied
|
7917
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse] parsed result object
|
7918
|
+
# @yieldparam err [StandardError] error object if request failed
|
7919
|
+
#
|
7920
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse]
|
7921
|
+
#
|
7922
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
7923
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
7924
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
7925
|
+
def stream_project_location_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1alpha_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
7926
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:streamAnswer', options)
|
7927
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest::Representation
|
7928
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_answer_query_request_object
|
7929
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse::Representation
|
7930
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
|
7931
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
7932
|
+
command.query['fields'] = fields unless fields.nil?
|
7933
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
7934
|
+
execute_or_queue_command(command, &block)
|
7935
|
+
end
|
7936
|
+
|
6720
7937
|
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
6721
7938
|
# error is returned.
|
6722
7939
|
# @param [String] parent
|
6723
|
-
# Required. Full resource name of parent data store. Format: `projects/`
|
6724
|
-
#
|
6725
|
-
# data_store_id``
|
7940
|
+
# Required. Full resource name of parent data store. Format: `projects/`project`/
|
7941
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id``
|
6726
7942
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession] google_cloud_discoveryengine_v1alpha_session_object
|
6727
7943
|
# @param [String] fields
|
6728
7944
|
# Selector specifying which fields to include in a partial response.
|
@@ -6757,7 +7973,7 @@ module Google
|
|
6757
7973
|
# is returned.
|
6758
7974
|
# @param [String] name
|
6759
7975
|
# Required. The resource name of the Session to delete. Format: `projects/`
|
6760
|
-
#
|
7976
|
+
# project`/locations/`location`/collections/`collection`/dataStores/`
|
6761
7977
|
# data_store_id`/sessions/`session_id``
|
6762
7978
|
# @param [String] fields
|
6763
7979
|
# Selector specifying which fields to include in a partial response.
|
@@ -6788,9 +8004,12 @@ module Google
|
|
6788
8004
|
|
6789
8005
|
# Gets a Session.
|
6790
8006
|
# @param [String] name
|
6791
|
-
# Required. The resource name of the Session to get. Format: `projects/`
|
6792
|
-
#
|
6793
|
-
#
|
8007
|
+
# Required. The resource name of the Session to get. Format: `projects/`project`/
|
8008
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store_id`/
|
8009
|
+
# sessions/`session_id``
|
8010
|
+
# @param [Boolean] include_answer_details
|
8011
|
+
# Optional. If set to true, the full session including all answer details will
|
8012
|
+
# be returned.
|
6794
8013
|
# @param [String] fields
|
6795
8014
|
# Selector specifying which fields to include in a partial response.
|
6796
8015
|
# @param [String] quota_user
|
@@ -6808,11 +8027,12 @@ module Google
|
|
6808
8027
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6809
8028
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6810
8029
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6811
|
-
def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
8030
|
+
def get_project_location_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6812
8031
|
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
6813
8032
|
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession::Representation
|
6814
8033
|
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession
|
6815
8034
|
command.params['name'] = name unless name.nil?
|
8035
|
+
command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
|
6816
8036
|
command.query['fields'] = fields unless fields.nil?
|
6817
8037
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6818
8038
|
execute_or_queue_command(command, &block)
|
@@ -6820,15 +8040,17 @@ module Google
|
|
6820
8040
|
|
6821
8041
|
# Lists all Sessions by their parent DataStore.
|
6822
8042
|
# @param [String] parent
|
6823
|
-
# Required. The data store resource name. Format: `projects/`
|
6824
|
-
#
|
8043
|
+
# Required. The data store resource name. Format: `projects/`project`/locations/`
|
8044
|
+
# location`/collections/`collection`/dataStores/`data_store_id``
|
6825
8045
|
# @param [String] filter
|
6826
8046
|
# A filter to apply on the list results. The supported features are:
|
6827
8047
|
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
6828
8048
|
# @param [String] order_by
|
6829
8049
|
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
6830
8050
|
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
6831
|
-
# create_time` * `session_name` Example: "update_time desc" "
|
8051
|
+
# create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
|
8052
|
+
# create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
|
8053
|
+
# first, then by update_time.
|
6832
8054
|
# @param [Fixnum] page_size
|
6833
8055
|
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
6834
8056
|
# allowed value is 1000.
|
@@ -6908,9 +8130,9 @@ module Google
|
|
6908
8130
|
|
6909
8131
|
# Gets a Answer.
|
6910
8132
|
# @param [String] name
|
6911
|
-
# Required. The resource name of the Answer to get. Format: `projects/`
|
6912
|
-
#
|
6913
|
-
#
|
8133
|
+
# Required. The resource name of the Answer to get. Format: `projects/`project`/
|
8134
|
+
# locations/`location`/collections/`collection`/engines/`engine_id`/sessions/`
|
8135
|
+
# session_id`/answers/`answer_id``
|
6914
8136
|
# @param [String] fields
|
6915
8137
|
# Selector specifying which fields to include in a partial response.
|
6916
8138
|
# @param [String] quota_user
|
@@ -7040,6 +8262,109 @@ module Google
|
|
7040
8262
|
execute_or_queue_command(command, &block)
|
7041
8263
|
end
|
7042
8264
|
|
8265
|
+
# Creates a Sitemap.
|
8266
|
+
# @param [String] parent
|
8267
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
8268
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
8269
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSitemap] google_cloud_discoveryengine_v1alpha_sitemap_object
|
8270
|
+
# @param [String] fields
|
8271
|
+
# Selector specifying which fields to include in a partial response.
|
8272
|
+
# @param [String] quota_user
|
8273
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8274
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8275
|
+
# @param [Google::Apis::RequestOptions] options
|
8276
|
+
# Request-specific options
|
8277
|
+
#
|
8278
|
+
# @yield [result, err] Result & error if block supplied
|
8279
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
8280
|
+
# @yieldparam err [StandardError] error object if request failed
|
8281
|
+
#
|
8282
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
8283
|
+
#
|
8284
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8285
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8286
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8287
|
+
def create_project_location_data_store_site_search_engine_sitemap(parent, google_cloud_discoveryengine_v1alpha_sitemap_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
8288
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/sitemaps', options)
|
8289
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSitemap::Representation
|
8290
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_sitemap_object
|
8291
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
8292
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
8293
|
+
command.params['parent'] = parent unless parent.nil?
|
8294
|
+
command.query['fields'] = fields unless fields.nil?
|
8295
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8296
|
+
execute_or_queue_command(command, &block)
|
8297
|
+
end
|
8298
|
+
|
8299
|
+
# Deletes a Sitemap.
|
8300
|
+
# @param [String] name
|
8301
|
+
# Required. Full resource name of Sitemap, such as `projects/`project`/locations/
|
8302
|
+
# `location`/collections/`collection`/dataStores/`data_store`/siteSearchEngine/
|
8303
|
+
# sitemaps/`sitemap``. If the caller does not have permission to access the
|
8304
|
+
# Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is
|
8305
|
+
# returned. If the requested Sitemap does not exist, a NOT_FOUND error is
|
8306
|
+
# returned.
|
8307
|
+
# @param [String] fields
|
8308
|
+
# Selector specifying which fields to include in a partial response.
|
8309
|
+
# @param [String] quota_user
|
8310
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8311
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8312
|
+
# @param [Google::Apis::RequestOptions] options
|
8313
|
+
# Request-specific options
|
8314
|
+
#
|
8315
|
+
# @yield [result, err] Result & error if block supplied
|
8316
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
8317
|
+
# @yieldparam err [StandardError] error object if request failed
|
8318
|
+
#
|
8319
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
8320
|
+
#
|
8321
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8322
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8323
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8324
|
+
def delete_project_location_data_store_site_search_engine_sitemap(name, fields: nil, quota_user: nil, options: nil, &block)
|
8325
|
+
command = make_simple_command(:delete, 'v1alpha/{+name}', options)
|
8326
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
8327
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
8328
|
+
command.params['name'] = name unless name.nil?
|
8329
|
+
command.query['fields'] = fields unless fields.nil?
|
8330
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8331
|
+
execute_or_queue_command(command, &block)
|
8332
|
+
end
|
8333
|
+
|
8334
|
+
# Fetch Sitemaps in a DataStore.
|
8335
|
+
# @param [String] parent
|
8336
|
+
# Required. Parent resource name of the SiteSearchEngine, such as `projects/*/
|
8337
|
+
# locations/*/collections/*/dataStores/*/siteSearchEngine`.
|
8338
|
+
# @param [Array<String>, String] matcher_uris_matcher_uris
|
8339
|
+
# The Sitemap uris.
|
8340
|
+
# @param [String] fields
|
8341
|
+
# Selector specifying which fields to include in a partial response.
|
8342
|
+
# @param [String] quota_user
|
8343
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
8344
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
8345
|
+
# @param [Google::Apis::RequestOptions] options
|
8346
|
+
# Request-specific options
|
8347
|
+
#
|
8348
|
+
# @yield [result, err] Result & error if block supplied
|
8349
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse] parsed result object
|
8350
|
+
# @yieldparam err [StandardError] error object if request failed
|
8351
|
+
#
|
8352
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse]
|
8353
|
+
#
|
8354
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
8355
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
8356
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
8357
|
+
def fetch_project_location_data_store_site_search_engine_sitemap(parent, matcher_uris_matcher_uris: nil, fields: nil, quota_user: nil, options: nil, &block)
|
8358
|
+
command = make_simple_command(:get, 'v1alpha/{+parent}/sitemaps:fetch', options)
|
8359
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse::Representation
|
8360
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse
|
8361
|
+
command.params['parent'] = parent unless parent.nil?
|
8362
|
+
command.query['matcher.urisMatcher.uris'] = matcher_uris_matcher_uris unless matcher_uris_matcher_uris.nil?
|
8363
|
+
command.query['fields'] = fields unless fields.nil?
|
8364
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
8365
|
+
execute_or_queue_command(command, &block)
|
8366
|
+
end
|
8367
|
+
|
7043
8368
|
# Creates TargetSite in a batch.
|
7044
8369
|
# @param [String] parent
|
7045
8370
|
# Required. The parent resource shared by all TargetSites being created. `
|
@@ -7335,8 +8660,12 @@ module Google
|
|
7335
8660
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
7336
8661
|
# Users should not call this method directly.
|
7337
8662
|
# @param [String] parent
|
7338
|
-
# Required. The parent
|
7339
|
-
#
|
8663
|
+
# Required. The parent resource name. If the collect user event action is
|
8664
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
8665
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
8666
|
+
# user event action is applied in Location level, for example, the event with
|
8667
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
8668
|
+
# locations/`location``.
|
7340
8669
|
# @param [Fixnum] ets
|
7341
8670
|
# The event timestamp in milliseconds. This prevents browser caching of
|
7342
8671
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
@@ -7422,8 +8751,8 @@ module Google
|
|
7422
8751
|
# first.
|
7423
8752
|
# @param [String] parent
|
7424
8753
|
# Required. The resource name of the catalog under which the events are created.
|
7425
|
-
# The format is `projects
|
7426
|
-
#
|
8754
|
+
# The format is `projects/`project`/locations/global/collections/`collection`/
|
8755
|
+
# dataStores/`dataStore``.
|
7427
8756
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest] google_cloud_discoveryengine_v1alpha_purge_user_events_request_object
|
7428
8757
|
# @param [String] fields
|
7429
8758
|
# Selector specifying which fields to include in a partial response.
|
@@ -7614,12 +8943,14 @@ module Google
|
|
7614
8943
|
# @param [String] evaluation
|
7615
8944
|
# Required. The evaluation resource name, such as `projects/`project`/locations/`
|
7616
8945
|
# location`/evaluations/`evaluation``. If the caller does not have permission to
|
7617
|
-
# list EvaluationResult under this evaluation,
|
7618
|
-
# evaluation set exists, a `PERMISSION_DENIED`
|
8946
|
+
# list ListEvaluationResultsResponse.EvaluationResult under this evaluation,
|
8947
|
+
# regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED`
|
8948
|
+
# error is returned.
|
7619
8949
|
# @param [Fixnum] page_size
|
7620
|
-
# Maximum number of EvaluationResult to return. If
|
7621
|
-
# The maximum allowed value is 1000. Values above
|
7622
|
-
# If this field is negative, an `INVALID_ARGUMENT`
|
8950
|
+
# Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If
|
8951
|
+
# unspecified, defaults to 100. The maximum allowed value is 1000. Values above
|
8952
|
+
# 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT`
|
8953
|
+
# error is returned.
|
7623
8954
|
# @param [String] page_token
|
7624
8955
|
# A page token ListEvaluationResultsResponse.next_page_token, received from a
|
7625
8956
|
# previous EvaluationService.ListEvaluationResults call. Provide this to
|
@@ -7865,7 +9196,7 @@ module Google
|
|
7865
9196
|
# Ranks a list of text records based on the given input query.
|
7866
9197
|
# @param [String] ranking_config
|
7867
9198
|
# Required. The resource name of the rank service config, such as `projects/`
|
7868
|
-
# project_num`/locations/`
|
9199
|
+
# project_num`/locations/`location`/rankingConfigs/default_ranking_config`.
|
7869
9200
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankRequest] google_cloud_discoveryengine_v1alpha_rank_request_object
|
7870
9201
|
# @param [String] fields
|
7871
9202
|
# Selector specifying which fields to include in a partial response.
|
@@ -7977,9 +9308,9 @@ module Google
|
|
7977
9308
|
# Deletes a SampleQuerySet.
|
7978
9309
|
# @param [String] name
|
7979
9310
|
# Required. Full resource name of SampleQuerySet, such as `projects/`project`/
|
7980
|
-
# locations/`location`/sampleQuerySets/`
|
7981
|
-
# have permission to delete the SampleQuerySet, regardless of whether or not
|
7982
|
-
# exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to
|
9311
|
+
# locations/`location`/sampleQuerySets/`sample_query_set``. If the caller does
|
9312
|
+
# not have permission to delete the SampleQuerySet, regardless of whether or not
|
9313
|
+
# it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to
|
7983
9314
|
# delete does not exist, a `NOT_FOUND` error is returned.
|
7984
9315
|
# @param [String] fields
|
7985
9316
|
# Selector specifying which fields to include in a partial response.
|
@@ -8011,10 +9342,10 @@ module Google
|
|
8011
9342
|
# Gets a SampleQuerySet.
|
8012
9343
|
# @param [String] name
|
8013
9344
|
# Required. Full resource name of SampleQuerySet, such as `projects/`project`/
|
8014
|
-
# locations/`location`/sampleQuerySets/`
|
8015
|
-
# have permission to access the SampleQuerySet, regardless of whether or not
|
8016
|
-
# exists, a PERMISSION_DENIED error is returned. If the requested
|
8017
|
-
# does not exist, a NOT_FOUND error is returned.
|
9345
|
+
# locations/`location`/sampleQuerySets/`sample_query_set``. If the caller does
|
9346
|
+
# not have permission to access the SampleQuerySet, regardless of whether or not
|
9347
|
+
# it exists, a PERMISSION_DENIED error is returned. If the requested
|
9348
|
+
# SampleQuerySet does not exist, a NOT_FOUND error is returned.
|
8018
9349
|
# @param [String] fields
|
8019
9350
|
# Selector specifying which fields to include in a partial response.
|
8020
9351
|
# @param [String] quota_user
|
@@ -8089,8 +9420,8 @@ module Google
|
|
8089
9420
|
|
8090
9421
|
# Updates a SampleQuerySet.
|
8091
9422
|
# @param [String] name
|
8092
|
-
#
|
8093
|
-
# projects/`project`/locations/`location`/sampleQuerySets/`
|
9423
|
+
# Identifier. The full resource name of the SampleQuerySet, in the format of `
|
9424
|
+
# projects/`project`/locations/`location`/sampleQuerySets/`sample_query_set``.
|
8094
9425
|
# This field must be a UTF-8 encoded string with a length limit of 1024
|
8095
9426
|
# characters.
|
8096
9427
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuerySet] google_cloud_discoveryengine_v1alpha_sample_query_set_object
|
@@ -8205,8 +9536,8 @@ module Google
|
|
8205
9536
|
# Deletes a SampleQuery.
|
8206
9537
|
# @param [String] name
|
8207
9538
|
# Required. Full resource name of SampleQuery, such as `projects/`project`/
|
8208
|
-
# locations/`location`/sampleQuerySets/`
|
8209
|
-
#
|
9539
|
+
# locations/`location`/sampleQuerySets/`sample_query_set`/sampleQueries/`
|
9540
|
+
# sample_query``. If the caller does not have permission to delete the
|
8210
9541
|
# SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED`
|
8211
9542
|
# error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND`
|
8212
9543
|
# error is returned.
|
@@ -8240,8 +9571,8 @@ module Google
|
|
8240
9571
|
# Gets a SampleQuery.
|
8241
9572
|
# @param [String] name
|
8242
9573
|
# Required. Full resource name of SampleQuery, such as `projects/`project`/
|
8243
|
-
# locations/`location`/sampleQuerySets/`
|
8244
|
-
#
|
9574
|
+
# locations/`location`/sampleQuerySets/`sample_query_set`/sampleQueries/`
|
9575
|
+
# sample_query``. If the caller does not have permission to access the
|
8245
9576
|
# SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error
|
8246
9577
|
# is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is
|
8247
9578
|
# returned.
|
@@ -8359,10 +9690,10 @@ module Google
|
|
8359
9690
|
|
8360
9691
|
# Updates a SampleQuery.
|
8361
9692
|
# @param [String] name
|
8362
|
-
#
|
8363
|
-
# projects/`project`/locations/`location`/sampleQuerySets/`
|
8364
|
-
# sampleQueries/`
|
8365
|
-
# length limit of 1024 characters.
|
9693
|
+
# Identifier. The full resource name of the sample query, in the format of `
|
9694
|
+
# projects/`project`/locations/`location`/sampleQuerySets/`sample_query_set`/
|
9695
|
+
# sampleQueries/`sample_query``. This field must be a UTF-8 encoded string with
|
9696
|
+
# a length limit of 1024 characters.
|
8366
9697
|
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSampleQuery] google_cloud_discoveryengine_v1alpha_sample_query_object
|
8367
9698
|
# @param [String] update_mask
|
8368
9699
|
# Indicates which fields in the provided imported 'simple query' to update. If
|
@@ -8402,8 +9733,12 @@ module Google
|
|
8402
9733
|
# only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
|
8403
9734
|
# Users should not call this method directly.
|
8404
9735
|
# @param [String] parent
|
8405
|
-
# Required. The parent
|
8406
|
-
#
|
9736
|
+
# Required. The parent resource name. If the collect user event action is
|
9737
|
+
# applied in DataStore level, the format is: `projects/`project`/locations/`
|
9738
|
+
# location`/collections/`collection`/dataStores/`data_store``. If the collect
|
9739
|
+
# user event action is applied in Location level, for example, the event with
|
9740
|
+
# Document across multiple DataStore, the format is: `projects/`project`/
|
9741
|
+
# locations/`location``.
|
8407
9742
|
# @param [Fixnum] ets
|
8408
9743
|
# The event timestamp in milliseconds. This prevents browser caching of
|
8409
9744
|
# otherwise identical get requests. The name is abbreviated to reduce the
|
@@ -8445,6 +9780,44 @@ module Google
|
|
8445
9780
|
execute_or_queue_command(command, &block)
|
8446
9781
|
end
|
8447
9782
|
|
9783
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
9784
|
+
# that already exist are skipped. Use this method for backfilling historical
|
9785
|
+
# user events. Operation.response is of type ImportResponse. Note that it is
|
9786
|
+
# possible for a subset of the items to be successfully inserted. Operation.
|
9787
|
+
# metadata is of type ImportMetadata.
|
9788
|
+
# @param [String] parent
|
9789
|
+
# Required. Parent DataStore resource name, of the form `projects/`project`/
|
9790
|
+
# locations/`location`/collections/`collection`/dataStores/`data_store``
|
9791
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest] google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
9792
|
+
# @param [String] fields
|
9793
|
+
# Selector specifying which fields to include in a partial response.
|
9794
|
+
# @param [String] quota_user
|
9795
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
9796
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
9797
|
+
# @param [Google::Apis::RequestOptions] options
|
9798
|
+
# Request-specific options
|
9799
|
+
#
|
9800
|
+
# @yield [result, err] Result & error if block supplied
|
9801
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
9802
|
+
# @yieldparam err [StandardError] error object if request failed
|
9803
|
+
#
|
9804
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
9805
|
+
#
|
9806
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
9807
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
9808
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
9809
|
+
def import_project_location_user_event(parent, google_cloud_discoveryengine_v1alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
9810
|
+
command = make_simple_command(:post, 'v1alpha/{+parent}/userEvents:import', options)
|
9811
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest::Representation
|
9812
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_import_user_events_request_object
|
9813
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
9814
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
9815
|
+
command.params['parent'] = parent unless parent.nil?
|
9816
|
+
command.query['fields'] = fields unless fields.nil?
|
9817
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
9818
|
+
execute_or_queue_command(command, &block)
|
9819
|
+
end
|
9820
|
+
|
8448
9821
|
# Writes a single user event.
|
8449
9822
|
# @param [String] parent
|
8450
9823
|
# Required. The parent resource name. If the write user event action is applied
|
@@ -8487,6 +9860,77 @@ module Google
|
|
8487
9860
|
execute_or_queue_command(command, &block)
|
8488
9861
|
end
|
8489
9862
|
|
9863
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
9864
|
+
# to poll the operation result at intervals as recommended by the API service.
|
9865
|
+
# @param [String] name
|
9866
|
+
# The name of the operation resource.
|
9867
|
+
# @param [String] fields
|
9868
|
+
# Selector specifying which fields to include in a partial response.
|
9869
|
+
# @param [String] quota_user
|
9870
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
9871
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
9872
|
+
# @param [Google::Apis::RequestOptions] options
|
9873
|
+
# Request-specific options
|
9874
|
+
#
|
9875
|
+
# @yield [result, err] Result & error if block supplied
|
9876
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
|
9877
|
+
# @yieldparam err [StandardError] error object if request failed
|
9878
|
+
#
|
9879
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
|
9880
|
+
#
|
9881
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
9882
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
9883
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
9884
|
+
def get_project_location_user_store_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
9885
|
+
command = make_simple_command(:get, 'v1alpha/{+name}', options)
|
9886
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
|
9887
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
|
9888
|
+
command.params['name'] = name unless name.nil?
|
9889
|
+
command.query['fields'] = fields unless fields.nil?
|
9890
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
9891
|
+
execute_or_queue_command(command, &block)
|
9892
|
+
end
|
9893
|
+
|
9894
|
+
# Lists operations that match the specified filter in the request. If the server
|
9895
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
9896
|
+
# @param [String] name
|
9897
|
+
# The name of the operation's parent resource.
|
9898
|
+
# @param [String] filter
|
9899
|
+
# The standard list filter.
|
9900
|
+
# @param [Fixnum] page_size
|
9901
|
+
# The standard list page size.
|
9902
|
+
# @param [String] page_token
|
9903
|
+
# The standard list page token.
|
9904
|
+
# @param [String] fields
|
9905
|
+
# Selector specifying which fields to include in a partial response.
|
9906
|
+
# @param [String] quota_user
|
9907
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
9908
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
9909
|
+
# @param [Google::Apis::RequestOptions] options
|
9910
|
+
# Request-specific options
|
9911
|
+
#
|
9912
|
+
# @yield [result, err] Result & error if block supplied
|
9913
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
|
9914
|
+
# @yieldparam err [StandardError] error object if request failed
|
9915
|
+
#
|
9916
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
|
9917
|
+
#
|
9918
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
9919
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
9920
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
9921
|
+
def list_project_location_user_store_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
9922
|
+
command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
|
9923
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
|
9924
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
|
9925
|
+
command.params['name'] = name unless name.nil?
|
9926
|
+
command.query['filter'] = filter unless filter.nil?
|
9927
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
9928
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
9929
|
+
command.query['fields'] = fields unless fields.nil?
|
9930
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
9931
|
+
execute_or_queue_command(command, &block)
|
9932
|
+
end
|
9933
|
+
|
8490
9934
|
# Gets the latest state of a long-running operation. Clients can use this method
|
8491
9935
|
# to poll the operation result at intervals as recommended by the API service.
|
8492
9936
|
# @param [String] name
|