Interface CatalogAttributeOrBuilder (2.56.0)

Version 2.56.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 CatalogAttributeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDynamicFacetableOption()

public abstract CatalogAttribute.DynamicFacetableOption getDynamicFacetableOption()

If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.

Must be specified, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;

Returns
Type	Description
CatalogAttribute.DynamicFacetableOption	The dynamicFacetableOption.

getDynamicFacetableOptionValue()

public abstract int getDynamicFacetableOptionValue()

If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.

Must be specified, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;

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

getExactSearchableOption()

public abstract CatalogAttribute.ExactSearchableOption getExactSearchableOption()

If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.

.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;

Returns
Type	Description
CatalogAttribute.ExactSearchableOption	The exactSearchableOption.

getExactSearchableOptionValue()

public abstract int getExactSearchableOptionValue()

If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.

.google.cloud.retail.v2beta.CatalogAttribute.ExactSearchableOption exact_searchable_option = 11;

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

getFacetConfig()

public abstract CatalogAttribute.FacetConfig getFacetConfig()

Contains facet options.

.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
CatalogAttribute.FacetConfig	The facetConfig.

getFacetConfigOrBuilder()

public abstract CatalogAttribute.FacetConfigOrBuilder getFacetConfigOrBuilder()

Contains facet options.

.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
CatalogAttribute.FacetConfigOrBuilder

getInUse()

public abstract boolean getInUse()

Output only. Indicates whether this attribute has been used by any products. True if at least one Product is using this attribute in Product.attributes. Otherwise, this field is False.

CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, [CatalogService.ImportCatalogAttributes][], or CatalogService.UpdateAttributesConfig APIs. This field is False for pre-loaded CatalogAttributes.

Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.

After catalog changes, it takes about 10 minutes for this field to update.

bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The inUse.

getIndexableOption()

public abstract CatalogAttribute.IndexableOption getIndexableOption()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.

Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;

Returns
Type	Description
CatalogAttribute.IndexableOption	The indexableOption.

getIndexableOptionValue()

public abstract int getIndexableOptionValue()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search.

Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.IndexableOption indexable_option = 5;

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

getKey()

public abstract String getKey()

Required. Attribute name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named attributes.abc_xyz can be indexed, but an attribute named attributes.abc-xyz cannot be indexed.

If the attribute key starts with attributes., then the attribute is a custom attribute. Attributes such as brands, patterns, and title are built-in and called system attributes.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The key.

getKeyBytes()

public abstract ByteString getKeyBytes()

Required. Attribute name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named attributes.abc_xyz can be indexed, but an attribute named attributes.abc-xyz cannot be indexed.

If the attribute key starts with attributes., then the attribute is a custom attribute. Attributes such as brands, patterns, and title are built-in and called system attributes.

string key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for key.

getRecommendationsFilteringOption()

public abstract RecommendationsFilteringOption getRecommendationsFilteringOption()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.

.google.cloud.retail.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;

Returns
Type	Description
RecommendationsFilteringOption	The recommendationsFilteringOption.

getRecommendationsFilteringOptionValue()

public abstract int getRecommendationsFilteringOptionValue()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.

.google.cloud.retail.v2beta.RecommendationsFilteringOption recommendations_filtering_option = 8;

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

getRetrievableOption()

public abstract CatalogAttribute.RetrievableOption getRetrievableOption()

If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.

.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;

Returns
Type	Description
CatalogAttribute.RetrievableOption	The retrievableOption.

getRetrievableOptionValue()

public abstract int getRetrievableOptionValue()

If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.

.google.cloud.retail.v2beta.CatalogAttribute.RetrievableOption retrievable_option = 12;

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

getSearchableOption()

public abstract CatalogAttribute.SearchableOption getSearchableOption()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.

If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.

Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;

Returns
Type	Description
CatalogAttribute.SearchableOption	The searchableOption.

getSearchableOptionValue()

public abstract int getSearchableOptionValue()

When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search.

If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes.

Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

.google.cloud.retail.v2beta.CatalogAttribute.SearchableOption searchable_option = 7;

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

getType()

public abstract CatalogAttribute.AttributeType getType()

Output only. The type of this attribute. This is derived from the attribute in Product.attributes.

.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
CatalogAttribute.AttributeType	The type.

getTypeValue()

public abstract int getTypeValue()

Output only. The type of this attribute. This is derived from the attribute in Product.attributes.

.google.cloud.retail.v2beta.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

hasFacetConfig()

public abstract boolean hasFacetConfig()

Contains facet options.

.google.cloud.retail.v2beta.CatalogAttribute.FacetConfig facet_config = 13;

Returns
Type	Description
boolean	Whether the facetConfig field is set.