Reference documentation and code samples for the Google Cloud Retail V2 Client class UpdateCatalogRequest.
Request for CatalogService.UpdateCatalog method.
Generated from protobuf message google.cloud.retail.v2.UpdateCatalogRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ catalog |
Google\Cloud\Retail\V2\Catalog
Required. The Catalog to update. If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned. |
↳ update_mask |
Google\Protobuf\FieldMask
Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
getCatalog
Required. The Catalog to update.
If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\Catalog|null | |
hasCatalog
clearCatalog
setCatalog
Required. The Catalog to update.
If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\Catalog
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateMask
Indicates which fields in the provided Catalog to update.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided Catalog to update.
If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
catalog |
Google\Cloud\Retail\V2\Catalog
Required. The Catalog to update. If the caller does not have permission to update the Catalog, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Catalog to update does not exist, a NOT_FOUND error is returned. |
updateMask |
Google\Protobuf\FieldMask
Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\UpdateCatalogRequest | |