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 | |
|---|---|
| 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: |
↳ 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: |
↳ 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
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Immutable. The fully qualified resource name of the attribute
config. Format: projects/*/locations/*/catalogs/*/attributesConfig
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| 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.
Generated from protobuf field map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;
| 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.
Generated from protobuf field map<string, .google.cloud.retail.v2.CatalogAttribute> catalog_attributes = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttributeConfigLevel
Output only. The AttributeConfigLevel used for this catalog.
Generated from protobuf field .google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setAttributeConfigLevel
Output only. The AttributeConfigLevel used for this catalog.
Generated from protobuf field .google.cloud.retail.v2.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |