Google Cloud Retail V2 Client - Class AttributesConfig (1.7.0)

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

Catalog level attribute config.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig
↳ catalog_attributes array|Google\Protobuf\Internal\MapField

Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. The maximum number of catalog attributes allowed in a request is 1000.
↳ attribute_config_level int

Output only. The AttributeConfigLevel used for this catalog.

getName

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

Returns
Type Description
string

setName

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

Parameter
Name Description
var string
Returns
Type Description
$this

getCatalogAttributes

Enable attribute(s) config at catalog level.

For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. The maximum number of catalog attributes allowed in a request is 1000.

Returns
Type Description
Google\Protobuf\Internal\MapField

setCatalogAttributes

Enable attribute(s) config at catalog level.

For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. The maximum number of catalog attributes allowed in a request is 1000.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAttributeConfigLevel

Output only. The AttributeConfigLevel used for this catalog.

Returns
Type Description
int

setAttributeConfigLevel

Output only. The AttributeConfigLevel used for this catalog.

Parameter
Name Description
var int
Returns
Type Description
$this