Class: Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttribute

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/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) ⇒ GoogleCloudRetailV2CatalogAttribute

Returns a new instance of GoogleCloudRetailV2CatalogAttribute.



819
820
821
 
# File 'lib/google/apis/retail_v2/classes.rb', line 819

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. Must be specified, otherwise throws INVALID_FORMAT error. Corresponds to the JSON property dynamicFacetableOption

Returns:

  • (String) 


744
745
746
 
# File 'lib/google/apis/retail_v2/classes.rb', line 744

def dynamic_facetable_option
  @dynamic_facetable_option
end

#exact_searchable_option ⇒ String

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

Returns:

  • (String) 


752
753
754
 
# File 'lib/google/apis/retail_v2/classes.rb', line 752

def exact_searchable_option
  @exact_searchable_option
end

#facet_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2CatalogAttributeFacetConfig

Possible options for the facet that corresponds to the current attribute config. Corresponds to the JSON property facetConfig

Returns:



758
759
760
 
# File 'lib/google/apis/retail_v2/classes.rb', line 758

def facet_config
  @facet_config
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 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. Corresponds to the JSON property inUse

Returns:

  • (Boolean) 


773
774
775
 
# File 'lib/google/apis/retail_v2/classes.rb', line 773

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. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error. Corresponds to the JSON property indexableOption

Returns:

  • (String) 


783
784
785
 
# File 'lib/google/apis/retail_v2/classes.rb', line 783

def indexable_option
  @indexable_option
end

#key ⇒ String

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

Returns:

  • (String) 


794
795
796
 
# File 'lib/google/apis/retail_v2/classes.rb', line 794

def key
  @key
end

#retrievable_option ⇒ String

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

Returns:

  • (String) 


800
801
802
 
# File 'lib/google/apis/retail_v2/classes.rb', line 800

def retrievable_option
  @retrievable_option
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. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error. Corresponds to the JSON property searchableOption

Returns:

  • (String) 


811
812
813
 
# File 'lib/google/apis/retail_v2/classes.rb', line 811

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) 


817
818
819
 
# File 'lib/google/apis/retail_v2/classes.rb', line 817

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/google/apis/retail_v2/classes.rb', line 824

def update!(**args)
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
  @exact_searchable_option = args[:exact_searchable_option] if args.key?(:exact_searchable_option)
  @facet_config = args[:facet_config] if args.key?(:facet_config)
  @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)
  @retrievable_option = args[:retrievable_option] if args.key?(:retrievable_option)
  @searchable_option = args[:searchable_option] if args.key?(:searchable_option)
  @type = args[:type] if args.key?(:type)
end