google-apis-retail_v2alpha 0.47.0 → 0.50.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.47.0"
19
+ GEM_VERSION = "0.50.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.9.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20220630"
25
+ REVISION = "20220722"
26
26
  end
27
27
  end
28
28
  end
@@ -244,6 +244,12 @@ module Google
244
244
  include Google::Apis::Core::JsonObjectSupport
245
245
  end
246
246
 
247
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
248
+ class Representation < Google::Apis::Core::JsonRepresentation; end
249
+
250
+ include Google::Apis::Core::JsonObjectSupport
251
+ end
252
+
247
253
  class GoogleCloudRetailV2alphaBigQuerySource
248
254
  class Representation < Google::Apis::Core::JsonRepresentation; end
249
255
 
@@ -328,6 +334,12 @@ module Google
328
334
  include Google::Apis::Core::JsonObjectSupport
329
335
  end
330
336
 
337
+ class GoogleCloudRetailV2alphaCreateModelMetadata
338
+ class Representation < Google::Apis::Core::JsonRepresentation; end
339
+
340
+ include Google::Apis::Core::JsonObjectSupport
341
+ end
342
+
331
343
  class GoogleCloudRetailV2alphaCustomAttribute
332
344
  class Representation < Google::Apis::Core::JsonRepresentation; end
333
345
 
@@ -448,6 +460,12 @@ module Google
448
460
  include Google::Apis::Core::JsonObjectSupport
449
461
  end
450
462
 
463
+ class GoogleCloudRetailV2alphaListModelsResponse
464
+ class Representation < Google::Apis::Core::JsonRepresentation; end
465
+
466
+ include Google::Apis::Core::JsonObjectSupport
467
+ end
468
+
451
469
  class GoogleCloudRetailV2alphaListProductsResponse
452
470
  class Representation < Google::Apis::Core::JsonRepresentation; end
453
471
 
@@ -478,6 +496,48 @@ module Google
478
496
  include Google::Apis::Core::JsonObjectSupport
479
497
  end
480
498
 
499
+ class GoogleCloudRetailV2alphaModel
500
+ class Representation < Google::Apis::Core::JsonRepresentation; end
501
+
502
+ include Google::Apis::Core::JsonObjectSupport
503
+ end
504
+
505
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfig
506
+ class Representation < Google::Apis::Core::JsonRepresentation; end
507
+
508
+ include Google::Apis::Core::JsonObjectSupport
509
+ end
510
+
511
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
512
+ class Representation < Google::Apis::Core::JsonRepresentation; end
513
+
514
+ include Google::Apis::Core::JsonObjectSupport
515
+ end
516
+
517
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
518
+ class Representation < Google::Apis::Core::JsonRepresentation; end
519
+
520
+ include Google::Apis::Core::JsonObjectSupport
521
+ end
522
+
523
+ class GoogleCloudRetailV2alphaModelServingConfigList
524
+ class Representation < Google::Apis::Core::JsonRepresentation; end
525
+
526
+ include Google::Apis::Core::JsonObjectSupport
527
+ end
528
+
529
+ class GoogleCloudRetailV2alphaOutputResult
530
+ class Representation < Google::Apis::Core::JsonRepresentation; end
531
+
532
+ include Google::Apis::Core::JsonObjectSupport
533
+ end
534
+
535
+ class GoogleCloudRetailV2alphaPauseModelRequest
536
+ class Representation < Google::Apis::Core::JsonRepresentation; end
537
+
538
+ include Google::Apis::Core::JsonObjectSupport
539
+ end
540
+
481
541
  class GoogleCloudRetailV2alphaPredictRequest
482
542
  class Representation < Google::Apis::Core::JsonRepresentation; end
483
543
 
@@ -664,6 +724,12 @@ module Google
664
724
  include Google::Apis::Core::JsonObjectSupport
665
725
  end
666
726
 
727
+ class GoogleCloudRetailV2alphaResumeModelRequest
728
+ class Representation < Google::Apis::Core::JsonRepresentation; end
729
+
730
+ include Google::Apis::Core::JsonObjectSupport
731
+ end
732
+
667
733
  class GoogleCloudRetailV2alphaRule
668
734
  class Representation < Google::Apis::Core::JsonRepresentation; end
669
735
 
@@ -832,6 +898,24 @@ module Google
832
898
  include Google::Apis::Core::JsonObjectSupport
833
899
  end
834
900
 
901
+ class GoogleCloudRetailV2alphaTuneModelMetadata
902
+ class Representation < Google::Apis::Core::JsonRepresentation; end
903
+
904
+ include Google::Apis::Core::JsonObjectSupport
905
+ end
906
+
907
+ class GoogleCloudRetailV2alphaTuneModelRequest
908
+ class Representation < Google::Apis::Core::JsonRepresentation; end
909
+
910
+ include Google::Apis::Core::JsonObjectSupport
911
+ end
912
+
913
+ class GoogleCloudRetailV2alphaTuneModelResponse
914
+ class Representation < Google::Apis::Core::JsonRepresentation; end
915
+
916
+ include Google::Apis::Core::JsonObjectSupport
917
+ end
918
+
835
919
  class GoogleCloudRetailV2alphaUserEvent
836
920
  class Representation < Google::Apis::Core::JsonRepresentation; end
837
921
 
@@ -886,6 +970,12 @@ module Google
886
970
  include Google::Apis::Core::JsonObjectSupport
887
971
  end
888
972
 
973
+ class GoogleCloudRetailV2betaBigQueryOutputResult
974
+ class Representation < Google::Apis::Core::JsonRepresentation; end
975
+
976
+ include Google::Apis::Core::JsonObjectSupport
977
+ end
978
+
889
979
  class GoogleCloudRetailV2betaExportErrorsConfig
890
980
  class Representation < Google::Apis::Core::JsonRepresentation; end
891
981
 
@@ -940,6 +1030,12 @@ module Google
940
1030
  include Google::Apis::Core::JsonObjectSupport
941
1031
  end
942
1032
 
1033
+ class GoogleCloudRetailV2betaOutputResult
1034
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1035
+
1036
+ include Google::Apis::Core::JsonObjectSupport
1037
+ end
1038
+
943
1039
  class GoogleCloudRetailV2betaPurgeMetadata
944
1040
  class Representation < Google::Apis::Core::JsonRepresentation; end
945
1041
 
@@ -1326,6 +1422,14 @@ module Google
1326
1422
  end
1327
1423
  end
1328
1424
 
1425
+ class GoogleCloudRetailV2alphaBigQueryOutputResult
1426
+ # @private
1427
+ class Representation < Google::Apis::Core::JsonRepresentation
1428
+ property :dataset_id, as: 'datasetId'
1429
+ property :table_id, as: 'tableId'
1430
+ end
1431
+ end
1432
+
1329
1433
  class GoogleCloudRetailV2alphaBigQuerySource
1330
1434
  # @private
1331
1435
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1476,6 +1580,13 @@ module Google
1476
1580
  end
1477
1581
  end
1478
1582
 
1583
+ class GoogleCloudRetailV2alphaCreateModelMetadata
1584
+ # @private
1585
+ class Representation < Google::Apis::Core::JsonRepresentation
1586
+ property :model, as: 'model'
1587
+ end
1588
+ end
1589
+
1479
1590
  class GoogleCloudRetailV2alphaCustomAttribute
1480
1591
  # @private
1481
1592
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1508,6 +1619,8 @@ module Google
1508
1619
 
1509
1620
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
1510
1621
 
1622
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult::Representation
1623
+
1511
1624
  end
1512
1625
  end
1513
1626
 
@@ -1518,6 +1631,8 @@ module Google
1518
1631
 
1519
1632
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaExportErrorsConfig::Representation
1520
1633
 
1634
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaOutputResult::Representation
1635
+
1521
1636
  end
1522
1637
  end
1523
1638
 
@@ -1666,6 +1781,15 @@ module Google
1666
1781
  end
1667
1782
  end
1668
1783
 
1784
+ class GoogleCloudRetailV2alphaListModelsResponse
1785
+ # @private
1786
+ class Representation < Google::Apis::Core::JsonRepresentation
1787
+ collection :models, as: 'models', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1788
+
1789
+ property :next_page_token, as: 'nextPageToken'
1790
+ end
1791
+ end
1792
+
1669
1793
  class GoogleCloudRetailV2alphaListProductsResponse
1670
1794
  # @private
1671
1795
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1716,6 +1840,78 @@ module Google
1716
1840
  end
1717
1841
  end
1718
1842
 
1843
+ class GoogleCloudRetailV2alphaModel
1844
+ # @private
1845
+ class Representation < Google::Apis::Core::JsonRepresentation
1846
+ property :create_time, as: 'createTime'
1847
+ property :data_state, as: 'dataState'
1848
+ property :display_name, as: 'displayName'
1849
+ property :filtering_option, as: 'filteringOption'
1850
+ property :last_tune_time, as: 'lastTuneTime'
1851
+ property :name, as: 'name'
1852
+ property :optimization_objective, as: 'optimizationObjective'
1853
+ property :page_optimization_config, as: 'pageOptimizationConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig::Representation
1854
+
1855
+ property :periodic_tuning_state, as: 'periodicTuningState'
1856
+ collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelServingConfigList, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelServingConfigList::Representation
1857
+
1858
+ property :serving_state, as: 'servingState'
1859
+ property :training_state, as: 'trainingState'
1860
+ property :tuning_operation, as: 'tuningOperation'
1861
+ property :type, as: 'type'
1862
+ property :update_time, as: 'updateTime'
1863
+ end
1864
+ end
1865
+
1866
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfig
1867
+ # @private
1868
+ class Representation < Google::Apis::Core::JsonRepresentation
1869
+ property :page_optimization_event_type, as: 'pageOptimizationEventType'
1870
+ collection :panels, as: 'panels', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel::Representation
1871
+
1872
+ property :restriction, as: 'restriction'
1873
+ end
1874
+ end
1875
+
1876
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate
1877
+ # @private
1878
+ class Representation < Google::Apis::Core::JsonRepresentation
1879
+ property :serving_config_id, as: 'servingConfigId'
1880
+ end
1881
+ end
1882
+
1883
+ class GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel
1884
+ # @private
1885
+ class Representation < Google::Apis::Core::JsonRepresentation
1886
+ collection :candidates, as: 'candidates', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
1887
+
1888
+ property :default_candidate, as: 'defaultCandidate', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate::Representation
1889
+
1890
+ property :display_name, as: 'displayName'
1891
+ end
1892
+ end
1893
+
1894
+ class GoogleCloudRetailV2alphaModelServingConfigList
1895
+ # @private
1896
+ class Representation < Google::Apis::Core::JsonRepresentation
1897
+ collection :serving_config_ids, as: 'servingConfigIds'
1898
+ end
1899
+ end
1900
+
1901
+ class GoogleCloudRetailV2alphaOutputResult
1902
+ # @private
1903
+ class Representation < Google::Apis::Core::JsonRepresentation
1904
+ collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBigQueryOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBigQueryOutputResult::Representation
1905
+
1906
+ end
1907
+ end
1908
+
1909
+ class GoogleCloudRetailV2alphaPauseModelRequest
1910
+ # @private
1911
+ class Representation < Google::Apis::Core::JsonRepresentation
1912
+ end
1913
+ end
1914
+
1719
1915
  class GoogleCloudRetailV2alphaPredictRequest
1720
1916
  # @private
1721
1917
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2018,6 +2214,12 @@ module Google
2018
2214
  end
2019
2215
  end
2020
2216
 
2217
+ class GoogleCloudRetailV2alphaResumeModelRequest
2218
+ # @private
2219
+ class Representation < Google::Apis::Core::JsonRepresentation
2220
+ end
2221
+ end
2222
+
2021
2223
  class GoogleCloudRetailV2alphaRule
2022
2224
  # @private
2023
2225
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2327,6 +2529,25 @@ module Google
2327
2529
  end
2328
2530
  end
2329
2531
 
2532
+ class GoogleCloudRetailV2alphaTuneModelMetadata
2533
+ # @private
2534
+ class Representation < Google::Apis::Core::JsonRepresentation
2535
+ property :model, as: 'model'
2536
+ end
2537
+ end
2538
+
2539
+ class GoogleCloudRetailV2alphaTuneModelRequest
2540
+ # @private
2541
+ class Representation < Google::Apis::Core::JsonRepresentation
2542
+ end
2543
+ end
2544
+
2545
+ class GoogleCloudRetailV2alphaTuneModelResponse
2546
+ # @private
2547
+ class Representation < Google::Apis::Core::JsonRepresentation
2548
+ end
2549
+ end
2550
+
2330
2551
  class GoogleCloudRetailV2alphaUserEvent
2331
2552
  # @private
2332
2553
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2420,6 +2641,14 @@ module Google
2420
2641
  end
2421
2642
  end
2422
2643
 
2644
+ class GoogleCloudRetailV2betaBigQueryOutputResult
2645
+ # @private
2646
+ class Representation < Google::Apis::Core::JsonRepresentation
2647
+ property :dataset_id, as: 'datasetId'
2648
+ property :table_id, as: 'tableId'
2649
+ end
2650
+ end
2651
+
2423
2652
  class GoogleCloudRetailV2betaExportErrorsConfig
2424
2653
  # @private
2425
2654
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2442,6 +2671,8 @@ module Google
2442
2671
 
2443
2672
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig::Representation
2444
2673
 
2674
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult::Representation
2675
+
2445
2676
  end
2446
2677
  end
2447
2678
 
@@ -2452,6 +2683,8 @@ module Google
2452
2683
 
2453
2684
  property :errors_config, as: 'errorsConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaExportErrorsConfig::Representation
2454
2685
 
2686
+ property :output_result, as: 'outputResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaOutputResult::Representation
2687
+
2455
2688
  end
2456
2689
  end
2457
2690
 
@@ -2504,6 +2737,14 @@ module Google
2504
2737
  end
2505
2738
  end
2506
2739
 
2740
+ class GoogleCloudRetailV2betaOutputResult
2741
+ # @private
2742
+ class Representation < Google::Apis::Core::JsonRepresentation
2743
+ collection :bigquery_result, as: 'bigqueryResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaBigQueryOutputResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2betaBigQueryOutputResult::Representation
2744
+
2745
+ end
2746
+ end
2747
+
2507
2748
  class GoogleCloudRetailV2betaPurgeMetadata
2508
2749
  # @private
2509
2750
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1347,6 +1347,257 @@ module Google
1347
1347
  execute_or_queue_command(command, &block)
1348
1348
  end
1349
1349
 
1350
+ # Creates a new model.
1351
+ # @param [String] parent
1352
+ # Required. The parent resource under which to create the model. Format:
1353
+ # projects/`project_number`/locations/`location_id`/catalogs/`catalog_id`
1354
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
1355
+ # @param [Boolean] dry_run
1356
+ # Optional. Whether to run a dry_run to validate the request (without actually
1357
+ # creating the model).
1358
+ # @param [String] fields
1359
+ # Selector specifying which fields to include in a partial response.
1360
+ # @param [String] quota_user
1361
+ # Available to use for quota purposes for server-side applications. Can be any
1362
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1363
+ # @param [Google::Apis::RequestOptions] options
1364
+ # Request-specific options
1365
+ #
1366
+ # @yield [result, err] Result & error if block supplied
1367
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
1368
+ # @yieldparam err [StandardError] error object if request failed
1369
+ #
1370
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
1371
+ #
1372
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1373
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1374
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1375
+ def create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
1376
+ command = make_simple_command(:post, 'v2alpha/{+parent}/models', options)
1377
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1378
+ command.request_object = google_cloud_retail_v2alpha_model_object
1379
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
1380
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
1381
+ command.params['parent'] = parent unless parent.nil?
1382
+ command.query['dryRun'] = dry_run unless dry_run.nil?
1383
+ command.query['fields'] = fields unless fields.nil?
1384
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1385
+ execute_or_queue_command(command, &block)
1386
+ end
1387
+
1388
+ # Deletes an existing model.
1389
+ # @param [String] name
1390
+ # Required. The resource name of the [Model] to delete. Format: projects/`
1391
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1392
+ # @param [String] fields
1393
+ # Selector specifying which fields to include in a partial response.
1394
+ # @param [String] quota_user
1395
+ # Available to use for quota purposes for server-side applications. Can be any
1396
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1397
+ # @param [Google::Apis::RequestOptions] options
1398
+ # Request-specific options
1399
+ #
1400
+ # @yield [result, err] Result & error if block supplied
1401
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleProtobufEmpty] parsed result object
1402
+ # @yieldparam err [StandardError] error object if request failed
1403
+ #
1404
+ # @return [Google::Apis::RetailV2alpha::GoogleProtobufEmpty]
1405
+ #
1406
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1407
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1408
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1409
+ def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
1410
+ command = make_simple_command(:delete, 'v2alpha/{+name}', options)
1411
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
1412
+ command.response_class = Google::Apis::RetailV2alpha::GoogleProtobufEmpty
1413
+ command.params['name'] = name unless name.nil?
1414
+ command.query['fields'] = fields unless fields.nil?
1415
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1416
+ execute_or_queue_command(command, &block)
1417
+ end
1418
+
1419
+ # Lists all the models linked to this event store.
1420
+ # @param [String] parent
1421
+ # Required. The parent for which to list models. Format: projects/`
1422
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`
1423
+ # @param [Fixnum] page_size
1424
+ # Optional. Maximum number of results to return. If unspecified, defaults to 50.
1425
+ # Max allowed value is 1000.
1426
+ # @param [String] page_token
1427
+ # Optional. A page token, received from a previous `ListModels` call. Provide
1428
+ # this to retrieve the subsequent page.
1429
+ # @param [String] fields
1430
+ # Selector specifying which fields to include in a partial response.
1431
+ # @param [String] quota_user
1432
+ # Available to use for quota purposes for server-side applications. Can be any
1433
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1434
+ # @param [Google::Apis::RequestOptions] options
1435
+ # Request-specific options
1436
+ #
1437
+ # @yield [result, err] Result & error if block supplied
1438
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse] parsed result object
1439
+ # @yieldparam err [StandardError] error object if request failed
1440
+ #
1441
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse]
1442
+ #
1443
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1444
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1445
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1446
+ def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1447
+ command = make_simple_command(:get, 'v2alpha/{+parent}/models', options)
1448
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse::Representation
1449
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse
1450
+ command.params['parent'] = parent unless parent.nil?
1451
+ command.query['pageSize'] = page_size unless page_size.nil?
1452
+ command.query['pageToken'] = page_token unless page_token.nil?
1453
+ command.query['fields'] = fields unless fields.nil?
1454
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1455
+ execute_or_queue_command(command, &block)
1456
+ end
1457
+
1458
+ # Update of model metadata. Only fields that currently can be updated are:
1459
+ # filtering_option, periodic_tuning_state. If other values are provided, this
1460
+ # API method will ignore them.
1461
+ # @param [String] name
1462
+ # Required. The fully qualified resource name of the model. Format: projects/`
1463
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1464
+ # catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
1465
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] google_cloud_retail_v2alpha_model_object
1466
+ # @param [String] update_mask
1467
+ # Optional. Indicates which fields in the provided 'model' to update. If not set,
1468
+ # will by default update all fields.
1469
+ # @param [String] fields
1470
+ # Selector specifying which fields to include in a partial response.
1471
+ # @param [String] quota_user
1472
+ # Available to use for quota purposes for server-side applications. Can be any
1473
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1474
+ # @param [Google::Apis::RequestOptions] options
1475
+ # Request-specific options
1476
+ #
1477
+ # @yield [result, err] Result & error if block supplied
1478
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
1479
+ # @yieldparam err [StandardError] error object if request failed
1480
+ #
1481
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
1482
+ #
1483
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1484
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1485
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1486
+ def patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1487
+ command = make_simple_command(:patch, 'v2alpha/{+name}', options)
1488
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1489
+ command.request_object = google_cloud_retail_v2alpha_model_object
1490
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1491
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
1492
+ command.params['name'] = name unless name.nil?
1493
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1494
+ command.query['fields'] = fields unless fields.nil?
1495
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1496
+ execute_or_queue_command(command, &block)
1497
+ end
1498
+
1499
+ # Pauses the training of an existing model.
1500
+ # @param [String] name
1501
+ # Required. The name of the model to pause. Format: projects/`project_number`/
1502
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1503
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest] google_cloud_retail_v2alpha_pause_model_request_object
1504
+ # @param [String] fields
1505
+ # Selector specifying which fields to include in a partial response.
1506
+ # @param [String] quota_user
1507
+ # Available to use for quota purposes for server-side applications. Can be any
1508
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1509
+ # @param [Google::Apis::RequestOptions] options
1510
+ # Request-specific options
1511
+ #
1512
+ # @yield [result, err] Result & error if block supplied
1513
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
1514
+ # @yieldparam err [StandardError] error object if request failed
1515
+ #
1516
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
1517
+ #
1518
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1519
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1520
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1521
+ def pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1522
+ command = make_simple_command(:post, 'v2alpha/{+name}:pause', options)
1523
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest::Representation
1524
+ command.request_object = google_cloud_retail_v2alpha_pause_model_request_object
1525
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1526
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
1527
+ command.params['name'] = name unless name.nil?
1528
+ command.query['fields'] = fields unless fields.nil?
1529
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1530
+ execute_or_queue_command(command, &block)
1531
+ end
1532
+
1533
+ # Resumes the training of an existing model.
1534
+ # @param [String] name
1535
+ # Required. The name of the model to resume. Format: projects/`project_number`/
1536
+ # locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1537
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest] google_cloud_retail_v2alpha_resume_model_request_object
1538
+ # @param [String] fields
1539
+ # Selector specifying which fields to include in a partial response.
1540
+ # @param [String] quota_user
1541
+ # Available to use for quota purposes for server-side applications. Can be any
1542
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1543
+ # @param [Google::Apis::RequestOptions] options
1544
+ # Request-specific options
1545
+ #
1546
+ # @yield [result, err] Result & error if block supplied
1547
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel] parsed result object
1548
+ # @yieldparam err [StandardError] error object if request failed
1549
+ #
1550
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel]
1551
+ #
1552
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1553
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1554
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1555
+ def resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1556
+ command = make_simple_command(:post, 'v2alpha/{+name}:resume', options)
1557
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest::Representation
1558
+ command.request_object = google_cloud_retail_v2alpha_resume_model_request_object
1559
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
1560
+ command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
1561
+ command.params['name'] = name unless name.nil?
1562
+ command.query['fields'] = fields unless fields.nil?
1563
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1564
+ execute_or_queue_command(command, &block)
1565
+ end
1566
+
1567
+ # Tunes an existing model.
1568
+ # @param [String] name
1569
+ # Required. The resource name of the model to tune. Format: projects/`
1570
+ # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
1571
+ # @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest] google_cloud_retail_v2alpha_tune_model_request_object
1572
+ # @param [String] fields
1573
+ # Selector specifying which fields to include in a partial response.
1574
+ # @param [String] quota_user
1575
+ # Available to use for quota purposes for server-side applications. Can be any
1576
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1577
+ # @param [Google::Apis::RequestOptions] options
1578
+ # Request-specific options
1579
+ #
1580
+ # @yield [result, err] Result & error if block supplied
1581
+ # @yieldparam result [Google::Apis::RetailV2alpha::GoogleLongrunningOperation] parsed result object
1582
+ # @yieldparam err [StandardError] error object if request failed
1583
+ #
1584
+ # @return [Google::Apis::RetailV2alpha::GoogleLongrunningOperation]
1585
+ #
1586
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1587
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1588
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1589
+ def tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1590
+ command = make_simple_command(:post, 'v2alpha/{+name}:tune', options)
1591
+ command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest::Representation
1592
+ command.request_object = google_cloud_retail_v2alpha_tune_model_request_object
1593
+ command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
1594
+ command.response_class = Google::Apis::RetailV2alpha::GoogleLongrunningOperation
1595
+ command.params['name'] = name unless name.nil?
1596
+ command.query['fields'] = fields unless fields.nil?
1597
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1598
+ execute_or_queue_command(command, &block)
1599
+ end
1600
+
1350
1601
  # Gets the latest state of a long-running operation. Clients can use this method
1351
1602
  # to poll the operation result at intervals as recommended by the API service.
1352
1603
  # @param [String] name
@@ -1426,9 +1677,9 @@ module Google
1426
1677
 
1427
1678
  # Makes a recommendation prediction.
1428
1679
  # @param [String] placement
1429
- # Required. Full resource name of the format: `placement=projects/*/locations/
1430
- # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
1431
- # locations/global/catalogs/default_catalog/placements/*`. We recommend using
1680
+ # Required. Full resource name of the format: ``placement=projects/*/locations/
1681
+ # global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
1682
+ # locations/global/catalogs/default_catalog/placements/*``. We recommend using
1432
1683
  # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
1433
1684
  # the Recommendations AI serving config or placement. Before you can request
1434
1685
  # predictions from your model, you must create at least one serving config or
@@ -1732,9 +1983,9 @@ module Google
1732
1983
 
1733
1984
  # Makes a recommendation prediction.
1734
1985
  # @param [String] placement
1735
- # Required. Full resource name of the format: `placement=projects/*/locations/
1736
- # global/catalogs/default_catalog/servingConfigs/*` or `placement=projects/*/
1737
- # locations/global/catalogs/default_catalog/placements/*`. We recommend using
1986
+ # Required. Full resource name of the format: ``placement=projects/*/locations/
1987
+ # global/catalogs/default_catalog/servingConfigs/*`` or ``placement=projects/*/
1988
+ # locations/global/catalogs/default_catalog/placements/*``. We recommend using
1738
1989
  # the `servingConfigs` resource. `placements` is a legacy resource. The ID of
1739
1990
  # the Recommendations AI serving config or placement. Before you can request
1740
1991
  # predictions from your model, you must create at least one serving config or