Class: Google::Cloud::Retail::V2::AddLocalInventoriesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/product_service.rb

Overview

Request message for ProductService.AddLocalInventories method.

Instance Attribute Summary collapse

Instance Attribute Details

#add_mask ⇒ ::Google::Protobuf::FieldMask

Returns Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is 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 list of LocalInventory to update. The field is updated to the provided value.

    If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

    If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

    If the mask is 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.



490
491
492
493
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 490

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

#add_time ⇒ ::Google::Protobuf::Timestamp

Returns The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.



490
491
492
493
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 490

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

#allow_missing ⇒ ::Boolean

Returns If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once 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 is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.



490
491
492
493
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 490

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

#local_inventories ⇒ ::Array<::Google::Cloud::Retail::V2::LocalInventory>

Returns Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

Returns:

  • (::Array<::Google::Cloud::Retail::V2::LocalInventory>) —

    Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.



490
491
492
493
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 490

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

#product ⇒ ::String

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

Returns:

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



490
491
492
493
 
# File 'proto_docs/google/cloud/retail/v2/product_service.rb', line 490

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