Class: Google::Apis::RetailV2beta::CloudRetailService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::RetailV2beta::CloudRetailService
- Defined in:
- lib/google/apis/retail_v2beta/service.rb
Overview
Vertex AI Search for Retail API
Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://retail.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Adds the specified CatalogAttribute to the AttributesConfig.
-
#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method.
-
#add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field.
-
#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Enables a Control on the specified ServingConfig.
-
#batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse
Removes all specified CatalogAttributes from the AttributesConfig.
-
#collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleApiHttpBody
Writes a single user event from the browser.
-
#complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse
Completes the specified prefix with keyword suggestions.
-
#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Creates a Product.
-
#create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Creates a Control.
-
#create_project_location_catalog_model(parent, google_cloud_retail_v2beta_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Creates a new model.
-
#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Creates a ServingConfig.
-
#delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a Product.
-
#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a Control.
-
#delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes an existing model.
-
#delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a ServingConfig.
-
#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2beta_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Exports analytics metrics.
-
#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Gets an AttributesConfig.
-
#get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Gets a Product.
-
#get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
Gets a CompletionConfig.
-
#get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Gets a Control.
-
#get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse
Get which branch is currently default branch set by CatalogService.
-
#get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Gets a model.
-
#get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Gets a ServingConfig.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation.
-
#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of multiple Products.
-
#import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of processed completion dataset.
-
#import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of User events.
-
#initialize ⇒ CloudRetailService
constructor
A new instance of CloudRetailService.
-
#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse
Gets a list of Products.
-
#list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse
Lists all Controls by their parent Catalog.
-
#list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse
Lists all the models linked to this event store.
-
#list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse
Lists all ServingConfigs linked to this catalog.
-
#list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse
Lists all the Catalogs associated with the project.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request.
-
#patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog
Updates the Catalogs.
-
#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2beta_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Updates a Product.
-
#patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Updates a Control.
-
#patch_project_location_catalog_model(name, google_cloud_retail_v2beta_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Update of model metadata.
-
#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Updates a ServingConfig.
-
#pause_project_location_catalog_model(name, google_cloud_retail_v2beta_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Pauses the training of an existing model.
-
#predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
Makes a recommendation prediction.
-
#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
Makes a recommendation prediction.
-
#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Permanently deletes all selected Products under a branch.
-
#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Deletes permanently all user events specified by the filter provided.
-
#rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Starts a user-event rejoin operation with latest product catalog.
-
#remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Removes the specified CatalogAttribute from the AttributesConfig.
-
#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method.
-
#remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Remove local inventory information for a Product at a list of places at a removal timestamp.
-
#remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Disables a Control on the specified ServingConfig.
-
#replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.
-
#resume_project_location_catalog_model(name, google_cloud_retail_v2beta_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Resumes the training of an existing model.
-
#search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
Performs a search.
-
#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
Performs a search.
-
#set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Updates inventory information for a Product while respecting the last update timestamps of each inventory field.
-
#set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Set a specified branch id as default branch.
-
#tune_project_location_catalog_model(name, google_cloud_retail_v2beta_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Tunes an existing model.
-
#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Updates the AttributesConfig.
-
#update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
Updates the CompletionConfigs.
-
#write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent
Writes a single user event.
Constructor Details
#initialize ⇒ CloudRetailService
Returns a new instance of CloudRetailService.
50 51 52 53 54 55 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 50 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-retail_v2beta', client_version: Google::Apis::RetailV2beta::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
43 44 45 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 43 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
48 49 50 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 48 def quota_user @quota_user end |
Instance Method Details
#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
512 513 514 515 516 517 518 519 520 521 522 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 512 def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+attributesConfig}:addCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2beta_add_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig command.params['attributesConfig'] = attributes_config unless attributes_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService. AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
697 698 699 700 701 702 703 704 705 706 707 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 697 def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+product}:addFulfillmentPlaces', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddFulfillmentPlacesRequest::Representation command.request_object = google_cloud_retail_v2beta_add_fulfillment_places_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['product'] = product unless product.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService. CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
745 746 747 748 749 750 751 752 753 754 755 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 745 def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+product}:addLocalInventories', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddLocalInventoriesRequest::Representation command.request_object = google_cloud_retail_v2beta_add_local_inventories_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['product'] = product unless product.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1909 def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+servingConfig}:addControl', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAddControlRequest::Representation command.request_object = google_cloud_retail_v2beta_add_control_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig command.params['servingConfig'] = serving_config unless serving_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse
Removes all specified CatalogAttributes from the AttributesConfig.
547 548 549 550 551 552 553 554 555 556 557 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 547 def batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+attributesConfig}:batchRemoveCatalogAttributes', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesRequest::Representation command.request_object = google_cloud_retail_v2beta_batch_remove_catalog_attributes_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaBatchRemoveCatalogAttributesResponse command.params['attributesConfig'] = attributes_config unless attributes_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleApiHttpBody
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2267 def collect_project_location_catalog_user_event(parent, ets: nil, prebuilt_rule: nil, raw_json: nil, uri: nil, user_event: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/userEvents:collect', ) command.response_representation = Google::Apis::RetailV2beta::GoogleApiHttpBody::Representation command.response_class = Google::Apis::RetailV2beta::GoogleApiHttpBody command.params['parent'] = parent unless parent.nil? command.query['ets'] = ets unless ets.nil? command.query['prebuiltRule'] = prebuilt_rule unless prebuilt_rule.nil? command.query['rawJson'] = raw_json unless raw_json.nil? command.query['uri'] = uri unless uri.nil? command.query['userEvent'] = user_event unless user_event.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse
Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 124 def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: nil, entity: nil, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+catalog}:completeQuery', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompleteQueryResponse command.params['catalog'] = catalog unless catalog.nil? command.query['dataset'] = dataset unless dataset.nil? command.query['deviceType'] = device_type unless device_type.nil? command.query['enableAttributeSuggestions'] = enable_attribute_suggestions unless enable_attribute_suggestions.nil? command.query['entity'] = entity unless entity.nil? command.query['languageCodes'] = language_codes unless language_codes.nil? command.query['maxSuggestions'] = max_suggestions unless max_suggestions.nil? command.query['query'] = query unless query.nil? command.query['visitorId'] = visitor_id unless visitor_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Creates a Product.
787 788 789 790 791 792 793 794 795 796 797 798 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 787 def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/products', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation command.request_object = google_cloud_retail_v2beta_product_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct command.params['parent'] = parent unless parent.nil? command.query['productId'] = product_id unless product_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1279 def create_project_location_catalog_control(parent, google_cloud_retail_v2beta_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/controls', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation command.request_object = google_cloud_retail_v2beta_control_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl command.params['parent'] = parent unless parent.nil? command.query['controlId'] = control_id unless control_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_catalog_model(parent, google_cloud_retail_v2beta_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Creates a new model.
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1468 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) command = make_simple_command(:post, 'v2beta/{+parent}/models', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.request_object = google_cloud_retail_v2beta_model_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['dryRun'] = dry_run unless dry_run.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1948 def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2beta_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/servingConfigs', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.request_object = google_cloud_retail_v2beta_serving_config_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig command.params['parent'] = parent unless parent.nil? command.query['servingConfigId'] = serving_config_id unless serving_config_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a Product.
828 829 830 831 832 833 834 835 836 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 828 def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
1315 1316 1317 1318 1319 1320 1321 1322 1323 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1315 def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes an existing model.
1503 1504 1505 1506 1507 1508 1509 1510 1511 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1503 def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
1984 1985 1986 1987 1988 1989 1990 1991 1992 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1984 def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2beta_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Exports analytics metrics. Operation.response
is of type
ExportAnalyticsMetricsResponse
. Operation.metadata
is of type
ExportMetadata
.
166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 166 def export_project_location_catalog_analytics_metrics(catalog, google_cloud_retail_v2beta_export_analytics_metrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+catalog}:exportAnalyticsMetrics', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaExportAnalyticsMetricsRequest::Representation command.request_object = google_cloud_retail_v2beta_export_analytics_metrics_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['catalog'] = catalog unless catalog.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Gets an AttributesConfig.
199 200 201 202 203 204 205 206 207 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 199 def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
651 652 653 654 655 656 657 658 659 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 651 def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Gets a Product.
862 863 864 865 866 867 868 869 870 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 862 def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
Gets a CompletionConfig.
230 231 232 233 234 235 236 237 238 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 230 def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Gets a Control.
1347 1348 1349 1350 1351 1352 1353 1354 1355 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1347 def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse
Get which branch is currently default branch set by CatalogService. SetDefaultBranch method under a specified parent catalog.
262 263 264 265 266 267 268 269 270 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 262 def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+catalog}:getDefaultBranch', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaGetDefaultBranchResponse command.params['catalog'] = catalog unless catalog.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Gets a model.
1534 1535 1536 1537 1538 1539 1540 1541 1542 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1534 def get_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
1749 1750 1751 1752 1753 1754 1755 1756 1757 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1749 def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
2017 2018 2019 2020 2021 2022 2023 2024 2025 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2017 def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
2458 2459 2460 2461 2462 2463 2464 2465 2466 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2458 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
2529 2530 2531 2532 2533 2534 2535 2536 2537 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2529 def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of multiple Products. Request processing may be synchronous. Non- existing items are created. Note that it is possible for a subset of the Products to be successfully updated.
897 898 899 900 901 902 903 904 905 906 907 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 897 def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/products:import', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportProductsRequest::Representation command.request_object = google_cloud_retail_v2beta_import_products_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1240 def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2beta_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/completionData:import', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportCompletionDataRequest::Representation command.request_object = google_cloud_retail_v2beta_import_completion_data_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Bulk import of User events. Request processing might be synchronous. Events
that already exist are skipped. Use this method for backfilling historical
user events. Operation.response
is of type ImportResponse
. Note that it is
possible for a subset of the items to be successfully inserted. Operation.
metadata
is of type ImportMetadata
.
2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2307 def import_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:import', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaImportUserEventsRequest::Representation command.request_object = google_cloud_retail_v2beta_import_user_events_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse
Gets a list of Products.
961 962 963 964 965 966 967 968 969 970 971 972 973 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 961 def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/products', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListProductsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['readMask'] = read_mask unless read_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse
Lists all Controls by their parent Catalog.
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1389 def list_project_location_catalog_controls(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/controls', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListControlsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse
Lists all the models linked to this event store.
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1571 def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/models', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListModelsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1786 def list_project_location_catalog_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse
Lists all ServingConfigs linked to this catalog.
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2054 def list_project_location_catalog_serving_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/servingConfigs', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListServingConfigsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse
Lists all the Catalogs associated with the project.
304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 304 def list_project_location_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+parent}/catalogs', ) command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaListCatalogsResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2495 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2566 def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v2beta/{+name}/operations', ) command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog
Updates the Catalogs.
340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 340 def patch_project_location_catalog(name, google_cloud_retail_v2beta_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog::Representation command.request_object = google_cloud_retail_v2beta_catalog_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCatalog command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_catalog_branch_product(name, google_cloud_retail_v2beta_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct
Updates a Product.
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1008 def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2beta_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation command.request_object = google_cloud_retail_v2beta_product_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProduct command.params['name'] = name unless name.nil? command.query['allowMissing'] = allow_missing unless allow_missing.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl
Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1430 def patch_project_location_catalog_control(name, google_cloud_retail_v2beta_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation command.request_object = google_cloud_retail_v2beta_control_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaControl command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_catalog_model(name, google_cloud_retail_v2beta_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Update of model metadata. Only fields that currently can be updated are:
filtering_option
and periodic_tuning_state
. If other values are provided,
this API method ignores them.
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1612 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) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.request_object = google_cloud_retail_v2beta_model_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Updates a ServingConfig.
2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2092 def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2beta_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.request_object = google_cloud_retail_v2beta_serving_config_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#pause_project_location_catalog_model(name, google_cloud_retail_v2beta_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Pauses the training of an existing model.
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1647 def pause_project_location_catalog_model(name, google_cloud_retail_v2beta_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+name}:pause', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPauseModelRequest::Representation command.request_object = google_cloud_retail_v2beta_pause_model_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
Makes a recommendation prediction.
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1829 def predict_project_location_catalog_placement(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+placement}:predict', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation command.request_object = google_cloud_retail_v2beta_predict_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse command.params['placement'] = placement unless placement.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse
Makes a recommendation prediction.
2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2135 def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2beta_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+placement}:predict', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictRequest::Representation command.request_object = google_cloud_retail_v2beta_predict_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPredictResponse command.params['placement'] = placement unless placement.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1052 def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2beta_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/products:purge', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPurgeProductsRequest::Representation command.request_object = google_cloud_retail_v2beta_purge_products_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2344 def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:purge', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaPurgeUserEventsRequest::Representation command.request_object = google_cloud_retail_v2beta_purge_user_events_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2385 def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:rejoin', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRejoinUserEventsRequest::Representation command.request_object = google_cloud_retail_v2beta_rejoin_user_events_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 582 def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+attributesConfig}:removeCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2beta_remove_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig command.params['attributesConfig'] = attributes_config unless attributes_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService. RemoveLocalInventories achieves the same results but provides more fine- grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1101 def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2beta_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+product}:removeFulfillmentPlaces', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveFulfillmentPlacesRequest::Representation command.request_object = google_cloud_retail_v2beta_remove_fulfillment_places_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['product'] = product unless product.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService. CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1147 def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2beta_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+product}:removeLocalInventories', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveLocalInventoriesRequest::Representation command.request_object = google_cloud_retail_v2beta_remove_local_inventories_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['product'] = product unless product.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig
Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.
2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2172 def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2beta_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+servingConfig}:removeControl', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRemoveControlRequest::Representation command.request_object = google_cloud_retail_v2beta_remove_control_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaServingConfig command.params['servingConfig'] = serving_config unless serving_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.
618 619 620 621 622 623 624 625 626 627 628 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 618 def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2beta_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+attributesConfig}:replaceCatalogAttribute', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaReplaceCatalogAttributeRequest::Representation command.request_object = google_cloud_retail_v2beta_replace_catalog_attribute_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig command.params['attributesConfig'] = attributes_config unless attributes_config.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#resume_project_location_catalog_model(name, google_cloud_retail_v2beta_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel
Resumes the training of an existing model.
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1681 def resume_project_location_catalog_model(name, google_cloud_retail_v2beta_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+name}:resume', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaResumeModelRequest::Representation command.request_object = google_cloud_retail_v2beta_resume_model_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaModel command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1869 def search_project_location_catalog_placements(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+placement}:search', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation command.request_object = google_cloud_retail_v2beta_search_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse command.params['placement'] = placement unless placement.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2212 def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+placement}:search', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequest::Representation command.request_object = google_cloud_retail_v2beta_search_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchResponse command.params['placement'] = placement unless placement.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Updates inventory information for a Product while respecting the last update
timestamps of each inventory field. This process is asynchronous and does not
require the Product to exist before updating fulfillment information. If the
request is valid, the update is enqueued and processed downstream. As a
consequence, when a response is returned, updates are not immediately
manifested in the Product queried by ProductService.GetProduct or
ProductService.ListProducts. When inventory is updated with ProductService.
CreateProduct and ProductService.UpdateProduct, the specified inventory field
value(s) overwrite any existing value(s) while ignoring the last update time
for this field. Furthermore, the last update times for the specified inventory
fields are overwritten by the times of the ProductService.CreateProduct or
ProductService.UpdateProduct request. If no inventory fields are set in
CreateProductRequest.product, then any pre-existing inventory information for
this product is used. If no inventory fields are set in SetInventoryRequest.
set_mask, then any existing inventory information is preserved. Pre-existing
inventory information can only be updated with ProductService.SetInventory,
ProductService.AddFulfillmentPlaces, and ProductService.
RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
and the GetOperation API returns NOT_FOUND
afterwards. If conflicting
updates are issued, the Operations associated with the stale updates are not
marked as done until they are obsolete.
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1201 def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2beta_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+name}:setInventory', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetInventoryRequest::Representation command.request_object = google_cloud_retail_v2beta_set_inventory_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleProtobufEmpty
Set a specified branch id as default branch. API methods such as SearchService.
Search, ProductService.GetProduct, ProductService.ListProducts will treat
requests using "default_branch" to the actual branch id set as default. For
example, if projects/*/locations/*/catalogs/*/branches/1
is set as default,
setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/
default_branch
is equivalent to setting SearchRequest.branch to projects/*/
locations/*/catalogs/*/branches/1
. Using multiple branches can be useful when
developers would like to have a staging branch to test and verify for future
usage. When it becomes ready, developers switch on the staging branch using
this API while keeping using projects/*/locations/*/catalogs/*/branches/
default_branch
as SearchRequest.branch to route the traffic to this staging
branch. CAUTION: If you have live predict/search traffic, switching the
default branch could potentially cause outages if the ID space of the new
branch is very different from the old one. More specifically: *
PredictionService will only return product IDs from branch newBranch
. *
SearchService will only return product IDs from branch newBranch
(if branch
is not explicitly set). * UserEventService will only join events with products
from branch newBranch
.
392 393 394 395 396 397 398 399 400 401 402 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 392 def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2beta_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+catalog}:setDefaultBranch', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSetDefaultBranchRequest::Representation command.request_object = google_cloud_retail_v2beta_set_default_branch_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleProtobufEmpty::Representation command.response_class = Google::Apis::RetailV2beta::GoogleProtobufEmpty command.params['catalog'] = catalog unless catalog.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#tune_project_location_catalog_model(name, google_cloud_retail_v2beta_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleLongrunningOperation
Tunes an existing model.
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 1716 def tune_project_location_catalog_model(name, google_cloud_retail_v2beta_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+name}:tune', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaTuneModelRequest::Representation command.request_object = google_cloud_retail_v2beta_tune_model_request_object command.response_representation = Google::Apis::RetailV2beta::GoogleLongrunningOperation::Representation command.response_class = Google::Apis::RetailV2beta::GoogleLongrunningOperation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig
Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
436 437 438 439 440 441 442 443 444 445 446 447 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 436 def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2beta_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.request_object = google_cloud_retail_v2beta_attributes_config_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaAttributesConfig command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig
Updates the CompletionConfigs.
476 477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 476 def update_project_location_catalog_completion_config(name, google_cloud_retail_v2beta_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v2beta/{+name}', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation command.request_object = google_cloud_retail_v2beta_completion_config_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCompletionConfig command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent
Writes a single user event.
2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 |
# File 'lib/google/apis/retail_v2beta/service.rb', line 2424 def write_project_location_catalog_user_event(parent, google_cloud_retail_v2beta_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v2beta/{+parent}/userEvents:write', ) command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation command.request_object = google_cloud_retail_v2beta_user_event_object command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent::Representation command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserEvent command.params['parent'] = parent unless parent.nil? command.query['writeAsync'] = write_async unless write_async.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |