Google Cloud Retail V2 Client - Class AddLocalInventoriesRequest (1.5.0)

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`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.
`↳ allow_missing`	`bool` 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.

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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`array<Google\Cloud\Retail\V2\LocalInventory>`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

Returns
Type	Description
`bool`

setAllowMissing

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

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. Please see Google\Cloud\Retail\V2\ProductServiceClient::productName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Retail\V2\AddLocalInventoriesRequest`