Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCatalogAttribute

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/representations.rb

Overview

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaCatalogAttribute

Returns a new instance of GoogleCloudRetailV2alphaCatalogAttribute.



1131
1132
1133
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1131

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dynamic_facetable_option ⇒ String

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. Corresponds to the JSON property dynamicFacetableOption

Returns:

  • (String) 


1086
1087
1088
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1086

def dynamic_facetable_option
  @dynamic_facetable_option
end

#in_use ⇒ Boolean Also known as: in_use?

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 CatalogAttributes that are not in use by products can be deleted. CatalogAttributes that are in use by products 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. Corresponds to the JSON property inUse

Returns:

  • (Boolean) 


1100
1101
1102
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1100

def in_use
  @in_use
end

#indexable_option ⇒ String

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. Corresponds to the JSON property indexableOption

Returns:

  • (String) 


1108
1109
1110
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1108

def indexable_option
  @indexable_option
end

#key ⇒ String

Required. Attribute name. For example: color, brands, attributes. custom_attribute, such as attributes.xyz. Corresponds to the JSON property key

Returns:

  • (String) 


1114
1115
1116
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1114

def key
  @key
end

#searchable_option ⇒ String

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. Corresponds to the JSON property searchableOption

Returns:

  • (String) 


1123
1124
1125
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1123

def searchable_option
  @searchable_option
end

#type ⇒ String

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

Returns:

  • (String) 


1129
1130
1131
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1129

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 1136

def update!(**args)
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
  @in_use = args[:in_use] if args.key?(:in_use)
  @indexable_option = args[:indexable_option] if args.key?(:indexable_option)
  @key = args[:key] if args.key?(:key)
  @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
  @type = args[:type] if args.key?(:type)
end