google-apis-retail_v2beta 0.50.0 → 0.53.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -52,8 +52,8 @@ module Google
52
52
  end
53
53
 
54
54
  # Completes the specified prefix with keyword suggestions. This feature is only
55
- # available for users who have Retail Search enabled. Please enable Retail
56
- # Search on Cloud Console before using this feature.
55
+ # available for users who have Retail Search enabled. Enable Retail Search on
56
+ # Cloud Console before using this feature.
57
57
  # @param [String] catalog
58
58
  # Required. Catalog for which the completion is performed. Full resource name of
59
59
  # catalog, such as `projects/*/locations/global/catalogs/default_catalog`.
@@ -159,8 +159,8 @@ module Google
159
159
 
160
160
  # Gets a CompletionConfig.
161
161
  # @param [String] name
162
- # Required. Full CompletionConfig resource name. Format: projects/`
163
- # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig
162
+ # Required. Full CompletionConfig resource name. Format: `projects/`
163
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/completionConfig`
164
164
  # @param [String] fields
165
165
  # Selector specifying which fields to include in a partial response.
166
166
  # @param [String] quota_user
@@ -614,9 +614,12 @@ module Google
614
614
  # updating fulfillment information. If the request is valid, the update will be
615
615
  # enqueued and processed downstream. As a consequence, when a response is
616
616
  # returned, the added place IDs are not immediately manifested in the Product
617
- # queried by ProductService.GetProduct or ProductService.ListProducts. This
618
- # feature is only available for users who have Retail Search enabled. Please
619
- # enable Retail Search on Cloud Console before using this feature.
617
+ # queried by ProductService.GetProduct or ProductService.ListProducts. The
618
+ # returned Operations will be obsolete after 1 day, and GetOperation API will
619
+ # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
620
+ # associated with the stale updates will not be marked as done until being
621
+ # obsolete. This feature is only available for users who have Retail Search
622
+ # enabled. Enable Retail Search on Cloud Console before using this feature.
620
623
  # @param [String] product
621
624
  # Required. Full resource name of Product, such as `projects/*/locations/global/
622
625
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -661,8 +664,11 @@ module Google
661
664
  # ProductService.GetProduct or ProductService.ListProducts. Local inventory
662
665
  # information can only be modified using this method. ProductService.
663
666
  # CreateProduct and ProductService.UpdateProduct has no effect on local
664
- # inventories. This feature is only available for users who have Retail Search
665
- # enabled. Please enable Retail Search on Cloud Console before using this
667
+ # inventories. The returned Operations will be obsolete after 1 day, and
668
+ # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
669
+ # issued, the Operations associated with the stale updates will not be marked as
670
+ # done until being obsolete. This feature is only available for users who have
671
+ # Retail Search enabled. Enable Retail Search on Cloud Console before using this
666
672
  # feature.
667
673
  # @param [String] product
668
674
  # Required. Full resource name of Product, such as `projects/*/locations/global/
@@ -969,9 +975,12 @@ module Google
969
975
  # updating fulfillment information. If the request is valid, the update will be
970
976
  # enqueued and processed downstream. As a consequence, when a response is
971
977
  # returned, the removed place IDs are not immediately manifested in the Product
972
- # queried by ProductService.GetProduct or ProductService.ListProducts. This
973
- # feature is only available for users who have Retail Search enabled. Please
974
- # enable Retail Search on Cloud Console before using this feature.
978
+ # queried by ProductService.GetProduct or ProductService.ListProducts. The
979
+ # returned Operations will be obsolete after 1 day, and GetOperation API will
980
+ # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
981
+ # associated with the stale updates will not be marked as done until being
982
+ # obsolete. This feature is only available for users who have Retail Search
983
+ # enabled. Enable Retail Search on Cloud Console before using this feature.
975
984
  # @param [String] product
976
985
  # Required. Full resource name of Product, such as `projects/*/locations/global/
977
986
  # catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1014,8 +1023,11 @@ module Google
1014
1023
  # queried by ProductService.GetProduct or ProductService.ListProducts. Local
1015
1024
  # inventory information can only be removed using this method. ProductService.
1016
1025
  # CreateProduct and ProductService.UpdateProduct has no effect on local
1017
- # inventories. This feature is only available for users who have Retail Search
1018
- # enabled. Please enable Retail Search on Cloud Console before using this
1026
+ # inventories. The returned Operations will be obsolete after 1 day, and
1027
+ # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
1028
+ # issued, the Operations associated with the stale updates will not be marked as
1029
+ # done until being obsolete. This feature is only available for users who have
1030
+ # Retail Search enabled. Enable Retail Search on Cloud Console before using this
1019
1031
  # feature.
1020
1032
  # @param [String] product
1021
1033
  # Required. Full resource name of Product, such as `projects/*/locations/global/
@@ -1055,23 +1067,26 @@ module Google
1055
1067
  # Updates inventory information for a Product while respecting the last update
1056
1068
  # timestamps of each inventory field. This process is asynchronous and does not
1057
1069
  # require the Product to exist before updating fulfillment information. If the
1058
- # request is valid, the update will be enqueued and processed downstream. As a
1070
+ # request is valid, the update is enqueued and processed downstream. As a
1059
1071
  # consequence, when a response is returned, updates are not immediately
1060
1072
  # manifested in the Product queried by ProductService.GetProduct or
1061
1073
  # ProductService.ListProducts. When inventory is updated with ProductService.
1062
1074
  # CreateProduct and ProductService.UpdateProduct, the specified inventory field
1063
- # value(s) will overwrite any existing value(s) while ignoring the last update
1064
- # time for this field. Furthermore, the last update time for the specified
1065
- # inventory fields will be overwritten to the time of the ProductService.
1066
- # CreateProduct or ProductService.UpdateProduct request. If no inventory fields
1067
- # are set in CreateProductRequest.product, then any pre-existing inventory
1068
- # information for this product will be used. If no inventory fields are set in
1069
- # SetInventoryRequest.set_mask, then any existing inventory information will be
1070
- # preserved. Pre-existing inventory information can only be updated with
1071
- # ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and
1072
- # ProductService.RemoveFulfillmentPlaces. This feature is only available for
1073
- # users who have Retail Search enabled. Please enable Retail Search on Cloud
1074
- # Console before using this feature.
1075
+ # value(s) overwrite any existing value(s) while ignoring the last update time
1076
+ # for this field. Furthermore, the last update times for the specified inventory
1077
+ # fields are overwritten by the times of the ProductService.CreateProduct or
1078
+ # ProductService.UpdateProduct request. If no inventory fields are set in
1079
+ # CreateProductRequest.product, then any pre-existing inventory information for
1080
+ # this product is used. If no inventory fields are set in SetInventoryRequest.
1081
+ # set_mask, then any existing inventory information is preserved. Pre-existing
1082
+ # inventory information can only be updated with ProductService.SetInventory,
1083
+ # ProductService.AddFulfillmentPlaces, and ProductService.
1084
+ # RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
1085
+ # and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
1086
+ # updates are issued, the Operations associated with the stale updates are not
1087
+ # marked as done until they are obsolete. This feature is only available for
1088
+ # users who have Retail Search enabled. Enable Retail Search on Cloud Console
1089
+ # before using this feature.
1075
1090
  # @param [String] name
1076
1091
  # Immutable. Full resource name of the product, such as `projects/*/locations/
1077
1092
  # global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1109,8 +1124,8 @@ module Google
1109
1124
  # asynchronous. Partial updating is not supported. The operation is successfully
1110
1125
  # finished only after the imported suggestions are indexed successfully and
1111
1126
  # ready for serving. The process takes hours. This feature is only available for
1112
- # users who have Retail Search enabled. Please enable Retail Search on Cloud
1113
- # Console before using this feature.
1127
+ # users who have Retail Search enabled. Enable Retail Search on Cloud Console
1128
+ # before using this feature.
1114
1129
  # @param [String] parent
1115
1130
  # Required. The catalog which the suggestions dataset belongs to. Format: `
1116
1131
  # projects/1234/locations/global/catalogs/default_catalog`.
@@ -1219,7 +1234,7 @@ module Google
1219
1234
 
1220
1235
  # Gets a Control.
1221
1236
  # @param [String] name
1222
- # Required. The resource name of the Control to delete. Format: `projects/`
1237
+ # Required. The resource name of the Control to get. Format: `projects/`
1223
1238
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/controls/`
1224
1239
  # control_id``
1225
1240
  # @param [String] fields
@@ -1249,7 +1264,7 @@ module Google
1249
1264
  execute_or_queue_command(command, &block)
1250
1265
  end
1251
1266
 
1252
- # Lists all Controls linked to this catalog.
1267
+ # Lists all Controls by their parent Catalog.
1253
1268
  # @param [String] parent
1254
1269
  # Required. The catalog resource name. Format: `projects/`project_number`/
1255
1270
  # locations/`location_id`/catalogs/`catalog_id``
@@ -1295,7 +1310,7 @@ module Google
1295
1310
  end
1296
1311
 
1297
1312
  # Updates a Control. Control cannot be set to a different oneof field, if so an
1298
- # INVALID_ARGUMENT is returned. If the Control to delete does not exist, a
1313
+ # INVALID_ARGUMENT is returned. If the Control to update does not exist, a
1299
1314
  # NOT_FOUND error is returned.
1300
1315
  # @param [String] name
1301
1316
  # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/
@@ -1335,6 +1350,260 @@ module Google
1335
1350
  execute_or_queue_command(command, &block)
1336
1351
  end
1337
1352
 
1353
+ # Creates a new model.
1354
+ # @param [String] parent
1355
+ # Required. The parent resource under which to create the model. Format: `
1356
+ # projects/`project_number`/locations/`location_id`/catalogs/`catalog_id``
1357
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel] google_cloud_retail_v2beta_model_object
1358
+ # @param [Boolean] dry_run
1359
+ # Optional. Whether to run a dry run to validate the request (without actually
1360
+ # creating the model).
1361
+ # @param [String] fields
1362
+ # Selector specifying which fields to include in a partial response.
1363
+ # @param [String] quota_user
1364
+ # Available to use for quota purposes for server-side applications. Can be any
1365
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1366
+ # @param [Google::Apis::RequestOptions] options
1367
+ # Request-specific options
1368
+ #
1369
+ # @yield [result, err] Result & error if block supplied
1370
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
1371
+ # @yieldparam err [StandardError] error object if request failed
1372
+ #
1373
+ # @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
1374
+ #
1375
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1376
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1377
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1378
+ def create_project_location_catalog_model(parent, google_cloud_retail_v2beta_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
1379
+ command = make_simple_command(:post, 'v2beta/{+parent}/models', options)
1380
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation
1381
+ command.request_object = google_cloud_retail_v2beta_model_object
1382
+ command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
1383
+ command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
1384
+ command.params['parent'] = parent unless parent.nil?
1385
+ command.query['dryRun'] = dry_run unless dry_run.nil?
1386
+ command.query['fields'] = fields unless fields.nil?
1387
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1388
+ execute_or_queue_command(command, &block)
1389
+ end
1390
+
1391
+ # Deletes an existing model.
1392
+ # @param [String] name
1393
+ # Required. The resource name of the Model to delete. Format: `projects/`
1394
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1395
+ # `
1396
+ # @param [String] fields
1397
+ # Selector specifying which fields to include in a partial response.
1398
+ # @param [String] quota_user
1399
+ # Available to use for quota purposes for server-side applications. Can be any
1400
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1401
+ # @param [Google::Apis::RequestOptions] options
1402
+ # Request-specific options
1403
+ #
1404
+ # @yield [result, err] Result & error if block supplied
1405
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleProtobufEmpty] parsed result object
1406
+ # @yieldparam err [StandardError] error object if request failed
1407
+ #
1408
+ # @return [Google::Apis::RetailV2beta::GoogleProtobufEmpty]
1409
+ #
1410
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1411
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1412
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1413
+ def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
1414
+ command = make_simple_command(:delete, 'v2beta/{+name}', options)
1415
+ command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation
1416
+ command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty
1417
+ command.params['name'] = name unless name.nil?
1418
+ command.query['fields'] = fields unless fields.nil?
1419
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1420
+ execute_or_queue_command(command, &block)
1421
+ end
1422
+
1423
+ # Lists all the models linked to this event store.
1424
+ # @param [String] parent
1425
+ # Required. The parent for which to list models. Format: `projects/`
1426
+ # project_number`/locations/`location_id`/catalogs/`catalog_id``
1427
+ # @param [Fixnum] page_size
1428
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1429
+ # Max allowed value is 1000.
1430
+ # @param [String] page_token
1431
+ # Optional. A page token, received from a previous `ListModels` call. Provide
1432
+ # this to retrieve the subsequent page.
1433
+ # @param [String] fields
1434
+ # Selector specifying which fields to include in a partial response.
1435
+ # @param [String] quota_user
1436
+ # Available to use for quota purposes for server-side applications. Can be any
1437
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1438
+ # @param [Google::Apis::RequestOptions] options
1439
+ # Request-specific options
1440
+ #
1441
+ # @yield [result, err] Result & error if block supplied
1442
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse] parsed result object
1443
+ # @yieldparam err [StandardError] error object if request failed
1444
+ #
1445
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse]
1446
+ #
1447
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1448
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1449
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1450
+ def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1451
+ command = make_simple_command(:get, 'v2beta/{+parent}/models', options)
1452
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse::Representation
1453
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse
1454
+ command.params['parent'] = parent unless parent.nil?
1455
+ command.query['pageSize'] = page_size unless page_size.nil?
1456
+ command.query['pageToken'] = page_token unless page_token.nil?
1457
+ command.query['fields'] = fields unless fields.nil?
1458
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1459
+ execute_or_queue_command(command, &block)
1460
+ end
1461
+
1462
+ # Update of model metadata. Only fields that currently can be updated are: `
1463
+ # filtering_option` and `periodic_tuning_state`. If other values are provided,
1464
+ # this API method ignores them.
1465
+ # @param [String] name
1466
+ # Required. The fully qualified resource name of the model. Format: `projects/`
1467
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1468
+ # ` catalog_id has char limit of 50. recommendation_model_id has char limit of
1469
+ # 40.
1470
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel] google_cloud_retail_v2beta_model_object
1471
+ # @param [String] update_mask
1472
+ # Optional. Indicates which fields in the provided 'model' to update. If not set,
1473
+ # by default updates all fields.
1474
+ # @param [String] fields
1475
+ # Selector specifying which fields to include in a partial response.
1476
+ # @param [String] quota_user
1477
+ # Available to use for quota purposes for server-side applications. Can be any
1478
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1479
+ # @param [Google::Apis::RequestOptions] options
1480
+ # Request-specific options
1481
+ #
1482
+ # @yield [result, err] Result & error if block supplied
1483
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel] parsed result object
1484
+ # @yieldparam err [StandardError] error object if request failed
1485
+ #
1486
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel]
1487
+ #
1488
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1489
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1490
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1491
+ def patch_project_location_catalog_model(name, google_cloud_retail_v2beta_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1492
+ command = make_simple_command(:patch, 'v2beta/{+name}', options)
1493
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation
1494
+ command.request_object = google_cloud_retail_v2beta_model_object
1495
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation
1496
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
1497
+ command.params['name'] = name unless name.nil?
1498
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1499
+ command.query['fields'] = fields unless fields.nil?
1500
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1501
+ execute_or_queue_command(command, &block)
1502
+ end
1503
+
1504
+ # Pauses the training of an existing model.
1505
+ # @param [String] name
1506
+ # Required. The name of the model to pause. Format: `projects/`project_number`/
1507
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1508
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPauseModelRequest] google_cloud_retail_v2beta_pause_model_request_object
1509
+ # @param [String] fields
1510
+ # Selector specifying which fields to include in a partial response.
1511
+ # @param [String] quota_user
1512
+ # Available to use for quota purposes for server-side applications. Can be any
1513
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1514
+ # @param [Google::Apis::RequestOptions] options
1515
+ # Request-specific options
1516
+ #
1517
+ # @yield [result, err] Result & error if block supplied
1518
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel] parsed result object
1519
+ # @yieldparam err [StandardError] error object if request failed
1520
+ #
1521
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel]
1522
+ #
1523
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1524
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1525
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1526
+ def pause_project_location_catalog_model(name, google_cloud_retail_v2beta_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1527
+ command = make_simple_command(:post, 'v2beta/{+name}:pause', options)
1528
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPauseModelRequest::Representation
1529
+ command.request_object = google_cloud_retail_v2beta_pause_model_request_object
1530
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation
1531
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
1532
+ command.params['name'] = name unless name.nil?
1533
+ command.query['fields'] = fields unless fields.nil?
1534
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1535
+ execute_or_queue_command(command, &block)
1536
+ end
1537
+
1538
+ # Resumes the training of an existing model.
1539
+ # @param [String] name
1540
+ # Required. The name of the model to resume. Format: `projects/`project_number`/
1541
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
1542
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaResumeModelRequest] google_cloud_retail_v2beta_resume_model_request_object
1543
+ # @param [String] fields
1544
+ # Selector specifying which fields to include in a partial response.
1545
+ # @param [String] quota_user
1546
+ # Available to use for quota purposes for server-side applications. Can be any
1547
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1548
+ # @param [Google::Apis::RequestOptions] options
1549
+ # Request-specific options
1550
+ #
1551
+ # @yield [result, err] Result & error if block supplied
1552
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel] parsed result object
1553
+ # @yieldparam err [StandardError] error object if request failed
1554
+ #
1555
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel]
1556
+ #
1557
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1558
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1559
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1560
+ def resume_project_location_catalog_model(name, google_cloud_retail_v2beta_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1561
+ command = make_simple_command(:post, 'v2beta/{+name}:resume', options)
1562
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaResumeModelRequest::Representation
1563
+ command.request_object = google_cloud_retail_v2beta_resume_model_request_object
1564
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation
1565
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
1566
+ command.params['name'] = name unless name.nil?
1567
+ command.query['fields'] = fields unless fields.nil?
1568
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1569
+ execute_or_queue_command(command, &block)
1570
+ end
1571
+
1572
+ # Tunes an existing model.
1573
+ # @param [String] name
1574
+ # Required. The resource name of the model to tune. Format: `projects/`
1575
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1576
+ # `
1577
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaTuneModelRequest] google_cloud_retail_v2beta_tune_model_request_object
1578
+ # @param [String] fields
1579
+ # Selector specifying which fields to include in a partial response.
1580
+ # @param [String] quota_user
1581
+ # Available to use for quota purposes for server-side applications. Can be any
1582
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1583
+ # @param [Google::Apis::RequestOptions] options
1584
+ # Request-specific options
1585
+ #
1586
+ # @yield [result, err] Result & error if block supplied
1587
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleLongrunningOperation] parsed result object
1588
+ # @yieldparam err [StandardError] error object if request failed
1589
+ #
1590
+ # @return [Google::Apis::RetailV2beta::GoogleLongrunningOperation]
1591
+ #
1592
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1593
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1594
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1595
+ def tune_project_location_catalog_model(name, google_cloud_retail_v2beta_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1596
+ command = make_simple_command(:post, 'v2beta/{+name}:tune', options)
1597
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaTuneModelRequest::Representation
1598
+ command.request_object = google_cloud_retail_v2beta_tune_model_request_object
1599
+ command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation
1600
+ command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation
1601
+ command.params['name'] = name unless name.nil?
1602
+ command.query['fields'] = fields unless fields.nil?
1603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1338
1607
  # Gets the latest state of a long-running operation. Clients can use this method
1339
1608
  # to poll the operation result at intervals as recommended by the API service.
1340
1609
  # @param [String] name
@@ -1455,7 +1724,7 @@ module Google
1455
1724
  end
1456
1725
 
1457
1726
  # Performs a search. This feature is only available for users who have Retail
1458
- # Search enabled. Please enable Retail Search on Cloud Console before using this
1727
+ # Search enabled. Enable Retail Search on Cloud Console before using this
1459
1728
  # feature.
1460
1729
  # @param [String] placement
1461
1730
  # Required. The resource name of the Retail Search serving config, such as `
@@ -1501,9 +1770,9 @@ module Google
1501
1770
  # Returns a FAILED_PRECONDITION error if the addition could exceed maximum
1502
1771
  # number of control allowed for that type of control.
1503
1772
  # @param [String] serving_config
1504
- # Required. The source ServingConfig resource name . Format: projects/`
1773
+ # Required. The source ServingConfig resource name . Format: `projects/`
1505
1774
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1506
- # serving_config_id`
1775
+ # serving_config_id``
1507
1776
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest] google_cloud_retail_v2beta_add_control_request_object
1508
1777
  # @param [String] fields
1509
1778
  # Selector specifying which fields to include in a partial response.
@@ -1577,9 +1846,9 @@ module Google
1577
1846
  # Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does
1578
1847
  # not exist.
1579
1848
  # @param [String] name
1580
- # Required. The resource name of the ServingConfig to delete. Format: projects/`
1849
+ # Required. The resource name of the ServingConfig to delete. Format: `projects/`
1581
1850
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1582
- # serving_config_id`
1851
+ # serving_config_id``
1583
1852
  # @param [String] fields
1584
1853
  # Selector specifying which fields to include in a partial response.
1585
1854
  # @param [String] quota_user
@@ -1610,9 +1879,9 @@ module Google
1610
1879
  # Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
1611
1880
  # exist.
1612
1881
  # @param [String] name
1613
- # Required. The resource name of the ServingConfig to get. Format: projects/`
1882
+ # Required. The resource name of the ServingConfig to get. Format: `projects/`
1614
1883
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1615
- # serving_config_id`
1884
+ # serving_config_id``
1616
1885
  # @param [String] fields
1617
1886
  # Selector specifying which fields to include in a partial response.
1618
1887
  # @param [String] quota_user
@@ -1642,8 +1911,8 @@ module Google
1642
1911
 
1643
1912
  # Lists all ServingConfigs linked to this catalog.
1644
1913
  # @param [String] parent
1645
- # Required. The catalog resource name. Format: projects/`project_number`/
1646
- # locations/`location_id`/catalogs/`catalog_id`
1914
+ # Required. The catalog resource name. Format: `projects/`project_number`/
1915
+ # locations/`location_id`/catalogs/`catalog_id``
1647
1916
  # @param [Fixnum] page_size
1648
1917
  # Optional. Maximum number of results to return. If unspecified, defaults to 100.
1649
1918
  # If a value greater than 100 is provided, at most 100 results are returned.
@@ -1764,9 +2033,9 @@ module Google
1764
2033
  # the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for
1765
2034
  # the ServingConfig.
1766
2035
  # @param [String] serving_config
1767
- # Required. The source ServingConfig resource name . Format: projects/`
2036
+ # Required. The source ServingConfig resource name . Format: `projects/`
1768
2037
  # project_number`/locations/`location_id`/catalogs/`catalog_id`/servingConfigs/`
1769
- # serving_config_id`
2038
+ # serving_config_id``
1770
2039
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest] google_cloud_retail_v2beta_remove_control_request_object
1771
2040
  # @param [String] fields
1772
2041
  # Selector specifying which fields to include in a partial response.
@@ -1798,7 +2067,7 @@ module Google
1798
2067
  end
1799
2068
 
1800
2069
  # Performs a search. This feature is only available for users who have Retail
1801
- # Search enabled. Please enable Retail Search on Cloud Console before using this
2070
+ # Search enabled. Enable Retail Search on Cloud Console before using this
1802
2071
  # feature.
1803
2072
  # @param [String] placement
1804
2073
  # Required. The resource name of the Retail Search serving config, such as `
@@ -1887,9 +2156,9 @@ module Google
1887
2156
 
1888
2157
  # Bulk import of User events. Request processing might be synchronous. Events
1889
2158
  # that already exist are skipped. Use this method for backfilling historical
1890
- # user events. Operation.response is of type ImportResponse. Note that it is
1891
- # possible for a subset of the items to be successfully inserted. Operation.
1892
- # metadata is of type ImportMetadata.
2159
+ # user events. `Operation.response` is of type `ImportResponse`. Note that it is
2160
+ # possible for a subset of the items to be successfully inserted. `Operation.
2161
+ # metadata` is of type `ImportMetadata`.
1893
2162
  # @param [String] parent
1894
2163
  # Required. `projects/1234/locations/global/catalogs/default_catalog`
1895
2164
  # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportUserEventsRequest] google_cloud_retail_v2beta_import_user_events_request_object
@@ -1959,12 +2228,12 @@ module Google
1959
2228
  execute_or_queue_command(command, &block)
1960
2229
  end
1961
2230
 
1962
- # Starts a user event rejoin operation with latest product catalog. Events will
1963
- # not be annotated with detailed product information if product is missing from
1964
- # the catalog at the time the user event is ingested, and these events are
1965
- # stored as unjoined events with a limited usage on training and serving. This
1966
- # method can be used to start a join operation on specified events with latest
1967
- # version of product catalog. It can also be used to correct events joined with
2231
+ # Starts a user-event rejoin operation with latest product catalog. Events are
2232
+ # not annotated with detailed product information for products that are missing
2233
+ # from the catalog when the user event is ingested. These events are stored as
2234
+ # unjoined events with limited usage on training and serving. You can use this
2235
+ # method to start a join operation on specified events with the latest version
2236
+ # of product catalog. You can also use this method to correct events joined with
1968
2237
  # the wrong product catalog. A rejoin operation can take hours or days to
1969
2238
  # complete.
1970
2239
  # @param [String] parent
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.50.0
4
+ version: 0.53.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-08-08 00:00:00.000000000 Z
11
+ date: 2022-08-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.50.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.53.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
63
63
  post_install_message:
64
64
  rdoc_options: []