Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CatalogAttribute.
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dynamic_facetable_option
def dynamic_facetable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption
-
(::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption) — 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.
#dynamic_facetable_option=
def dynamic_facetable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption
-
value (::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption) — 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::V2::CatalogAttribute::DynamicFacetableOption) — 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.
#exact_searchable_option
def exact_searchable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption
- (::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption) — 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.
#exact_searchable_option=
def exact_searchable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption
- value (::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption) — 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::V2::CatalogAttribute::ExactSearchableOption) — 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.
#in_use
def in_use() -> ::Boolean
-
(::Boolean) — 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 isFalse
.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][google.cloud.retail.v2.CatalogAttribute] that are neither in use by products nor predefined can be deleted. [Catalog attributes][google.cloud.retail.v2.CatalogAttribute] 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.
#indexable_option
def indexable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption
-
(::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption) — 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, otherwise throws INVALID_FORMAT error.
#indexable_option=
def indexable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption
-
value (::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption) — 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, otherwise throws INVALID_FORMAT error.
-
(::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption) — 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, otherwise throws INVALID_FORMAT error.
#key
def key() -> ::String
-
(::String) — Required. Attribute name.
For example:
color
,brands
,attributes.custom_attribute
, such asattributes.xyz
. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyz
can be indexed, but an attribute namedattributes.abc-xyz
cannot be indexed.If the attribute key starts with
attributes.
, then the attribute is a custom attribute. Attributes such asbrands
,patterns
, andtitle
are built-in and called system attributes.
#key=
def key=(value) -> ::String
-
value (::String) — Required. Attribute name.
For example:
color
,brands
,attributes.custom_attribute
, such asattributes.xyz
. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyz
can be indexed, but an attribute namedattributes.abc-xyz
cannot be indexed.If the attribute key starts with
attributes.
, then the attribute is a custom attribute. Attributes such asbrands
,patterns
, andtitle
are built-in and called system attributes.
-
(::String) — Required. Attribute name.
For example:
color
,brands
,attributes.custom_attribute
, such asattributes.xyz
. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute namedattributes.abc_xyz
can be indexed, but an attribute namedattributes.abc-xyz
cannot be indexed.If the attribute key starts with
attributes.
, then the attribute is a custom attribute. Attributes such asbrands
,patterns
, andtitle
are built-in and called system attributes.
#retrievable_option
def retrievable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption
- (::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption) — If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
#retrievable_option=
def retrievable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption
- value (::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption) — If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
- (::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption) — If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
#searchable_option
def searchable_option() -> ::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption
-
(::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption) — 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, otherwise throws INVALID_FORMAT error.
#searchable_option=
def searchable_option=(value) -> ::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption
-
value (::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption) — 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, otherwise throws INVALID_FORMAT error.
-
(::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption) — 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, otherwise throws INVALID_FORMAT error.
#type
def type() -> ::Google::Cloud::Retail::V2::CatalogAttribute::AttributeType
- (::Google::Cloud::Retail::V2::CatalogAttribute::AttributeType) — Output only. The type of this attribute. This is derived from the attribute in Product.attributes.