Class Google::Cloud::Retail::V2::SetInventoryRequest (v0.6.4)

Version 0.6.4

• 1.1.0 (latest)
• 1.0.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.1
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.4

Request message for [SetInventory][] method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_missing

def allow_missing() -> ::Boolean

Returns

• (::Boolean) — 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, a NOT_FOUND error is returned if the Product is not found.

#allow_missing=

def allow_missing=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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, a NOT_FOUND error is returned if the Product is not found.

Returns

• (::Boolean) — 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, a NOT_FOUND error is returned if the Product is not found.

#inventory

def inventory() -> ::Google::Cloud::Retail::V2::Product

Returns

• (::Google::Cloud::Retail::V2::Product) — Required. The inventory information to update. The allowable fields to update are:
  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask.

  If [SetInventoryRequest.inventory.name][] is empty or invalid, an INVALID_ARGUMENT error is returned.

  If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  If the Product to update does not have existing inventory information, the provided inventory information will be inserted.

  If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time.

  The last update time is recorded for the following inventory fields:

  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info

  If a full overwrite of inventory information while ignoring timestamps is needed, [UpdateProduct][] should be invoked instead.

#inventory=

def inventory=(value) -> ::Google::Cloud::Retail::V2::Product

Parameter

• value (::Google::Cloud::Retail::V2::Product) — Required. The inventory information to update. The allowable fields to update are:
  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask.

  If [SetInventoryRequest.inventory.name][] is empty or invalid, an INVALID_ARGUMENT error is returned.

  If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  If the Product to update does not have existing inventory information, the provided inventory information will be inserted.

  If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time.

  The last update time is recorded for the following inventory fields:

  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info

  If a full overwrite of inventory information while ignoring timestamps is needed, [UpdateProduct][] should be invoked instead.

Returns

• (::Google::Cloud::Retail::V2::Product) — Required. The inventory information to update. The allowable fields to update are:
  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask.

  If [SetInventoryRequest.inventory.name][] is empty or invalid, an INVALID_ARGUMENT error is returned.

  If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  If the Product to update does not have existing inventory information, the provided inventory information will be inserted.

  If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time.

  The last update time is recorded for the following inventory fields:

  • Product.price_info
  • Product.availability
  • Product.available_quantity
  • Product.fulfillment_info

  If a full overwrite of inventory information while ignoring timestamps is needed, [UpdateProduct][] should be invoked instead.

#set_mask

def set_mask() -> ::Google::Protobuf::FieldMask

Returns

• (::Google::Protobuf::FieldMask) — 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.

#set_mask=

def set_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

• value (::Google::Protobuf::FieldMask) — 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.

Returns

• (::Google::Protobuf::FieldMask) — 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.

#set_time

def set_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — 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.

#set_time=

def set_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — 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.

Returns

• (::Google::Protobuf::Timestamp) — 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.