google-apis-discoveryengine_v1alpha 0.26.0 → 0.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -190,6 +190,77 @@ module Google
190
190
  execute_or_queue_command(command, &block)
191
191
  end
192
192
 
193
+ # Gets the latest state of a long-running operation. Clients can use this method
194
+ # to poll the operation result at intervals as recommended by the API service.
195
+ # @param [String] name
196
+ # The name of the operation resource.
197
+ # @param [String] fields
198
+ # Selector specifying which fields to include in a partial response.
199
+ # @param [String] quota_user
200
+ # Available to use for quota purposes for server-side applications. Can be any
201
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
202
+ # @param [Google::Apis::RequestOptions] options
203
+ # Request-specific options
204
+ #
205
+ # @yield [result, err] Result & error if block supplied
206
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
207
+ # @yieldparam err [StandardError] error object if request failed
208
+ #
209
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
210
+ #
211
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
212
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
213
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
214
+ def get_project_location_collection_data_connector_operation(name, fields: nil, quota_user: nil, options: nil, &block)
215
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
216
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
217
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
218
+ command.params['name'] = name unless name.nil?
219
+ command.query['fields'] = fields unless fields.nil?
220
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
221
+ execute_or_queue_command(command, &block)
222
+ end
223
+
224
+ # Lists operations that match the specified filter in the request. If the server
225
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
226
+ # @param [String] name
227
+ # The name of the operation's parent resource.
228
+ # @param [String] filter
229
+ # The standard list filter.
230
+ # @param [Fixnum] page_size
231
+ # The standard list page size.
232
+ # @param [String] page_token
233
+ # The standard list page token.
234
+ # @param [String] fields
235
+ # Selector specifying which fields to include in a partial response.
236
+ # @param [String] quota_user
237
+ # Available to use for quota purposes for server-side applications. Can be any
238
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
239
+ # @param [Google::Apis::RequestOptions] options
240
+ # Request-specific options
241
+ #
242
+ # @yield [result, err] Result & error if block supplied
243
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
244
+ # @yieldparam err [StandardError] error object if request failed
245
+ #
246
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
247
+ #
248
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
249
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
250
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
251
+ def list_project_location_collection_data_connector_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
252
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
253
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
254
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
255
+ command.params['name'] = name unless name.nil?
256
+ command.query['filter'] = filter unless filter.nil?
257
+ command.query['pageSize'] = page_size unless page_size.nil?
258
+ command.query['pageToken'] = page_token unless page_token.nil?
259
+ command.query['fields'] = fields unless fields.nil?
260
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
261
+ execute_or_queue_command(command, &block)
262
+ end
263
+
193
264
  # Completes the specified user input with keyword suggestions.
194
265
  # @param [String] data_store
195
266
  # Required. The parent data store resource name for which the completion is
@@ -252,6 +323,211 @@ module Google
252
323
  execute_or_queue_command(command, &block)
253
324
  end
254
325
 
326
+ # Creates a DataStore. DataStore is for storing Documents. To serve these
327
+ # documents for Search, or Recommendation use case, an Engine needs to be
328
+ # created separately.
329
+ # @param [String] parent
330
+ # Required. The parent resource name, such as `projects/`project`/locations/`
331
+ # location`/collections/`collection``.
332
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
333
+ # @param [Boolean] create_advanced_site_search
334
+ # A boolean flag indicating whether user want to directly create an advanced
335
+ # data store for site search. If the data store is not configured as site search
336
+ # (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
337
+ # ignored.
338
+ # @param [String] data_store_id
339
+ # Required. The ID to use for the DataStore, which will become the final
340
+ # component of the DataStore's resource name. This field must conform to [RFC-
341
+ # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
342
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
343
+ # @param [String] fields
344
+ # Selector specifying which fields to include in a partial response.
345
+ # @param [String] quota_user
346
+ # Available to use for quota purposes for server-side applications. Can be any
347
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
348
+ # @param [Google::Apis::RequestOptions] options
349
+ # Request-specific options
350
+ #
351
+ # @yield [result, err] Result & error if block supplied
352
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
353
+ # @yieldparam err [StandardError] error object if request failed
354
+ #
355
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
356
+ #
357
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
358
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
359
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
360
+ 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)
361
+ command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
362
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
363
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
364
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
365
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
366
+ command.params['parent'] = parent unless parent.nil?
367
+ command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
368
+ command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
369
+ command.query['fields'] = fields unless fields.nil?
370
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
371
+ execute_or_queue_command(command, &block)
372
+ end
373
+
374
+ # Deletes a DataStore.
375
+ # @param [String] name
376
+ # Required. Full resource name of DataStore, such as `projects/`project`/
377
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
378
+ # If the caller does not have permission to delete the DataStore, regardless of
379
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
380
+ # DataStore to delete does not exist, a NOT_FOUND error is returned.
381
+ # @param [String] fields
382
+ # Selector specifying which fields to include in a partial response.
383
+ # @param [String] quota_user
384
+ # Available to use for quota purposes for server-side applications. Can be any
385
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
386
+ # @param [Google::Apis::RequestOptions] options
387
+ # Request-specific options
388
+ #
389
+ # @yield [result, err] Result & error if block supplied
390
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
391
+ # @yieldparam err [StandardError] error object if request failed
392
+ #
393
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
394
+ #
395
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
396
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
397
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
398
+ def delete_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
399
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
400
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
401
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
402
+ command.params['name'] = name unless name.nil?
403
+ command.query['fields'] = fields unless fields.nil?
404
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
405
+ execute_or_queue_command(command, &block)
406
+ end
407
+
408
+ # Gets a DataStore.
409
+ # @param [String] name
410
+ # Required. Full resource name of DataStore, such as `projects/`project`/
411
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
412
+ # If the caller does not have permission to access the DataStore, regardless of
413
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
414
+ # requested DataStore does not exist, a NOT_FOUND error is returned.
415
+ # @param [String] fields
416
+ # Selector specifying which fields to include in a partial response.
417
+ # @param [String] quota_user
418
+ # Available to use for quota purposes for server-side applications. Can be any
419
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
420
+ # @param [Google::Apis::RequestOptions] options
421
+ # Request-specific options
422
+ #
423
+ # @yield [result, err] Result & error if block supplied
424
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
425
+ # @yieldparam err [StandardError] error object if request failed
426
+ #
427
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
428
+ #
429
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
430
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
431
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
432
+ def get_project_location_collection_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
433
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
434
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
435
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
436
+ command.params['name'] = name unless name.nil?
437
+ command.query['fields'] = fields unless fields.nil?
438
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
439
+ execute_or_queue_command(command, &block)
440
+ end
441
+
442
+ # Lists all the DataStores associated with the project.
443
+ # @param [String] parent
444
+ # Required. The parent branch resource name, such as `projects/`project`/
445
+ # locations/`location`/collections/`collection_id``. If the caller does not have
446
+ # permission to list DataStoress under this location, regardless of whether or
447
+ # not this data store exists, a PERMISSION_DENIED error is returned.
448
+ # @param [String] filter
449
+ # Filter by solution type. For example: filter = 'solution_type:
450
+ # SOLUTION_TYPE_SEARCH'
451
+ # @param [Fixnum] page_size
452
+ # Maximum number of DataStores to return. If unspecified, defaults to 10. The
453
+ # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
454
+ # field is negative, an INVALID_ARGUMENT is returned.
455
+ # @param [String] page_token
456
+ # A page token ListDataStoresResponse.next_page_token, received from a previous
457
+ # DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
458
+ # page. When paginating, all other parameters provided to DataStoreService.
459
+ # ListDataStores must match the call that provided the page token. Otherwise, an
460
+ # INVALID_ARGUMENT error is returned.
461
+ # @param [String] fields
462
+ # Selector specifying which fields to include in a partial response.
463
+ # @param [String] quota_user
464
+ # Available to use for quota purposes for server-side applications. Can be any
465
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
466
+ # @param [Google::Apis::RequestOptions] options
467
+ # Request-specific options
468
+ #
469
+ # @yield [result, err] Result & error if block supplied
470
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse] parsed result object
471
+ # @yieldparam err [StandardError] error object if request failed
472
+ #
473
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse]
474
+ #
475
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
476
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
477
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
478
+ def list_project_location_collection_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
479
+ command = make_simple_command(:get, 'v1alpha/{+parent}/dataStores', options)
480
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse::Representation
481
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
482
+ command.params['parent'] = parent unless parent.nil?
483
+ command.query['filter'] = filter unless filter.nil?
484
+ command.query['pageSize'] = page_size unless page_size.nil?
485
+ command.query['pageToken'] = page_token unless page_token.nil?
486
+ command.query['fields'] = fields unless fields.nil?
487
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
488
+ execute_or_queue_command(command, &block)
489
+ end
490
+
491
+ # Updates a DataStore
492
+ # @param [String] name
493
+ # Immutable. The full resource name of the data store. Format: `projects/`
494
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
495
+ # data_store_id``. This field must be a UTF-8 encoded string with a length limit
496
+ # of 1024 characters.
497
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
498
+ # @param [String] update_mask
499
+ # Indicates which fields in the provided DataStore to update. If an unsupported
500
+ # or unknown field is provided, an INVALID_ARGUMENT error is returned.
501
+ # @param [String] fields
502
+ # Selector specifying which fields to include in a partial response.
503
+ # @param [String] quota_user
504
+ # Available to use for quota purposes for server-side applications. Can be any
505
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
506
+ # @param [Google::Apis::RequestOptions] options
507
+ # Request-specific options
508
+ #
509
+ # @yield [result, err] Result & error if block supplied
510
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
511
+ # @yieldparam err [StandardError] error object if request failed
512
+ #
513
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
514
+ #
515
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
516
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
517
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
518
+ def patch_project_location_collection_data_store(name, google_cloud_discoveryengine_v1alpha_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
519
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
520
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
521
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
522
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
523
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
524
+ command.params['name'] = name unless name.nil?
525
+ command.query['updateMask'] = update_mask unless update_mask.nil?
526
+ command.query['fields'] = fields unless fields.nil?
527
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
528
+ execute_or_queue_command(command, &block)
529
+ end
530
+
255
531
  # Creates a Document.
256
532
  # @param [String] parent
257
533
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -1228,10 +1504,14 @@ module Google
1228
1504
 
1229
1505
  # Makes a recommendation, which requires a contextual user event.
1230
1506
  # @param [String] serving_config
1231
- # Required. Full resource name of the format: `projects/*/locations/global/
1232
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
1233
- # recommendations from your model, you must create at least one serving config
1234
- # for it.
1507
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
1508
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
1509
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
1510
+ # created along with your recommendation engine creation. The engine ID will be
1511
+ # used as the ID of the default serving config. For example, for Engine `
1512
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
1513
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
1514
+ # engine` for your Recommend requests.
1235
1515
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
1236
1516
  # @param [String] fields
1237
1517
  # Selector specifying which fields to include in a partial response.
@@ -1265,9 +1545,11 @@ module Google
1265
1545
  # Performs a search.
1266
1546
  # @param [String] serving_config
1267
1547
  # Required. The resource name of the Search serving config, such as `projects/*/
1268
- # locations/global/collections/default_collection/dataStores/default_data_store/
1269
- # servingConfigs/default_serving_config`. This field is used to identify the
1270
- # serving configuration name, set of models used to make the search.
1548
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
1549
+ # default_serving_config`, or `projects/*/locations/global/collections/
1550
+ # default_collection/dataStores/default_data_store/servingConfigs/
1551
+ # default_serving_config`. This field is used to identify the serving
1552
+ # configuration name, set of models used to make the search.
1271
1553
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
1272
1554
  # @param [String] fields
1273
1555
  # Selector specifying which fields to include in a partial response.
@@ -1632,10 +1914,16 @@ module Google
1632
1914
  execute_or_queue_command(command, &block)
1633
1915
  end
1634
1916
 
1635
- # Gets the latest state of a long-running operation. Clients can use this method
1636
- # to poll the operation result at intervals as recommended by the API service.
1637
- # @param [String] name
1638
- # The name of the operation resource.
1917
+ # Creates a Engine.
1918
+ # @param [String] parent
1919
+ # Required. The parent resource name, such as `projects/`project`/locations/`
1920
+ # location`/collections/`collection``.
1921
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
1922
+ # @param [String] engine_id
1923
+ # Required. The ID to use for the Engine, which will become the final component
1924
+ # of the Engine's resource name. This field must conform to [RFC-1034](https://
1925
+ # tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
1926
+ # Otherwise, an INVALID_ARGUMENT error is returned.
1639
1927
  # @param [String] fields
1640
1928
  # Selector specifying which fields to include in a partial response.
1641
1929
  # @param [String] quota_user
@@ -1653,26 +1941,26 @@ module Google
1653
1941
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1654
1942
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1655
1943
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1656
- def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
1657
- command = make_simple_command(:get, 'v1alpha/{+name}', options)
1944
+ def create_project_location_collection_engine(parent, google_cloud_discoveryengine_v1alpha_engine_object = nil, engine_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1945
+ command = make_simple_command(:post, 'v1alpha/{+parent}/engines', options)
1946
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
1947
+ command.request_object = google_cloud_discoveryengine_v1alpha_engine_object
1658
1948
  command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1659
1949
  command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1660
- command.params['name'] = name unless name.nil?
1950
+ command.params['parent'] = parent unless parent.nil?
1951
+ command.query['engineId'] = engine_id unless engine_id.nil?
1661
1952
  command.query['fields'] = fields unless fields.nil?
1662
1953
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1663
1954
  execute_or_queue_command(command, &block)
1664
1955
  end
1665
1956
 
1666
- # Lists operations that match the specified filter in the request. If the server
1667
- # doesn't support this method, it returns `UNIMPLEMENTED`.
1957
+ # Deletes a Engine.
1668
1958
  # @param [String] name
1669
- # The name of the operation's parent resource.
1670
- # @param [String] filter
1671
- # The standard list filter.
1672
- # @param [Fixnum] page_size
1673
- # The standard list page size.
1674
- # @param [String] page_token
1675
- # The standard list page token.
1959
+ # Required. Full resource name of Engine, such as `projects/`project`/locations/`
1960
+ # location`/collections/`collection_id`/engines/`engine_id``. If the caller does
1961
+ # not have permission to delete the Engine, regardless of whether or not it
1962
+ # exists, a PERMISSION_DENIED error is returned. If the Engine to delete does
1963
+ # not exist, a NOT_FOUND error is returned.
1676
1964
  # @param [String] fields
1677
1965
  # Selector specifying which fields to include in a partial response.
1678
1966
  # @param [String] quota_user
@@ -1682,34 +1970,28 @@ module Google
1682
1970
  # Request-specific options
1683
1971
  #
1684
1972
  # @yield [result, err] Result & error if block supplied
1685
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
1973
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
1686
1974
  # @yieldparam err [StandardError] error object if request failed
1687
1975
  #
1688
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
1976
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
1689
1977
  #
1690
1978
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1691
1979
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1692
1980
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1693
- def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1694
- command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
1695
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
1696
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
1981
+ def delete_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
1982
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
1983
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
1984
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
1697
1985
  command.params['name'] = name unless name.nil?
1698
- command.query['filter'] = filter unless filter.nil?
1699
- command.query['pageSize'] = page_size unless page_size.nil?
1700
- command.query['pageToken'] = page_token unless page_token.nil?
1701
1986
  command.query['fields'] = fields unless fields.nil?
1702
1987
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1703
1988
  execute_or_queue_command(command, &block)
1704
1989
  end
1705
1990
 
1706
- # Makes a recommendation, which requires a contextual user event.
1707
- # @param [String] serving_config
1708
- # Required. Full resource name of the format: `projects/*/locations/global/
1709
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
1710
- # recommendations from your model, you must create at least one serving config
1711
- # for it.
1712
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
1991
+ # Gets a Engine.
1992
+ # @param [String] name
1993
+ # Required. Full resource name of Engine, such as `projects/`project`/locations/`
1994
+ # location`/collections/`collection_id`/engines/`engine_id``.
1713
1995
  # @param [String] fields
1714
1996
  # Selector specifying which fields to include in a partial response.
1715
1997
  # @param [String] quota_user
@@ -1719,37 +2001,336 @@ module Google
1719
2001
  # Request-specific options
1720
2002
  #
1721
2003
  # @yield [result, err] Result & error if block supplied
1722
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
2004
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
1723
2005
  # @yieldparam err [StandardError] error object if request failed
1724
2006
  #
1725
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
2007
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
1726
2008
  #
1727
2009
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1728
2010
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1729
2011
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1730
- def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1731
- command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
1732
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
1733
- command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
1734
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
1735
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
1736
- command.params['servingConfig'] = serving_config unless serving_config.nil?
2012
+ def get_project_location_collection_engine(name, fields: nil, quota_user: nil, options: nil, &block)
2013
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2014
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2015
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2016
+ command.params['name'] = name unless name.nil?
1737
2017
  command.query['fields'] = fields unless fields.nil?
1738
2018
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1739
2019
  execute_or_queue_command(command, &block)
1740
2020
  end
1741
2021
 
1742
- # Performs a search.
1743
- # @param [String] serving_config
1744
- # Required. The resource name of the Search serving config, such as `projects/*/
1745
- # locations/global/collections/default_collection/dataStores/default_data_store/
1746
- # servingConfigs/default_serving_config`. This field is used to identify the
1747
- # serving configuration name, set of models used to make the search.
1748
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
1749
- # @param [String] fields
1750
- # Selector specifying which fields to include in a partial response.
1751
- # @param [String] quota_user
1752
- # Available to use for quota purposes for server-side applications. Can be any
2022
+ # Lists all the Engines associated with the project.
2023
+ # @param [String] parent
2024
+ # Required. The parent resource name, such as `projects/`project`/locations/`
2025
+ # location`/collections/`collection_id``.
2026
+ # @param [String] filter
2027
+ # Optional. Filter by solution type. For example: solution_type=
2028
+ # SOLUTION_TYPE_SEARCH
2029
+ # @param [Fixnum] page_size
2030
+ # Optional. Not supported.
2031
+ # @param [String] page_token
2032
+ # Optional. Not supported.
2033
+ # @param [String] fields
2034
+ # Selector specifying which fields to include in a partial response.
2035
+ # @param [String] quota_user
2036
+ # Available to use for quota purposes for server-side applications. Can be any
2037
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2038
+ # @param [Google::Apis::RequestOptions] options
2039
+ # Request-specific options
2040
+ #
2041
+ # @yield [result, err] Result & error if block supplied
2042
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse] parsed result object
2043
+ # @yieldparam err [StandardError] error object if request failed
2044
+ #
2045
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse]
2046
+ #
2047
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2048
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2049
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2050
+ def list_project_location_collection_engines(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2051
+ command = make_simple_command(:get, 'v1alpha/{+parent}/engines', options)
2052
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse::Representation
2053
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListEnginesResponse
2054
+ command.params['parent'] = parent unless parent.nil?
2055
+ command.query['filter'] = filter unless filter.nil?
2056
+ command.query['pageSize'] = page_size unless page_size.nil?
2057
+ command.query['pageToken'] = page_token unless page_token.nil?
2058
+ command.query['fields'] = fields unless fields.nil?
2059
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2060
+ execute_or_queue_command(command, &block)
2061
+ end
2062
+
2063
+ # Updates an Engine
2064
+ # @param [String] name
2065
+ # Immutable. The fully qualified resource name of the engine. This field must be
2066
+ # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
2067
+ # projects/`project_number`/locations/`location`/collections/`collection`/
2068
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
2069
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
2070
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] google_cloud_discoveryengine_v1alpha_engine_object
2071
+ # @param [String] update_mask
2072
+ # Indicates which fields in the provided Engine to update. If an unsupported or
2073
+ # unknown field is provided, an INVALID_ARGUMENT error is returned.
2074
+ # @param [String] fields
2075
+ # Selector specifying which fields to include in a partial response.
2076
+ # @param [String] quota_user
2077
+ # Available to use for quota purposes for server-side applications. Can be any
2078
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2079
+ # @param [Google::Apis::RequestOptions] options
2080
+ # Request-specific options
2081
+ #
2082
+ # @yield [result, err] Result & error if block supplied
2083
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2084
+ # @yieldparam err [StandardError] error object if request failed
2085
+ #
2086
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2087
+ #
2088
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2089
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2090
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2091
+ def patch_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_engine_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2092
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2093
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2094
+ command.request_object = google_cloud_discoveryengine_v1alpha_engine_object
2095
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2096
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2097
+ command.params['name'] = name unless name.nil?
2098
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2099
+ command.query['fields'] = fields unless fields.nil?
2100
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2101
+ execute_or_queue_command(command, &block)
2102
+ end
2103
+
2104
+ # Pauses the training of an existing engine. Only applicable if solution_type is
2105
+ # SOLUTION_TYPE_RECOMMENDATION.
2106
+ # @param [String] name
2107
+ # Required. The name of the engine to pause. Format: `projects/`project_number`/
2108
+ # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
2109
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest] google_cloud_discoveryengine_v1alpha_pause_engine_request_object
2110
+ # @param [String] fields
2111
+ # Selector specifying which fields to include in a partial response.
2112
+ # @param [String] quota_user
2113
+ # Available to use for quota purposes for server-side applications. Can be any
2114
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2115
+ # @param [Google::Apis::RequestOptions] options
2116
+ # Request-specific options
2117
+ #
2118
+ # @yield [result, err] Result & error if block supplied
2119
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2120
+ # @yieldparam err [StandardError] error object if request failed
2121
+ #
2122
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2123
+ #
2124
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2125
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2126
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2127
+ def pause_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_pause_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2128
+ command = make_simple_command(:post, 'v1alpha/{+name}:pause', options)
2129
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaPauseEngineRequest::Representation
2130
+ command.request_object = google_cloud_discoveryengine_v1alpha_pause_engine_request_object
2131
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2132
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2133
+ command.params['name'] = name unless name.nil?
2134
+ command.query['fields'] = fields unless fields.nil?
2135
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2136
+ execute_or_queue_command(command, &block)
2137
+ end
2138
+
2139
+ # Resumes the training of an existing engine. Only applicable if solution_type
2140
+ # is SOLUTION_TYPE_RECOMMENDATION.
2141
+ # @param [String] name
2142
+ # Required. The name of the engine to resume. Format: `projects/`project_number`/
2143
+ # locations/`location_id`/collections/`collection_id`/engines/`engine_id``
2144
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest] google_cloud_discoveryengine_v1alpha_resume_engine_request_object
2145
+ # @param [String] fields
2146
+ # Selector specifying which fields to include in a partial response.
2147
+ # @param [String] quota_user
2148
+ # Available to use for quota purposes for server-side applications. Can be any
2149
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2150
+ # @param [Google::Apis::RequestOptions] options
2151
+ # Request-specific options
2152
+ #
2153
+ # @yield [result, err] Result & error if block supplied
2154
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine] parsed result object
2155
+ # @yieldparam err [StandardError] error object if request failed
2156
+ #
2157
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine]
2158
+ #
2159
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2160
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2161
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2162
+ def resume_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_resume_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2163
+ command = make_simple_command(:post, 'v1alpha/{+name}:resume', options)
2164
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaResumeEngineRequest::Representation
2165
+ command.request_object = google_cloud_discoveryengine_v1alpha_resume_engine_request_object
2166
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine::Representation
2167
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine
2168
+ command.params['name'] = name unless name.nil?
2169
+ command.query['fields'] = fields unless fields.nil?
2170
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2171
+ execute_or_queue_command(command, &block)
2172
+ end
2173
+
2174
+ # Tunes an existing engine. Only applicable if solution_type is
2175
+ # SOLUTION_TYPE_RECOMMENDATION.
2176
+ # @param [String] name
2177
+ # Required. The resource name of the engine to tune. Format: `projects/`
2178
+ # project_number`/locations/`location_id`/collections/`collection_id`/engines/`
2179
+ # engine_id``
2180
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest] google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2181
+ # @param [String] fields
2182
+ # Selector specifying which fields to include in a partial response.
2183
+ # @param [String] quota_user
2184
+ # Available to use for quota purposes for server-side applications. Can be any
2185
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2186
+ # @param [Google::Apis::RequestOptions] options
2187
+ # Request-specific options
2188
+ #
2189
+ # @yield [result, err] Result & error if block supplied
2190
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2191
+ # @yieldparam err [StandardError] error object if request failed
2192
+ #
2193
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2194
+ #
2195
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2196
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2197
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2198
+ def tune_project_location_collection_engine(name, google_cloud_discoveryengine_v1alpha_tune_engine_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2199
+ command = make_simple_command(:post, 'v1alpha/{+name}:tune', options)
2200
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTuneEngineRequest::Representation
2201
+ command.request_object = google_cloud_discoveryengine_v1alpha_tune_engine_request_object
2202
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2203
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2204
+ command.params['name'] = name unless name.nil?
2205
+ command.query['fields'] = fields unless fields.nil?
2206
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2207
+ execute_or_queue_command(command, &block)
2208
+ end
2209
+
2210
+ # Gets the latest state of a long-running operation. Clients can use this method
2211
+ # to poll the operation result at intervals as recommended by the API service.
2212
+ # @param [String] name
2213
+ # The name of the operation resource.
2214
+ # @param [String] fields
2215
+ # Selector specifying which fields to include in a partial response.
2216
+ # @param [String] quota_user
2217
+ # Available to use for quota purposes for server-side applications. Can be any
2218
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2219
+ # @param [Google::Apis::RequestOptions] options
2220
+ # Request-specific options
2221
+ #
2222
+ # @yield [result, err] Result & error if block supplied
2223
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2224
+ # @yieldparam err [StandardError] error object if request failed
2225
+ #
2226
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2227
+ #
2228
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2229
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2230
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2231
+ def get_project_location_collection_engine_operation(name, fields: nil, quota_user: nil, options: nil, &block)
2232
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2233
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2234
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2235
+ command.params['name'] = name unless name.nil?
2236
+ command.query['fields'] = fields unless fields.nil?
2237
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2238
+ execute_or_queue_command(command, &block)
2239
+ end
2240
+
2241
+ # Lists operations that match the specified filter in the request. If the server
2242
+ # doesn't support this method, it returns `UNIMPLEMENTED`.
2243
+ # @param [String] name
2244
+ # The name of the operation's parent resource.
2245
+ # @param [String] filter
2246
+ # The standard list filter.
2247
+ # @param [Fixnum] page_size
2248
+ # The standard list page size.
2249
+ # @param [String] page_token
2250
+ # The standard list page token.
2251
+ # @param [String] fields
2252
+ # Selector specifying which fields to include in a partial response.
2253
+ # @param [String] quota_user
2254
+ # Available to use for quota purposes for server-side applications. Can be any
2255
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2256
+ # @param [Google::Apis::RequestOptions] options
2257
+ # Request-specific options
2258
+ #
2259
+ # @yield [result, err] Result & error if block supplied
2260
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse] parsed result object
2261
+ # @yieldparam err [StandardError] error object if request failed
2262
+ #
2263
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse]
2264
+ #
2265
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2266
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2267
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2268
+ def list_project_location_collection_engine_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2269
+ command = make_simple_command(:get, 'v1alpha/{+name}/operations', options)
2270
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse::Representation
2271
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningListOperationsResponse
2272
+ command.params['name'] = name unless name.nil?
2273
+ command.query['filter'] = filter unless filter.nil?
2274
+ command.query['pageSize'] = page_size unless page_size.nil?
2275
+ command.query['pageToken'] = page_token unless page_token.nil?
2276
+ command.query['fields'] = fields unless fields.nil?
2277
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2278
+ execute_or_queue_command(command, &block)
2279
+ end
2280
+
2281
+ # Makes a recommendation, which requires a contextual user event.
2282
+ # @param [String] serving_config
2283
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
2284
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
2285
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
2286
+ # created along with your recommendation engine creation. The engine ID will be
2287
+ # used as the ID of the default serving config. For example, for Engine `
2288
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
2289
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
2290
+ # engine` for your Recommend requests.
2291
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
2292
+ # @param [String] fields
2293
+ # Selector specifying which fields to include in a partial response.
2294
+ # @param [String] quota_user
2295
+ # Available to use for quota purposes for server-side applications. Can be any
2296
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2297
+ # @param [Google::Apis::RequestOptions] options
2298
+ # Request-specific options
2299
+ #
2300
+ # @yield [result, err] Result & error if block supplied
2301
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
2302
+ # @yieldparam err [StandardError] error object if request failed
2303
+ #
2304
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
2305
+ #
2306
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2307
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2308
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2309
+ def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2310
+ command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
2311
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
2312
+ command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
2313
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
2314
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
2315
+ command.params['servingConfig'] = serving_config unless serving_config.nil?
2316
+ command.query['fields'] = fields unless fields.nil?
2317
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2318
+ execute_or_queue_command(command, &block)
2319
+ end
2320
+
2321
+ # Performs a search.
2322
+ # @param [String] serving_config
2323
+ # Required. The resource name of the Search serving config, such as `projects/*/
2324
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
2325
+ # default_serving_config`, or `projects/*/locations/global/collections/
2326
+ # default_collection/dataStores/default_data_store/servingConfigs/
2327
+ # default_serving_config`. This field is used to identify the serving
2328
+ # configuration name, set of models used to make the search.
2329
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
2330
+ # @param [String] fields
2331
+ # Selector specifying which fields to include in a partial response.
2332
+ # @param [String] quota_user
2333
+ # Available to use for quota purposes for server-side applications. Can be any
1753
2334
  # arbitrary string assigned to a user, but should not exceed 40 characters.
1754
2335
  # @param [Google::Apis::RequestOptions] options
1755
2336
  # Request-specific options
@@ -1908,6 +2489,211 @@ module Google
1908
2489
  execute_or_queue_command(command, &block)
1909
2490
  end
1910
2491
 
2492
+ # Creates a DataStore. DataStore is for storing Documents. To serve these
2493
+ # documents for Search, or Recommendation use case, an Engine needs to be
2494
+ # created separately.
2495
+ # @param [String] parent
2496
+ # Required. The parent resource name, such as `projects/`project`/locations/`
2497
+ # location`/collections/`collection``.
2498
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
2499
+ # @param [Boolean] create_advanced_site_search
2500
+ # A boolean flag indicating whether user want to directly create an advanced
2501
+ # data store for site search. If the data store is not configured as site search
2502
+ # (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be
2503
+ # ignored.
2504
+ # @param [String] data_store_id
2505
+ # Required. The ID to use for the DataStore, which will become the final
2506
+ # component of the DataStore's resource name. This field must conform to [RFC-
2507
+ # 1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63
2508
+ # characters. Otherwise, an INVALID_ARGUMENT error is returned.
2509
+ # @param [String] fields
2510
+ # Selector specifying which fields to include in a partial response.
2511
+ # @param [String] quota_user
2512
+ # Available to use for quota purposes for server-side applications. Can be any
2513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2514
+ # @param [Google::Apis::RequestOptions] options
2515
+ # Request-specific options
2516
+ #
2517
+ # @yield [result, err] Result & error if block supplied
2518
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2519
+ # @yieldparam err [StandardError] error object if request failed
2520
+ #
2521
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2522
+ #
2523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2526
+ 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)
2527
+ command = make_simple_command(:post, 'v1alpha/{+parent}/dataStores', options)
2528
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2529
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
2530
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2531
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2532
+ command.params['parent'] = parent unless parent.nil?
2533
+ command.query['createAdvancedSiteSearch'] = create_advanced_site_search unless create_advanced_site_search.nil?
2534
+ command.query['dataStoreId'] = data_store_id unless data_store_id.nil?
2535
+ command.query['fields'] = fields unless fields.nil?
2536
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2537
+ execute_or_queue_command(command, &block)
2538
+ end
2539
+
2540
+ # Deletes a DataStore.
2541
+ # @param [String] name
2542
+ # Required. Full resource name of DataStore, such as `projects/`project`/
2543
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
2544
+ # If the caller does not have permission to delete the DataStore, regardless of
2545
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
2546
+ # DataStore to delete does not exist, a NOT_FOUND error is returned.
2547
+ # @param [String] fields
2548
+ # Selector specifying which fields to include in a partial response.
2549
+ # @param [String] quota_user
2550
+ # Available to use for quota purposes for server-side applications. Can be any
2551
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2552
+ # @param [Google::Apis::RequestOptions] options
2553
+ # Request-specific options
2554
+ #
2555
+ # @yield [result, err] Result & error if block supplied
2556
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation] parsed result object
2557
+ # @yieldparam err [StandardError] error object if request failed
2558
+ #
2559
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation]
2560
+ #
2561
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2562
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2563
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2564
+ def delete_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
2565
+ command = make_simple_command(:delete, 'v1alpha/{+name}', options)
2566
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation::Representation
2567
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleLongrunningOperation
2568
+ command.params['name'] = name unless name.nil?
2569
+ command.query['fields'] = fields unless fields.nil?
2570
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2571
+ execute_or_queue_command(command, &block)
2572
+ end
2573
+
2574
+ # Gets a DataStore.
2575
+ # @param [String] name
2576
+ # Required. Full resource name of DataStore, such as `projects/`project`/
2577
+ # locations/`location`/collections/`collection_id`/dataStores/`data_store_id``.
2578
+ # If the caller does not have permission to access the DataStore, regardless of
2579
+ # whether or not it exists, a PERMISSION_DENIED error is returned. If the
2580
+ # requested DataStore does not exist, a NOT_FOUND error is returned.
2581
+ # @param [String] fields
2582
+ # Selector specifying which fields to include in a partial response.
2583
+ # @param [String] quota_user
2584
+ # Available to use for quota purposes for server-side applications. Can be any
2585
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2586
+ # @param [Google::Apis::RequestOptions] options
2587
+ # Request-specific options
2588
+ #
2589
+ # @yield [result, err] Result & error if block supplied
2590
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
2591
+ # @yieldparam err [StandardError] error object if request failed
2592
+ #
2593
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
2594
+ #
2595
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2596
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2597
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2598
+ def get_project_location_data_store(name, fields: nil, quota_user: nil, options: nil, &block)
2599
+ command = make_simple_command(:get, 'v1alpha/{+name}', options)
2600
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2601
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
2602
+ command.params['name'] = name unless name.nil?
2603
+ command.query['fields'] = fields unless fields.nil?
2604
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2605
+ execute_or_queue_command(command, &block)
2606
+ end
2607
+
2608
+ # Lists all the DataStores associated with the project.
2609
+ # @param [String] parent
2610
+ # Required. The parent branch resource name, such as `projects/`project`/
2611
+ # locations/`location`/collections/`collection_id``. If the caller does not have
2612
+ # permission to list DataStoress under this location, regardless of whether or
2613
+ # not this data store exists, a PERMISSION_DENIED error is returned.
2614
+ # @param [String] filter
2615
+ # Filter by solution type. For example: filter = 'solution_type:
2616
+ # SOLUTION_TYPE_SEARCH'
2617
+ # @param [Fixnum] page_size
2618
+ # Maximum number of DataStores to return. If unspecified, defaults to 10. The
2619
+ # maximum allowed value is 50. Values above 50 will be coerced to 50. If this
2620
+ # field is negative, an INVALID_ARGUMENT is returned.
2621
+ # @param [String] page_token
2622
+ # A page token ListDataStoresResponse.next_page_token, received from a previous
2623
+ # DataStoreService.ListDataStores call. Provide this to retrieve the subsequent
2624
+ # page. When paginating, all other parameters provided to DataStoreService.
2625
+ # ListDataStores must match the call that provided the page token. Otherwise, an
2626
+ # INVALID_ARGUMENT error is returned.
2627
+ # @param [String] fields
2628
+ # Selector specifying which fields to include in a partial response.
2629
+ # @param [String] quota_user
2630
+ # Available to use for quota purposes for server-side applications. Can be any
2631
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2632
+ # @param [Google::Apis::RequestOptions] options
2633
+ # Request-specific options
2634
+ #
2635
+ # @yield [result, err] Result & error if block supplied
2636
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse] parsed result object
2637
+ # @yieldparam err [StandardError] error object if request failed
2638
+ #
2639
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse]
2640
+ #
2641
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2642
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2643
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2644
+ def list_project_location_data_stores(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
2645
+ command = make_simple_command(:get, 'v1alpha/{+parent}/dataStores', options)
2646
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse::Representation
2647
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
2648
+ command.params['parent'] = parent unless parent.nil?
2649
+ command.query['filter'] = filter unless filter.nil?
2650
+ command.query['pageSize'] = page_size unless page_size.nil?
2651
+ command.query['pageToken'] = page_token unless page_token.nil?
2652
+ command.query['fields'] = fields unless fields.nil?
2653
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2654
+ execute_or_queue_command(command, &block)
2655
+ end
2656
+
2657
+ # Updates a DataStore
2658
+ # @param [String] name
2659
+ # Immutable. The full resource name of the data store. Format: `projects/`
2660
+ # project`/locations/`location`/collections/`collection_id`/dataStores/`
2661
+ # data_store_id``. This field must be a UTF-8 encoded string with a length limit
2662
+ # of 1024 characters.
2663
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] google_cloud_discoveryengine_v1alpha_data_store_object
2664
+ # @param [String] update_mask
2665
+ # Indicates which fields in the provided DataStore to update. If an unsupported
2666
+ # or unknown field is provided, an INVALID_ARGUMENT error is returned.
2667
+ # @param [String] fields
2668
+ # Selector specifying which fields to include in a partial response.
2669
+ # @param [String] quota_user
2670
+ # Available to use for quota purposes for server-side applications. Can be any
2671
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2672
+ # @param [Google::Apis::RequestOptions] options
2673
+ # Request-specific options
2674
+ #
2675
+ # @yield [result, err] Result & error if block supplied
2676
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore] parsed result object
2677
+ # @yieldparam err [StandardError] error object if request failed
2678
+ #
2679
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore]
2680
+ #
2681
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2682
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2683
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2684
+ def patch_project_location_data_store(name, google_cloud_discoveryengine_v1alpha_data_store_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
2685
+ command = make_simple_command(:patch, 'v1alpha/{+name}', options)
2686
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2687
+ command.request_object = google_cloud_discoveryengine_v1alpha_data_store_object
2688
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore::Representation
2689
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore
2690
+ command.params['name'] = name unless name.nil?
2691
+ command.query['updateMask'] = update_mask unless update_mask.nil?
2692
+ command.query['fields'] = fields unless fields.nil?
2693
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2694
+ execute_or_queue_command(command, &block)
2695
+ end
2696
+
1911
2697
  # Creates a Document.
1912
2698
  # @param [String] parent
1913
2699
  # Required. The parent resource name, such as `projects/`project`/locations/`
@@ -2813,10 +3599,14 @@ module Google
2813
3599
 
2814
3600
  # Makes a recommendation, which requires a contextual user event.
2815
3601
  # @param [String] serving_config
2816
- # Required. Full resource name of the format: `projects/*/locations/global/
2817
- # collections/*/dataStores/*/servingConfigs/*` Before you can request
2818
- # recommendations from your model, you must create at least one serving config
2819
- # for it.
3602
+ # Required. Full resource name of a ServingConfig: `projects/*/locations/global/
3603
+ # collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
3604
+ # collections/*/dataStores/*/servingConfigs/*` One default serving config is
3605
+ # created along with your recommendation engine creation. The engine ID will be
3606
+ # used as the ID of the default serving config. For example, for Engine `
3607
+ # projects/*/locations/global/collections/*/engines/my-engine`, you can use `
3608
+ # projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
3609
+ # engine` for your Recommend requests.
2820
3610
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
2821
3611
  # @param [String] fields
2822
3612
  # Selector specifying which fields to include in a partial response.
@@ -2850,9 +3640,11 @@ module Google
2850
3640
  # Performs a search.
2851
3641
  # @param [String] serving_config
2852
3642
  # Required. The resource name of the Search serving config, such as `projects/*/
2853
- # locations/global/collections/default_collection/dataStores/default_data_store/
2854
- # servingConfigs/default_serving_config`. This field is used to identify the
2855
- # serving configuration name, set of models used to make the search.
3643
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3644
+ # default_serving_config`, or `projects/*/locations/global/collections/
3645
+ # default_collection/dataStores/default_data_store/servingConfigs/
3646
+ # default_serving_config`. This field is used to identify the serving
3647
+ # configuration name, set of models used to make the search.
2856
3648
  # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
2857
3649
  # @param [String] fields
2858
3650
  # Selector specifying which fields to include in a partial response.