Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SetInventoryRequest.
Request message for [SetInventory][] method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allow_missing
def allow_missing() -> ::Boolean- (::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- 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.
- (::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-
(::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 caller can replace place IDs for a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types and corresponding place IDs to update in [SetInventoryRequest.inventory.fulfillment_info][]
The caller can clear all place IDs from a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types to clear in [SetInventoryRequest.inventory.fulfillment_info][]
- Checks that only the desired fulfillment info types have empty [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
The last update time is recorded for the following inventory fields:
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-
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 caller can replace place IDs for a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types and corresponding place IDs to update in [SetInventoryRequest.inventory.fulfillment_info][]
The caller can clear all place IDs from a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types to clear in [SetInventoryRequest.inventory.fulfillment_info][]
- Checks that only the desired fulfillment info types have empty [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
The last update time is recorded for the following inventory fields:
If a full overwrite of inventory information while ignoring timestamps is needed, [UpdateProduct][] should be invoked instead.
-
(::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 caller can replace place IDs for a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types and corresponding place IDs to update in [SetInventoryRequest.inventory.fulfillment_info][]
The caller can clear all place IDs from a subset of fulfillment types in the following ways:
- Adds "fulfillment_info" in SetInventoryRequest.set_mask
- Specifies only the desired fulfillment types to clear in [SetInventoryRequest.inventory.fulfillment_info][]
- Checks that only the desired fulfillment info types have empty [SetInventoryRequest.inventory.fulfillment_info.place_ids][]
The last update time is recorded for the following inventory fields:
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-
(::Google::Protobuf::FieldMask) — Indicates which inventory fields in the provided
Product to update.
At least one field must be provided.
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-
value (::Google::Protobuf::FieldMask) — Indicates which inventory fields in the provided
Product to update.
At least one field must be provided.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.
-
(::Google::Protobuf::FieldMask) — Indicates which inventory fields in the provided
Product to update.
At least one field must be provided.
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- (::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- 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.
- (::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.