Reference documentation and code samples for the Google Cloud Retail V2 Client class UpdateProductRequest.
Request message for ProductService.UpdateProduct method.
Generated from protobuf message google.cloud.retail.v2.UpdateProductRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ product |
Google\Cloud\Retail\V2\Product
Required. The product to update/create. If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned. |
↳ update_mask |
Google\Protobuf\FieldMask
Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update. |
↳ allow_missing |
bool
If set to true, and the Product is not found, a new Product will be created. In this situation, |
getProduct
Required. The product to update/create.
If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.
Generated from protobuf field .google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\Product|null | |
hasProduct
clearProduct
setProduct
Required. The product to update/create.
If the caller does not have permission to update the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.
Generated from protobuf field .google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\Product
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided Product to update. The immutable and output only fields are NOT supported. If not set, all supported fields (the fields that are neither immutable nor output only) are updated.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. The attribute key can be updated by setting the mask path as "attributes.${key_name}". If a key name is present in the mask but not in the patching product from the request, this key will be deleted after the update.
Generated from protobuf field .google.protobuf.FieldMask update_mask = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowMissing
If set to true, and the Product is not
found, a new Product will be created. In
this situation, update_mask is ignored.
Generated from protobuf field bool allow_missing = 3;
| Returns | |
|---|---|
| Type | Description |
bool | |
setAllowMissing
If set to true, and the Product is not
found, a new Product will be created. In
this situation, update_mask is ignored.
Generated from protobuf field bool allow_missing = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |