Interface AttributesConfigOrBuilder (2.54.0)

Version 2.54.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public interface AttributesConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsCatalogAttributes(String key)

public abstract boolean containsCatalogAttributes(String key)

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.

map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAttributeConfigLevel()

public abstract AttributeConfigLevel getAttributeConfigLevel()

Output only. The AttributeConfigLevel used for this catalog.

.google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
AttributeConfigLevel	The attributeConfigLevel.

getAttributeConfigLevelValue()

public abstract int getAttributeConfigLevelValue()

Output only. The AttributeConfigLevel used for this catalog.

.google.cloud.retail.v2alpha.AttributeConfigLevel attribute_config_level = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for attributeConfigLevel.

getCatalogAttributes() (deprecated)

public abstract Map<String,CatalogAttribute> getCatalogAttributes()

Use #getCatalogAttributesMap() instead.

Returns
Type	Description
Map<String,CatalogAttribute>

getCatalogAttributesCount()

public abstract int getCatalogAttributesCount()

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.

map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

Returns
Type	Description
int

getCatalogAttributesMap()

public abstract Map<String,CatalogAttribute> getCatalogAttributesMap()

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.

map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

Returns
Type	Description
Map<String,CatalogAttribute>

getCatalogAttributesOrDefault(String key, CatalogAttribute defaultValue)

public abstract CatalogAttribute getCatalogAttributesOrDefault(String key, CatalogAttribute defaultValue)

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.

map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

Parameters
Name	Description
key	String
defaultValue	CatalogAttribute

Returns
Type	Description
CatalogAttribute

getCatalogAttributesOrThrow(String key)

public abstract CatalogAttribute getCatalogAttributesOrThrow(String key)

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.

map<string, .google.cloud.retail.v2alpha.CatalogAttribute> catalog_attributes = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
CatalogAttribute

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.