Retail V2 API - Class Google::Cloud::Retail::V2::AddLocalInventoriesRequest (v1.1.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::AddLocalInventoriesRequest.

Request message for ProductService.AddLocalInventories method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#add_mask

def add_mask() -> ::Google::Protobuf::FieldMask
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.

#add_mask=

def add_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::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.

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.

#add_time

def add_time() -> ::Google::Protobuf::Timestamp
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.

#add_time=

def add_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::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.
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.

#allow_missing

def allow_missing() -> ::Boolean
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.

#allow_missing=

def allow_missing=(value) -> ::Boolean
Parameter
  • value (::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.
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.

#local_inventories

def local_inventories() -> ::Array<::Google::Cloud::Retail::V2::LocalInventory>
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.

#local_inventories=

def local_inventories=(value) -> ::Array<::Google::Cloud::Retail::V2::LocalInventory>
Parameter
  • value (::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.
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.

#product

def product() -> ::String
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.

#product=

def product=(value) -> ::String
Parameter
  • value (::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.

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.