Google Cloud Retail V2 Client - Class AttributesConfig (1.2.1)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getAttributeConfigLevel

Output only. The AttributeConfigLevel used for this catalog.

Returns
TypeDescription
int

setAttributeConfigLevel

Output only. The AttributeConfigLevel used for this catalog.

Parameter
NameDescription
var int
Returns
TypeDescription
$this