Reference documentation and code samples for the Google Cloud Retail V2 Client class AddLocalInventoriesRequest.
Request message for ProductService.AddLocalInventories method.
Generated from protobuf message google.cloud.retail.v2.AddLocalInventoriesRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ product
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.
↳ local_inventories
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.
↳ add_mask
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
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.
getProduct
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.
Generated from protobuf field string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
string
setProduct
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.
Generated from protobuf field string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
var
string
$this
getLocalInventories
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.
Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
Google\Protobuf\Internal\RepeatedField
setLocalInventories
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.
Generated from protobuf field repeated .google.cloud.retail.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
$this
getAddMask
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.
Generated from protobuf field .google.protobuf.FieldMask add_mask = 4;
Google\Protobuf\FieldMask|null
hasAddMask
clearAddMask
setAddMask
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.
Generated from protobuf field .google.protobuf.FieldMask add_mask = 4;
var
Google\Protobuf\FieldMask
$this
getAddTime
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.
Generated from protobuf field .google.protobuf.Timestamp add_time = 5;
Google\Protobuf\Timestamp|null
hasAddTime
clearAddTime
setAddTime
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.
Generated from protobuf field .google.protobuf.Timestamp add_time = 5;
var
Google\Protobuf\Timestamp
$this
getAllowMissing
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.
Generated from protobuf field bool allow_missing = 6;
bool
setAllowMissing
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.
Generated from protobuf field bool allow_missing = 6;
var
bool
$this
