Class: Google::Cloud::Retail::V2::SetInventoryRequest

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::SetInventoryRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/product_service.rb

Overview

Request message for ProductService.SetInventory method.

Instance Attribute Summary

• #allow_missing ⇒ ::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.

• #inventory ⇒ ::Google::Cloud::Retail::V2::Product

  Required.

• #set_mask ⇒ ::Google::Protobuf::FieldMask

  Indicates which inventory fields in the provided Product to update.

• #set_time ⇒ ::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.

Instance Attribute Details

#allow_missing ⇒ ::Boolean

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 334

class SetInventoryRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#inventory ⇒ ::Google::Cloud::Retail::V2::Product

Returns 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:

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

If a full overwrite of inventory information while ignoring timestamps is needed, ProductService.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 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:

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

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

# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 334

class SetInventoryRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#set_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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.

Returns:

• (::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.

# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 334

class SetInventoryRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#set_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 334

class SetInventoryRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end