Reference documentation and code samples for the Google Cloud Retail V2 Client class RemoveLocalInventoriesRequest.
Request message for ProductService.RemoveLocalInventories method.
Generated from protobuf message google.cloud.retail.v2.RemoveLocalInventoriesRequest
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 |
↳ place_ids |
array
Required. A list of place IDs to have their inventory deleted. At most 3000 place IDs are allowed per request. |
↳ remove_time |
Google\Protobuf\Timestamp
The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions 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 removal request 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.
Generated from protobuf field string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPlaceIds
Required. A list of place IDs to have their inventory deleted.
At most 3000 place IDs are allowed per request.
Generated from protobuf field repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPlaceIds
Required. A list of place IDs to have their inventory deleted.
At most 3000 place IDs are allowed per request.
Generated from protobuf field repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRemoveTime
The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used.
Generated from protobuf field .google.protobuf.Timestamp remove_time = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasRemoveTime
clearRemoveTime
setRemoveTime
The time when the inventory deletions are issued. Used to prevent out-of-order updates and deletions on local inventory fields. If not provided, the internal system time will be used.
Generated from protobuf field .google.protobuf.Timestamp remove_time = 5;
| 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 removal request 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 = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setAllowMissing
If set to true, and the Product is not found, the local inventory removal request 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 = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |