Google Cloud Retail V2 Client - Class ReplaceCatalogAttributeRequest (1.0.1)

Version 1.0.1

• 2.1.0 (latest)
• 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 ReplaceCatalogAttributeRequest.

Request for CatalogService.ReplaceCatalogAttribute method.

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

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	Google\Cloud\Retail\V2\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

Generated from protobuf field string attributes_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
Type	Description
string

setAttributesConfig

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

Generated from protobuf field string attributes_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCatalogAttribute

Required. The updated CatalogAttribute.

Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute catalog_attribute = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Google\Cloud\Retail\V2\CatalogAttribute|null

hasCatalogAttribute

clearCatalogAttribute

setCatalogAttribute

Required. The updated CatalogAttribute.

Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute catalog_attribute = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
var	Google\Cloud\Retail\V2\CatalogAttribute

Returns
Type	Description
$this

getUpdateMask

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

• CatalogAttribute.key If not set, all supported fields are updated.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 3;

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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

• CatalogAttribute.key If not set, all supported fields are updated.

Generated from protobuf field .google.protobuf.FieldMask update_mask = 3;

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this