Interface AttributesConfigOrBuilder (2.56.0)

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.v2.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.v2.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.v2.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()
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.v2.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.v2.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.v2.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.v2.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.