Google Cloud Retail V2 Client - Class SetInventoryRequest (2.1.2)

Version latest

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Retail V2 Client class SetInventoryRequest.

Request message for ProductService.SetInventory method.

Generated from protobuf message google.cloud.retail.v2.SetInventoryRequest

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ inventory	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.
↳ set_mask	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.
↳ 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. If not provided, the internal system time will be used.
↳ allow_missing	bool 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.

getInventory

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
Type	Description
Product|null

hasInventory

clearInventory

setInventory

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.

Parameter
Name	Description
var	Product

Returns
Type	Description
$this

getSetMask

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
Type	Description
Google\Protobuf\FieldMask|null

hasSetMask

clearSetMask

setSetMask

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.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getSetTime

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
Type	Description
Google\Protobuf\Timestamp|null

hasSetTime

clearSetTime

setSetTime

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.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getAllowMissing

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
Type	Description
bool

setAllowMissing

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameters
Name	Description
inventory	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.
setMask	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.

Returns
Type	Description
SetInventoryRequest