Class: Google::Apis::RetailV2::GoogleCloudRetailV2SetInventoryRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Request message for SetInventory method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2SetInventoryRequest

Returns a new instance of GoogleCloudRetailV2SetInventoryRequest.



3046
3047
3048
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3046

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_missing ⇒ Boolean Also known as: allow_missing?

If set to true, and the Product with name Product.name is not found, the inventory update will still be processed and retained for at most 1 day until the Product is created. If set to false, an INVALID_ARGUMENT error is returned if the Product is not found. Corresponds to the JSON property allowMissing

Returns:

  • (Boolean) 


3022
3023
3024
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3022

def allow_missing
  @allow_missing
end

#inventory ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2Product

Product captures all metadata information of items to be recommended or searched. Corresponds to the JSON property inventory

Returns:



3029
3030
3031
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3029

def inventory
  @inventory
end

#set_mask ⇒ String

Indicates which inventory fields in the provided Product to update. If not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored. Corresponds to the JSON property setMask

Returns:

  • (String) 


3037
3038
3039
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3037

def set_mask
  @set_mask
end

#set_time ⇒ String

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used. Corresponds to the JSON property setTime

Returns:

  • (String) 


3044
3045
3046
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3044

def set_time
  @set_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3051
3052
3053
3054
3055
3056
 
# File 'lib/google/apis/retail_v2/classes.rb', line 3051

def update!(**args)
  @allow_missing = args[:allow_missing] if args.key?(:allow_missing)
  @inventory = args[:inventory] if args.key?(:inventory)
  @set_mask = args[:set_mask] if args.key?(:set_mask)
  @set_time = args[:set_time] if args.key?(:set_time)
end