Class: Google::Apis::RetailV2alpha::CloudRetailService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/retail_v2alpha/service.rb

Overview

Retail API

Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.

Examples:

require 'google/apis/retail_v2alpha'

Retail = Google::Apis::RetailV2alpha # Alias the module
service = Retail::CloudRetailService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudRetailService

Returns a new instance of CloudRetailService.



47
48
49
50
51
52
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 47

def initialize
  super('https://retail.googleapis.com/', '',
        client_name: 'google-apis-retail_v2alpha',
        client_version: Google::Apis::RetailV2alpha::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.

Returns:

  • (String) —

    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.



40
41
42
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 40

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.

Returns:

  • (String) —

    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.



45
46
47
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2alpha_add_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 467

def add_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_add_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:addCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

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.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2alpha_add_fulfillment_places_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 680

def add_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_add_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:addFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2alpha_add_local_inventories_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 728

def add_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_add_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:addLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_local_inventories_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

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.

Parameters:

  • serving_config (String) —

    Required. The source ServingConfig resource name . Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id``

  • google_cloud_retail_v2alpha_add_control_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1868

def add_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_add_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+servingConfig}:addControl', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAddControlRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_add_control_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse

Removes all specified CatalogAttributes from the AttributesConfig.

Parameters:

  • attributes_config (String) —

    Required. The attributes config resource shared by all catalog attributes being deleted. Format: projects/project_number/locations/location_id/ catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 502

def batch_project_location_catalog_attributes_config_remove_catalog_attributes(attributes_config, google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:batchRemoveCatalogAttributes', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_batch_remove_catalog_attributes_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse
  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::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. The parent catalog name, such as projects/1234/locations/global/ catalogs/default_catalog.

  • ets (Fixnum) (defaults to: nil) —

    The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

  • prebuilt_rule (String) (defaults to: nil) —

    The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

  • raw_json (String) (defaults to: nil) —

    An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.

  • uri (String) (defaults to: nil) —

    The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.

  • user_event (String) (defaults to: nil) —

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2226

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, 'v2alpha/{+parent}/userEvents:collect', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleApiHttpBody::Representation
  command.response_class = Google::Apis::RetailV2alpha::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, language_codes: nil, max_suggestions: nil, query: nil, visitor_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse

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.

Parameters:

  • catalog (String) —

    Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

  • dataset (String) (defaults to: nil) —

    Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud- retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: * user- data * cloud-retail: This option requires enabling auto-learning function first. See guidelines.

  • device_type (String) (defaults to: nil) —

    The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. DESKTOP, MOBILE. If it is empty, the suggestions are across all device types. Supported formats: * UNKNOWN_DEVICE_TYPE * DESKTOP * MOBILE * A customized string starts with OTHER_, e.g. OTHER_IPHONE.

  • enable_attribute_suggestions (Boolean) (defaults to: nil) —

    If true, attribute suggestions are enabled and provided in response. This field is only available for "cloud-retail" dataset.

  • language_codes (Array<String>, String) (defaults to: nil) —

    Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.

  • max_suggestions (Fixnum) (defaults to: nil) —

    Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

  • query (String) (defaults to: nil) —

    Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

  • visitor_id (String) (defaults to: nil) —

    Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 116

def complete_project_location_catalog_query(catalog, dataset: nil, device_type: nil, enable_attribute_suggestions: 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, 'v2alpha/{+catalog}:completeQuery', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponse
  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['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_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct

Creates a Product.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch.

  • google_cloud_retail_v2alpha_product_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) (defaults to: nil)
  • product_id (String) (defaults to: nil) —

    Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



770
771
772
773
774
775
776
777
778
779
780
781
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 770

def create_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_product_object = nil, product_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.request_object = google_cloud_retail_v2alpha_product_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent catalog. Format: projects/ project_number/locations/location_id/catalogs/catalog_id``

  • google_cloud_retail_v2alpha_control_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) (defaults to: nil)
  • control_id (String) (defaults to: nil) —

    Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1263

def create_project_location_catalog_control(parent, google_cloud_retail_v2alpha_control_object = nil, control_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/controls', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.request_object = google_cloud_retail_v2alpha_control_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

Creates a new model.

Parameters:

  • parent (String) —

    Required. The parent resource under which to create the model. Format: projects/project_number/locations/location_id/catalogs/catalog_id``

  • google_cloud_retail_v2alpha_model_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) (defaults to: nil)
  • dry_run (Boolean) (defaults to: nil) —

    Optional. Whether to run a dry run to validate the request (without actually creating the model).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1452

def create_project_location_catalog_model(parent, google_cloud_retail_v2alpha_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/models', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.request_object = google_cloud_retail_v2alpha_model_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

Parameters:

  • parent (String) —

    Required. Full resource name of parent. Format: projects/project_number/ locations/location_id/catalogs/catalog_id``

  • google_cloud_retail_v2alpha_serving_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) (defaults to: nil)
  • serving_config_id (String) (defaults to: nil) —

    Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-z-_/.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1907

def create_project_location_catalog_serving_config(parent, google_cloud_retail_v2alpha_serving_config_object = nil, serving_config_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/servingConfigs', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_serving_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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::RetailV2alpha::GoogleProtobufEmpty

Deletes a Product.

Parameters:

  • name (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



811
812
813
814
815
816
817
818
819
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 811

def delete_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleProtobufEmpty

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters:

  • name (String) —

    Required. The resource name of the Control to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/controls/ control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1299

def delete_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleProtobufEmpty

Deletes an existing model.

Parameters:

  • name (String) —

    Required. The resource name of the Model to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_id

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1487

def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleProtobufEmpty

Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Parameters:

  • name (String) —

    Required. The resource name of the ServingConfig to delete. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1943

def delete_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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

#get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

Gets an AttributesConfig.

Parameters:

  • name (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



154
155
156
157
158
159
160
161
162
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 154

def get_project_location_catalog_attributes_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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::RetailV2alpha::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



606
607
608
609
610
611
612
613
614
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 606

def get_project_location_catalog_branch_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_place_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



637
638
639
640
641
642
643
644
645
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 637

def get_project_location_catalog_branch_place_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleCloudRetailV2alphaProduct

Gets a Product.

Parameters:

  • name (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



845
846
847
848
849
850
851
852
853
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 845

def get_project_location_catalog_branch_product(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig

Gets a CompletionConfig.

Parameters:

  • name (String) —

    Required. Full CompletionConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/completionConfig

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



185
186
187
188
189
190
191
192
193
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 185

def get_project_location_catalog_completion_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
  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::RetailV2alpha::GoogleCloudRetailV2alphaControl

Gets a Control.

Parameters:

  • name (String) —

    Required. The resource name of the Control to get. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/controls/ control_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1331

def get_project_location_catalog_control(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse

Get which branch is currently default branch set by CatalogService. SetDefaultBranch method under a specified parent catalog.

Parameters:

  • catalog (String) —

    The parent catalog resource name, such as projects/*/locations/global/ catalogs/default_catalog.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



217
218
219
220
221
222
223
224
225
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 217

def get_project_location_catalog_default_branch(catalog, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+catalog}:getDefaultBranch', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaGetDefaultBranchResponse
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1702
1703
1704
1705
1706
1707
1708
1709
1710
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1702

def get_project_location_catalog_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Parameters:

  • name (String) —

    Required. The resource name of the ServingConfig to get. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id``

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1976

def get_project_location_catalog_serving_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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::RetailV2alpha::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2417
2418
2419
2420
2421
2422
2423
2424
2425
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2417

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2494

def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+name}', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. projects/1234/locations/global/catalogs/default_catalog/branches/ default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

  • google_cloud_retail_v2alpha_import_products_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportProductsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 880

def import_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_import_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportProductsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_products_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. The catalog which the suggestions dataset belongs to. Format: projects/1234/locations/global/catalogs/default_catalog.

  • google_cloud_retail_v2alpha_import_completion_data_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1224

def import_project_location_catalog_completion_datum(parent, google_cloud_retail_v2alpha_import_completion_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/completionData:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportCompletionDataRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_completion_data_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. projects/1234/locations/global/catalogs/default_catalog

  • google_cloud_retail_v2alpha_import_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportUserEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2266

def import_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_import_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:import', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaImportUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_import_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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, require_total_size: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse

Gets a list of Products.

Parameters:

  • parent (String) —

    Required. The parent branch resource name, such as projects/*/locations/ global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

  • filter (String) (defaults to: nil) —

    A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List Product.Type. VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id" * List Products bundled in a Product. Type.COLLECTION Product. For example: collection_product_id = " some_product_id" * List Products with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION" If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • read_mask (String) (defaults to: nil) —

    The fields of Product to return in the responses. If not set or empty, the following fields are returned: * Product.name * Product.id * Product.title * Product.uri * Product.images * Product.price_info * Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • require_total_size (Boolean) (defaults to: nil) —

    If true and page_token is empty, ListProductsResponse.total_size is set to the total count of matched items irrespective of pagination. Notice that setting this field to true affects the performance.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



948
949
950
951
952
953
954
955
956
957
958
959
960
961
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 948

def list_project_location_catalog_branch_products(parent, filter: nil, page_size: nil, page_token: nil, read_mask: nil, require_total_size: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2alpha/{+parent}/products', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListProductsResponse
  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['requireTotalSize'] = require_total_size unless require_total_size.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::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse

Lists all Controls by their parent Catalog.

Parameters:

  • parent (String) —

    Required. The catalog resource name. Format: projects/project_number/ locations/location_id/catalogs/catalog_id``

  • filter (String) (defaults to: nil) —

    Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. * List controls that are used in a single ServingConfig: 'serving_config = " boosted_home_page_cvr"'

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1373

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, 'v2alpha/{+parent}/controls', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListControlsResponse
  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::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse

Lists all the models linked to this event store.

Parameters:

  • parent (String) —

    Required. The parent for which to list models. Format: projects/ project_number/locations/location_id/catalogs/catalog_id``

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListModels call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1524

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, 'v2alpha/{+parent}/models', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListModelsResponse
  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::RetailV2alpha::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1745

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, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse

Lists all ServingConfigs linked to this catalog.

Parameters:

  • parent (String) —

    Required. The catalog resource name. Format: projects/project_number/ locations/location_id/catalogs/catalog_id``

  • page_size (Fixnum) (defaults to: nil) —

    Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.

  • page_token (String) (defaults to: nil) —

    Optional. A page token, received from a previous ListServingConfigs call. Provide this to retrieve the subsequent page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2013

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, 'v2alpha/{+parent}/servingConfigs', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListServingConfigsResponse
  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::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse

Lists all the Catalogs associated with the project.

Parameters:

  • parent (String) —

    Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

  • page_size (Fixnum) (defaults to: nil) —

    Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.

  • page_token (String) (defaults to: nil) —

    A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 259

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, 'v2alpha/{+parent}/catalogs', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaListCatalogsResponse
  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::RetailV2alpha::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2460

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, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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::RetailV2alpha::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2537

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, 'v2alpha/{+name}/operations', options)
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog

Updates the Catalogs.

Parameters:

  • name (String) —

    Required. Immutable. The fully qualified resource name of the catalog.

  • google_cloud_retail_v2alpha_catalog_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 295

def patch_project_location_catalog(name, google_cloud_retail_v2alpha_catalog_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog::Representation
  command.request_object = google_cloud_retail_v2alpha_catalog_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalog
  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_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct

Updates a Product.

Parameters:

  • name (String) —

    Immutable. Full resource name of the product, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch/products/product_id.

  • google_cloud_retail_v2alpha_product_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct) (defaults to: nil)
  • allow_missing (Boolean) (defaults to: nil) —

    If set to true, and the Product is not found, a new Product will be created. In this situation, update_mask is ignored.

  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as " attributes.$key_name". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 996

def patch_project_location_catalog_branch_product(name, google_cloud_retail_v2alpha_product_object = nil, allow_missing: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.request_object = google_cloud_retail_v2alpha_product_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProduct
  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_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl

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.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ controls/*

  • google_cloud_retail_v2alpha_control_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1414

def patch_project_location_catalog_control(name, google_cloud_retail_v2alpha_control_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.request_object = google_cloud_retail_v2alpha_control_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl
  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_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

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.

Parameters:

  • name (String) —

    Required. The fully qualified resource name of the model. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_id catalog_id has char limit of 50. recommendation_model_id has char limit of 40.

  • google_cloud_retail_v2alpha_model_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1565

def patch_project_location_catalog_model(name, google_cloud_retail_v2alpha_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.request_object = google_cloud_retail_v2alpha_model_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

Updates a ServingConfig.

Parameters:

  • name (String) —

    Immutable. Fully qualified name projects/*/locations/global/catalogs/*/ servingConfig/*

  • google_cloud_retail_v2alpha_serving_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2051

def patch_project_location_catalog_serving_config(name, google_cloud_retail_v2alpha_serving_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_serving_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

Pauses the training of an existing model.

Parameters:

  • name (String) —

    Required. The name of the model to pause. Format: projects/project_number/ locations/location_id/catalogs/catalog_id/models/model_id``

  • google_cloud_retail_v2alpha_pause_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1600

def pause_project_location_catalog_model(name, google_cloud_retail_v2alpha_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:pause', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPauseModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_pause_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse

Makes a recommendation prediction.

Parameters:

  • placement (String) —

    Required. Full resource name of the format: placement=projects/*/locations/ global/catalogs/default_catalog/servingConfigs/* or placement=projects/*/ locations/global/catalogs/default_catalog/placements/*. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/ catalogs/default_catalog/configs

  • google_cloud_retail_v2alpha_predict_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1788

def predict_project_location_catalog_placement(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_predict_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
  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_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse

Makes a recommendation prediction.

Parameters:

  • placement (String) —

    Required. Full resource name of the format: placement=projects/*/locations/ global/catalogs/default_catalog/servingConfigs/* or placement=projects/*/ locations/global/catalogs/default_catalog/placements/*. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/ catalogs/default_catalog/configs

  • google_cloud_retail_v2alpha_predict_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2094

def predict_project_location_catalog_serving_config(placement, google_cloud_retail_v2alpha_predict_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:predict', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_predict_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse
  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_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. The resource name of the branch under which the products are created. The format is projects/$projectId/locations/global/catalogs/$catalogId/ branches/$branchId``

  • google_cloud_retail_v2alpha_purge_products_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1040

def purge_project_location_catalog_branch_product(parent, google_cloud_retail_v2alpha_purge_products_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/products:purge', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeProductsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_purge_products_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. The resource name of the catalog under which the events are created. The format is projects/$projectId/locations/global/catalogs/$catalogId``

  • google_cloud_retail_v2alpha_purge_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeUserEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2303

def purge_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_purge_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:purge', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurgeUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_purge_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/1234/locations/ global/catalogs/default_catalog.

  • google_cloud_retail_v2alpha_rejoin_user_events_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRejoinUserEventsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2344

def rejoin_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_rejoin_user_events_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:rejoin', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRejoinUserEventsRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_rejoin_user_events_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2alpha_remove_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 537

def remove_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_remove_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:removeCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

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.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2alpha_remove_fulfillment_places_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1085

def remove_project_location_catalog_branch_product_fulfillment_places(product, google_cloud_retail_v2alpha_remove_fulfillment_places_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:removeFulfillmentPlaces', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_fulfillment_places_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • product (String) —

    Required. Full resource name of Product, such as projects/*/locations/global/ catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  • google_cloud_retail_v2alpha_remove_local_inventories_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1131

def remove_project_location_catalog_branch_product_local_inventories(product, google_cloud_retail_v2alpha_remove_local_inventories_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+product}:removeLocalInventories', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_local_inventories_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig

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.

Parameters:

  • serving_config (String) —

    Required. The source ServingConfig resource name . Format: projects/ project_number/locations/location_id/catalogs/catalog_id/servingConfigs/ serving_config_id``

  • google_cloud_retail_v2alpha_remove_control_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2131

def remove_project_location_catalog_serving_config_control(serving_config, google_cloud_retail_v2alpha_remove_control_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+servingConfig}:removeControl', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaRemoveControlRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_remove_control_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaServingConfig
  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_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

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.

Parameters:

  • attributes_config (String) —

    Required. Full AttributesConfig resource name. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/attributesConfig

  • google_cloud_retail_v2alpha_replace_catalog_attribute_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 573

def replace_project_location_catalog_attributes_config_catalog_attribute(attributes_config, google_cloud_retail_v2alpha_replace_catalog_attribute_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+attributesConfig}:replaceCatalogAttribute', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_replace_catalog_attribute_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

Resumes the training of an existing model.

Parameters:

  • name (String) —

    Required. The name of the model to resume. Format: projects/project_number/ locations/location_id/catalogs/catalog_id/models/model_id``

  • google_cloud_retail_v2alpha_resume_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1634

def resume_project_location_catalog_model(name, google_cloud_retail_v2alpha_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:resume', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaResumeModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_resume_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel
  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_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse

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.

Parameters:

  • placement (String) —

    Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search . This field is used to identify the serving config name and the set of models that will be used to make the search.

  • google_cloud_retail_v2alpha_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1828

def search_project_location_catalog_placements(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
  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_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse

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.

Parameters:

  • placement (String) —

    Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/ default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search . This field is used to identify the serving config name and the set of models that will be used to make the search.

  • google_cloud_retail_v2alpha_search_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2171

def search_project_location_catalog_serving_configs(placement, google_cloud_retail_v2alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+placement}:search', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_search_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponse
  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_v2alpha_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • name (String) —

    Immutable. Full resource name of the product, such as projects/*/locations/ global/catalogs/default_catalog/branches/default_branch/products/product_id.

  • google_cloud_retail_v2alpha_set_inventory_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetInventoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1185

def set_project_location_catalog_branch_product_inventory(name, google_cloud_retail_v2alpha_set_inventory_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:setInventory', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetInventoryRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_set_inventory_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::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.

Parameters:

  • catalog (String) —

    Full resource name of the catalog, such as projects/*/locations/global/ catalogs/default_catalog.

  • google_cloud_retail_v2alpha_set_default_branch_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetDefaultBranchRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 347

def set_project_location_catalog_default_branch(catalog, google_cloud_retail_v2alpha_set_default_branch_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+catalog}:setDefaultBranch', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSetDefaultBranchRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_set_default_branch_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleLongrunningOperation

Tunes an existing model.

Parameters:

  • name (String) —

    Required. The resource name of the model to tune. Format: projects/ project_number/locations/location_id/catalogs/catalog_id/models/model_id

  • google_cloud_retail_v2alpha_tune_model_request_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 1669

def tune_project_location_catalog_model(name, google_cloud_retail_v2alpha_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+name}:tune', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaTuneModelRequest::Representation
  command.request_object = google_cloud_retail_v2alpha_tune_model_request_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::RetailV2alpha::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_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig

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.

Parameters:

  • name (String) —

    Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

  • google_cloud_retail_v2alpha_attributes_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 391

def update_project_location_catalog_attributes_config(name, google_cloud_retail_v2alpha_attributes_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_attributes_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaAttributesConfig
  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_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig

Updates the CompletionConfigs.

Parameters:

  • name (String) —

    Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/ completionConfig

  • google_cloud_retail_v2alpha_completion_config_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 431

def update_project_location_catalog_completion_config(name, google_cloud_retail_v2alpha_completion_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2alpha/{+name}', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
  command.request_object = google_cloud_retail_v2alpha_completion_config_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompletionConfig
  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_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent

Writes a single user event.

Parameters:

  • parent (String) —

    Required. The parent catalog resource name, such as projects/1234/locations/ global/catalogs/default_catalog.

  • google_cloud_retail_v2alpha_user_event_object (Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent) (defaults to: nil)
  • write_async (Boolean) (defaults to: nil) —

    If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
 
# File 'lib/google/apis/retail_v2alpha/service.rb', line 2383

def write_project_location_catalog_user_event(parent, google_cloud_retail_v2alpha_user_event_object = nil, write_async: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2alpha/{+parent}/userEvents:write', options)
  command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
  command.request_object = google_cloud_retail_v2alpha_user_event_object
  command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent::Representation
  command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserEvent
  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