Google Cloud Retail V2 Client - Class ReplaceCatalogAttributeRequest (2.1.1)

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

Request for CatalogService.ReplaceCatalogAttribute method.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ attributes_config string

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig
↳ catalog_attribute CatalogAttribute

Required. The updated CatalogAttribute.
↳ update_mask Google\Protobuf\FieldMask

Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported: * * CatalogAttribute.key If not set, all supported fields are updated.

getAttributesConfig

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

Returns
Type Description
string

setAttributesConfig

Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

Parameter
Name Description
var string
Returns
Type Description
$this

getCatalogAttribute

Required. The updated CatalogAttribute.

Returns
Type Description
CatalogAttribute|null

hasCatalogAttribute

clearCatalogAttribute

setCatalogAttribute

Required. The updated CatalogAttribute.

Parameter
Name Description
var CatalogAttribute
Returns
Type Description
$this

getUpdateMask

Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported:

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided CatalogAttribute to update. The following are NOT supported:

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this