Class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaCustomAttribute

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

Overview

A custom attribute that is not explicitly modeled in Product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2betaCustomAttribute

Returns a new instance of GoogleCloudRetailV2betaCustomAttribute.



2175
2176
2177
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2175

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

Instance Attribute Details

#indexable ⇒ Boolean Also known as: indexable?

This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. You may learn more on configuration mode. if true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in SearchService. Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details. Corresponds to the JSON property indexable

Returns:

  • (Boolean) 


2145
2146
2147
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2145

def indexable
  @indexable
end

#numbers ⇒ Array<Float>

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property numbers

Returns:

  • (Array<Float>) 


2153
2154
2155
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2153

def numbers
  @numbers
end

#searchable ⇒ Boolean Also known as: searchable?

This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. You may learn more on configuration mode. If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned. Corresponds to the JSON property searchable

Returns:

  • (Boolean) 


2164
2165
2166
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2164

def searchable
  @searchable
end

#text ⇒ Array<String>

The textual values of this custom attribute. For example, ["yellow", "green"] when the key is "color". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property text

Returns:

  • (Array<String>) 


2173
2174
2175
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2173

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2180
2181
2182
2183
2184
2185
 
# File 'lib/google/apis/retail_v2beta/classes.rb', line 2180

def update!(**args)
  @indexable = args[:indexable] if args.key?(:indexable)
  @numbers = args[:numbers] if args.key?(:numbers)
  @searchable = args[:searchable] if args.key?(:searchable)
  @text = args[:text] if args.key?(:text)
end